diff options
author | mueller <mueller@afe2bf4a-e733-0410-8a33-86f594647bc7> | 1999-12-15 19:26:45 (GMT) |
---|---|---|
committer | mueller <mueller@afe2bf4a-e733-0410-8a33-86f594647bc7> | 1999-12-15 19:26:45 (GMT) |
commit | a6cb7ef1dc7c3d6b6ff949646b9b2deda3fc0bf3 (patch) | |
tree | bec2e27efcff1ecb747c25b00bb9fea1e068d151 /doc | |
parent | 719f0a35063be88eddcc4ed8fe7a940de47ef20c (diff) | |
download | Doxygen-a6cb7ef1dc7c3d6b6ff949646b9b2deda3fc0bf3.zip Doxygen-a6cb7ef1dc7c3d6b6ff949646b9b2deda3fc0bf3.tar.gz Doxygen-a6cb7ef1dc7c3d6b6ff949646b9b2deda3fc0bf3.tar.bz2 |
mods for doxygen-0.49-990522
Diffstat (limited to 'doc')
-rw-r--r-- | doc/autolink.doc | 17 | ||||
-rw-r--r-- | doc/commands.doc | 211 | ||||
-rw-r--r-- | doc/config.doc | 9 | ||||
-rw-r--r-- | doc/index.doc | 5 | ||||
-rw-r--r-- | doc/trouble.doc | 5 |
5 files changed, 139 insertions, 108 deletions
diff --git a/doc/autolink.doc b/doc/autolink.doc index b0f0fa4..900d819 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -18,7 +18,7 @@ Most documentation systems have special `see also' sections where links to other pieces of documentation can be inserted. Although doxygen also has a command to start such a section (See section - \ref cmdsa), it does allow you to put these kind of links anywhere in the + \ref cmdsa "\\sa"), it does allow you to put these kind of links anywhere in the documentation. For \f$\mbox{\LaTeX}\f$ documentation a reference to the page number is written instead of a link. Furthermore, the index at the end of the @@ -93,20 +93,7 @@ for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \subsection resolving Resolving of defines and typedefs. - - Macro definitions of the form: -\verbatim -#define TypeName ClassName -\endverbatim - will be resolved inside documentation blocks. - - \par Example: - \verbinclude resdefine.cpp - \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/resdefine/html/exportedname.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. - \endhtmlonly + \subsection resolving typedefs. Typedefs that involve classes, structs and unions, like \verbatim diff --git a/doc/commands.doc b/doc/commands.doc index c288be7..48f5c53 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -42,6 +42,7 @@ documentation: \endlatexonly <li> \refitem cmda \a <li> \refitem cmdaddindex \addindex +<li> \refitem cmdanchor \anchor <li> \refitem cmdarg \arg <li> \refitem cmdauthor \author <li> \refitem cmdb \b @@ -148,7 +149,7 @@ Doxygen. Unrecognized commands are treated as normal text. classes and members that are documented are automatically replaced by links to the documentation. - \sa section \ref cmdendcode, section \ref cmdverbatim + \sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim" <hr> \subsection cmddef \def <name> @@ -172,14 +173,14 @@ Doxygen. Unrecognized commands are treated as normal text. group of classes, files or namespaces. This can be used to categorize classes, files or namespaces, and document those categories. - \sa section \ref cmdingroup + \sa section \ref cmdingroup "\\ingroup" <hr> \subsection cmdendcode \endcode \addindex \endcode Ends a block of code. - \sa section \ref cmdcode + \sa section \ref cmdcode "\\code" <hr> \subsection cmdenum \enum <name> @@ -226,7 +227,7 @@ Doxygen. Unrecognized commands are treated as normal text. for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \sa section \ref cmdinclude. + \sa section \ref cmdinclude "\\include". <hr> \subsection cmdfile \file [<name>] @@ -266,7 +267,7 @@ Doxygen. Unrecognized commands are treated as normal text. for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \sa section \ref cmdvar and \ref cmdtypedef + \sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef". <hr> \subsection cmdingroup \ingroup <groupname> @@ -275,7 +276,7 @@ Doxygen. Unrecognized commands are treated as normal text. If the \\ingroup command is placed in a comment block of a class, file or namespace, then it will be added to the group. - \sa section \ref cmddefgroup + \sa section \ref cmddefgroup "\\defgroup". <hr> \subsection cmdinternal \internal @@ -337,8 +338,9 @@ Doxygen. Unrecognized commands are treated as normal text. for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \sa section \ref cmdsection, section \ref cmdsubsection, and - section \ref cmdref + \sa section \ref cmdsection "\\section", section + \ref cmdsubsection "\\subsection", and section + \ref cmdref "\\ref". <hr> \subsection cmdrelates \relates <name> @@ -366,7 +368,7 @@ Doxygen. Unrecognized commands are treated as normal text. struct with name \<name\>. The arguments are equal to the \\class command. - \sa section \ref cmdclass. + \sa section \ref cmdclass "\\class". <hr> \subsection cmdtypedef \typedef (typedef declaration) @@ -376,7 +378,7 @@ Doxygen. Unrecognized commands are treated as normal text. typedef (either global or as a member of a class). This command is equivalent to \\var and \\fn. - \sa section \ref cmdfn and \ref cmdvar + \sa section \ref cmdfn "\\fn" and \ref cmdvar "\\var". <hr> \subsection cmdunion \union <name> [<header-file>] [<header-name>] @@ -386,7 +388,7 @@ Doxygen. Unrecognized commands are treated as normal text. union with name \<name\>. The arguments are equal to the \\class command. - \sa section \ref cmdclass. + \sa section \ref cmdclass "\\class". <hr> \subsection cmdvar \var (variable declaration) @@ -396,7 +398,7 @@ Doxygen. Unrecognized commands are treated as normal text. enum value (either global or as a member of a class). This command is equivalent to \\typedef and \\fn. - \sa section \ref cmdfn and \cmdtypedef + \sa section \ref cmdfn "\\fn" and \ref cmdtypedef "\\typedef". <hr> @@ -423,7 +425,7 @@ Doxygen. Unrecognized commands are treated as normal text. for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \sa Section \ref cmdjdauthor. + \sa Section \ref cmdjdauthor "@author". <hr> \subsection cmdbrief \brief {brief description} @@ -437,9 +439,9 @@ Doxygen. Unrecognized commands are treated as normal text. it is advised to keep it brief!). A brief description ends when a blank line or another sectioning command is encountered. If multiple \\brief commands are present they will be joined. See section - \ref cmdauthor for an example. + \ref cmdauthor "\\author" for an example. - \sa Section \ref cmdjdshort + \sa Section \ref cmdjdshort "@short". <hr> \subsection cmdbug \bug { bug description } @@ -453,8 +455,8 @@ Doxygen. Unrecognized commands are treated as normal text. Each bug description will start on a new line. Alternatively, one \\bug command may mention several bugs. The \\bug command ends when a blank line or some other - sectioning command is encountered. See section \ref cmdauthor for an - example. + sectioning command is encountered. See section \ref cmdauthor "\\author" + for an example. <hr> \subsection cmddate \date { date description } @@ -468,10 +470,10 @@ Doxygen. Unrecognized commands are treated as normal text. Each date description will start on a new line. Alternatively, one \\date command may mention several dates. The \\date command ends when a blank line or some other - sectioning command is encountered. See section \ref cmdauthor for an - example. + sectioning command is encountered. See section \ref cmdauthor "\\author" + for an example. - \sa Section \ref cmdjddate. + \sa Section \ref cmdjddate "@date". <hr> \subsection cmdpar \par (paragraph title) { paragraph } @@ -504,10 +506,10 @@ Doxygen. Unrecognized commands are treated as normal text. Multiple adjacent \\param commands will be joined into a single paragraph. Each parameter description will start on a new line. The \\param description ends when a blank line or some other - sectioning command is encountered. See section \ref cmdfn for an + sectioning command is encountered. See section \ref cmdfn "\\fn" for an example. - \sa Section \ref cmdjdparam. + \sa Section \ref cmdjdparam "@param". <hr> \subsection cmdexception \exception <exception-object> { exception description } @@ -521,10 +523,10 @@ Doxygen. Unrecognized commands are treated as normal text. Multiple adjacent \\exception commands will be joined into a single paragraph. Each parameter description will start on a new line. The \\exception description ends when a blank line or some other - sectioning command is encountered. See section \ref cmdfn for an + sectioning command is encountered. See section \ref cmdfn "\\fn" for an example. - \sa Section \ref cmdjdexception. + \sa Section \ref cmdjdexception "@exception". <hr> \subsection cmdreturn \return { description of the return value } @@ -535,10 +537,10 @@ Doxygen. Unrecognized commands are treated as normal text. enhancement commands may be used inside the paragraph. Multiple adjacent \\return commands will be joined into a single paragraph. The \\return description ends when a blank line or some other - sectioning command is encountered. See section \ref cmdfn for an + sectioning command is encountered. See section \ref cmdfn "\\fn" for an example. - \sa Section \ref cmdjdreturn. + \sa Section \ref cmdjdreturn "@return". <hr> \subsection cmdsa \sa { references } @@ -551,8 +553,8 @@ Doxygen. Unrecognized commands are treated as normal text. may be selected by including a parenthesized list of argument types after the method. - \sa section \ref autolink for information on how to create links to objects - and section \ref cmdjdsee for the JavaDoc version of this command. + \sa section \ref autolink "\\autolink" for information on how to create links to objects + and section \ref cmdjdsee "@see" for the JavaDoc version of this command. <hr> \subsection cmdversion \version { version number } @@ -566,10 +568,10 @@ Doxygen. Unrecognized commands are treated as normal text. Each version description will start on a new line. Alternatively, one \\version command may mention several dates. The \\version command ends when a blank line or some other - sectioning command is encountered. See section \ref cmdauthor for an - example. + sectioning command is encountered. See section \ref cmdauthor "\\author" + for an example. - \sa Section \ref cmdjdversion. + \sa Section \ref cmdjdversion "@version". <hr> \subsection cmdwarning \warning { warning message } @@ -583,25 +585,35 @@ Doxygen. Unrecognized commands are treated as normal text. Each warning description will start on a new line. Alternatively, one \\warning command may mention several warnings. The \\warning command ends when a blank line or some other - sectioning command is encountered. See section \ref cmdauthor for an - example. + sectioning command is encountered. See section \ref cmdauthor "\\author" + for an example. +<hr> <h2>\htmlonly <center> --- \endhtmlonly Commands to create links \htmlonly --- </center>\endhtmlonly</h2> -\subsection cmdaddindex \addindex <word> +\subsection cmdaddindex \addindex (text) \addindex \addindex - This command adds \<word\> to the \htmlonly LaTeX\endhtmlonly - \latexonly\LaTeX\ \endlatexonly index. + This command adds (text) to the \f$\mbox{\LaTeX}\f$ index. + +<hr> +\subsection cmdanchor \anchor <word> + \addindex \anchor + This command places an invisble, named anchor into to documentation + to which you can refer with the \\ref command. + + \sa section \ref cmdref "\\ref". + +<hr> \subsection cmdendlink \endlink \addindex \endlink This command ends a link that is started with the \\link command. - \sa section \ref cmdlink. + \sa section \ref cmdlink "\\link". <hr> \subsection cmdlink \link <link-object> @@ -616,25 +628,28 @@ Doxygen. Unrecognized commands are treated as normal text. the \\link and \\endlink commands serves as text for a link to the \<link-object\> specified as the first argument of \\link. - See section \ref autolink for more information on automatically + See section \ref autolink "\\autolink" for more information on automatically generated links and valid link-objects. \b Notice: Keep in mind that links are only meaningful in HTML text; - in \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly - text, the link text is just written to the output. + in \f$\mbox{\LaTeX}\f$ text, the link text is just written to the output. <hr> -\subsection cmdref \ref <section-name> +\subsection cmdref \ref <name> ["(text)"] \addindex \ref - Creates a reference to a named section, subsection, or page. + Creates a reference to a named section, subsection, page or anchor. For HTML documentation the reference command will generate a link to - the section, the title of the section will be used as the link text. - For \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly documentation the reference command will generate a section - number. + the section. For a sections or subsections the title of the section will be + used as the text of the link. For anchor the optional text between quotes + will be used or \<name\> if no text is specified. + For \f$\mbox{\LaTeX}\f$ documentation the reference command will + generate a section number for sections or the text followed by a + page number if \<name\> refers to an anchor. - See section \ref cmdpage for an example of the \\ref command. + \sa + Section \ref cmdpage "\\page" for an example of the \\ref command. <hr> \subsection cmdsection \section <section-name> (section title) @@ -644,7 +659,11 @@ Doxygen. Unrecognized commands are treated as normal text. section should be specified as the second argument of the \\section command. - See section \ref cmdpage for an example of the \\cmdsection command. + \warning This command only works inside related page documentation and + \e not in other documentation blocks! + + \sa + Section \ref cmdpage "\\page" for an example of the \\cmdsection command. <hr> \subsection cmdsubsection \subsection <subsection-name> (subsection title) @@ -653,7 +672,11 @@ Doxygen. Unrecognized commands are treated as normal text. subsection should be specified as the second argument of the \\subsection command. - See section \ref cmdpage for an example of the \\cmdsubsection command. + \warning This command only works inside related page documentation and + \e not in other documentation blocks! + + \sa + Section \ref cmdpage "\\page" for an example of the \\cmdsubsection command. <hr> <h2>\htmlonly <center> --- \endhtmlonly @@ -682,7 +705,8 @@ Doxygen. Unrecognized commands are treated as normal text. for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \sa sections \ref cmdline, \ref cmdskip, \ref cmdskipline, and \ref cmduntil. + \sa sections \ref cmdline "\\line", \ref cmdskip "\\skip", + \ref cmdskipline "\\skipline", and \ref cmduntil "\\until". <hr> \subsection cmdinclude \include <file-name> @@ -706,7 +730,7 @@ Doxygen. Unrecognized commands are treated as normal text. \\until commands. An internal pointer is used for these command. The \\include command sets the pointer to the first line of the example. - \sa section \ref cmdexample and \ref cmddontinclude. + \sa section \ref cmdexample "\\example" and \ref cmddontinclude "\\dontinclude". <hr> \subsection cmdline \line ( pattern ) @@ -722,7 +746,7 @@ Doxygen. Unrecognized commands are treated as normal text. line that was found (or to the end of the example if no such line could be found). - See section \ref cmddontinclude for an example. + See section \ref cmddontinclude "\\dontinclude" for an example. <hr> \subsection cmdskip \skip ( pattern ) @@ -736,7 +760,7 @@ Doxygen. Unrecognized commands are treated as normal text. the example, is set to the start of the line that contains the specified pattern (or to the end of the example if the pattern could not be found). - See section \ref cmddontinclude for an example. + See section \ref cmddontinclude "\\dontinclude" for an example. <hr> \subsection cmdskipline \skipline ( pattern ) @@ -758,7 +782,7 @@ Doxygen. Unrecognized commands are treated as normal text. \skip pattern \line pattern\endverbatim - See section \ref cmddontinclude for an example. + See section \ref cmddontinclude "\\dontinclude" for an example. <hr> \subsection cmduntil \until ( pattern ) @@ -773,7 +797,7 @@ Doxygen. Unrecognized commands are treated as normal text. the example, is set to the start of the line following last written line (or to the end of the example if the pattern could not be found). - See section \ref cmddontinclude for an example. + See section \ref cmddontinclude "\\dontinclude" for an example. <hr> \subsection cmdverbinclude \verbinclude <file-name> @@ -875,7 +899,7 @@ Doxygen. Unrecognized commands are treated as normal text. \addindex \endhtmlonly Ends a block of text that was started with a \\htmlonly command. - \sa section \ref cmdhtmlonly. + \sa section \ref cmdhtmlonly "\\htmlonly". <hr> \subsection cmdendlatexonly \endlatexonly @@ -883,7 +907,7 @@ Doxygen. Unrecognized commands are treated as normal text. \addindex \endlatexonly Ends a block of text that was started with a \\latexonly command. - \sa section \ref cmdlatexonly. + \sa section \ref cmdlatexonly "\\latexonly". <hr> \subsection cmdendverbatim \endverbatim @@ -891,7 +915,7 @@ Doxygen. Unrecognized commands are treated as normal text. \addindex \endverbatim Ends a block of text that was started with a \\verbatim command. - \sa section \ref cmdverbatim. + \sa section \ref cmdverbatim "\\verbatim". <hr> \subsection cmdfdollar \f$ @@ -899,7 +923,7 @@ Doxygen. Unrecognized commands are treated as normal text. \addindex \\f$ Marks the start and end of an in-text formula. - \sa section \ref formulas for an example. + \sa section \ref formulas "formulas" for an example. <hr> \subsection cmdfbropen \f[ @@ -908,7 +932,7 @@ Doxygen. Unrecognized commands are treated as normal text. Marks the start of a long formula that is displayed centered on a separate line. - \sa section \ref cmdfbrclose and section \ref formulas. + \sa section \ref cmdfbrclose "\\f]" and section \ref formulas "formulas". <hr> \subsection cmdfbrclose \f] @@ -917,7 +941,7 @@ Doxygen. Unrecognized commands are treated as normal text. Marks the end of a long formula that is displayed centered on a separate line. - \sa section \ref cmdfbropen and section \ref formulas. + \sa section \ref cmdfbropen ""\\f[" and section \ref formulas "formulas". <hr> \subsection cmdhtmlonly \htmlonly @@ -930,38 +954,42 @@ Doxygen. Unrecognized commands are treated as normal text. This command can be used to include HTML code that is too complex for Doxygen (i.e. images, applets, java-scripts, and HTML tags that require attributes). You can use the \\latexonly and \\endlatexonly - pair to provide a proper \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly alternative. + pair to provide a proper \f$\mbox{\LaTeX}\f$ alternative. \b Notice: environment variables (like \$(HOME) ) are resolved inside a HTML-only block. - \sa section \ref cmdhtmlonly and section \ref cmdlatexonly. + \sa section \ref cmdhtmlonly "\\htmlonly" and section + \ref cmdlatexonly "\\latexonly". <hr> \subsection cmdlatexonly \latexonly \addindex \latexonly Starts a block of text that will be verbatim included in the - generated \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly documentation only. The block ends with a + generated \f$\mbox{\LaTeX}\f$ documentation only. The block ends with a endlatexonly command. - This command can be used to include \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly code that is too complex - for Doxygen (i.e. images, formulas, special characters). You can use the - \\htmlonly and \\endhtmlonly pair to provide a proper HTML alternative. + This command can be used to include \f$\mbox{\LaTeX}\f$ code that is too + complex for Doxygen (i.e. images, formulas, special characters). You can + use the \\htmlonly and \\endhtmlonly pair to provide a proper HTML + alternative. \b Notice: environment variables (like \$(HOME) ) are resolved inside a - \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\endlatexonly-only block. + \f$\mbox{\LaTeX}\f$-only block. - \sa section \ref cmdlatexonly and section \ref cmdhtmlonly. + \sa section \ref cmdlatexonly "\\latexonly" + and section \ref cmdhtmlonly "\\htmlonly". <hr> \subsection cmdverbatim \verbatim \addindex \verbatim Starts a block of text that will be verbatim included in both the - HTML and the \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly documentation. The block should end with a + HTML and the + \f$\mbox{\LaTeX}\f$ documentation. The block should end with a \\endverbatim block. All commands are disabled in a verbatim block. \warning Make sure you include a \\endverbatim command for each @@ -971,30 +999,32 @@ Doxygen. Unrecognized commands are treated as normal text. \subsection cmdbackslash \\ \addindex \\ - This command writes a backslash character (\\) to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. - The backslash has to be escaped in some cases because Doxygen uses it to - detect commands. + This command writes a backslash character (\\) to the HTML and + \f$\mbox{\LaTeX}\f$ output. The backslash has to be escaped in some + cases because Doxygen uses it to detect commands. <hr> \subsection cmdat \@ \addindex \@ - This command writes an at-sign (@) to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. - The at-sign has to be escaped in some cases because Doxygen uses it to - detect JavaDoc commands. + This command writes an at-sign (@) to the HTML and + \f$\mbox{\LaTeX}\f$ output. The at-sign has to be escaped in some cases + because Doxygen uses it to detect JavaDoc commands. <hr> \subsection cmdamp \& \addindex \& - This command writes the \& character to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. This - character has to be escaped because it has a special meaning in HTML. + This command writes the \& character to the HTML and + \f$\mbox{\LaTeX}\f$ output. This character has to be escaped because + it has a special meaning in HTML. <hr> \subsection cmddollar \$ \addindex \$ - This command writes the \$ character to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. This + This command writes the \$ character to the HTML and + \f$\mbox{\LaTeX}\f$ output. This character has to be escaped in some cases, because it is used to expand environment variables. @@ -1002,7 +1032,8 @@ Doxygen. Unrecognized commands are treated as normal text. \subsection cmdhash \# \addindex \# - This command writes the \# character to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. This + This command writes the \# character to the HTML and + \f$\mbox{\LaTeX}\f$ output. This character has to be escaped in some cases, because it is used to refer to documented entities. @@ -1010,14 +1041,16 @@ Doxygen. Unrecognized commands are treated as normal text. \subsection cmdlt \\< \addindex \\< - This command writes the \< character to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. This + This command writes the \< character to the HTML and + \f$\mbox{\LaTeX}\f$ output. This character has to be escaped because it has a special meaning in HTML. <hr> \subsection cmdgt \\> \addindex \\> - This command writes the \> character to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. This + This command writes the \> character to the HTML and + \f$\mbox{\LaTeX}\f$ output. This character has to be escaped because it has a special meaning in HTML. <hr> @@ -1030,28 +1063,28 @@ The following command JavaDoc command are support. \subsection cmdjdauthor @author { list of authors } \addindex @author - Equivalent to \\author (see section \ref cmdauthor). + Equivalent to \\author (see section \ref cmdauthor "\\author"). \subsection cmdjddate @date { date description } \addindex @date - Equivalent to \\date (see section \ref cmddate). + Equivalent to \\date (see section \ref cmddate "\\date"). \subsection cmdjdparam @param <parameter-name> { parameter-description } \addindex @param - Equivalent to \\param (see section \ref cmdparam). + Equivalent to \\param (see section \ref cmdparam "\\param"). \subsection cmdjdexception @exception <exception-object> { exception-description } \addindex @exception - Equivalent to \\exception (see section \ref cmdexception). + Equivalent to \\exception (see section \ref cmdexception "\\exception"). \subsection cmdjdreturn @return { description of the return value } \addindex @return - Equivalent to \\return (see section \ref cmdreturn). + Equivalent to \\return (see section \ref cmdreturn "\\return"). \subsection cmdjdsee @see { references } \addindex @see - Equivalent to \\sa (see section \ref cmdsa). + Equivalent to \\sa (see section \ref cmdsa "\\sa"). \subsection cmdjdshort @short { brief description } \addindex @short - Equivalent to \\brief (see section \ref cmdbrief). + Equivalent to \\brief (see section \ref cmdbrief "\\brief"). \subsection cmdjdversion @version { version number } \addindex @version - Equivalent to \\version (see section \ref cmdversion). + Equivalent to \\version (see section \ref cmdversion "\\version"). <h2>\htmlonly <center> --- \endhtmlonly Commands included for Qt compatibility diff --git a/doc/config.doc b/doc/config.doc index 0412634..481925c 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -169,7 +169,7 @@ Below is a list of tags that are recognized for each category. If the VERBATIM_HEADERS tag is set the YES (the default) then Doxygen\n"; will generate a verbatim copy of the header file for each class for\n"; which an include is specified. Set to NO to disable this.\n"; - \sa Section \ref cmdclass. + \sa Section \ref cmdclass "\\class". </dl> @@ -216,7 +216,7 @@ Below is a list of tags that are recognized for each category. \addindex EXAMPLE_PATH The \c EXAMPLE_PATH tag can be used to specify one or more files or directories that contain example code fragments that are included (see - the \\include command in section \ref cmdinclude). + the \\include command in section \ref cmdinclude "\\include"). <dt>\c INCLUDE_PATH <dd> \addindex INCLUDE_PATH @@ -262,6 +262,7 @@ Below is a list of tags that are recognized for each category. <HTML> <HEAD> <TITLE>My title</TITLE> + <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> </HEAD> <BODY BGCOLOR="#FFFFFF"> \endverbatim @@ -341,6 +342,10 @@ EXTRA_PACKAGES = times A directory man3 will be created inside the directory specified by \c MAN_OUTPUT. +<dt>\c MAN_EXTENSION <dd> + \addindex MAX_EXTENSION + The MAN_EXTENSION tag determines the extension that is added to + the generated man pages (default is the subroutine's section .3) </dl> \subsection config_prepro Preprocessor related options diff --git a/doc/index.doc b/doc/index.doc index add62b4..f60eec9 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -155,8 +155,9 @@ Ole Gerden, Olaf Meeuwissen, Feiyi Wang, Robert J. Clark, -Matthias Baas and -Walter Mueller +Matthias Baas, +Walter Mueller, and +William van Dieten for suggestions, patches and bug reports. </ul> */ diff --git a/doc/trouble.doc b/doc/trouble.doc index 5103bda..72013d3 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -62,6 +62,11 @@ Furthermore, I would appreciate a mail if you have found a bug, or if you have ideas (or even better some code or a patch) how to fix existing bugs and limitations. +The easiest way for me to solve bugs is if you can send me a small example +demonstrating the problem you have (make sure the example compiles!). It is +usually a good idea to send along the configuation file as well, but please +use doxygen with the <code>-s</code> flag while generating it. + My email address: <a href="mailto:dimitri@stack.nl">dimitri@stack.nl</a> */ |