diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.doc | 56 | ||||
| -rw-r--r-- | doc/diagrams.doc | 2 | ||||
| -rw-r--r-- | doc/install.doc | 8 | ||||
| -rw-r--r-- | doc/language.doc | 59 | ||||
| -rw-r--r-- | doc/output.doc | 3 |
5 files changed, 81 insertions, 47 deletions
diff --git a/doc/config.doc b/doc/config.doc index a84184e..aa362e2 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -90,6 +90,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_enabled_sections ENABLED_SECTIONS <li> \refitem cfg_example_path EXAMPLE_PATH <li> \refitem cfg_example_patterns EXAMPLE_PATTERNS +<li> \refitem cfg_example_recursive EXAMPLE_RECURSIVE <li> \refitem cfg_exclude EXCLUDE <li> \refitem cfg_exclude_patterns EXCLUDE_PATTERNS <li> \refitem cfg_expand_as_defined EXPAND_AS_DEFINED @@ -157,6 +158,8 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_project_number PROJECT_NUMBER <li> \refitem cfg_quiet QUIET <li> \refitem cfg_recursive RECURSIVE +<li> \refitem cfg_referenced_by_relation REFERENCED_BY_RELATION +<li> \refitem cfg_references_relation REFERENCES_RELATION <li> \refitem cfg_repeat_brief REPEAT_BRIEF <li> \refitem cfg_rtf_extensions_file RTF_EXTENSIONS_FILE <li> \refitem cfg_rtf_hyperlinks RTF_HYPERLINKS @@ -319,18 +322,6 @@ followed by the descriptions of the tags grouped by category. to \c NO (the default) then the documentation will be excluded. Set it to \c YES to include the internal documentation. -\anchor cfg_source_browser -<dt>\c SOURCE_BROWSER <dd> - \addindex SOURCE_BROWSER - If the \c SOURCE_BROWSER tag is set to \c YES then a list of source files will - be generated. Documented entities will be cross-referenced with these sources. - -\anchor cfg_inline_sources -<dt>\c INLINE_SOURCES <dd> - \addindex INLINE_SOURCES - Setting the \c INLINE_SOURCES tag to \c YES will include the body - of functions, classes and enums directly into the documentation. - \anchor cfg_strip_code_comments <dt>\c STRIP_CODE_COMMENTS <dd> \addindex STRIP_CODE_COMMENTS @@ -588,6 +579,14 @@ followed by the descriptions of the tags grouped by category. directories that contain example code fragments that are included (see the \\include command in section \ref cmdinclude "\\include"). +\anchor cfg_example_recursive +<dt>\c EXAMPLE_RECURSIVE <dd> + \addindex EXAMPLE_RECURSIVE + If the \c EXAMPLE_RECURSIVE tag is set to \c YES then subdirectories will be + searched for input files to be used with the \\include or \\dontinclude + commands irrespective of the value of the \c RECURSIVE tag. + Possible values are \c YES and \c NO. If left blank \c NO is used. + \anchor cfg_example_patterns <dt>\c EXAMPLE_PATTERNS <dd> \addindex EXAMPLE_PATTERNS @@ -626,6 +625,37 @@ followed by the descriptions of the tags grouped by category. </dl> +\subsection sourcebrowser_index Source browsing related options +\anchor cfg_source_browser +<dl> + +<dt>\c SOURCE_BROWSER <dd> + \addindex SOURCE_BROWSER + If the \c SOURCE_BROWSER tag is set to \c YES then a list of source files will + be generated. Documented entities will be cross-referenced with these sources. + +\anchor cfg_inline_sources +<dt>\c INLINE_SOURCES <dd> + \addindex INLINE_SOURCES + Setting the \c INLINE_SOURCES tag to \c YES will include the body + of functions, classes and enums directly into the documentation. + +\anchor cfg_referenced_by_relation +<dt>\c REFERENCED_BY_RELATION <dd> + \addindex REFERENCED_BY_RELATION + If the \c REFERENCED_BY_RELATION tag is set to \c YES (the default) + then for each documented function all documented + functions referencing it will be listed. + +\anchor cfg_references_relation +<dt>\c REFERENCE_RELATION <dd> + \addindex REFERENCES_RELATION + If the \c REFERENCES_RELATION tag is set to \c YES (the default) + then for each documented function all documented entities + called/used by that function will be listed. + +</dl> + \subsection alphabetical_index Alphabetical index options \anchor cfg_alphabetical_index <dl> @@ -1144,7 +1174,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> \addindex HAVE_DOT If you set the \c HAVE_DOT tag to \c YES then doxygen will assume the dot tool is available from the path. This tool is part of - <a href="http://www.graphviz.org/">Graphviz</a>, a graph + <a href="http://www.research.att.com/sw/tools/graphviz/">Graphviz</a>, a graph visualization toolkit from AT&T and Lucent Bell Labs. The other options in this section have no effect if this option is set to \c NO (the default) diff --git a/doc/diagrams.doc b/doc/diagrams.doc index d283ed2..3094720 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -22,7 +22,7 @@ Doxygen can use the "dot" tool from graphviz 1.5 to generate more advanced diagrams & graphs. Graphviz is an open-sourced, cross-platform graph drawing toolkit from AT&T and Lucent Bell Labs and - can be found at http://www.graphviz.org/ + can be found at http://www.research.att.com/sw/tools/graphviz/ If you have the "dot" tool available in the path, you can set \ref cfg_have_dot "HAVE_DOT" to \c YES in the configuration file to diff --git a/doc/install.doc b/doc/install.doc index 1025961..f565ab1 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -61,9 +61,9 @@ tools should be installed. <a href="http://www.tug.org/">teTeX 1.0</a>.<br> \latexonly(see {\tt http://www.tug.org/})\endlatexonly. This is needed for generating LaTeX, Postscript, and PDF output. -<li><a href="http://www.graphviz.org/"> +<li><a href="http://www.research.att.com/sw/tools/graphviz/"> the Graph visualization toolkit version 1.5</a><br> - \latexonly(see {\tt http://www.graphviz.org/})\endlatexonly. + \latexonly(see {\tt http://www.research.att.com/sw/tools/graphviz/})\endlatexonly. Needed for the include dependency graphs, the graphical inheritance graphs, and the collaboration graphs. <li>The ghostscript interpreter. @@ -450,9 +450,9 @@ Here is what is required: <code>objects</code> and <code>bin</code> manually in the root of the distribution before compiling. -<li><a href="http://www.graphviz.org/"> +<li><a href="http://www.research.att.com/sw/tools/graphviz/"> the Graph visualization toolkit version 1.5</a><br> - \latexonly(see {\tt http://www.graphviz.org/})\endlatexonly. + \latexonly(see {\tt http://www.research.att.com/sw/tools/graphviz/})\endlatexonly. Needed for the include dependency graphs, the graphical inheritance graphs, and the collaboration graphs. </ul> diff --git a/doc/language.doc b/doc/language.doc index 19e5133..a586338 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -25,7 +25,7 @@ Doxygen has built-in support for multiple languages. This means that the text fragments that doxygen generates can be produced in languages other than English (the default) at configuration time. -Currently (version 1.2.11), 24 languages +Currently (version 1.2.11-20011021), 24 languages are supported (sorted alphabetically): Brazilian Portuguese, Chinese, Croatian, Czech, Danish, Dutch, English, Finnish, French, German, @@ -54,25 +54,25 @@ when the translator was updated. <TD>Brazilian</TD> <TD>Fabio "FJTC" Jun Takada Chino</TD> <TD>chino@NOSPAM.grad.icmc.sc.usp.br</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Chinese</TD> - <TD>Wang Weihan</TD> - <TD>wangweihan@NOSPAM.capinfo.com.cn</TD> - <TD>1.2.1</TD> + <TD>Wei Liu<br>Wang Weihan</TD> + <TD>liuwei@NOSPAM.asiainfo.com<br>wangweihan@NOSPAM.capinfo.com.cn</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Croatian</TD> <TD>Boris Bralo</TD> <TD>boris.bralo@NOSPAM.zg.tel.hr</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Czech</TD> <TD>Petr Přikryl</TD> <TD>prikrylp@NOSPAM.skil.cz</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Danish</TD> @@ -84,7 +84,7 @@ when the translator was updated. <TD>Dutch</TD> <TD>Dimitri van Heesch</TD> <TD>dimitri@NOSPAM.stack.nl</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>English</TD> @@ -102,13 +102,13 @@ when the translator was updated. <TD>French</TD> <TD>Xavier Outhier</TD> <TD>xouthier@NOSPAM.yahoo.fr</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>German</TD> <TD>Jens Seidel<br>Jens Breitenstein</TD> <TD>jensseidel@NOSPAM.users.sf.net<br>Jens.Breitenstein@NOSPAM.tlc.de</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Hungarian</TD> @@ -120,7 +120,7 @@ when the translator was updated. <TD>Italian</TD> <TD>Ahmed Aldo Faisal<br>Alessandro Falappa</TD> <TD>aaf23@NOSPAM.cam.ac.uk<br>a.falappa@NOSPAM.flashnet.it</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Japanese</TD> @@ -150,7 +150,7 @@ when the translator was updated. <TD>Portuguese</TD> <TD>Rui Godinho Lopes</TD> <TD>ruiglopes@NOSPAM.yahoo.com</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Romanian</TD> @@ -162,19 +162,19 @@ when the translator was updated. <TD>Russian</TD> <TD>Alexandr Chelpanov</TD> <TD>cav@NOSPAM.cryptopro.ru</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Slovak</TD> <TD>Stanislav Kudláč</TD> <TD>qwerty1@NOSPAM.pobox.sk</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Slovene</TD> <TD>Matjaz Ostroversnik</TD> <TD>matjaz.ostroversnik@NOSPAM.zrs-tk.si</TD> - <TD>1.1.5</TD> + <TD>1.2.11</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Spanish</TD> @@ -192,7 +192,7 @@ when the translator was updated. <TD>Ukrainian</TD> <TD>Olexij Tkatchenko</TD> <TD>olexij.tkatchenko@NOSPAM.gmx.de</TD> - <TD>up-to-date</TD> + <TD>1.2.11</TD> </TR> </TABLE> </TD> @@ -205,30 +205,31 @@ when the translator was updated. {\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\ \hline \hline - Brazilian & Fabio "FJTC" Jun Takada Chino & {\tt chino@grad.icmc.sc.usp.br} & up-to-date \\ + Brazilian & Fabio "FJTC" Jun Takada Chino & {\tt chino@grad.icmc.sc.usp.br} & 1.2.11 \\ \hline - Chinese & Wang Weihan & {\tt wangweihan@capinfo.com.cn} & 1.2.1 \\ + Chinese & Wei Liu & {\tt liuwei@asiainfo.com} & 1.2.11 \\ + & Wang Weihan & {\tt wangweihan@capinfo.com.cn} & \\ \hline - Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & up-to-date \\ + Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & 1.2.11 \\ \hline - Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & up-to-date \\ + Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & 1.2.11 \\ \hline Danish & Erik S\o{}e S\o{}rensen & {\tt erik@mail.nu} & 1.2.7 \\ \hline - Dutch & Dimitri van Heesch & {\tt dimitri@stack.nl} & up-to-date \\ + Dutch & Dimitri van Heesch & {\tt dimitri@stack.nl} & 1.2.11 \\ \hline English & Dimitri van Heesch & {\tt dimitri@stack.nl} & up-to-date \\ \hline Finnish & Olli Korhonen & {\tt Olli.Korhonen@ccc.fi} & 1.0.0 \\ \hline - French & Xavier Outhier & {\tt xouthier@yahoo.fr} & up-to-date \\ + French & Xavier Outhier & {\tt xouthier@yahoo.fr} & 1.2.11 \\ \hline - German & Jens Seidel & {\tt jensseidel@users.sf.net} & up-to-date \\ + German & Jens Seidel & {\tt jensseidel@users.sf.net} & 1.2.11 \\ & Jens Breitenstein & {\tt Jens.Breitenstein@tlc.de} & \\ \hline Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt foldvari@diatronltd.com} & 1.2.1 \\ \hline - Italian & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & up-to-date \\ + Italian & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & 1.2.11 \\ & Alessandro Falappa & {\tt a.falappa@flashnet.it} & \\ \hline Japanese & Kenji Nagamatsu & {\tt naga@joyful.club.ne.jp} & 1.2.5 \\ @@ -239,22 +240,22 @@ when the translator was updated. \hline Polish & Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} & 1.2.1 \\ \hline - Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & up-to-date \\ + Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & 1.2.11 \\ \hline Romanian & Alexandru Iosup & {\tt aiosup@yahoo.com} & 1.2.1 \\ \hline - Russian & Alexandr Chelpanov & {\tt cav@cryptopro.ru} & up-to-date \\ + Russian & Alexandr Chelpanov & {\tt cav@cryptopro.ru} & 1.2.11 \\ \hline - Slovak & Stanislav Kudl\'{a}\v{c} & {\tt qwerty1@pobox.sk} & up-to-date \\ + Slovak & Stanislav Kudl\'{a}\v{c} & {\tt qwerty1@pobox.sk} & 1.2.11 \\ \hline - Slovene & Matjaz Ostroversnik & {\tt matjaz.ostroversnik@zrs-tk.si} & 1.1.5 \\ + Slovene & Matjaz Ostroversnik & {\tt matjaz.ostroversnik@zrs-tk.si} & 1.2.11 \\ \hline Spanish & Francisco Oltra Thennet & {\tt foltra@puc.cl} & 1.2.7 \\ \hline Swedish & Samuel H\"{a}agglund & {\tt sahag96@nts.mh.se} & 1.0.0 \\ & XeT Erixon & {\tt xet@hem.passagen.se} & \\ \hline - Ukrainian & Olexij Tkatchenko & {\tt olexij.tkatchenko@gmx.de} & up-to-date \\ + Ukrainian & Olexij Tkatchenko & {\tt olexij.tkatchenko@gmx.de} & 1.2.11 \\ \hline \end{tabular} \endlatexonly diff --git a/doc/output.doc b/doc/output.doc index 8e427a9..4ee733c 100644 --- a/doc/output.doc +++ b/doc/output.doc @@ -32,6 +32,9 @@ The following output formats are \e directly supported by doxygen: <dd>Generated if \c GENERATE_RTF is set to \c YES in the configuration file.<p> Note that the RTF output probably only looks nice with Microsoft's Word 97. If you have success with other programs, please let me know. +<dt><b>XML</b> +<dd>Generated if \c GENERATE_XML is set to \c YES in the configuration file.<p> + Note that the XML output is still under development. </dl> The following output formats are \e indirectly supported by doxygen: |