/****************************************************************************** * * $Id$ * * Copyright (C) 1997-1999 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * * All output generated with Doxygen is not covered by this license. * */ /*! \page commands \section commands Special Commands All commands in the documentation start with a backslash (\\) or an at-sign (\@). Some commands have one or more arguments. Each argument has a certain range: If [square] brackets are used the argument is optional. Here is an alphabetically sorted list of all commands with references to their documentation: \htmlonly \endhtmlonly \latexonly \end{CompactList} \end{multicols} \endlatexonly The following subsections provide a list of all commands that are recognized by Doxygen. Unrecognized commands are treated as normal text.

\htmlonly
--- \endhtmlonly Structural indicators \htmlonly ---
\endhtmlonly

\subsection cmdclass \class [] [] \addindex \class Indicates that a comment block contains documentation for a class with name \. Optionally a header file and a header name can be specified. If the header-file is specified, a link to a verbatim copy of the header will be included in the HTML documentation. The \ argument can be used to overwrite the name of the link that is used in the class documentation to something other than \. This can be useful if the include name is not located on the default include path (like \). \par Example: \verbinclude class.h \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly
\subsection cmdcode \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 links to the documentation. \sa section \ref cmdendcode, section \ref cmdverbatim
\subsection cmddef \def \addindex \def Indicates that a comment block contains documentation for a \c #define macro. \par Example: \verbinclude define.h \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly
\subsection cmddefgroup \defgroup (group title) \addindex \defgroup Indicates that a comment block contains documentation for a group of classes, files or namespaces. This can be used to categorize classes, files or namespaces, and document those categories. \sa section \ref cmdingroup
\subsection cmdendcode \endcode \addindex \endcode Ends a block of code. \sa section \ref cmdcode
\subsection cmdenum \enum \addindex \enum Indicates that a comment block contains documentation for an enumeration, with name \. If the enum is a member of a class and the documentation block is located outside the class definition, the scope of the class should be specified as well. If a comment block is located directly in front of an enum declaration, the \\enum comment may be omitted. \par Notice: The type of an anonymous enum cannot be documented, but the values of an anonymous enum can. \par Example: \verbinclude enum.h \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly
\subsection cmdexample \example \addindex \example Indicates that a comment block contains documentation for a source code example. The name of the source file is \. The text of this file will be included in the documentation, just after the documentation contained in the comment block. All examples are placed in a list. The source code is scanned for documented members and classes. If any are found, the names are cross-referenced with the documentation. If more that one source file is needed for the example, the \\include command can be used. \par Example: \verbinclude example.cpp Where the example file \c example_test.cpp looks as follows: \verbinclude example_test.cpp \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly \sa section \ref cmdinclude.
\subsection cmdfile \file [] \addindex \file Indicates that a comment block contains documentation for a source or header file with name \. The file name may include (part of) the path if the file-name alone is not unique. If the file name is omitted (i.e. the line after \\file is left blank) then the documentation block that contains the \\file command will belong to the file it is located in. \par Important: The documentation of global functions, variables, typedefs, and enums will only be included in the output if the file they are in is documented as well. \par Example: \verbinclude file.h \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly
\subsection cmdfn \fn (function declaration) \addindex \fn Indicates that a comment block contains documentation for a function (either global or as a member of a class). This command is needed if a comment block is \e not located before the function declaration or definition. A full function declaration should be specified after the \fn command. The argument ends at the end of the line. \par Example: \verbinclude func.h \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly \sa section \ref cmdvar and \ref cmdtypedef
\subsection cmdingroup \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. \sa section \ref cmddefgroup
\subsection cmdinternal \internal \addindex \internal This command writes the message `For internal use only' to the output. All text after a \c \internal command is ignored.
\subsection cmdnamespace \namespace \addindex \namespace Indicates that a comment block contains documentation for a namespace with name \.
\subsection cmdoverload \overload [(function declaration)] \addindex \overload This command can be used to generate the following standard text for an overloaded member function: `This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.' If the documentation for the overloaded member function is not located in front of the function declaration or definition, the optional argument should be used to specify the correct function. Any other documentation that is inside the documentation block will by appended after the generated message. \par Notice 1: You are responsible that there is indeed an earlier documented member that is overloaded by this one. \par Notice 2: The \\overload command does not work inside a one-line comment. \par Example: \verbinclude examples/overload.cpp \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly
\subsection cmdpage \page (title) \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 \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly generator starts a new section in the chapter `Page documentation'. \par Example: \verbinclude page.doc \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly \sa section \ref cmdsection, section \ref cmdsubsection, and section \ref cmdref
\subsection cmdrelates \relates \addindex \relates This command can be used in the documentation of a non-member function \. It puts the function inside the `related function' section of the class documentation. This command is useful for documenting non-friend functions that are nevertheless strongly coupled to a certain class. It prevents the need of having to document a file, but only works for functions. \par Example: \verbinclude relates.cpp \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly
\subsection cmdstruct \struct [] [] \addindex \struct Indicates that a comment block contains documentation for a struct with name \. The arguments are equal to the \\class command. \sa section \ref cmdclass.
\subsection cmdtypedef \typedef (typedef declaration) \addindex \typedef Indicates that a comment block contains documentation for a typedef, typedef (either global or as a member of a class). This command is equivalent to \\var and \\fn. \sa section \ref cmdfn and \ref cmdvar
\subsection cmdunion \union [] [] \addindex \union Indicates that a comment block contains documentation for a union with name \. The arguments are equal to the \\class command. \sa section \ref cmdclass.
\subsection cmdvar \var (variable declaration) \addindex \var Indicates that a comment block contains documentation for a variable, enum value (either global or as a member of a class). This command is equivalent to \\typedef and \\fn. \sa section \ref cmdfn and \cmdtypedef

\htmlonly
--- \endhtmlonly Section indicators \htmlonly ---
\endhtmlonly

\subsection cmdauthor \author { list of authors } \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 enhancement commands may be used inside the paragraph. Multiple adjacent \\author commands will be joined into a single paragraph and separated by commas. Alternatively, one \\author command may mention several authors. The \\author command ends when a blank line or some other sectioning command is encountered. \par Example: \verbinclude author.cpp \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly \sa Section \ref cmdjdauthor.
\subsection cmdbrief \brief {brief description} \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 will be placed at the declaration of the member and prepended to the detailed description. A brief description may span several lines (although it is advised to keep it brief!). A brief description ends when a blank line or another sectioning command is encountered. If multiple \\brief commands are present they will be joined. See section \ref cmdauthor for an example. \sa Section \ref cmdjdshort
\subsection cmdbug \bug { bug description } \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 enhancement commands may be used inside the paragraph. Multiple adjacent \\bug commands will be joined into a single paragraph. Each bug description will start on a new line. Alternatively, one \\bug command may mention several bugs. The \\bug command ends when a blank line or some other sectioning command is encountered. See section \ref cmdauthor for an example.
\subsection cmddate \date { date description } \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 enhancement commands may be used inside the paragraph. Multiple adjacent \\date commands will be joined into a single paragraph. Each date description will start on a new line. Alternatively, one \\date command may mention several dates. The \\date command ends when a blank line or some other sectioning command is encountered. See section \ref cmdauthor for an example. \sa Section \ref cmdjddate.
\subsection cmdpar \par (paragraph title) { paragraph } \addindex \par Starts a paragraph with a user defined heading. The heading is specified using the paragraph title argument and extends until the end of the line. 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. The \\par command ends when a blank line or some other sectioning command is encountered. \par Example: \verbinclude par.cpp \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly
\subsection cmdparam \param { parameter description } \addindex \param Starts a parameter description for a function parameter with name \. Followed by a description of the parameter. The existence of the parameter is not checked. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent \\param commands will be joined into a single paragraph. Each parameter description will start on a new line. The \\param description ends when a blank line or some other sectioning command is encountered. See section \ref cmdfn for an example. \sa Section \ref cmdjdparam.
\subsection cmdexception \exception { exception description } \addindex \exception Starts an exception description for an exception object with name \. Followed by a description of the exception. The existence of the exception object is not checked. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent \\exception commands will be joined into a single paragraph. Each parameter description will start on a new line. The \\exception description ends when a blank line or some other sectioning command is encountered. See section \ref cmdfn for an example. \sa Section \ref cmdjdexception.
\subsection cmdreturn \return { description of the return value } \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. Multiple adjacent \\return commands will be joined into a single paragraph. The \\return description ends when a blank line or some other sectioning command is encountered. See section \ref cmdfn for an example. \sa Section \ref cmdjdreturn.
\subsection cmdsa \sa { references } \addindex \sa Starts a paragraph where one or more cross-references to classes, functions, methods, variables, files or URL may be specified. The separators \c :: and \c # may be used to separate a class from the name of its members. One of several overloaded methods or constructors may be selected by including a parenthesized list of argument types after the method. \sa section \ref autolink for information on how to create links to objects and section \ref cmdjdsee for the JavaDoc version of this command.
\subsection cmdversion \version { version number } \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 enhancement commands may be used inside the paragraph. Multiple adjacent \\version commands will be joined into a single paragraph. Each version description will start on a new line. Alternatively, one \\version command may mention several dates. The \\version command ends when a blank line or some other sectioning command is encountered. See section \ref cmdauthor for an example. \sa Section \ref cmdjdversion.
\subsection cmdwarning \warning { warning message } \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 enhancement commands may be used inside the paragraph. Multiple adjacent \\warning commands will be joined into a single paragraph. Each warning description will start on a new line. Alternatively, one \\warning command may mention several warnings. The \\warning command ends when a blank line or some other sectioning command is encountered. See section \ref cmdauthor for an example.

\htmlonly
--- \endhtmlonly Commands to create links \htmlonly ---
\endhtmlonly

\subsection cmdaddindex \addindex \addindex \addindex This command adds \ to the \htmlonly LaTeX\endhtmlonly \latexonly\LaTeX\ \endlatexonly index. \subsection cmdendlink \endlink \addindex \endlink This command ends a link that is started with the \\link command. \sa section \ref cmdlink.
\subsection cmdlink \link \addindex \link The links that are automatically generated by Doxygen always have the name of the object they point to as link-text. The \\link command can be used to create a link to an object (a file, class, or member) with a user specified link-text. The link command should end with an \\endlink command. All text between the \\link and \\endlink commands serves as text for a link to the \ specified as the first argument of \\link. See section \ref autolink for more information on automatically generated links and valid link-objects. \b Notice: Keep in mind that links are only meaningful in HTML text; in \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly text, the link text is just written to the output.
\subsection cmdref \ref \addindex \ref Creates a reference to a named section, subsection, or page. For HTML documentation the reference command will generate a link to the section, the title of the section will be used as the link text. For \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly documentation the reference command will generate a section number. See section \ref cmdpage for an example of the \\ref command.
\subsection cmdsection \section (section title) \addindex \section Creates a section with name \. The title of the section should be specified as the second argument of the \\section command. See section \ref cmdpage for an example of the \\cmdsection command.
\subsection cmdsubsection \subsection (subsection title) \addindex \subsection Creates a subsection with name \. The title of the subsection should be specified as the second argument of the \\subsection command. See section \ref cmdpage for an example of the \\cmdsubsection command.

\htmlonly
--- \endhtmlonly Commands for displaying examples \htmlonly ---
\endhtmlonly

\subsection cmddontinclude \dontinclude \addindex \dontinclude This command can be used to parse a source file without actually including it. Any class and member declarations inside the code are `remembered' during the parsing of the comment block that contained the \\dontinclude command. For line by line description of source files, one or more lines of the example can be displayed using the \\line, \\skip, \\skipline, and \\until commands. An internal pointer is used for these commands. The \\dontinclude command sets the pointer to the first line of the example. \par Example: \verbinclude include.cpp Where the example file \c example_test.cpp looks as follows: \verbinclude example_test.cpp \htmlonly Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly \sa sections \ref cmdline, \ref cmdskip, \ref cmdskipline, and \ref cmduntil.
\subsection cmdinclude \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. Include files or directories can be specified using the \c INCLUDE_PATH tag of Doxygen's configuration file. Using the \\include command is equivalent to inserting the file into the documentation block and surrounding it with \\code and \\endcode commands. The main purpose of the \\include command is to avoid code duplication in case of example blocks that consist of multiple source and header files. For line by line description of source files, one or more lines of the example can be displayed using the \\line, \\skip, \\skipline, and \\until commands. An internal pointer is used for these command. The \\include command sets the pointer to the first line of the example. \sa section \ref cmdexample and \ref cmddontinclude.
\subsection cmdline \line ( pattern ) \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 to the output. The internal pointer that is used to keep track of the current line in the example, is set to the start of the line following the non-blank line that was found (or to the end of the example if no such line could be found). See section \ref cmddontinclude for an example.
\subsection cmdskip \skip ( pattern ) \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. The internal pointer that is used to keep track of the current line in the example, is set to the start of the line that contains the specified pattern (or to the end of the example if the pattern could not be found). See section \ref cmddontinclude for an example.
\subsection cmdskipline \skipline ( pattern ) \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. The internal pointer that is used to keep track of the current line in the example, is set to the start of the line following the line that is written (or to the end of the example if the pattern could not be found). \par Notice: The command: \verbatim\skipline pattern\endverbatim is equivalent to: \verbatim \skip pattern \line pattern\endverbatim See section \ref cmddontinclude for an example.
\subsection cmduntil \until ( pattern ) \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 will be written as well. The internal pointer that is used to keep track of the current line in the example, is set to the start of the line following last written line (or to the end of the example if the pattern could not be found). See section \ref cmddontinclude for an example.
\subsection cmdverbinclude \verbinclude \addindex \verbinclude This command includes the file \ verbatim in the documentation. The command is equivalent to pasting the file in the documentation and placing \\verbatim and \\endverbatim commands around it.

\htmlonly
--- \endhtmlonly Commands for visual enhancements \htmlonly ---
\endhtmlonly

\subsection cmda \a \addindex \a Displays the argument \ using a special font. Use this command to refer to member arguments in the running text. \par Example: \verbatim ... the \a x and \y coordinates are used to ... \endverbatim This will result in the following text:

... the \a x and \a y coordinates are used to ...
\subsection cmdarg \arg { item-description } \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 arguments. Each argument should start with a \\arg command. \par Example: Typing: \verbatim \arg \c AlignLeft left alignment. \arg \c AlignCenter center alignment. \arg \c AlignRight right alignment No other types of alignment are supported. \endverbatim will result in the following text:

  • \c AlignLeft left alignment.
  • \c AlignCenter center alignment.
  • \c AlignRight right alignment

No other types of alignment are supported. \par Notice: For nested lists, HTML commands should be used.
\subsection cmdb \b \addindex \b Displays the argument \ using a bold font. Equivalent to \word\.
\subsection cmdc \c \addindex \c Displays the argument \ using a typewriter font. Use this to refer to a word of code. Equivalent to \word\. \par Example: Typing: \verbatim ... This function returns \c void and not \c int ... \endverbatim will result in the following text:

... This function returns \c void and not \c int ...
\subsection cmde \e \addindex \e Displays the argument \ in italics. Use this command to emphasize words. \par Example: Typing: \verbatim ... this is a \e really good example ... \endverbatim will result in the following text:

... this is a \e really good example ...
\subsection cmdendhtmlonly \endhtmlonly \addindex \endhtmlonly Ends a block of text that was started with a \\htmlonly command. \sa section \ref cmdhtmlonly.
\subsection cmdendlatexonly \endlatexonly \addindex \endlatexonly Ends a block of text that was started with a \\latexonly command. \sa section \ref cmdlatexonly.
\subsection cmdendverbatim \endverbatim \addindex \endverbatim Ends a block of text that was started with a \\verbatim command. \sa section \ref cmdverbatim.
\subsection cmdfdollar \f$ \addindex \\f$ Marks the start and end of an in-text formula. \sa section \ref formulas for an example.
\subsection cmdfbropen \f[ \addindex \\f[ Marks the start of a long formula that is displayed centered on a separate line. \sa section \ref cmdfbrclose and section \ref formulas.
\subsection cmdfbrclose \f] \addindex \\f] Marks the end of a long formula that is displayed centered on a separate line. \sa section \ref cmdfbropen and section \ref formulas.
\subsection cmdhtmlonly \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. This command can be used to include HTML code that is too complex for Doxygen (i.e. images, applets, java-scripts, and HTML tags that require attributes). You can use the \\latexonly and \\endlatexonly pair to provide a proper \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly alternative. \b Notice: environment variables (like \$(HOME) ) are resolved inside a HTML-only block. \sa section \ref cmdhtmlonly and section \ref cmdlatexonly.
\subsection cmdlatexonly \latexonly \addindex \latexonly Starts a block of text that will be verbatim included in the generated \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly documentation only. The block ends with a endlatexonly command. This command can be used to include \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly code that is too complex for Doxygen (i.e. images, formulas, special characters). You can use the \\htmlonly and \\endhtmlonly pair to provide a proper HTML alternative. \b Notice: environment variables (like \$(HOME) ) are resolved inside a \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\endlatexonly-only block. \sa section \ref cmdlatexonly and section \ref cmdhtmlonly.
\subsection cmdverbatim \verbatim \addindex \verbatim Starts a block of text that will be verbatim included in both the HTML and the \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly documentation. The block should end with a \\endverbatim block. All commands are disabled in a verbatim block. \warning Make sure you include a \\endverbatim command for each \\verbatim command or the parser will get confused!
\subsection cmdbackslash \\ \addindex \\ This command writes a backslash character (\\) to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. The backslash has to be escaped in some cases because Doxygen uses it to detect commands.
\subsection cmdat \@ \addindex \@ This command writes an at-sign (@) to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. The at-sign has to be escaped in some cases because Doxygen uses it to detect JavaDoc commands.
\subsection cmdamp \& \addindex \& This command writes the \& character to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. This character has to be escaped because it has a special meaning in HTML.
\subsection cmddollar \$ \addindex \$ This command writes the \$ character to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. This character has to be escaped in some cases, because it is used to expand environment variables.
\subsection cmdhash \# \addindex \# This command writes the \# character to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. This character has to be escaped in some cases, because it is used to refer to documented entities.
\subsection cmdlt \\< \addindex \\< This command writes the \< character to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. This character has to be escaped because it has a special meaning in HTML.
\subsection cmdgt \\> \addindex \\> This command writes the \> character to the HTML and \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly output. This character has to be escaped because it has a special meaning in HTML.

\htmlonly
--- \endhtmlonly Commands included for JavaDoc compatibility \htmlonly ---
\endhtmlonly

The following command JavaDoc command are support. \subsection cmdjdauthor @author { list of authors } \addindex @author Equivalent to \\author (see section \ref cmdauthor). \subsection cmdjddate @date { date description } \addindex @date Equivalent to \\date (see section \ref cmddate). \subsection cmdjdparam @param { parameter-description } \addindex @param Equivalent to \\param (see section \ref cmdparam). \subsection cmdjdexception @exception { exception-description } \addindex @exception Equivalent to \\exception (see section \ref cmdexception). \subsection cmdjdreturn @return { description of the return value } \addindex @return Equivalent to \\return (see section \ref cmdreturn). \subsection cmdjdsee @see { references } \addindex @see Equivalent to \\sa (see section \ref cmdsa). \subsection cmdjdshort @short { brief description } \addindex @short Equivalent to \\brief (see section \ref cmdbrief). \subsection cmdjdversion @version { version number } \addindex @version Equivalent to \\version (see section \ref cmdversion).

\htmlonly
--- \endhtmlonly Commands included for Qt compatibility \htmlonly ---
\endhtmlonly

The following commands are supported to remain compatible to the Qt class browser generator. Do \e not use these commands in your own documentation.
  • \\annotatedclasslist
  • \\classhierarchy
  • \\define
  • \\functionindex
  • \\header
  • \\headerfilelist
  • \\ingroup
  • \\inherit
  • \\l
  • \\postheader
*/