summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2000-05-28 19:46:08 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2000-05-28 19:46:08 (GMT)
commit832e08dcc70203d84f75249583a95fa172492aa2 (patch)
tree1f7723f69aa2917d2408894c68e7150f7b7ff3d5 /doc
parentf38608d4bec002a5051c860a599dd4d5229a9671 (diff)
downloadDoxygen-832e08dcc70203d84f75249583a95fa172492aa2.zip
Doxygen-832e08dcc70203d84f75249583a95fa172492aa2.tar.gz
Doxygen-832e08dcc70203d84f75249583a95fa172492aa2.tar.bz2
Release-1.1.3-20000528
Diffstat (limited to 'doc')
-rw-r--r--doc/config.doc159
-rw-r--r--doc/faq.doc2
-rw-r--r--doc/index.doc2
3 files changed, 84 insertions, 79 deletions
diff --git a/doc/config.doc b/doc/config.doc
index bc27a16..cfd41d9 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -148,9 +148,9 @@ followed by the descriptions of the tags grouped by category.
\endlatexonly
\subsection config_general General options
+\anchor cfg_project_name
<dl>
-\anchor cfg_project_name
<dt>\c PROJECT_NAME <dd>
\addindex PROJECT_NAME
The \c PROJECT_NAME tag is a single word (or a sequence of words
@@ -269,9 +269,9 @@ followed by the descriptions of the tags grouped by category.
\anchor cfg_always_detailed_sec
<dt>\c ALWAYS_DETAILED_SEC <dd>
-If the \c ALWAYS_DETAILED_SEC and \c REPEAT_BRIEF tags are both set to \c YES then
-Doxygen will generate a detailed section even if there is only a brief
-description.
+ If the \c ALWAYS_DETAILED_SEC and \c REPEAT_BRIEF tags are both set to \c YES then
+ Doxygen will generate a detailed section even if there is only a brief
+ description.
\anchor cfg_full_path_names
<dt>\c FULL_PATH_NAMES <dd>
@@ -369,23 +369,23 @@ description.
\anchor cfg_tab_size
<dt>\c TAB_SIZE <dd>
- \addindex TAB_SIZE
- the \c TAB_SIZE tag can be used to set the number of spaces in a tab.
- Doxygen uses this value to replace tabs by spaces in code fragments.
+ \addindex TAB_SIZE
+ the \c TAB_SIZE tag can be used to set the number of spaces in a tab.
+ Doxygen uses this value to replace tabs by spaces in code fragments.
\anchor cfg_enabled_sections
<dt>\c ENABLED_SECTIONS <dd>
- \addindex ENABLED_SECTIONS
- The \c ENABLE_SECTIONS tag can be used to enable conditional
- documentation sections, marked by \ref cmdif "\\if" \<section-label\> ...
- \ref cmdendif "\\endif" blocks.
+ \addindex ENABLED_SECTIONS
+ The \c ENABLE_SECTIONS tag can be used to enable conditional
+ documentation sections, marked by \ref cmdif "\\if" \<section-label\> ...
+ \ref cmdendif "\\endif" blocks.
</dl>
\subsection config_input Input related options
+\anchor cfg_input
<dl>
-\anchor cfg_input
<dt>\c INPUT <dd>
\addindex INPUT
The \c INPUT tag is used to specify the files and/or directories that contain
@@ -465,9 +465,9 @@ description.
</dl>
\subsection html_output HTML related options
+\anchor cfg_generate_html
<dl>
-\anchor cfg_generate_html
<dt>\c GENERATE_HTML <dd>
\addindex GENERATE_HTML
If the \c GENERATE_HTML tag is set to \c YES (the default) Doxygen will
@@ -553,7 +553,7 @@ TD.md { background-color: #f2f2ff }
DIV.groupHeader { margin-left: 16; margin-top: 12; margin-bottom: 6; font-weight
DIV.groupText { margin-left: 16; font-style: italic; font-size: smaller }
FONT.keyword { color: #008000 }
-FONT.keywordtype { color: #008060 }
+FONT.keywordtype { color: #604020 }
FONT.keywordflow { color: #e08000 }
FONT.comment { color: #800000 }
FONT.preprocessor { color: #806020 }
@@ -563,66 +563,70 @@ FONT.charliteral { color: #008080 }
\anchor cfg_html_align_members
<dt>\c HTML_ALIGN_MEMBERS <dd>
-If the \c HTML_ALIGN_MEMBERS tag is set to \c YES, the members of classes,
-files or namespaces will be aligned in HTML using tables. If set to
-NO a bullet list will be used.
+ \addindex HTML_ALIGN_MEMBERS
+ If the \c HTML_ALIGN_MEMBERS tag is set to \c YES, the members of classes,
+ files or namespaces will be aligned in HTML using tables. If set to
+ NO a bullet list will be used.
-<b>Note:</b>
-Setting this tag to NO will become obsolete in the future, since I only
-intent to support and test the aligned representation.
+ <b>Note:</b>
+ Setting this tag to NO will become obsolete in the future, since I only
+ intent to support and test the aligned representation.
\anchor cfg_generate_htmlhelp
<dt>\c GENERATE_HTMLHELP <dd>
-If the \c GENERATE_HTMLHELP tag is set to \c YES then
-doxygen generates three additional HTML index files:
-\c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a
-project file that can be read by
-<a href="http://msdn.microsoft.com/workshop/author/htmlhelp">
-Microsoft HTML help workshop</a>
-\latexonly
-(see http://msdn.microsoft.com/workshop/author/htmlhelp)
-\endlatexonly
-on Windows.
-
-The HTML workshop contains a compiler that can convert all HTML output
-generated by doxygen into a single compressed HTML file (.chm). Compressed
-HTML files are now used as the Windows 98 help format, and will replace
-the old windows help format (.hlp) on all Windows platforms in the future.
-Compressed HTML files also contain an index, a table of contents,
-and you can search for words in the documentation
-(which basically renders \c doxysearch obsolete on Windows).
-The HTML workshop also contains a viewer for compressed HTML files.
+ \addindex GENERATE_HTMLHELP
+ If the \c GENERATE_HTMLHELP tag is set to \c YES then
+ doxygen generates three additional HTML index files:
+ \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a
+ project file that can be read by
+ <a href="http://msdn.microsoft.com/workshop/author/htmlhelp">
+ Microsoft HTML help workshop</a>
+ \latexonly
+ (see http://msdn.microsoft.com/workshop/author/htmlhelp)
+ \endlatexonly
+ on Windows.
+
+ The HTML workshop contains a compiler that can convert all HTML output
+ generated by doxygen into a single compressed HTML file (.chm). Compressed
+ HTML files are now used as the Windows 98 help format, and will replace
+ the old windows help format (.hlp) on all Windows platforms in the future.
+ Compressed HTML files also contain an index, a table of contents,
+ and you can search for words in the documentation
+ (which basically renders \c doxysearch obsolete on Windows).
+ The HTML workshop also contains a viewer for compressed HTML files.
</dl>
\subsection alphabetical_index Alphabetical index options
+\anchor cfg_alphabetical_index
<dl>
-\anchor cfg_alphabetical_index
<dt>\c ALPHABETICAL_INDEX <dd>
-If the \c ALPHABETICAL_INDEX tag is set to \c YES, an alphabetical index
-of all compounds will be generated. Enable this if the project contains
-a lot of classes, structs, unions or interfaces.
+ \addindex ALPHABETICAL_INDEX
+ If the \c ALPHABETICAL_INDEX tag is set to \c YES, an alphabetical index
+ of all compounds will be generated. Enable this if the project contains
+ a lot of classes, structs, unions or interfaces.
\anchor cfg_cols_in_alpha_index
<dt>\c COLS_IN_ALPHA_INDEX <dd>
-If the alphabetical index is enabled
-(see \c ALPHABETICAL_INDEX) then the \c COLS_IN_ALPHA_INDEX tag can be
-used to specify the number of columns in which this list will be split (can be a number in the range [1..20])
+ \addindex COLS_IN_ALPHA_INDEX
+ If the alphabetical index is enabled
+ (see \c ALPHABETICAL_INDEX) then the \c COLS_IN_ALPHA_INDEX tag can be
+ used to specify the number of columns in which this list will be split (can be a number in the range [1..20])
\anchor cfg_ignore_prefix
<dt>\c IGNORE_PREFIX <dd>
-In case all classes in a project start with a common prefix, all classes will
-be put under the same header in the alphabetical index.
-The \c IGNORE_PREFIX tag can be used to specify a prefix
-(or a list of prefixes) that should be ignored while generating the index
-headers.
+ \addindex IGNORE_PREFIX
+ In case all classes in a project start with a common prefix, all classes will
+ be put under the same header in the alphabetical index.
+ The \c IGNORE_PREFIX tag can be used to specify a prefix
+ (or a list of prefixes) that should be ignored while generating the index
+ headers.
</dl>
-
\subsection latex_output LaTeX related options
+\anchor cfg_generate_latex
<dl>
-\anchor cfg_generate_latex
<dt>\c GENERATE_LATEX <dd>
\addindex GENERATE_LATEX
If the \c GENERATE_LATEX tag is set to \c YES (the default) Doxygen will
@@ -716,32 +720,32 @@ EXTRA_PACKAGES = times
<dt>\c PDF_HYPERLINKS <dd>
\addindex PDF_HYPERLINKS
-If the \c PDF_HYPERLINKS tag is set to \c YES, the LaTeX that is generated
-is prepared for conversion to pdf (using ps2pdf). The pdf file will
-contain links (just like the HTML output) instead of page references
-This makes the output suitable for online browsing using a pdf viewer.
+ If the \c PDF_HYPERLINKS tag is set to \c YES, the LaTeX that is generated
+ is prepared for conversion to pdf (using ps2pdf). The pdf file will
+ contain links (just like the HTML output) instead of page references
+ This makes the output suitable for online browsing using a pdf viewer.
\anchor cfg_latex_batchmode
<dt>\c LATEX_BATCHMODE <dd>
\addindex LATEX_BATCHMODE
-If the \c LATEX_BATCHMODE tag is set to \c YES, doxygen will add the \\batchmode.
-command to the generated \f$\mbox{\LaTeX}\f$ files. This will
-instruct \f$\mbox{\LaTeX}\f$ to keep running if errors occur, instead of
-asking the user for help. This option is also used when generating formulas
-in HTML.
+ If the \c LATEX_BATCHMODE tag is set to \c YES, doxygen will add the \\batchmode.
+ command to the generated \f$\mbox{\LaTeX}\f$ files. This will
+ instruct \f$\mbox{\LaTeX}\f$ to keep running if errors occur, instead of
+ asking the user for help. This option is also used when generating formulas
+ in HTML.
</dl>
-
\subsection rtf_output RTF related options
-<dl>
\anchor cfg_generate_rtf
+<dl>
+
<dt>\c GENERATE_RTF <dd>
\addindex GENERATE_RTF
- If the \c GENERATE_RTF tag is set to \c YES Doxygen will generate RTF output.
- For now this is experimental and is disabled by default. The RTF
- output is optimised for Word 97 and may not look too pretty with
- other readers/editors.
+ If the \c GENERATE_RTF tag is set to \c YES Doxygen will generate RTF output.
+ For now this is experimental and is disabled by default. The RTF
+ output is optimised for Word 97 and may not look too pretty with
+ other readers/editors.
\anchor cfg_rtf_output
<dt>\c RTF_OUTPUT <dd>
@@ -772,9 +776,9 @@ in HTML.
</dl>
\subsection man_output Man page related options
+\anchor cfg_generate_man
<dl>
-\anchor cfg_generate_man
<dt>\c GENERATE_MAN <dd>
\addindex GENERATE_MAN
If the \c GENERATE_MAN tag is set to \c YES (the default) Doxygen will
@@ -797,9 +801,9 @@ in HTML.
</dl>
\subsection config_prepro Preprocessor related options
+\anchor cfg_enable_preprocessing
<dl>
-\anchor cfg_enable_preprocessing
<dt>\c ENABLE_PREPROCESSING <dd>
\addindex ENABLE_PREPROCESSING
If the \c ENABLE_PREPROCESSING tag is set to \c YES (the default) Doxygen will
@@ -843,11 +847,10 @@ in HTML.
\c PREDEFINED tag.
</dl>
-
\subsection config_extref External reference options
+\anchor cfg_tagfiles
<dl>
-\anchor cfg_tagfiles
<dt>\c TAGFILES <dd>
\addindex TAGFILES
The \c TAGFILES tag can be used to specify one or more tagfiles.
@@ -896,9 +899,9 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
</dl>
\subsection config_dot Dot options
+\anchor cfg_have_dot
<dl>
-\anchor cfg_have_dot
<dt>\c HAVE_DOT <dd>
\addindex HAVE_DOT
If you set the \c HAVE_DOT tag to \c YES then doxygen will assume the dot tool is
@@ -910,10 +913,10 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
\anchor cfg_class_graph
<dt>\c CLASS_GRAPH <dd>
\addindex CLASS_GRAPH
-If the \c CLASS_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen
-will generate a graph for each documented class showing the direct and
-indirect inheritance relations. Setting this tag to \c YES will force the
-the \c CLASS_DIAGRAMS tag to NO.
+ If the \c CLASS_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen
+ will generate a graph for each documented class showing the direct and
+ indirect inheritance relations. Setting this tag to \c YES will force the
+ the \c CLASS_DIAGRAMS tag to NO.
\anchor cfg_collaboration_graph
<dt>\c COLLABORATION_GRAPH <dd>
@@ -939,9 +942,9 @@ the \c CLASS_DIAGRAMS tag to NO.
</dl>
\subsection config_search Search engine options
+\anchor cfg_searchengine
<dl>
-\anchor cfg_searchengine
<dt>\c SEARCHENGINE <dd>
\addindex SEARCHENGINE
The \c SEARCHENGINE tag specifies whether or not a
diff --git a/doc/faq.doc b/doc/faq.doc
index 8e3bc1b..cf679f3 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -149,7 +149,7 @@ QDict, QString, QArray, QTextStream, QRegExp etc.
The GUI front-end doxywizard uses Qt for... well... the GUI!
-<li><b>Can use doxygen on my Java code?</b>
+<li><b>Can I use doxygen on my Java code?</b>
No, at the moment there is no support for Java. I suggest to
use Sun's JavaDoc instead.
diff --git a/doc/index.doc b/doc/index.doc
index 1657d03..1c52565 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -163,6 +163,7 @@ Thanks go to:
PDF links, and the configuration generator.
<li>Matthias Andree for providing a .spec script for building rpms from the
sources.
+<li>Tim Mensch for adding the todo command.
<li>Jens Breitenstein, Christophe Bordeaux, Samuel Hägglund, Xet Erixon,
Vlastimil Havran, Ahmed Also Faisal, Alessandro Falappa, Kenji Nagamatsu,
Francisco Oltra Thennet, Olli Korhonen for providing translations into
@@ -236,6 +237,7 @@ Peter Garner,
Fred Labrosse,
Frank Schimmel,
Reinhard Nissl,
+Alexander Gidon,
and many others for suggestions, patches and bug reports.
</ul>
*/