diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 6 | ||||
| -rw-r--r-- | doc/config.doc | 20 | ||||
| -rw-r--r-- | doc/docblocks.doc | 27 | ||||
| -rw-r--r-- | doc/features.doc | 18 | ||||
| -rw-r--r-- | doc/output.doc | 6 |
5 files changed, 57 insertions, 20 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index b1ce780..e1571b1 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -783,7 +783,7 @@ See section \ref memgroup for an example. \ref cmdendcond "\\endcond" command, which is typically found in another comment block. The main purpose of this pair of commands is to (conditionally) exclude part of a file from processing - (traditionally this could only be achieved using C processor commands). + (in older version of doxygen this could only be achieved using C preprocessor commands). The section between \\cond and \\endcond commands can be included by adding its section label to the \ref cfg_enabled_sections "ENABLED_SECTIONS" @@ -838,8 +838,8 @@ class Implementation : public Intf /// @endcond \endverbatim -The output will be different depending on whether \c ENABLED_SECTIONS -is empty, \c TEST, \c DEV, or \c DEV \c TEST. +The output will be different depending on whether or not \c ENABLED_SECTIONS +contains \c TEST, or \c DEV <hr> \section cmddate \\date { date description } diff --git a/doc/config.doc b/doc/config.doc index 9eaf7a4..049b120 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -100,6 +100,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_external_groups EXTERNAL_GROUPS \refitem cfg_extra_packages EXTRA_PACKAGES \refitem cfg_extract_all EXTRACT_ALL +\refitem cfg_extract_anon_nspaces EXTRACT_ANON_NSPACES \refitem cfg_extract_local_classes EXTRACT_LOCAL_CLASSES \refitem cfg_extract_local_methods EXTRACT_LOCAL_METHODS \refitem cfg_extract_private EXTRACT_PRIVATE @@ -136,6 +137,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_hide_undoc_members HIDE_UNDOC_MEMBERS \refitem cfg_hide_undoc_relations HIDE_UNDOC_RELATIONS \refitem cfg_html_align_members HTML_ALIGN_MEMBERS +\refitem cfg_html_dynamic_sections HTML_DYNAMIC_SECTIONS \refitem cfg_html_footer HTML_FOOTER \refitem cfg_html_header HTML_HEADER \refitem cfg_html_output HTML_OUTPUT @@ -548,6 +550,14 @@ followed by the descriptions of the tags grouped by category. If set to NO only classes defined in header files are included. Does not have any effect for Java sources. +\anchor cfg_extract_anon_nspaces +<dt>\c EXTRACT_ANON_NSPACES <dd> + \addindex EXTRACT_ANON_NSPACES + If this flag is set to YES, the members of anonymous namespaces will be extracted + and appear in the documentation as a namespace called 'anonymous_namespace{file}', + where file will be replaced with the base name of the file that contains the anonymous + namespace. By default anonymous namespace are hidden. + \anchor cfg_extract_local_methods <dt>\c EXTRACT_LOCAL_METHODS <dd> \addindex EXTRACT_LOCAL_METHODS @@ -1128,6 +1138,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" Setting this tag to \c 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> \addindex GENERATE_HTMLHELP @@ -1147,6 +1158,15 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" and you can search for words in the documentation. The HTML workshop also contains a viewer for compressed HTML files. +\anchor cfg_html_dynamic_sections +<dt>\c HTML_DYNAMIC_SECTIONS <dd> + \addindex HTML_DYNAMIC_SECTIONS + If the \c HTML_DYNAMIC_SECTIONS tag is set to \c YES then the generated HTML + documentation will contain sections that can be hidden and shown after the + page has loaded. For this to work a browser that supports + JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox + Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + \anchor cfg_chm_file <dt>\c CHM_FILE <dd> \addindex CHM_FILE diff --git a/doc/docblocks.doc b/doc/docblocks.doc index d5ff845..d364858 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -24,15 +24,21 @@ needs to end up in the generated documentation. For Python code there is a different comment convention, which can be found in section \ref pythonblocks -For each code item there are two types of descriptions, which together -form the documentation: a \e brief description and \e detailed -description, both are optional. -Having more than one brief or detailed description however, is -not allowed. +For each code item there are two (or in some cases three) types of descriptions, +which together form the documentation: a \e brief description and \e detailed +description, both are optional. For methods and functions there is also a third +type of description, the so called "in body" description, which consists of +the concatenation of all comment blocks found within the body of the method or function. + +Having more than one brief or detailed description is allowed (but not recommended, +as the order in which the descriptions will appear is not specified). As the name suggest, a brief description is a short one-liner, whereas the detailed description provides longer, -more detailed documentation. +more detailed documentation. An "in body" description can also act as a detailed +description or can describe a collection of implementation details. +For the HTML output brief descriptions are also +use to provide tooltips at places where an item is referenced. There are several ways to mark a comment block as a detailed description: <ol> @@ -87,6 +93,15 @@ or Some people like to make their comment blocks more visible in the documentation. For this purpose you can use the following: + +\verbatim +/************************************************ + * ... text + ***********************************************/ +\endverbatim + +or + \verbatim ///////////////////////////////////////////////// /// ... text ... diff --git a/doc/features.doc b/doc/features.doc index 9acf6b8..1936b74 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -30,8 +30,8 @@ <li>Automatically generates class and collaboration diagrams in HTML (as clickable image maps) and \f$\mbox{\LaTeX}\f$ (as Encapsulated PostScript images). <li>Uses the dot tool of the Graphviz tool kit to generate - include dependency graphs, collaboration diagrams, and - graphical class hierarchy graphs. + include dependency graphs, collaboration diagrams, call graphs, directory structure + graphs, and graphical class hierarchy graphs. <li>Flexible comment placement: Allows you to put documentation in the header file (before the declaration of an entity), source file (before the definition of an entity) @@ -78,14 +78,14 @@ <li>Can cope with large projects easily. </UL> -Although doxygen can be used in any C or C++ project, -initially it was specifically designed to be used for projects that make -use of Troll Tech's -<A HREF="http://www.trolltech.com/products/qt.html">Qt toolkit</A>. I have tried to make doxygen -`Qt-compatible'. That is: Doxygen can read the documentation contained in -the Qt source code and create a class browser that looks very similar to the +Although doxygen can now be used in any project written in a language that is +supported by doxygen, initially it was specifically designed to be used for projects +that make use of Troll Tech's +<A HREF="http://www.trolltech.com/products/qt.html">Qt toolkit</A>. I have tried to +make doxygen `Qt-compatible'. That is: Doxygen can read the documentation contained in +the Qt source code and create a class browser that looks quite similar to the one that is generated by Troll Tech. Doxygen understands the C++ extensions -used by Qt such as signals and slots. +used by Qt such as signals and slots and many of the markup commands used in the Qt sources. Doxygen can also automatically generate links to existing documentation that was generated with Doxygen or with Qt's non-public class browser diff --git a/doc/output.doc b/doc/output.doc index 76c1b68..21664ba 100644 --- a/doc/output.doc +++ b/doc/output.doc @@ -49,8 +49,10 @@ The following output formats are \e indirectly supported by doxygen: <dt><b>PDF</b>\htmlonly \endhtmlonly <dd>Generated from the \f$\mbox{\LaTeX}\f$ output by running <code>make pdf</code> in the output directory. - In order to get hyperlinks in the PDF file, - \c PDF_HYPERLINKS should be set to \c YES in the configuration file. + To improve the PDF output, you typically would want to enable the use + of \c pdflatex by setting \ref cfg_use_pdflatex "USE_PDFLATEX" to \c YES in the + configuration file. In order to get hyperlinks in the PDF file you also need to enable + \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS". </dl> */ |