diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2002-08-04 20:55:47 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2002-08-04 20:55:47 (GMT) |
commit | 2e2f09d60ce079a1fe283e47bcf023de01f051c5 (patch) | |
tree | 8e54169bc0b7214246ec4c1dfe3f58228ef12928 /doc | |
parent | adac91e9a353095c3bae4b580d27b7cfd8617493 (diff) | |
download | Doxygen-2e2f09d60ce079a1fe283e47bcf023de01f051c5.zip Doxygen-2e2f09d60ce079a1fe283e47bcf023de01f051c5.tar.gz Doxygen-2e2f09d60ce079a1fe283e47bcf023de01f051c5.tar.bz2 |
Release-1.2.17-20020804
Diffstat (limited to 'doc')
-rw-r--r-- | doc/autolink.doc | 12 | ||||
-rw-r--r-- | doc/commands.doc | 625 | ||||
-rw-r--r-- | doc/config.doc | 330 | ||||
-rw-r--r-- | doc/diagrams.doc | 6 | ||||
-rw-r--r-- | doc/docblocks.doc | 30 | ||||
-rw-r--r-- | doc/doxysearch_usage.doc | 5 | ||||
-rw-r--r-- | doc/faq.doc | 2 | ||||
-rw-r--r-- | doc/grouping.doc | 8 | ||||
-rw-r--r-- | doc/history.doc | 30 | ||||
-rw-r--r-- | doc/htmlcmds.doc | 158 | ||||
-rw-r--r-- | doc/index.doc | 6 | ||||
-rw-r--r-- | doc/install.doc | 34 | ||||
-rw-r--r-- | doc/installdox_usage.doc | 2 | ||||
-rw-r--r-- | doc/language.doc | 51 | ||||
-rw-r--r-- | doc/language.tpl | 31 | ||||
-rw-r--r-- | doc/lists.doc | 2 | ||||
-rw-r--r-- | doc/preprocessing.doc | 4 | ||||
-rw-r--r-- | doc/starting.doc | 6 |
18 files changed, 680 insertions, 662 deletions
diff --git a/doc/autolink.doc b/doc/autolink.doc index 94b28d4..c7f9ba7 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -30,12 +30,12 @@ The next sections show how to generate links to the various documented entities in a source file. - \subsection linkurl Links to web pages and mail addresses + \section linkurl Links to web pages and mail addresses Doxygen will automatically replace any URLs and mail addresses found in the documentation by links (in HTML). - \subsection linkclass Links to classes. + \section linkclass Links to classes. All words in the documentation that correspond to a documented class will automatically be replaced by a link to the page containing the @@ -43,14 +43,14 @@ that corresponds to a documented class is replaced by a link you should put a \% in front of the word. - \subsection linkfile Links to files. + \section linkfile Links to files. All words that contain a dot (<tt>.</tt>) that is not the last character in the word are considered to be file names. If the word is indeed the name of a documented input file, a link will automatically be created to the documentation of that file. - \subsection linkfunc Links to functions. + \section linkfunc Links to functions. Links to functions are created if one of the following patterns is encountered: @@ -90,7 +90,7 @@ that matches the pattern. </ol> - \subsection linkother Links to variables, typedefs, enum types, enum values and defines. + \section linkother Links to variables, typedefs, enum types, enum values and defines. All of these entities can be linked to in the same way as described in the previous section. For sake of clarity it is advised to only use @@ -103,7 +103,7 @@ for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \subsection resolving typedefs. + \section resolving typedefs. Typedefs that involve classes, structs and unions, like \verbatim diff --git a/doc/commands.doc b/doc/commands.doc index 5ceb1df..0a6a352 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -14,9 +14,9 @@ * input used in their production; they are not affected by this license. * */ -/*! \page commands +/*! \page commands Special Commands -\section commands Special Commands +\section cmd_intro Introduction All commands in the documentation start with a backslash (<b>\\</b>) or an at-sign (<b>\@</b>). If you prefer you can replace all commands starting with a @@ -25,7 +25,7 @@ backslash below, by their counterparts that start with an at-sign. Some commands have one or more arguments. Each argument has a certain range: <ul> -<li>If <sharp> braces are used the argument is a single word. +<li>If \<sharp\> braces are used the argument is a single word. <li>If (round) braces are used the argument extends until the end of the line on which the command was found. <li>If {curly} braces are used the argument extends until the next paragraph. @@ -35,121 +35,107 @@ If [square] brackets are used the argument is optional. Here is an alphabetically sorted list of all commands with references to their documentation: -\htmlonly -<multicol cols=4> -<ul> -\endhtmlonly -\latexonly -\begin{multicols}{3} -\begin{CompactList} -\endlatexonly -<li> \refitem cmda \a -<li> \refitem cmdaddindex \addindex -<li> \refitem cmdaddtogroup \addtogroup -<li> \refitem cmdanchor \anchor -<li> \refitem cmdarg \arg -<li> \refitem cmdattention \attention -<li> \refitem cmdauthor \author -<li> \refitem cmdb \b -<li> \refitem cmdbrief \brief -<li> \refitem cmdbug \bug -<li> \refitem cmdc \c -<li> \refitem cmdclass \class -<li> \refitem cmdcode \code -<li> \refitem cmdcopydoc \copydoc -<li> \refitem cmddate \date -<li> \refitem cmddef \def -<li> \refitem cmddefgroup \defgroup -<li> \refitem cmddeprecated \deprecated -<li> \refitem cmddontinclude \dontinclude -<li> \refitem cmddotfile \dotfile -<li> \refitem cmde \e -<li> \refitem cmdelse \else -<li> \refitem cmdelseif \elseif -<li> \refitem cmdem \em -<li> \refitem cmdendcode \endcode -<li> \refitem cmdendhtmlonly \endhtmlonly -<li> \refitem cmdendif \endif -<li> \refitem cmdendlatexonly \endlatexonly -<li> \refitem cmdendlink \endlink -<li> \refitem cmdendverbatim \endverbatim -<li> \refitem cmdenum \enum -<li> \refitem cmdexample \example -<li> \refitem cmdexception \exception -<li> \refitem cmdfdollar \f$ -<li> \refitem cmdfbropen \f[ -<li> \refitem cmdfbrclose \f] -<li> \refitem cmdfile \file -<li> \refitem cmdfn \fn -<li> \refitem cmdhideinitializer \hideinitializer -<li> \refitem cmdhtmlinclude \htmlinclude -<li> \refitem cmdhtmlonly \htmlonly -<li> \refitem cmdif \if -<li> \refitem cmdifnot \\ifnot -<li> \refitem cmdimage \image -<li> \refitem cmdinclude \include -<li> \refitem cmdingroup \ingroup -<li> \refitem cmdinternal \internal -<li> \refitem cmdinvariant \invariant -<li> \refitem cmdinterface \interface -<li> \refitem cmdlatexonly \latexonly -<li> \refitem cmdli \li -<li> \refitem cmdline \line -<li> \refitem cmdlink \link -<li> \refitem cmdmainpage \mainpage -<li> \refitem cmdname \name -<li> \refitem cmdnamespace \namespace -<li> \refitem cmdnosubgrouping \nosubgrouping -<li> \refitem cmdnote \note -<li> \refitem cmdoverload \overload -<li> \refitem cmdp \p -<li> \refitem cmdpackage \package -<li> \refitem cmdpage \page -<li> \refitem cmdpar \par -<li> \refitem cmdparam \param -<li> \refitem cmdpost \post -<li> \refitem cmdpre \pre -<li> \refitem cmdref \ref -<li> \refitem cmdrelates \relates -<li> \refitem cmdremarks \remarks -<li> \refitem cmdreturn \return -<li> \refitem cmdretval \retval -<li> \refitem cmdsa \sa -<li> \refitem cmdsection \section -<li> \refitem cmdshowinitializer \showinitializer -<li> \refitem cmdsince \since -<li> \refitem cmdskip \skip -<li> \refitem cmdskipline \skipline -<li> \refitem cmdstruct \struct -<li> \refitem cmdsubsection \subsection -<li> \refitem cmdtest \test -<li> \refitem cmdthrow \throw -<li> \refitem cmdtodo \todo -<li> \refitem cmdtypedef \typedef -<li> \refitem cmdunion \union -<li> \refitem cmduntil \until -<li> \refitem cmdvar \var -<li> \refitem cmdverbatim \verbatim -<li> \refitem cmdverbinclude \verbinclude -<li> \refitem cmdversion \version -<li> \refitem cmdwarning \warning -<li> \refitem cmdweakgroup \weakgroup -<li> \refitem cmddollar \$ -<li> \refitem cmdat \@ -<li> \refitem cmdbackslash \\ -<li> \refitem cmdamp \& -<li> \refitem cmdtilde \~ -<li> \refitem cmdlt \\< -<li> \refitem cmdgt \\> -<li> \refitem cmdhash \# -\htmlonly -</ul> -</multicol> -\endhtmlonly -\latexonly -\end{CompactList} -\end{multicols} -\endlatexonly +\secreflist +\refitem cmda \\a +\refitem cmdaddindex \\addindex +\refitem cmdaddtogroup \\addtogroup +\refitem cmdanchor \\anchor +\refitem cmdarg \\arg +\refitem cmdattention \\attention +\refitem cmdauthor \\author +\refitem cmdb \\b +\refitem cmdbrief \\brief +\refitem cmdbug \\bug +\refitem cmdc \\c +\refitem cmdclass \\class +\refitem cmdcode \\code +\refitem cmdcopydoc \\copydoc +\refitem cmddate \\date +\refitem cmddef \\def +\refitem cmddefgroup \\defgroup +\refitem cmddeprecated \\deprecated +\refitem cmddontinclude \\dontinclude +\refitem cmddotfile \\dotfile +\refitem cmde \\e +\refitem cmdelse \\else +\refitem cmdelseif \\elseif +\refitem cmdem \\em +\refitem cmdendcode \\endcode +\refitem cmdendhtmlonly \\endhtmlonly +\refitem cmdendif \\endif +\refitem cmdendlatexonly \\endlatexonly +\refitem cmdendlink \\endlink +\refitem cmdendverbatim \\endverbatim +\refitem cmdenum \\enum +\refitem cmdexample \\example +\refitem cmdexception \\exception +\refitem cmdfdollar \\f\$ +\refitem cmdfbropen \\f[ +\refitem cmdfbrclose \\f] +\refitem cmdfile \\file +\refitem cmdfn \\fn +\refitem cmdhideinitializer \\hideinitializer +\refitem cmdhtmlinclude \\htmlinclude +\refitem cmdhtmlonly \\htmlonly +\refitem cmdif \\if +\refitem cmdifnot \\ifnot +\refitem cmdimage \\image +\refitem cmdinclude \\include +\refitem cmdingroup \\ingroup +\refitem cmdinternal \\internal +\refitem cmdinvariant \\invariant +\refitem cmdinterface \\interface +\refitem cmdlatexonly \\latexonly +\refitem cmdli \\li +\refitem cmdline \\line +\refitem cmdlink \\link +\refitem cmdmainpage \\mainpage +\refitem cmdname \\name +\refitem cmdnamespace \\namespace +\refitem cmdnosubgrouping \\nosubgrouping +\refitem cmdnote \\note +\refitem cmdoverload \\overload +\refitem cmdp \\p +\refitem cmdpackage \\package +\refitem cmdpage \\page +\refitem cmdpar \\par +\refitem cmdparam \\param +\refitem cmdpost \\post +\refitem cmdpre \\pre +\refitem cmdref \\ref +\refitem cmdrelates \\relates +\refitem cmdremarks \\remarks +\refitem cmdreturn \\return +\refitem cmdretval \\retval +\refitem cmdsa \\sa +\refitem cmdsection \\section +\refitem cmdshowinitializer \\showinitializer +\refitem cmdsince \\since +\refitem cmdskip \\skip +\refitem cmdskipline \\skipline +\refitem cmdstruct \\struct +\refitem cmdsubsection \\subsection +\refitem cmdtest \\test +\refitem cmdthrow \\throw +\refitem cmdtodo \\todo +\refitem cmdtypedef \\typedef +\refitem cmdunion \\union +\refitem cmduntil \\until +\refitem cmdvar \\var +\refitem cmdverbatim \\verbatim +\refitem cmdverbinclude \\verbinclude +\refitem cmdversion \\version +\refitem cmdwarning \\warning +\refitem cmdweakgroup \\weakgroup +\refitem cmddollar \\\$ +\refitem cmdat \\\@ +\refitem cmdbackslash \\\\ +\refitem cmdamp \\\& +\refitem cmdtilde \\~ +\refitem cmdlt \\\< +\refitem cmdgt \\\> +\refitem cmdhash \\\# +\endsecreflist The following subsections provide a list of all commands that are recognized by doxygen. Unrecognized commands are treated as normal text. @@ -158,8 +144,8 @@ doxygen. Unrecognized commands are treated as normal text. Structural indicators \htmlonly --- </center>\endhtmlonly</h2> -\subsection cmdaddtogroup \addtogroup <name> [(title)] - \addindex \addtogroup +\section cmdaddtogroup \addtogroup <name> [(title)] + \addindex \\addtogroup Defines a group just like \ref cmddefgroup "\\defgroup", but in contrast to that command using the same \<name\> more than once will not result in a warning, but rather one group with a merged documentation and the first title found in @@ -192,9 +178,9 @@ doxygen. Unrecognized commands are treated as normal text. \sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup", \ref cmdingroup "\\ingroup" and \ref cmdweakgroup "\\weakgroup". -\subsection cmdclass \class <name> [<header-file>] [<header-name>] +\section cmdclass \class <name> [<header-file>] [<header-name>] - \addindex \class + \addindex \\class Indicates that a comment block contains documentation for a class with name \<name\>. Optionally a header file and a header name can be specified. If the header-file is specified, a link to a verbatim copy @@ -215,9 +201,9 @@ doxygen. Unrecognized commands are treated as normal text. \endhtmlonly <hr> -\subsection cmddef \def <name> +\section cmddef \def <name> - \addindex \def + \addindex \\def Indicates that a comment block contains documentation for a \c #define macro. @@ -229,9 +215,9 @@ doxygen. Unrecognized commands are treated as normal text. \endhtmlonly <hr> -\subsection cmddefgroup \defgroup <name> (group title) +\section cmddefgroup \defgroup <name> (group title) - \addindex \defgroup + \addindex \\defgroup Indicates that a comment block contains documentation for a \ref modules "group" of classes, files or namespaces. This can be used to categorize classes, files or namespaces, and document those @@ -245,9 +231,9 @@ doxygen. Unrecognized commands are treated as normal text. <hr> -\subsection cmdenum \enum <name> +\section cmdenum \enum <name> - \addindex \enum + \addindex \\enum Indicates that a comment block contains documentation for an enumeration, with name \<name\>. If the enum is a member of a class and the documentation block is located outside the class definition, @@ -267,9 +253,9 @@ doxygen. Unrecognized commands are treated as normal text. \endhtmlonly <hr> -\subsection cmdexample \example <file-name> +\section cmdexample \example <file-name> - \addindex \example + \addindex \\example Indicates that a comment block contains documentation for a source code example. The name of the source file is \<file-name\>. The text of this file will be included in the documentation, just after the @@ -300,9 +286,9 @@ doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdinclude "\\include". <hr> -\subsection cmdfile \file [<name>] +\section cmdfile \file [<name>] - \addindex \file + \addindex \\file Indicates that a comment block contains documentation for a source or header file with name \<name\>. The file name may include (part of) the path if the file-name alone is not unique. If the file name is omitted @@ -321,9 +307,9 @@ doxygen. Unrecognized commands are treated as normal text. \endhtmlonly <hr> -\subsection cmdfn \fn (function declaration) +\section cmdfn \fn (function declaration) - \addindex \fn + \addindex \\fn Indicates that a comment block contains documentation for a function (either global or as a member of a class). This command is \em only needed if a comment block is \e not placed in front (or behind) @@ -352,9 +338,9 @@ doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef". <hr> -\subsection cmdhideinitializer \hideinitializer +\section cmdhideinitializer \hideinitializer - \addindex \hideinitializer + \addindex \\hideinitializer By default the value of a define and the initializer of a variable are displayed unless they are longer than 30 lines. By putting this command in a comment block of a define or variable, the @@ -363,9 +349,9 @@ doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdshowinitializer "\\showinitializer". <hr> -\subsection cmdingroup \ingroup (<groupname> [<groupname> <groupname>]) +\section cmdingroup \ingroup (<groupname> [<groupname> <groupname>]) - \addindex \ingroup + \addindex \\ingroup If the \\ingroup command is placed in a comment block of a class, file or namespace, then it will be added to the group or groups identified by \<groupname\>. @@ -374,9 +360,9 @@ doxygen. Unrecognized commands are treated as normal text. \ref cmdaddtogroup "\\addtogroup" and \ref cmdweakgroup "\\weakgroup" <hr> -\subsection cmdinterface \interface +\section cmdinterface \interface - \addindex \interface + \addindex \\interface Indicates that a comment block contains documentation for an interface with name \<name\>. The arguments are equal to the \\class command. @@ -384,18 +370,18 @@ doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdclass "\\class". <hr> -\subsection cmdinternal \internal +\section cmdinternal \internal - \addindex \internal + \addindex \\internal This command writes the message `For internal use only' to the output and all text \e after a \c \\internal command is ignored. You can use \ref cfg_internal_docs "INTERNAL_DOCS" in the config file to show or hide the internal documentation. <hr> -\subsection cmdmainpage \mainpage [(title)] +\section cmdmainpage \mainpage [(title)] - \addindex \mainpage + \addindex \\mainpage If the \\mainpage command is placed in a comment block the block is used to customize the index page (in HTML) or @@ -427,35 +413,36 @@ doxygen. Unrecognized commands are treated as normal text. section \ref cmdpage "\\page". <hr> -\subsection cmdname \name (header) +\section cmdname \name (header) This command turns a comment block into a header definition of a member group. The comment block should be followed by a -<code>//@{ ... //@}</code> block containing the +<code>//\@{ ... //\@}</code> block containing the members of the group. See section \ref memgroup for an example. <hr> -\subsection cmdnamespace \namespace <name> +\section cmdnamespace \namespace <name> - \addindex \namespace + \addindex \\namespace Indicates that a comment block contains documentation for a namespace with name \<name\>. <hr> -\subsection cmdnosubgrouping \nosubgrouping +\section cmdnosubgrouping \nosubgrouping -This command can be put in the documentation -of a class. It can be used in combination with member grouping -to avoid that doxygen puts a member group as a subgroup of a -Public/Protected/Private/... section. + \addindex \\nosubgrouping + This command can be put in the documentation + of a class. It can be used in combination with member grouping + to avoid that doxygen puts a member group as a subgroup of a + Public/Protected/Private/... section. <hr> -\subsection cmdoverload \overload [(function declaration)] +\section cmdoverload \overload [(function declaration)] - \addindex \overload + \addindex \\overload This command can be used to generate the following standard text for an overloaded member function: @@ -484,16 +471,16 @@ Public/Protected/Private/... section. \endhtmlonly <hr> -\subsection cmdpackage \package <name> +\section cmdpackage \package <name> - \addindex \package + \addindex \\package Indicates that a comment block contains documentation for a Java package with name \<name\>. <hr> -\subsection cmdpage \page <name> (title) +\section cmdpage \page <name> (title) - \addindex \page + \addindex \\page Indicates that a comment block contains a piece of documentation that is not directly related to one specific class, file or member. The HTML generator creates a page containing the documentation. The @@ -521,9 +508,9 @@ Public/Protected/Private/... section. \ref cmdref "\\ref". <hr> -\subsection cmdrelates \relates <name> +\section cmdrelates \relates <name> - \addindex \relates + \addindex \\relates This command can be used in the documentation of a non-member function \<name\>. It puts the function inside the `related function' section of the class documentation. This command is useful for documenting @@ -539,9 +526,9 @@ Public/Protected/Private/... section. \endhtmlonly <hr> -\subsection cmdshowinitializer \showinitializer +\section cmdshowinitializer \showinitializer - \addindex \showinitializer + \addindex \\showinitializer By default the value of a define and the initializer of a variable are only displayed if they are less than 30 lines long. By putting this command in a comment block of a define or variable, the @@ -550,9 +537,9 @@ Public/Protected/Private/... section. \sa section \ref cmdhideinitializer "\\hideinitializer". <hr> -\subsection cmdstruct \struct <name> [<header-file>] [<header-name>] +\section cmdstruct \struct <name> [<header-file>] [<header-name>] - \addindex \struct + \addindex \\struct Indicates that a comment block contains documentation for a struct with name \<name\>. The arguments are equal to the \\class command. @@ -560,9 +547,9 @@ Public/Protected/Private/... section. \sa section \ref cmdclass "\\class". <hr> -\subsection cmdtypedef \typedef (typedef declaration) +\section cmdtypedef \typedef (typedef declaration) - \addindex \typedef + \addindex \\typedef Indicates that a comment block contains documentation for a typedef (either global or as a member of a class). This command is equivalent to \\var and \\fn. @@ -570,9 +557,9 @@ Public/Protected/Private/... section. \sa section \ref cmdfn "\\fn" and \ref cmdvar "\\var". <hr> -\subsection cmdunion \union <name> [<header-file>] [<header-name>] +\section cmdunion \union <name> [<header-file>] [<header-name>] - \addindex \union + \addindex \\union Indicates that a comment block contains documentation for a union with name \<name\>. The arguments are equal to the \\class command. @@ -580,9 +567,9 @@ Public/Protected/Private/... section. \sa section \ref cmdclass "\\class". <hr> -\subsection cmdvar \var (variable declaration) +\section cmdvar \var (variable declaration) - \addindex \var + \addindex \\var Indicates that a comment block contains documentation for a variable or enum value (either global or as a member of a class). This command is equivalent to \\typedef and \\fn. @@ -590,8 +577,8 @@ Public/Protected/Private/... section. \sa section \ref cmdfn "\\fn" and \ref cmdtypedef "\\typedef". <hr> -\subsection cmdweakgroup \weakgroup <name> [(title)] - \addindex \addtogroup +\section cmdweakgroup \weakgroup <name> [(title)] + \addindex \\addtogroup Can be used exactly like \ref cmdaddtogroup "\\addtogroup", but has a lower priority when it comes to resolving conflicting grouping definitions. @@ -605,9 +592,9 @@ Public/Protected/Private/... section. \htmlonly --- </center>\endhtmlonly</h2> <hr> -\subsection cmdattention \attention { attention text } +\section cmdattention \attention { attention text } - \addindex \attention + \addindex \\attention Starts a paragraph where a message that needs attention may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual @@ -616,9 +603,9 @@ Public/Protected/Private/... section. The \\attention command ends when a blank line or some other sectioning command is encountered. -\subsection cmdauthor \author { list of authors } +\section cmdauthor \author { list of authors } - \addindex \author + \addindex \\author Starts a paragraph where one or more author names may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual @@ -636,9 +623,9 @@ Public/Protected/Private/... section. \endhtmlonly <hr> -\subsection cmdbrief \brief {brief description} +\section cmdbrief \brief {brief description} - \addindex \brief + \addindex \\brief Starts a paragraph that serves as a brief description. For classes and files the brief description will be used in lists and at the start of the documentation page. For class and file members, the brief description @@ -652,9 +639,9 @@ Public/Protected/Private/... section. Synonymous to \\short. <hr> -\subsection cmdbug \bug { bug description } +\section cmdbug \bug { bug description } - \addindex \bug + \addindex \\bug Starts a paragraph where one or more bugs may be reported. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual @@ -667,9 +654,9 @@ Public/Protected/Private/... section. for an example. <hr> -\subsection cmddate \date { date description } +\section cmddate \date { date description } - \addindex \date + \addindex \\date Starts a paragraph where one or more dates may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual @@ -682,17 +669,17 @@ Public/Protected/Private/... section. for an example. <hr> -\subsection cmddeprecated \deprecated { description } +\section cmddeprecated \deprecated { description } - \addindex \deprecated + \addindex \\deprecated Starts a paragraph indicating that this documentation block belongs to a deprecated entity. Can be used to describe alternatives, expected life span, etc. <hr> -\subsection cmdelse \else +\section cmdelse \else - \addindex \else + \addindex \\else Starts a conditional section if the previous conditional section was not enabled. The previous section should have been started with a \c \\if, \c \\ifnot, or \c \\elseif command. @@ -701,9 +688,9 @@ Public/Protected/Private/... section. \ref cmdendif "\\endif." <hr> -\subsection cmdelseif \elseif <section-label> +\section cmdelseif \elseif <section-label> - \addindex \elseif + \addindex \\elseif Starts a conditional documentation section if the previous section was not enabled. A conditional section is disabled by default. To enable it you must put the @@ -716,7 +703,7 @@ Public/Protected/Private/... section. \ref cmdelse "\\else", and \ref cmdelseif "\\elseif". <hr> -\subsection cmdendif \endif +\section cmdendif \endif \addindex \\endif Ends a conditional section that was started with \c \\if or \c \\ifnot @@ -725,9 +712,9 @@ Public/Protected/Private/... section. \sa \ref cmdif "\\if", and \ref cmdifnot "\\ifnot". <hr> -\subsection cmdexception \exception <exception-object> { exception description } +\section cmdexception \exception <exception-object> { exception description } - \addindex \exception + \addindex \\exception Starts an exception description for an exception object with name \<exception-object\>. Followed by a description of the exception. The existence of the exception object is not checked. @@ -743,7 +730,7 @@ Public/Protected/Private/... section. the tag \\exceptions is a synonym for this tag. <hr> -\subsection cmdif \if <section-label> +\section cmdif \if <section-label> \addindex \\if Starts a conditional documentation section. The section ends @@ -801,9 +788,9 @@ ALIASES = "english=\if english" \ \ref cmdelse "\\else", and \ref cmdelseif "\\elseif". <hr> -\subsection cmdifnot \ifnot <section-label> +\section cmdifnot \ifnot <section-label> - \addindex \ifnot + \addindex \\ifnot Starts a conditional documentation section. The section ends with a matching \c \\endif command. This conditional section is enabled by default. To disable it you must put the @@ -815,9 +802,9 @@ ALIASES = "english=\if english" \ \ref cmdelse "\\else", and \ref cmdelseif "\\elseif". <hr> -\subsection cmdinvariant \invariant { description of invariant } +\section cmdinvariant \invariant { description of invariant } - \addindex \invariant + \addindex \\invariant Starts a paragraph where the invariant of an entity can be described. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual @@ -829,9 +816,9 @@ ALIASES = "english=\if english" \ sectioning command is encountered. <hr> -\subsection cmdnote \note { text } +\section cmdnote \note { text } - \addindex \note + \addindex \\note Starts a paragraph where a note can be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. @@ -843,9 +830,9 @@ ALIASES = "english=\if english" \ for an example. <hr> -\subsection cmdpar \par [(paragraph title)] { paragraph } +\section cmdpar \par [(paragraph title)] { paragraph } - \addindex \par + \addindex \\par If a paragraph title is given this command starts a paragraph with a user defined heading. The heading extends until the end of the line. The paragraph following the command will be indented. @@ -867,9 +854,9 @@ ALIASES = "english=\if english" \ \endhtmlonly <hr> -\subsection cmdparam \param <parameter-name> { parameter description } +\section cmdparam \param <parameter-name> { parameter description } - \addindex \param + \addindex \\param Starts a parameter description for a function parameter with name \<parameter-name\>. Followed by a description of the parameter. The existence of the parameter is not checked. @@ -882,9 +869,9 @@ ALIASES = "english=\if english" \ example. <hr> -\subsection cmdpost \post { description of the postcondition } +\section cmdpost \post { description of the postcondition } - \addindex \post + \addindex \\post Starts a paragraph where the postcondition of an entity can be described. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual @@ -896,9 +883,9 @@ ALIASES = "english=\if english" \ sectioning command is encountered. <hr> -\subsection cmdpre \pre { description of the precondition } +\section cmdpre \pre { description of the precondition } - \addindex \pre + \addindex \\pre Starts a paragraph where the precondition of an entity can be described. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual @@ -910,9 +897,9 @@ ALIASES = "english=\if english" \ sectioning command is encountered. <hr> -\subsection cmdremarks \remarks { remark text } +\section cmdremarks \remarks { remark text } - \addindex \remarks + \addindex \\remarks Starts a paragraph where one or more remarks may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual @@ -924,9 +911,9 @@ ALIASES = "english=\if english" \ sectioning command is encountered. <hr> -\subsection cmdreturn \return { description of the return value } +\section cmdreturn \return { description of the return value } - \addindex \return + \addindex \\return Starts a return value description for a function. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. @@ -936,9 +923,9 @@ ALIASES = "english=\if english" \ example. <hr> -\subsection cmdretval \retval <return value> { description } +\section cmdretval \retval <return value> { description } - \addindex \retval + \addindex \\retval Starts a return value description for a function with name \<return value\>. Followed by a description of the return value. The text of the paragraph that forms the description has no special @@ -950,9 +937,9 @@ ALIASES = "english=\if english" \ sectioning command is encountered. <hr> -\subsection cmdsa \sa { references } +\section cmdsa \sa { references } - \addindex \sa + \addindex \\sa Starts a paragraph where one or more cross-references to classes, functions, methods, variables, files or URL may be specified. Two names joined by either <code>::</code> or <code>\#</code> @@ -967,9 +954,9 @@ ALIASES = "english=\if english" \ to objects. <hr> -\subsection cmdsince \since { text } +\section cmdsince \since { text } - \addindex \since + \addindex \\since This tag can be used to specify since when (version or time) an entity is available. The paragraph that follows \\since does not have any special internal structure. All visual enhancement commands may be @@ -977,9 +964,9 @@ ALIASES = "english=\if english" \ line or some other sectioning command is encountered. <hr> -\subsection cmdtest \test { paragraph describing a test case } +\section cmdtest \test { paragraph describing a test case } - \addindex \test + \addindex \\test Starts a paragraph where a test case can be described. The description will also add the test case to a separate test list. The two instances of the description will be cross-referenced. @@ -987,18 +974,18 @@ ALIASES = "english=\if english" \ indicates the origin of the test case. <hr> -\subsection cmdthrow \throw <exception-object> { exception description } +\section cmdthrow \throw <exception-object> { exception description } - \addindex \throw + \addindex \\throw Synonymous to \\exception (see section \ref cmdexception "\\exception"). \par Note: the tag \\throws is a synonym for this tag. <hr> -\subsection cmdtodo \todo { paragraph describing what is to be done } +\section cmdtodo \todo { paragraph describing what is to be done } - \addindex \todo + \addindex \\todo Starts a paragraph where a TODO item is described. The description will also add an item to a separate TODO list. The two instances of the description will be cross-referenced. @@ -1006,9 +993,9 @@ ALIASES = "english=\if english" \ indicates the origin of the item. <hr> -\subsection cmdversion \version { version number } +\section cmdversion \version { version number } - \addindex \version + \addindex \\version Starts a paragraph where one or more version strings may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual @@ -1022,9 +1009,9 @@ ALIASES = "english=\if english" \ for an example. <hr> -\subsection cmdwarning \warning { warning message } +\section cmdwarning \warning { warning message } - \addindex \warning + \addindex \\warning Starts a paragraph where one or more warning messages may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual @@ -1041,32 +1028,32 @@ ALIASES = "english=\if english" \ Commands to create links \htmlonly --- </center>\endhtmlonly</h2> -\subsection cmdaddindex \addindex (text) +\section cmdaddindex \addindex (text) - \addindex \addindex + \addindex \\addindex This command adds (text) to the \f$\mbox{\LaTeX}\f$ index. <hr> -\subsection cmdanchor \anchor <word> +\section cmdanchor \anchor <word> - \addindex \anchor + \addindex \\anchor This command places an invisible, named anchor into the documentation to which you can refer with the \\ref command. \sa section \ref cmdref "\\ref". <hr> -\subsection cmdendlink \endlink +\section cmdendlink \endlink - \addindex \endlink + \addindex \\endlink This command ends a link that is started with the \\link command. \sa section \ref cmdlink "\\link". <hr> -\subsection cmdlink \link <link-object> +\section cmdlink \link <link-object> - \addindex \link + \addindex \\link The links that are automatically generated by doxygen always have the name of the object they point to as link-text. @@ -1080,9 +1067,9 @@ ALIASES = "english=\if english" \ generated links and valid link-objects. <hr> -\subsection cmdref \ref <name> ["(text)"] +\section cmdref \ref <name> ["(text)"] - \addindex \ref + \addindex \\ref Creates a reference to a named section, subsection, page or anchor. For HTML documentation the reference command will generate a link to the section. For a sections or subsections the title of the section will be @@ -1096,9 +1083,9 @@ ALIASES = "english=\if english" \ Section \ref cmdpage "\\page" for an example of the \\ref command. <hr> -\subsection cmdsection \section <section-name> (section title) +\section cmdsection \section <section-name> (section title) - \addindex \section + \addindex \\section Creates a section with name \<section-name\>. The title of the section should be specified as the second argument of the \\section command. @@ -1107,9 +1094,9 @@ ALIASES = "english=\if english" \ \e not in other documentation blocks! <hr> -\subsection cmdsubsection \subsection <subsection-name> (subsection title) +\section cmdsubsection \subsection <subsection-name> (subsection title) - \addindex \subsection + \addindex \\subsection Creates a subsection with name \<subsection-name\>. The title of the subsection should be specified as the second argument of the \\subsection command. @@ -1127,9 +1114,9 @@ ALIASES = "english=\if english" \ Commands for displaying examples \htmlonly --- </center>\endhtmlonly</h2> -\subsection cmddontinclude \dontinclude <file-name> +\section cmddontinclude \dontinclude <file-name> - \addindex \dontinclude + \addindex \\dontinclude This command can be used to parse a source file without actually verbatim including it in the documentation (as the \\include command does). This is useful if you want to divide the source file into smaller pieces and @@ -1160,9 +1147,9 @@ ALIASES = "english=\if english" \ \ref cmdskipline "\\skipline", and \ref cmduntil "\\until". <hr> -\subsection cmdinclude \include <file-name> +\section cmdinclude \include <file-name> - \addindex \include + \addindex \\include This command can be used to include a source file as a block of code. The command takes the name of an include file as an argument. Source files or directories can be specified using the @@ -1191,9 +1178,9 @@ ALIASES = "english=\if english" \ \sa section \ref cmdexample "\\example" and \ref cmddontinclude "\\dontinclude". <hr> -\subsection cmdline \line ( pattern ) +\section cmdline \line ( pattern ) - \addindex \line + \addindex \\line This command searches line by line through the example that was last included using \\include or \\dontinclude until it finds a non-blank line. If that line contains the specified pattern, it is written @@ -1207,9 +1194,9 @@ ALIASES = "english=\if english" \ See section \ref cmddontinclude "\\dontinclude" for an example. <hr> -\subsection cmdskip \skip ( pattern ) +\section cmdskip \skip ( pattern ) - \addindex \skip + \addindex \\skip This command searches line by line through the example that was last included using \\include or \\dontinclude until it finds a line that contains the specified pattern. @@ -1221,9 +1208,9 @@ ALIASES = "english=\if english" \ See section \ref cmddontinclude "\\dontinclude" for an example. <hr> -\subsection cmdskipline \skipline ( pattern ) +\section cmdskipline \skipline ( pattern ) - \addindex \skipline + \addindex \\skipline This command searches line by line through the example that was last included using \\include or \\dontinclude until it finds a line that contains the specified pattern. It then writes the line to the output. @@ -1243,9 +1230,9 @@ ALIASES = "english=\if english" \ See section \ref cmddontinclude "\\dontinclude" for an example. <hr> -\subsection cmduntil \until ( pattern ) +\section cmduntil \until ( pattern ) - \addindex \until + \addindex \\until This command writes all lines of the example that was last included using \\include or \\dontinclude to the output, until it finds a line containing the specified pattern. The line containing the pattern @@ -1258,9 +1245,9 @@ ALIASES = "english=\if english" \ See section \ref cmddontinclude "\\dontinclude" for an example. <hr> -\subsection cmdverbinclude \verbinclude <file-name> +\section cmdverbinclude \verbinclude <file-name> - \addindex \verbinclude + \addindex \\verbinclude This command includes the file \<file-name\> verbatim in the documentation. The command is equivalent to pasting the file in the documentation and placing \\verbatim and \\endverbatim commands around it. @@ -1269,9 +1256,9 @@ ALIASES = "english=\if english" \ \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file. <hr> -\subsection cmdhtmlinclude \htmlinclude <file-name> +\section cmdhtmlinclude \htmlinclude <file-name> - \addindex \htmlinclude + \addindex \\htmlinclude This command includes the file \<file-name\> as is in the HTML documentation. The command is equivalent to pasting the file in the documentation and placing \\htmlonly and \\endhtmlonly commands around it. @@ -1284,9 +1271,9 @@ ALIASES = "english=\if english" \ Commands for visual enhancements \htmlonly --- </center>\endhtmlonly</h2> -\subsection cmda \a <word> +\section cmda \a <word> - \addindex \a + \addindex \\a Displays the argument \<word\> using a special font. Use this command to refer to member arguments in the running text. @@ -1298,9 +1285,9 @@ ALIASES = "english=\if english" \ ... the \a x and \a y coordinates are used to ... <hr> -\subsection cmdarg \arg { item-description } +\section cmdarg \arg { item-description } - \addindex \arg + \addindex \\arg This command has one argument that continues until the first blank line or until another \\arg is encountered. The command can be used to generate a simple, not nested list of @@ -1331,17 +1318,17 @@ ALIASES = "english=\if english" \ <hr> -\subsection cmdb \b <word> +\section cmdb \b <word> - \addindex \b + \addindex \\b Displays the argument \<word\> using a bold font. Equivalent to \<b\>word\</b\>. To put multiple words in bold use \<b\>multiple words\</b\>. <hr> -\subsection cmdc \c <word> +\section cmdc \c <word> - \addindex \c + \addindex \\c Displays the argument \<word\> using a typewriter font. Use this to refer to a word of code. Equivalent to \<tt\>word\</tt\>. @@ -1358,9 +1345,9 @@ ALIASES = "english=\if english" \ To have multiple words in typewriter font use \<tt\>multiple words\</tt\>. <hr> -\subsection cmdcode \code +\section cmdcode \code - \addindex \code + \addindex \\code Starts a block of code. A code block is treated differently from ordinary text. It is interpreted as C/C++ code. The names of the classes and members that are documented are automatically replaced by @@ -1369,9 +1356,9 @@ ALIASES = "english=\if english" \ \sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim" <hr> -\subsection cmdcopydoc \copydoc <link-object> +\section cmdcopydoc \copydoc <link-object> - \addindex \copydoc + \addindex \\copydoc Copies a documentation block from the object specified by \<link-object\> and pastes it at the location of the command. This command can be useful to avoid cases where a documentation block would otherwise have to be @@ -1403,9 +1390,9 @@ ALIASES = "english=\if english" \ relation will be broken and flagged as an error. <hr> -\subsection cmddotfile \dotfile <file> ["caption"] +\section cmddotfile \dotfile <file> ["caption"] - \addindex \dotfile + \addindex \\dotfile Inserts an image generated by dot from \<file\> into the documentation. The first argument specifies the file name of the image. @@ -1421,9 +1408,9 @@ ALIASES = "english=\if english" \ stripped before the caption is displayed. <hr> -\subsection cmde \e <word> +\section cmde \e <word> - \addindex \e + \addindex \\e Displays the argument \<word\> in italics. Use this command to emphasize words. @@ -1439,9 +1426,9 @@ ALIASES = "english=\if english" \ To emphasis multiple words use \<em\>multiple words\</em\>. <hr> -\subsection cmdem \em <word> +\section cmdem \em <word> - \addindex \e + \addindex \\em Displays the argument \<word\> in italics. Use this command to emphasize words. @@ -1456,66 +1443,66 @@ ALIASES = "english=\if english" \ Equivalent to \ref cmde "\\e" <hr> -\subsection cmdendcode \endcode +\section cmdendcode \endcode - \addindex \endcode + \addindex \\endcode Ends a block of code. \sa section \ref cmdcode "\\code" <hr> -\subsection cmdendhtmlonly \endhtmlonly +\section cmdendhtmlonly \endhtmlonly - \addindex \endhtmlonly + \addindex \\endhtmlonly Ends a block of text that was started with a \\htmlonly command. \sa section \ref cmdhtmlonly "\\htmlonly". <hr> -\subsection cmdendlatexonly \endlatexonly +\section cmdendlatexonly \endlatexonly - \addindex \endlatexonly + \addindex \\endlatexonly Ends a block of text that was started with a \\latexonly command. \sa section \ref cmdlatexonly "\\latexonly". <hr> -\subsection cmdendverbatim \endverbatim +\section cmdendverbatim \endverbatim - \addindex \endverbatim + \addindex \\endverbatim Ends a block of text that was started with a \\verbatim command. \sa section \ref cmdverbatim "\\verbatim". <hr> -\subsection cmdfdollar \f$ +\section cmdfdollar \f$ - \addindex \f$ + \addindex \\f\$ Marks the start and end of an in-text formula. \sa section \ref formulas "formulas" for an example. <hr> -\subsection cmdfbropen \f[ +\section cmdfbropen \f[ - \addindex \f[ + \addindex \\f[ Marks the start of a long formula that is displayed centered on a separate line. \sa section \ref cmdfbrclose "\\f]" and section \ref formulas "formulas". <hr> -\subsection cmdfbrclose \f] +\section cmdfbrclose \f] - \addindex \f] + \addindex \\f] Marks the end of a long formula that is displayed centered on a separate line. - \sa section \ref cmdfbropen ""\\f[" and section \ref formulas "formulas". + \sa section \ref cmdfbropen "\\f[" and section \ref formulas "formulas". <hr> -\subsection cmdhtmlonly \htmlonly +\section cmdhtmlonly \htmlonly - \addindex \htmlonly + \addindex \\htmlonly Starts a block of text that will be verbatim included in the generated HTML documentation only. The block ends with a endhtmlonly command. @@ -1533,9 +1520,9 @@ ALIASES = "english=\if english" \ \ref cmdlatexonly "\\latexonly". <hr> -\subsection cmdimage \image <format> <file> ["caption"] [<sizeindication>=<size>] +\section cmdimage \image <format> <file> ["caption"] [<sizeindication>=<size>] - \addindex \image + \addindex \\image Inserts an image into the documentation. This command is format specific, so if you want to insert an image for more than one format you'll have to repeat this command for each format. @@ -1588,9 +1575,9 @@ ALIASES = "english=\if english" \ So \e you have to make sure this is the case! <hr> -\subsection cmdlatexonly \latexonly +\section cmdlatexonly \latexonly - \addindex \latexonly + \addindex \\latexonly Starts a block of text that will be verbatim included in the generated \f$\mbox{\LaTeX}\f$ documentation only. The block ends with a endlatexonly command. @@ -1608,9 +1595,9 @@ ALIASES = "english=\if english" \ and section \ref cmdhtmlonly "\\htmlonly". <hr> -\subsection cmdli \li { item-description } +\section cmdli \li { item-description } - \addindex \li + \addindex \\li This command has one argument that continues until the first blank line or until another \\li is encountered. The command can be used to generate a simple, not nested list of @@ -1640,9 +1627,9 @@ ALIASES = "english=\if english" \ Equivalent to \ref cmdarg "\\arg" <hr> -\subsection cmdp \p <word> +\section cmdp \p <word> - \addindex \p + \addindex \\p Displays the parameter \<word\> using a typewriter font. You can use this command to refer to member function parameters in the running text. @@ -1657,9 +1644,9 @@ ALIASES = "english=\if english" \ Equivalent to \ref cmdc "\\c" <hr> -\subsection cmdverbatim \verbatim +\section cmdverbatim \verbatim - \addindex \verbatim + \addindex \\verbatim Starts a block of text that will be verbatim included in both the HTML and the \f$\mbox{\LaTeX}\f$ documentation. The block should end with a @@ -1669,24 +1656,24 @@ ALIASES = "english=\if english" \ \\verbatim command or the parser will get confused! <hr> -\subsection cmdbackslash \\ +\section cmdbackslash \\ - \addindex \\ + \addindex \\\\ 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 \@ +\section cmdat \@ - \addindex \@ - This command writes an at-sign (@) to the HTML and + \addindex \\\@ + 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 cmdtilde \~[LanguageId] - \addindex \~ +\section cmdtilde \~[LanguageId] + \addindex \\~ This command enables/disables a language specific filter. This can be used to put documentation for different language into one comment block and use the \c OUTPUT_LANGUAGE tag to filter out only a specific language. @@ -1702,43 +1689,43 @@ ALIASES = "english=\if english" \ <hr> -\subsection cmdamp \& +\section cmdamp \& - \addindex \& + \addindex \\\& 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 \$ +\section cmddollar \$ - \addindex \$ + \addindex \\\$ 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. <hr> -\subsection cmdhash \# +\section cmdhash \# - \addindex \# + \addindex \\\# 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. <hr> -\subsection cmdlt \\< +\section cmdlt \\< - \addindex \\< + \addindex \\\< 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 \\> +\section cmdgt \\> - \addindex \\> + \addindex \\\> 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. diff --git a/doc/config.doc b/doc/config.doc index a4a48a5..1c3d995 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -16,7 +16,7 @@ */ /*! \page config Configuration -\subsection config_format Format +\section config_format Format A configuration file is a free-form ASCII text file with a structure that is similar to that of a Makefile, default name \c Doxyfile. It is @@ -54,160 +54,144 @@ The configuration options can be divided into several categories. Below is an alphabetical index of the tags that are recognized followed by the descriptions of the tags grouped by category. -\htmlonly -<multicol cols=3> -<ul> -\endhtmlonly -\latexonly -\footnotesize -\begin{multicols}{2} -\begin{CompactList} -\endlatexonly -<li> \refitem cfg_aliases ALIASES -<li> \refitem cfg_allexternals ALLEXTERNALS -<li> \refitem cfg_alphabetical_index ALPHABETICAL_INDEX -<li> \refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC -<li> \refitem cfg_bin_abspath BIN_ABSPATH -<li> \refitem cfg_binary_toc BINARY_TOC -<li> \refitem cfg_brief_member_desc BRIEF_MEMBER_DESC -<li> \refitem cfg_case_sense_names CASE_SENSE_NAMES -<li> \refitem cfg_cgi_name CGI_NAME -<li> \refitem cfg_cgi_url CGI_URL -<li> \refitem cfg_chm_file CHM_FILE -<li> \refitem cfg_class_diagrams CLASS_DIAGRAMS -<li> \refitem cfg_class_graph CLASS_GRAPH -<li> \refitem cfg_collaboration_graph COLLABORATION_GRAPH -<li> \refitem cfg_cols_in_alpha_index COLS_IN_ALPHA_INDEX -<li> \refitem cfg_compact_latex COMPACT_LATEX -<li> \refitem cfg_compact_rtf COMPACT_RTF -<li> \refitem cfg_details_at_top DETAILS_AT_TOP -<li> \refitem cfg_disable_index DISABLE_INDEX -<li> \refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC -<li> \refitem cfg_doc_abspath DOC_ABSPATH -<li> \refitem cfg_doc_url DOC_URL -<li> \refitem cfg_dot_image_format DOT_IMAGE_FORMAT -<li> \refitem cfg_dot_path DOT_PATH -<li> \refitem cfg_dotfile_dirs DOTFILE_DIRS -<li> \refitem cfg_enable_preprocessing ENABLE_PREPROCESSING -<li> \refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE -<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_exclude_symlinks EXCLUDE_SYMLINKS -<li> \refitem cfg_expand_as_defined EXPAND_AS_DEFINED -<li> \refitem cfg_expand_only_predef EXPAND_ONLY_PREDEF -<li> \refitem cfg_ext_doc_paths EXT_DOC_PATHS -<li> \refitem cfg_external_groups EXTERNAL_GROUPS -<li> \refitem cfg_extra_packages EXTRA_PACKAGES -<li> \refitem cfg_extract_all EXTRACT_ALL -<li> \refitem cfg_extract_local_classes EXTRACT_LOCAL_CLASSES -<li> \refitem cfg_extract_private EXTRACT_PRIVATE -<li> \refitem cfg_extract_static EXTRACT_STATIC -<li> \refitem cfg_file_patterns FILE_PATTERNS -<li> \refitem cfg_filter_source_files FILTER_SOURCE_FILES -<li> \refitem cfg_full_path_names FULL_PATH_NAMES -<li> \refitem cfg_generate_buglist GENERATE_BUGLIST -<li> \refitem cfg_generate_chi GENERATE_CHI -<li> \refitem cfg_generate_html GENERATE_HTML -<li> \refitem cfg_generate_htmlhelp GENERATE_HTMLHELP -<li> \refitem cfg_generate_latex GENERATE_LATEX -<li> \refitem cfg_generate_legend GENERATE_LEGEND -<li> \refitem cfg_generate_man GENERATE_MAN -<li> \refitem cfg_generate_rtf GENERATE_RTF -<li> \refitem cfg_generate_tagfile GENERATE_TAGFILE -<li> \refitem cfg_generate_testlist GENERATE_TESTLIST -<li> \refitem cfg_generate_todolist GENERATE_TODOLIST -<li> \refitem cfg_generate_treeview GENERATE_TREEVIEW -<li> \refitem cfg_graphical_hierarchy GRAPHICAL_HIERARCHY -<li> \refitem cfg_have_dot HAVE_DOT -<li> \refitem cfg_hhc_location HHC_LOCATION -<li> \refitem cfg_hide_scope_names HIDE_SCOPE_NAMES -<li> \refitem cfg_hide_undoc_classes HIDE_UNDOC_CLASSES -<li> \refitem cfg_hide_undoc_members HIDE_UNDOC_MEMBERS -<li> \refitem cfg_hide_undoc_relations HIDE_UNDOC_RELATIONS -<li> \refitem cfg_html_align_members HTML_ALIGN_MEMBERS -<li> \refitem cfg_html_footer HTML_FOOTER -<li> \refitem cfg_html_header HTML_HEADER -<li> \refitem cfg_html_output HTML_OUTPUT -<li> \refitem cfg_html_stylesheet HTML_STYLESHEET -<li> \refitem cfg_ignore_prefix IGNORE_PREFIX -<li> \refitem cfg_image_path IMAGE_PATH -<li> \refitem cfg_include_graph INCLUDE_GRAPH -<li> \refitem cfg_include_path INCLUDE_PATH -<li> \refitem cfg_inherit_docs INHERIT_DOCS -<li> \refitem cfg_inline_info INLINE_INFO -<li> \refitem cfg_inline_inherited_memb INLINE_INHERITED_MEMB -<li> \refitem cfg_inline_sources INLINE_SOURCES -<li> \refitem cfg_input INPUT -<li> \refitem cfg_input_filter INPUT_FILTER -<li> \refitem cfg_internal_docs INTERNAL_DOCS -<li> \refitem cfg_javadoc_autobrief JAVADOC_AUTOBRIEF -<li> \refitem cfg_latex_batchmode LATEX_BATCHMODE -<li> \refitem cfg_latex_cmd_name LATEX_CMD_NAME -<li> \refitem cfg_latex_header LATEX_HEADER -<li> \refitem cfg_latex_output LATEX_OUTPUT -<li> \refitem cfg_macro_expansion MACRO_EXPANSION -<li> \refitem cfg_makeindex_cmd_name MAKEINDEX_CMD_NAME -<li> \refitem cfg_man_extension MAN_EXTENSION -<li> \refitem cfg_man_links MAN_LINKS -<li> \refitem cfg_man_output MAN_OUTPUT -<li> \refitem cfg_max_dot_graph_height MAX_DOT_GRAPH_HEIGHT -<li> \refitem cfg_max_dot_graph_width MAX_DOT_GRAPH_WIDTH -<li> \refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES -<li> \refitem cfg_multiline_cpp_is_brief MULTILINE_CPP_IS_BRIEF -<li> \refitem cfg_optimize_output_for_c OPTIMIZE_OUTPUT_FOR_C -<li> \refitem cfg_optimize_output_java OPTIMIZE_OUTPUT_JAVA -<li> \refitem cfg_output_directory OUTPUT_DIRECTORY -<li> \refitem cfg_output_language OUTPUT_LANGUAGE -<li> \refitem cfg_paper_type PAPER_TYPE -<li> \refitem cfg_pdf_hyperlinks PDF_HYPERLINKS -<li> \refitem cfg_perl_path PERL_PATH -<li> \refitem cfg_predefined PREDEFINED -<li> \refitem cfg_project_name PROJECT_NAME -<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 -<li> \refitem cfg_rtf_output RTF_OUTPUT -<li> \refitem cfg_rtf_stylesheet_file RTF_STYLESHEET_FILE -<li> \refitem cfg_search_includes SEARCH_INCLUDES -<li> \refitem cfg_searchengine SEARCHENGINE -<li> \refitem cfg_short_names SHORT_NAMES -<li> \refitem cfg_show_include_files SHOW_INCLUDE_FILES -<li> \refitem cfg_show_used_files SHOW_USED_FILES -<li> \refitem cfg_skip_function_macros SKIP_FUNCTION_MACROS -<li> \refitem cfg_sort_member_docs SORT_MEMBER_DOCS -<li> \refitem cfg_source_browser SOURCE_BROWSER -<li> \refitem cfg_strip_code_comments STRIP_CODE_COMMENTS -<li> \refitem cfg_strip_from_path STRIP_FROM_PATH -<li> \refitem cfg_tab_size TAB_SIZE -<li> \refitem cfg_tagfiles TAGFILES -<li> \refitem cfg_template_relations TEMPLATE_RELATIONS -<li> \refitem cfg_toc_expand TOC_EXPAND -<li> \refitem cfg_treeview_width TREEVIEW_WIDTH -<li> \refitem cfg_verbatim_headers VERBATIM_HEADERS -<li> \refitem cfg_warn_format WARN_FORMAT -<li> \refitem cfg_warn_if_undocumented WARN_IF_UNDOCUMENTED -<li> \refitem cfg_warn_logfile WARN_LOGFILE -<li> \refitem cfg_warnings WARNINGS -\htmlonly -</ul> -</multicol> -\endhtmlonly -\latexonly -\end{CompactList} -\end{multicols} -\normalsize -\endlatexonly - -\subsection config_general General options +\secreflist +\refitem cfg_aliases ALIASES +\refitem cfg_allexternals ALLEXTERNALS +\refitem cfg_alphabetical_index ALPHABETICAL_INDEX +\refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC +\refitem cfg_bin_abspath BIN_ABSPATH +\refitem cfg_binary_toc BINARY_TOC +\refitem cfg_brief_member_desc BRIEF_MEMBER_DESC +\refitem cfg_case_sense_names CASE_SENSE_NAMES +\refitem cfg_cgi_name CGI_NAME +\refitem cfg_cgi_url CGI_URL +\refitem cfg_chm_file CHM_FILE +\refitem cfg_class_diagrams CLASS_DIAGRAMS +\refitem cfg_class_graph CLASS_GRAPH +\refitem cfg_collaboration_graph COLLABORATION_GRAPH +\refitem cfg_cols_in_alpha_index COLS_IN_ALPHA_INDEX +\refitem cfg_compact_latex COMPACT_LATEX +\refitem cfg_compact_rtf COMPACT_RTF +\refitem cfg_details_at_top DETAILS_AT_TOP +\refitem cfg_disable_index DISABLE_INDEX +\refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC +\refitem cfg_doc_abspath DOC_ABSPATH +\refitem cfg_doc_url DOC_URL +\refitem cfg_dot_image_format DOT_IMAGE_FORMAT +\refitem cfg_dot_path DOT_PATH +\refitem cfg_dotfile_dirs DOTFILE_DIRS +\refitem cfg_enable_preprocessing ENABLE_PREPROCESSING +\refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE +\refitem cfg_enabled_sections ENABLED_SECTIONS +\refitem cfg_example_path EXAMPLE_PATH +\refitem cfg_example_patterns EXAMPLE_PATTERNS +\refitem cfg_example_recursive EXAMPLE_RECURSIVE +\refitem cfg_exclude EXCLUDE +\refitem cfg_exclude_patterns EXCLUDE_PATTERNS +\refitem cfg_exclude_symlinks EXCLUDE_SYMLINKS +\refitem cfg_expand_as_defined EXPAND_AS_DEFINED +\refitem cfg_expand_only_predef EXPAND_ONLY_PREDEF +\refitem cfg_ext_doc_paths EXT_DOC_PATHS +\refitem cfg_external_groups EXTERNAL_GROUPS +\refitem cfg_extra_packages EXTRA_PACKAGES +\refitem cfg_extract_all EXTRACT_ALL +\refitem cfg_extract_local_classes EXTRACT_LOCAL_CLASSES +\refitem cfg_extract_private EXTRACT_PRIVATE +\refitem cfg_extract_static EXTRACT_STATIC +\refitem cfg_file_patterns FILE_PATTERNS +\refitem cfg_filter_source_files FILTER_SOURCE_FILES +\refitem cfg_full_path_names FULL_PATH_NAMES +\refitem cfg_generate_buglist GENERATE_BUGLIST +\refitem cfg_generate_chi GENERATE_CHI +\refitem cfg_generate_html GENERATE_HTML +\refitem cfg_generate_htmlhelp GENERATE_HTMLHELP +\refitem cfg_generate_latex GENERATE_LATEX +\refitem cfg_generate_legend GENERATE_LEGEND +\refitem cfg_generate_man GENERATE_MAN +\refitem cfg_generate_rtf GENERATE_RTF +\refitem cfg_generate_tagfile GENERATE_TAGFILE +\refitem cfg_generate_testlist GENERATE_TESTLIST +\refitem cfg_generate_todolist GENERATE_TODOLIST +\refitem cfg_generate_treeview GENERATE_TREEVIEW +\refitem cfg_graphical_hierarchy GRAPHICAL_HIERARCHY +\refitem cfg_have_dot HAVE_DOT +\refitem cfg_hhc_location HHC_LOCATION +\refitem cfg_hide_scope_names HIDE_SCOPE_NAMES +\refitem cfg_hide_undoc_classes HIDE_UNDOC_CLASSES +\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_footer HTML_FOOTER +\refitem cfg_html_header HTML_HEADER +\refitem cfg_html_output HTML_OUTPUT +\refitem cfg_html_stylesheet HTML_STYLESHEET +\refitem cfg_ignore_prefix IGNORE_PREFIX +\refitem cfg_image_path IMAGE_PATH +\refitem cfg_include_graph INCLUDE_GRAPH +\refitem cfg_include_path INCLUDE_PATH +\refitem cfg_inherit_docs INHERIT_DOCS +\refitem cfg_inline_info INLINE_INFO +\refitem cfg_inline_inherited_memb INLINE_INHERITED_MEMB +\refitem cfg_inline_sources INLINE_SOURCES +\refitem cfg_input INPUT +\refitem cfg_input_filter INPUT_FILTER +\refitem cfg_internal_docs INTERNAL_DOCS +\refitem cfg_javadoc_autobrief JAVADOC_AUTOBRIEF +\refitem cfg_latex_batchmode LATEX_BATCHMODE +\refitem cfg_latex_cmd_name LATEX_CMD_NAME +\refitem cfg_latex_header LATEX_HEADER +\refitem cfg_latex_output LATEX_OUTPUT +\refitem cfg_macro_expansion MACRO_EXPANSION +\refitem cfg_makeindex_cmd_name MAKEINDEX_CMD_NAME +\refitem cfg_man_extension MAN_EXTENSION +\refitem cfg_man_links MAN_LINKS +\refitem cfg_man_output MAN_OUTPUT +\refitem cfg_max_dot_graph_height MAX_DOT_GRAPH_HEIGHT +\refitem cfg_max_dot_graph_width MAX_DOT_GRAPH_WIDTH +\refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES +\refitem cfg_multiline_cpp_is_brief MULTILINE_CPP_IS_BRIEF +\refitem cfg_optimize_output_for_c OPTIMIZE_OUTPUT_FOR_C +\refitem cfg_optimize_output_java OPTIMIZE_OUTPUT_JAVA +\refitem cfg_output_directory OUTPUT_DIRECTORY +\refitem cfg_output_language OUTPUT_LANGUAGE +\refitem cfg_paper_type PAPER_TYPE +\refitem cfg_pdf_hyperlinks PDF_HYPERLINKS +\refitem cfg_perl_path PERL_PATH +\refitem cfg_predefined PREDEFINED +\refitem cfg_project_name PROJECT_NAME +\refitem cfg_project_number PROJECT_NUMBER +\refitem cfg_quiet QUIET +\refitem cfg_recursive RECURSIVE +\refitem cfg_referenced_by_relation REFERENCED_BY_RELATION +\refitem cfg_references_relation REFERENCES_RELATION +\refitem cfg_repeat_brief REPEAT_BRIEF +\refitem cfg_rtf_extensions_file RTF_EXTENSIONS_FILE +\refitem cfg_rtf_hyperlinks RTF_HYPERLINKS +\refitem cfg_rtf_output RTF_OUTPUT +\refitem cfg_rtf_stylesheet_file RTF_STYLESHEET_FILE +\refitem cfg_search_includes SEARCH_INCLUDES +\refitem cfg_searchengine SEARCHENGINE +\refitem cfg_short_names SHORT_NAMES +\refitem cfg_show_include_files SHOW_INCLUDE_FILES +\refitem cfg_show_used_files SHOW_USED_FILES +\refitem cfg_skip_function_macros SKIP_FUNCTION_MACROS +\refitem cfg_sort_member_docs SORT_MEMBER_DOCS +\refitem cfg_source_browser SOURCE_BROWSER +\refitem cfg_strip_code_comments STRIP_CODE_COMMENTS +\refitem cfg_strip_from_path STRIP_FROM_PATH +\refitem cfg_tab_size TAB_SIZE +\refitem cfg_tagfiles TAGFILES +\refitem cfg_template_relations TEMPLATE_RELATIONS +\refitem cfg_toc_expand TOC_EXPAND +\refitem cfg_treeview_width TREEVIEW_WIDTH +\refitem cfg_verbatim_headers VERBATIM_HEADERS +\refitem cfg_warn_format WARN_FORMAT +\refitem cfg_warn_if_undocumented WARN_IF_UNDOCUMENTED +\refitem cfg_warn_logfile WARN_LOGFILE +\refitem cfg_warnings WARNINGS +\endsecreflist + +\section config_general General options \anchor cfg_project_name <dl> @@ -510,7 +494,7 @@ followed by the descriptions of the tags grouped by category. consists of more lines than specified here it will be hidden. Use a value of 0 to hide initializers completely. The appearance of the value of individual variables and defines can be controlled using \ref cmdshowinitializer "\\showinitializer" - or \ref cmdhideinitializer "\hideinitializer" command in the documentation. + or \ref cmdhideinitializer "\\hideinitializer" command in the documentation. \anchor cfg_optimize_output_for_c <dt>\c OPTIMIZE_OUTPUT_FOR_C <dd> @@ -537,7 +521,7 @@ followed by the descriptions of the tags grouped by category. </dl> -\subsection messages_input Options related to warning and progress messages +\section messages_input Options related to warning and progress messages \anchor cfg_quiet <dl> @@ -582,7 +566,7 @@ followed by the descriptions of the tags grouped by category. </dl> -\subsection config_input Input related options +\section config_input Input related options \anchor cfg_input <dl> @@ -663,7 +647,7 @@ followed by the descriptions of the tags grouped by category. \addindex IMAGE_PATH The \c IMAGE_PATH tag can be used to specify one or more files or directories that contain images that are to be included in the - documentation (see the \ref cmdimage "\image" command). + documentation (see the \ref cmdimage "\\image" command). \anchor cfg_input_filter <dt>\c INPUT_FILTER <dd> @@ -688,7 +672,7 @@ followed by the descriptions of the tags grouped by category. </dl> -\subsection sourcebrowser_index Source browsing related options +\section sourcebrowser_index Source browsing related options \anchor cfg_source_browser <dl> @@ -719,7 +703,7 @@ followed by the descriptions of the tags grouped by category. </dl> -\subsection alphabetical_index Alphabetical index options +\section alphabetical_index Alphabetical index options \anchor cfg_alphabetical_index <dl> @@ -746,7 +730,7 @@ followed by the descriptions of the tags grouped by category. headers. </dl> -\subsection html_output HTML related options +\section html_output HTML related options \anchor cfg_generate_html <dl> @@ -774,7 +758,7 @@ followed by the descriptions of the tags grouped by category. \addindex HTML_HEADER The \c HTML_HEADER tag can be used to specify a user defined HTML header file for each generated HTML page. To get valid HTML the header file - should contain at least a \c <HTML> and a \c <BODY> tag, but it is + should contain at least a \c \<HTML\> and a \c \<BODY\> tag, but it is good idea to include the style sheet that is generated by doxygen as well. Minimal example: \verbatim @@ -805,7 +789,7 @@ followed by the descriptions of the tags grouped by category. \addindex HTML_FOOTER The \c HTML_FOOTER tag can be used to specify a user defined HTML footer for each generated HTML page. To get valid HTML the header file should contain - at least a \c </BODY> and a \c </HTML> tag. A minimal example: + at least a \c \</BODY\> and a \c \</HTML\> tag. A minimal example: \verbatim </BODY> </HTML> @@ -935,7 +919,7 @@ followed by the descriptions of the tags grouped by category. is shown. </dl> -\subsection latex_output LaTeX related options +\section latex_output LaTeX related options \anchor cfg_generate_latex <dl> @@ -1049,7 +1033,7 @@ EXTRA_PACKAGES = times in HTML. </dl> -\subsection rtf_output RTF related options +\section rtf_output RTF related options \anchor cfg_generate_rtf <dl> @@ -1104,7 +1088,7 @@ EXTRA_PACKAGES = times </dl> -\subsection man_output Man page related options +\section man_output Man page related options \anchor cfg_generate_man <dl> @@ -1139,7 +1123,7 @@ EXTRA_PACKAGES = times </dl> -\subsection config_prepro Preprocessor related options +\section config_prepro Preprocessor related options \anchor cfg_enable_preprocessing <dl> @@ -1204,7 +1188,7 @@ EXTRA_PACKAGES = times used for boiler-plate code, and will confuse the parser if not removed. </dl> -\subsection config_extref External reference options +\section config_extref External reference options \anchor cfg_tagfiles <dl> @@ -1263,7 +1247,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> interpreter (i.e. the result of `<tt>which perl</tt>'). </dl> -\subsection config_dot Dot options +\section config_dot Dot options \anchor cfg_class_diagrams <dl> @@ -1282,7 +1266,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> 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.research.att.com/sw/tools/graphviz/">Graphviz</a>, a graph - visualization toolkit from AT&T and Lucent Bell Labs. The other options in + 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) \anchor cfg_class_graph @@ -1374,7 +1358,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> the specified constraint. Beware that most browsers cannot cope with very large images. -\anchor cfg_generate_legend <dd> +\anchor cfg_generate_legend <dt>\c GENERATE_LEGEND <dd> \addindex GENERATE_LEGEND If the \c GENERATE_LEGEND tag is set to \c YES (the default) doxygen will @@ -1388,7 +1372,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> If left blank, "NO" is assumed. </dl> -\subsection config_search Search engine options +\section config_search Search engine options \anchor cfg_searchengine <dl> diff --git a/doc/diagrams.doc b/doc/diagrams.doc index d44a8b4..b6109ca 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -20,8 +20,8 @@ classes. 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 + more advanced diagrams and 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.research.att.com/sw/tools/graphviz/ If you have the "dot" tool available in the path, you can set @@ -48,7 +48,7 @@ graph is drawn for each documented class and struct that shows: <ul> <li> the inheritance relations with base classes. - <li> the usage relations with other structs & classes (e.g. + <li> the usage relations with other structs and classes (e.g. class \c A has a member variable \c m_a of type class \c B, then \c A has an arrow to \c B with \c m_a as label). </ul> diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 804187a..47a40e2 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -16,7 +16,7 @@ */ /*! \page docblocks Documenting the code -\subsection specialblock Special documentation blocks +\section specialblock Special documentation blocks A special documentation block is a C or C++ comment block with some additional markings, so doxygen knows it is a piece of documentation that @@ -95,7 +95,7 @@ documentation. For this purpose you can use the following: For the brief description there are also several posibilities: <ol> -<li>One could use the \ref cmdbrief "\brief" command with one of the +<li>One could use the \ref cmdbrief "\\brief" command with one of the above comment blocks. This command ends at the end of a paragraph, so the detailed description follows after an empty line. @@ -215,7 +215,7 @@ implementer of the members more direct access to the documentation. As a compromise the brief description could be placed before the declaration and the detailed description before the member definition. -\subsection memberdoc Putting documentation after members +\section memberdoc Putting documentation after members If you want to document the members of a file, struct, union, class, or enum, and you want to put the documentation for these members inside the compound, @@ -272,7 +272,7 @@ Here is an example of the use of these comment blocks: commands mentioned in the next section (like <code>\\class</code>) are ignored inside these comment blocks. -\subsection structuralcommands Documentation at other places +\section structuralcommands Documentation at other places So far we have assumed that the documentation blocks are always located in front of the declaration or definition of a file, class or namespace or in @@ -303,20 +303,20 @@ in the input that is read by doxygen: */ \endverbatim -Here the special command \c \class is used to indicate that the +Here the special command \c \\class is used to indicate that the comment block contains documentation for the class \c Test. Other structural commands are: <ul> -<li>\c \struct to document a C-struct. -<li>\c \union to document a union. -<li>\c \enum to document an enumeration type. -<li>\c \fn to document a function. -<li>\c \var to document a variable or typedef or enum value. -<li>\c \def to document a \#define. -<li>\c \file to document a file. -<li>\c \namespace to document a namespace. -<li>\c \package to document a Java package. -<li>\c \interface to document an IDL interface. +<li>\c \\struct to document a C-struct. +<li>\c \\union to document a union. +<li>\c \\enum to document an enumeration type. +<li>\c \\fn to document a function. +<li>\c \\var to document a variable or typedef or enum value. +<li>\c \\def to document a \#define. +<li>\c \\file to document a file. +<li>\c \\namespace to document a namespace. +<li>\c \\package to document a Java package. +<li>\c \\interface to document an IDL interface. </ul> See section \ref commands for detailed information about these and many other commands. diff --git a/doc/doxysearch_usage.doc b/doc/doxysearch_usage.doc index a919360..46a3de1 100644 --- a/doc/doxysearch_usage.doc +++ b/doc/doxysearch_usage.doc @@ -48,9 +48,8 @@ by typing: g++ doxysearch.cpp -o doxysearch \endverbatim -<a name="se"> +<a name="se"></a> <h3>Generating the search engine</h3> -</a> To include a search engine in the documentation generated by doxygen follow these steps: @@ -121,7 +120,7 @@ the Qt documentation, without needing the sources! This can be done by carefully following these steps: <ol> <li>Go to the html directory of the Qt-distribution: - <pre>cd $QTDIR/html</pre> + <pre>cd \$QTDIR/html</pre> <li>Generate the search index by typing: <pre>doxytag -s search.idx</pre> in the directory where the HTML files are located. diff --git a/doc/faq.doc b/doc/faq.doc index b9821bf..98199eb 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -104,7 +104,7 @@ You can document your class like To make doxygen put <br><br> <code> -#include <path/include.h> +#include \<path/include.h\> </code> in the documentation of the class MyClassName regardless of the name of the actual diff --git a/doc/grouping.doc b/doc/grouping.doc index 0d20b39..0c854a0 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -22,7 +22,7 @@ for each group. These groups are called "modules" in the documentation. The other mechanism works within a member list of some compound entity, and is refered to as a "member group". -\subsection modules Modules +\section modules Modules Modules are a way to group things together on a separate page. You can document a group as a whole, as well as all individual members. @@ -122,7 +122,7 @@ Click <a href="$(DOXYGEN_DOCDIR)/examples/group/html/modules.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly -\subsection memgroup Member Groups +\section memgroup Member Groups If a compound (e.g. a class or file) has many members, it is often desired to group them together. Doxygen already automatically groups @@ -149,8 +149,8 @@ comments. Note that the members of the group should be physcially inside the member group's body. Before the opening marker of a block a separate comment block may be -placed. This block should contain the \ref cmdname "@name" -(or \ref cmdname "\name") command and is used to specify the header +placed. This block should contain the \ref cmdname "@@name" +(or \ref cmdname "\\name") command and is used to specify the header of the group. Optionally, the comment block may also contain more detailed information about the group. diff --git a/doc/history.doc b/doc/history.doc index 0866130..96314e8 100644 --- a/doc/history.doc +++ b/doc/history.doc @@ -17,11 +17,11 @@ /*! \page history Doxygen History -<h3>Version 1.2.0</h3> -<h4>Major new features:</h4> +<h2>Version 1.2.0</h2> +<h3>Major new features:</h3> <ul> <li>Support for RTF output. -<li>Using the dot tool of the AT&T's GraphViz package, doxygen can now +<li>Using the dot tool of the AT\&T's GraphViz package, doxygen can now generate inheritance diagrams, collaboration diagrams, include dependency graphs, included by graphs and graphical inheritance overviews. <li>Function arguments can now be documented with separate comment blocks. @@ -46,26 +46,26 @@ The colors can be changed using cascading style sheets. </ul> -<h3>Version 1.0.0</h3> +<h2>Version 1.0.0</h2> -<h4>Major new features:</h4> +<h3>Major new features:</h3> <ul> <li>Support for templates and namespaces. <li>Internationalization support. Currently supported languages are: English, Czech, German, Spanish, Finnish, French, Italian, Japanese, Dutch, and Swedish. -<li>Automatic generation of inheritance diagrams for sub & super classes. +<li>Automatic generation of inheritance diagrams for sub and super classes. <li>Support for man page, compressed HTML help, and hyperlinked PDF output. <li>Cross-referencing documentation with source code and source inlining. <li>LaTeX formulas can be included in the documentation. -<li>Support for parsing Corba & Microsoft IDL. +<li>Support for parsing Corba and Microsoft IDL. <li>Images can be included in the documentation. -<li>Improved parsing & preprocessing. +<li>Improved parsing and preprocessing. </ul> -<h3>Version 0.4</h3> +<h2>Version 0.4</h2> -<h4>Major new features:</h4> +<h3>Major new features:</h3> <ul> <li>LaTeX output generation. <li>Full JavaDoc support. @@ -82,8 +82,8 @@ <li>A lot of small examples are now included. </ul> -<h3>Version 0.3</h3> -<h4>Major new features:</h4> +<h2>Version 0.3</h2> +<h3>Major new features:</h3> <ul> <li>A search engine <a href="doxysearch_usage.html">doxysearch</a>, that allows you to search through the generated documentation. @@ -99,8 +99,8 @@ documentation. </ul> -<h3>Version 0.2</h3> -<h4>Major new features:</h4> +<h2>Version 0.2</h2> +<h3>Major new features:</h3> <ul> <li>Blocks of code are now parsed. Function calls and variables are replaced by links to their documentation if possible. @@ -120,7 +120,7 @@ instead of only the used ones. </ul> -<h3>Version 0.1</h3> +<h2>Version 0.1</h2> Initial version. */ diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 476be78..7f79852 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -23,96 +23,96 @@ documentation. Note that all attributes of a HTML tag are ignored <ul> <li><tt>\<A HREF="..."\></tt> Starts a HTML hyper-link (HTML only). <li><tt>\<A NAME="..."\></tt> Starts an named anchor (HTML only). -<li>\c </A> Ends a link or anchor (HTML only). -<li>\c <B> Starts a piece of text displayed in a bold font. -<li>\c </B> Ends a \c <B> section. -<li>\c <BODY> Does not generate any output. -<li>\c </BODY> Does not generate any output. -<li>\c <BR> Forces a line break. -<li>\c <CENTER> starts a section of centered text. -<li>\c </CENTER> ends a section of centered text. -<li>\c <CAPTION> Starts a caption. Use within a table only. -<li>\c </CAPTION> Ends a caption. Use within a table only. -<li>\c <CODE> Starts a piece of text displayed in a typewriter font. -<li>\c </CODE> End a \c <CODE> section. -<li>\c <DD> Starts an item description. -<li>\c <DFN> Starts a piece of text displayed in a typewriter font. -<li>\c </DFN> Ends a \c <DFN> section. -<li>\c <DL> Starts a description list. -<li>\c </DL> Ends a description list. -<li>\c <DT> Starts an item title. -<li>\c </DT> Ends an item title. -<li>\c <EM> Starts a piece of text displayed in an italic font. -<li>\c </EM> Ends a \c <EM> section. -<li>\c <FORM> Does not generate any output. -<li>\c </FORM> Does not generate any output. -<li>\c <HR> Writes a horizontal ruler. -<li>\c <H1> Starts an unnumbered section. -<li>\c </H1> Ends an unnumberd section. -<li>\c <H2> Starts an unnumbered subsection. -<li>\c </H2> Ends an unnumbered subsection. -<li>\c <H?> Where ? is one of {3,4,5,6}, starts an unnumbered subsubsection using \c <H3> in HTML. -<li>\c </H?> Where ? is one of {3,4,5,6}, ends an unnumbered subsubsection using \c <H3> in HTML. -<li>\c <I> Starts a piece of text displayed in an italic font. -<li>\c <INPUT> Does not generate any output. -<li>\c </I> Ends a \c <I> section. -<li>\c <IMG> This command is written with attributes to the HTML output only. -<li>\c <LI> Starts a new list item. -<li>\c </LI> Ends a list item. -<li>\c <META> Does not generate any output. -<li>\c <MULTICOL> ignored by doxygen. -<li>\c </MUTLICOL> ignored by doxygen. -<li>\c <OL> Starts a numbered item list. -<li>\c </OL> Ends a numbered item list. -<li>\c <P> Starts a new paragraph. -<li>\c </P> Ends a paragraph. -<li>\c <PRE> Starts a preformatted fragment. -<li>\c </PRE> Ends a preformatted fragment. -<li>\c <SMALL> Starts a section of text displayed in a smaller font. -<li>\c </SMALL> Ends a \c <SMALL> section. -<li>\c <STRONG> Starts a section of bold text. -<li>\c </STRONG> Ends a section of bold text. -<li>\c <SUB> Starts a piece of text displayed in subscript. -<li>\c </SUB> Ends a \c <SUB> section. -<li>\c <SUP> Starts a piece of text displayed in superscript. -<li>\c </SUP> Ends a \c </SUP> section. -<li>\c <TABLE> starts a table. -<li>\c </TABLE> ends a table. -<li>\c <TD> Starts a new table data element. -<li>\c </TD> Ends a table data element. -<li>\c <TR> Starts a new table row. -<li>\c </TR> Ends a table row. -<li>\c <TT> Starts a piece of text displayed in a typewriter font. -<li>\c </TT> Ends a \c <TT> section. -<li>\c <KBD> Starts a piece of text displayed in a typewriter font. -<li>\c </KBD> Ends a \c <KBD> section. -<li>\c <UL> Starts an unnumbered item list. -<li>\c </UL> Ends an unnumbered item list. -<li>\c <VAR> Starts a piece of text displayed in an italic font. -<li>\c </VAR> Ends a \c </VAR> section. +<li><tt>\</A></tt> Ends a link or anchor (HTML only). +<li><tt>\<B></tt> Starts a piece of text displayed in a bold font. +<li><tt>\</B></tt> Ends a <tt>\<B\></tt> section. +<li><tt>\<BODY></tt> Does not generate any output. +<li><tt>\</BODY></tt> Does not generate any output. +<li><tt>\<BR></tt> Forces a line break. +<li><tt>\<CENTER></tt> starts a section of centered text. +<li><tt>\</CENTER></tt> ends a section of centered text. +<li><tt>\<CAPTION></tt> Starts a caption. Use within a table only. +<li><tt>\</CAPTION></tt> Ends a caption. Use within a table only. +<li><tt>\<CODE></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</CODE></tt> End a <tt>\<CODE\></tt> section. +<li><tt>\<DD></tt> Starts an item description. +<li><tt>\<DFN></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</DFN></tt> Ends a <tt>\<DFN\></tt> section. +<li><tt>\<DL></tt> Starts a description list. +<li><tt>\</DL></tt> Ends a description list. +<li><tt>\<DT></tt> Starts an item title. +<li><tt>\</DT></tt> Ends an item title. +<li><tt>\<EM></tt> Starts a piece of text displayed in an italic font. +<li><tt>\</EM></tt> Ends a <tt>\<EM\></tt> section. +<li><tt>\<FORM></tt> Does not generate any output. +<li><tt>\</FORM></tt> Does not generate any output. +<li><tt>\<HR></tt> Writes a horizontal ruler. +<li><tt>\<H1></tt> Starts an unnumbered section. +<li><tt>\</H1></tt> Ends an unnumberd section. +<li><tt>\<H2></tt> Starts an unnumbered subsection. +<li><tt>\</H2></tt> Ends an unnumbered subsection. +<li><tt>\<H3></tt> Starts an unnumbered subsubsection. +<li><tt>\</H3></tt> Ends an unnumbered subsubsection. +<li><tt>\<I></tt> Starts a piece of text displayed in an italic font. +<li><tt>\<INPUT></tt> Does not generate any output. +<li><tt>\</I></tt> Ends a <tt>\<I\></tt> section. +<li><tt>\<IMG></tt> This command is written with attributes to the HTML output only. +<li><tt>\<LI></tt> Starts a new list item. +<li><tt>\</LI></tt> Ends a list item. +<li><tt>\<META></tt> Does not generate any output. +<li><tt>\<MULTICOL></tt> ignored by doxygen. +<li><tt>\</MUTLICOL></tt> ignored by doxygen. +<li><tt>\<OL></tt> Starts a numbered item list. +<li><tt>\</OL></tt> Ends a numbered item list. +<li><tt>\<P></tt> Starts a new paragraph. +<li><tt>\</P></tt> Ends a paragraph. +<li><tt>\<PRE></tt> Starts a preformatted fragment. +<li><tt>\</PRE></tt> Ends a preformatted fragment. +<li><tt>\<SMALL></tt> Starts a section of text displayed in a smaller font. +<li><tt>\</SMALL></tt> Ends a <tt>\<SMALL\></tt> section. +<li><tt>\<STRONG></tt> Starts a section of bold text. +<li><tt>\</STRONG></tt> Ends a section of bold text. +<li><tt>\<SUB></tt> Starts a piece of text displayed in subscript. +<li><tt>\</SUB></tt> Ends a <tt>\<SUB\></tt> section. +<li><tt>\<SUP></tt> Starts a piece of text displayed in superscript. +<li><tt>\</SUP></tt> Ends a <tt>\</SUP\></tt> section. +<li><tt>\<TABLE></tt> starts a table. +<li><tt>\</TABLE></tt> ends a table. +<li><tt>\<TD></tt> Starts a new table data element. +<li><tt>\</TD></tt> Ends a table data element. +<li><tt>\<TR></tt> Starts a new table row. +<li><tt>\</TR></tt> Ends a table row. +<li><tt>\<TT></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</TT></tt> Ends a <tt>\<TT\></tt> section. +<li><tt>\<KBD></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</KBD></tt> Ends a <tt>\<KBD\></tt> section. +<li><tt>\<UL></tt> Starts an unnumbered item list. +<li><tt>\</UL></tt> Ends an unnumbered item list. +<li><tt>\<VAR></tt> Starts a piece of text displayed in an italic font. +<li><tt>\</VAR></tt> Ends a <tt>\</VAR\></tt> section. </ul> The special HTML character entities that are recognized by Doxygen: <ul> -<li>\c © the copyright symbol -<li>\c " a double quote -<li>\c &?uml; where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, +<li><tt>\©</tt> the copyright symbol +<li><tt>\"</tt> a double quote +<li><tt>\&?uml;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, writes a character with a diaeresis accent (like ä). -<li>\c &?acute; where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, +<li><tt>\&?acute;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, writes a character with a acute accent (like á). -<li>\c &?grave; where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, +<li><tt>\&?grave;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, writes a character with a grave accent (like à). -<li>\c &?circ; where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, +<li><tt>\&?circ;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, writes a character with a circumflex accent (like â). -<li>\c &?tilde; where ? is one of {A,N,O,a,n,o}, +<li><tt>\&?tilde;</tt> where ? is one of {A,N,O,a,n,o}, writes a character with a tilde accent (like ã). -<li>\c ß write a sharp s (i.e. ß) to the output. -<li>\c &?cedil; where ? is one of {c,C}, +<li><tt>\ß</tt> write a sharp s (i.e. ß) to the output. +<li><tt>\&?cedil;</tt> where ? is one of {c,C}, writes a c-cedille (like ç). -<li>\c &?ring; where ? is one of {a,A}, - writes an \c a with a ring (like å). -<li>\c a non breakable space. +<li><tt>\&?ring;</tt> where ? is one of {a,A}, + writes an <tt>a</tt> with a ring (like å). +<li><tt>\ </tt> a non breakable space. </ul> Finally, to put invisible comments inside comment blocks, HTML style diff --git a/doc/index.doc b/doc/index.doc index a9fad12..6c1aa66 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -155,8 +155,8 @@ of possible and/or requested enhancements. \addindex acknowledgements Thanks go to: <ul> -\addindex Doc++ -<li>Malte Zöckler and Roland Wunderling, authors of DOC++. +<li>\addindex Doc++ + Malte Zöckler and Roland Wunderling, authors of DOC++. The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still given me a good start in writing doxygen. @@ -182,7 +182,7 @@ Thanks go to: Roddy, Paul Schwartz, Charles Duffy, Vadym Voznyuk, Philip Walton and Dwight Browne for donating money. <li>The Comms group of <a href="http://www.symbian.com">Symbian</a> for donating - an ultra cool <a href="http://www.psion.com/revoplus>Revo plus</a> + an ultra cool <a href="http://www.psion.com/revoplus">Revo plus</a> organizer! <li>The band <a href="http://www.porcupinetree.com">Porcupine Tree</a> for providing hours of great music to listen to while coding. diff --git a/doc/install.doc b/doc/install.doc index 0cd453e..96a1056 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -22,7 +22,7 @@ First go to the \latexonly({\tt http://www.doxygen.org/download.html})\endlatexonly to get the latest distribution, if you did not have it already. -This section is divided into the following subsections: +This section is divided into the following sections: <ul> <li>\ref install_src_unix "Compiling from source on Unix" <li>\ref install_bin_unix "Installating the binaries on Unix" @@ -32,7 +32,7 @@ This section is divided into the following subsections: <li>\ref build_tools "Tools used to develop doxygen" </ul> -\subsection install_src_unix Compiling from source on Unix +\section install_src_unix Compiling from source on Unix If you downloaded the source distribution, you need at least the following to build the executable: @@ -43,7 +43,7 @@ following to build the executable: \addindex bison \addindex make <li>In order to generate a Makefile for your platform, you need - <a href="http://www.perl.com/>perl</a> + <a href="http://www.perl.com/">perl</a> \latexonly(see {\tt http://www.perl.com/})\endlatexonly. \addindex perl </ul> @@ -156,7 +156,7 @@ Compilation is now done by performing the following steps: </ol> -\subsection install_bin_unix Installating the binaries on Unix +\section install_bin_unix Installating the binaries on Unix After the compilation of the source code do a <code>make install</code> to install doxygen. If you downloaded the binary distribution for Unix, @@ -187,7 +187,7 @@ Compilation is now done by performing the following steps: If you have a RPM or DEP package, then please follow the standard installation procedure that is required for these packages. -\subsection unix_problems Known compilation problems for Unix +\section unix_problems Known compilation problems for Unix <b>Qt problems</b> @@ -205,7 +205,7 @@ The solution: go to the root of the doxygen distribution and do: export QTDIR=$PWD \endverbatim -If you have a csh-like shell you should use <code>setenv QTDIR $PWD</code> +If you have a csh-like shell you should use <code>setenv QTDIR \$PWD</code> instead of the <code>export</code> command above. Now install doxygen as described above. @@ -228,7 +228,7 @@ your distribution does not have it please select another paper type in the config file (see the \ref cfg_paper_type "PAPER_TYPE" tag in the config file). -<b>HP-UX & Digital Unix problems</b> +<b>HP-UX \& Digital Unix problems</b> If you are compiling for HP-UX with aCC and you get this error: \verbatim @@ -357,11 +357,11 @@ or omit the -O2 for the particular files in the Makefile. <b>Dot problems</b> Due to a change in the way image maps are generated, older versions -of doxygen (<=1.2.17) will not work correctly with newer versions of -graphviz (>=1.8.8). The effect of this incompatibility is that +of doxygen (\<=1.2.17) will not work correctly with newer versions of +graphviz (\>=1.8.8). The effect of this incompatibility is that generated graphs in HTML are not properly clickable. -\subsection install_src_windows Compiling from source on Windows +\section install_src_windows Compiling from source on Windows Currently, I have only compiled doxygen for Windows using Microsoft's Visual C++ (version 6.0). For other compilers you may need to edit the @@ -459,8 +459,10 @@ Here is what is required: to produce PDF output instead of DVI, or the PDF can be produced from PostScript using the utility <code>ps2pdf</code>. - If you want to use MikTeX then you need to download the - fancyhdr package separately. You can find it at: + If you want to use MikTeX then you need to select at least the + medium size installation. For really old versions of MikTex or minimal + installations, you may need to download the fancyhdr package separately. + You can find it at: ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/supported/fancyhdr/ <li>If you want to generate compressed HTML help @@ -526,15 +528,15 @@ Compilation is now done by performing the following steps: nmake \endverbatim - The generated HTML docs are located in the <code>..\html</code> + The generated HTML docs are located in the <code>..\\html</code> subdirectory. - The sources for LaTeX documentation are located in the <code>..\latex</code> + The sources for LaTeX documentation are located in the <code>..\\latex</code> subdirectory. From those sources, the DVI, PostScript, and PDF documentation can be generated. </ol> -\subsection install_bin_windows Installating the binaries on Windows +\section install_bin_windows Installating the binaries on Windows There is no fancy installation procedure at the moment (if anyone can add it in a location independent way please let me know). @@ -549,7 +551,7 @@ the Qt library first. This library can be downloaded from http://www.trolltech.com/products/download/qt-win-noncomm.html --> -\subsection build_tools Tools used to develop doxygen +\section build_tools Tools used to develop doxygen Doxygen was developed and tested under Linux using the following open-source tools: diff --git a/doc/installdox_usage.doc b/doc/installdox_usage.doc index df9973e..a939ec2 100644 --- a/doc/installdox_usage.doc +++ b/doc/installdox_usage.doc @@ -42,7 +42,7 @@ The following options are available: an absolute path or a URL. \par Note: - Each <tagfile> must be unique and should only be the name of the + Each \<tagfile\> must be unique and should only be the name of the file, not including the path. <dt><b>-q</b><dd> diff --git a/doc/language.doc b/doc/language.doc index 0594241..42b1195 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -55,7 +55,7 @@ when the translator was updated. <TD>Brazilian Portuguese</TD> <TD>Fabio "FJTC" Jun Takada Chino</TD> <TD>chino@NOSPAM.icmc.sc.usp.br</TD> - <TD>1.2.17</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Chinese</TD> @@ -73,13 +73,13 @@ when the translator was updated. <TD>Croatian</TD> <TD>Boris Bralo</TD> <TD>boris.bralo@NOSPAM.zg.tel.hr</TD> - <TD>1.2.17</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Czech</TD> <TD>Petr Přikryl</TD> <TD>prikrylp@NOSPAM.skil.cz</TD> - <TD>1.2.17</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Danish</TD> @@ -163,7 +163,7 @@ when the translator was updated. <TD>Portuguese</TD> <TD>Rui Godinho Lopes</TD> <TD>ruiglopes@NOSPAM.yahoo.com</TD> - <TD>1.2.17</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Romanian</TD> @@ -187,7 +187,7 @@ when the translator was updated. <TD>Slovak</TD> <TD>Stanislav Kudláč</TD> <TD>skudlac@NOSPAM.pobox.sk</TD> - <TD>1.2.13</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Slovene</TD> @@ -224,16 +224,16 @@ when the translator was updated. {\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\ \hline \hline - Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt chino@icmc.sc.usp.br} & 1.2.17 \\ + Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt chino@icmc.sc.usp.br} & up-to-date \\ \hline Chinese & Wei Liu & {\tt liuwei@asiainfo.com} & 1.2.13 \\ & Wang Weihan & {\tt wangweihan@capinfo.com.cn} & \\ \hline Chinese Traditional & Gary Lee & {\tt garylee@ecosine.com.tw} & 1.2.16 \\ \hline - Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & 1.2.17 \\ + Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & up-to-date \\ \hline - Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & 1.2.17 \\ + Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & up-to-date \\ \hline Danish & Erik S\o{}e S\o{}rensen & {\tt erik@mail.nu} & 1.2.7 \\ \hline @@ -265,7 +265,7 @@ when the translator was updated. Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & 1.2.16 \\ & Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} & \\ \hline - Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & 1.2.17 \\ + Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & up-to-date \\ \hline Romanian & Alexandru Iosup & {\tt aiosup@yahoo.com} & 1.2.16 \\ \hline @@ -273,7 +273,7 @@ when the translator was updated. \hline Serbian & Dejan Milosavljevic & {\tt dmilos@email.com} & 1.2.16 \\ \hline - Slovak & Stanislav Kudl\'{a}\v{c} & {\tt skudlac@pobox.sk} & 1.2.13 \\ + Slovak & Stanislav Kudl\'{a}\v{c} & {\tt skudlac@pobox.sk} & up-to-date \\ \hline Slovene & Matjaz Ostroversnik & {\tt matjaz.ostroversnik@zrs-tk.si} & 1.2.16 \\ \hline @@ -305,26 +305,49 @@ Just follow these steps: is already working on support for that language, you will be assigned as the maintainer for the language. <li>Create a copy of translator_en.h and name it - translator_<your_2_letter_country_code>.h + translator_\<your_2_letter_country_code\>.h I'll use xx in the rest of this document. +<li>Add definition of the symbol for your language into lang_cfg.h: +\verbatim +#define LANG_xx +\endverbatim + Use capital letters for your \c xx (to be consistent). The \c lang_cfg.h + defines which language translators will be compiled into doxygen + executable. It is a kind of configuration file. If you are sure that + you do not need some of the languages, you can remove (comment out) + definitions of symbols for the languages, or you can say \c #undef + instead of \c #define for them. <li>Edit language.cpp: Add a \verbatim +#ifdef LANG_xx #include<translator_xx.h> +#endif \endverbatim - in <code>setTranslator()</code> add + Remember to use the same symbol LANG_xx that you added to \c lang_cfg.h. + I.e., the \c xx should be capital letters that identify your language. + On the other hand, the \c xx inside your \c translator_xx.h should be + lower case. + <p>Now, in <code>setTranslator()</code> add \verbatim +#ifdef LANG_xx else if (L_EQUAL("your_language_name")) { theTranslator = new TranslatorYourLanguage; } +#endif \endverbatim - after the <code>if { ... }</code> + after the <code>if { ... }</code>. I.e., it must be placed after the code + for creating the English translator at the beginning, and before the + <code>else { ... }</code> part that creates the translator for the + default language (English again). <li>Edit libdoxygen.pro.in and add \c translator_xx.h to the \c HEADERS line. <li>Edit <code>translator_xx.h</code>: <ul> - <li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code> twice. + <li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code> + twice (i.e. in the \c #ifndef and \c #define preprocessor commands at + the beginning of the file). <li>Rename TranslatorEnglish to TranslatorYourLanguage <li>In the member <code>idLanguage()</code> change "english" into the name of your language (use lower case characters only). Depending diff --git a/doc/language.tpl b/doc/language.tpl index 875d770..a0dc352 100644 --- a/doc/language.tpl +++ b/doc/language.tpl @@ -52,26 +52,49 @@ Just follow these steps: is already working on support for that language, you will be assigned as the maintainer for the language. <li>Create a copy of translator_en.h and name it - translator_<your_2_letter_country_code>.h + translator_\<your_2_letter_country_code\>.h I'll use xx in the rest of this document. +<li>Add definition of the symbol for your language into lang_cfg.h: +\verbatim +#define LANG_xx +\endverbatim + Use capital letters for your \c xx (to be consistent). The \c lang_cfg.h + defines which language translators will be compiled into doxygen + executable. It is a kind of configuration file. If you are sure that + you do not need some of the languages, you can remove (comment out) + definitions of symbols for the languages, or you can say \c #undef + instead of \c #define for them. <li>Edit language.cpp: Add a \verbatim +#ifdef LANG_xx #include<translator_xx.h> +#endif \endverbatim - in <code>setTranslator()</code> add + Remember to use the same symbol LANG_xx that you added to \c lang_cfg.h. + I.e., the \c xx should be capital letters that identify your language. + On the other hand, the \c xx inside your \c translator_xx.h should be + lower case. + <p>Now, in <code>setTranslator()</code> add \verbatim +#ifdef LANG_xx else if (L_EQUAL("your_language_name")) { theTranslator = new TranslatorYourLanguage; } +#endif \endverbatim - after the <code>if { ... }</code> + after the <code>if { ... }</code>. I.e., it must be placed after the code + for creating the English translator at the beginning, and before the + <code>else { ... }</code> part that creates the translator for the + default language (English again). <li>Edit libdoxygen.pro.in and add \c translator_xx.h to the \c HEADERS line. <li>Edit <code>translator_xx.h</code>: <ul> - <li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code> twice. + <li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code> + twice (i.e. in the \c #ifndef and \c #define preprocessor commands at + the beginning of the file). <li>Rename TranslatorEnglish to TranslatorYourLanguage <li>In the member <code>idLanguage()</code> change "english" into the name of your language (use lower case characters only). Depending diff --git a/doc/lists.doc b/doc/lists.doc index 251160e..84e0ac9 100644 --- a/doc/lists.doc +++ b/doc/lists.doc @@ -106,7 +106,7 @@ For compatibility with the Troll Tech's internal documentation tool and with KDoc, doxygen has two commands that can be used to create simple unnested lists. -See \ref cmdarg "\arg" and \ref cmdli "\li" for more info. +See \ref cmdarg "\\arg" and \ref cmdli "\\li" for more info. \htmlonly Go to the <a href="grouping.html">next</a> section or return to the diff --git a/doc/preprocessing.doc b/doc/preprocessing.doc index ff44316..bb46765 100644 --- a/doc/preprocessing.doc +++ b/doc/preprocessing.doc @@ -157,8 +157,8 @@ for class QList is to define: PREDEFINED = QListT:=QList \endverbatim -Here is an example provided by Valter Minute & Reyes Ponce that helps -doxygen to wade through the boilerplate code in Microsoft's ATL & MFC +Here is an example provided by Valter Minute and Reyes Ponce that helps +doxygen to wade through the boilerplate code in Microsoft's ATL \& MFC libraries: \verbatim diff --git a/doc/starting.doc b/doc/starting.doc index 8d4bc16..85341e3 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -32,7 +32,7 @@ engine. See section \ref doxysearch_usage for more detailed usage information. Optionally, the executable \c doxywizard is a GUI front-end for editing the configuration files that are used by doxygen. -\subsection step1 Step 1: Creating a configuration file +\section step1 Step 1: Creating a configuration file Doxygen uses a configuration file to determine all of its settings. Each project should get its own configuration file. A project can consist @@ -106,7 +106,7 @@ It can also include the sources directly into the documentation by setting \ref cfg_inline_sources "INLINE_SOURCES" to \c YES (this can be handy for code reviews for instance). -\subsection step2 Step 2: Running doxygen +\section step2 Step 2: Running doxygen To generate the documentation you can now enter: \verbatim @@ -159,7 +159,7 @@ environment variable). Note that there are some limitations to the capabilities of the man page format, so some information (like class diagrams, cross references and formulas) will be lost. -\subsection step3 Step 3: Documenting the sources +\section step3 Step 3: Documenting the sources Although documenting the source is presented as step 3, in a new project this should of course be step 1. Here I assume |