Note 1: You are responsible that there is indeed an earlier documented member that is overloaded by this one. 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.Īny other documentation that is inside the documentation block will by appended after the generated message. It differs from the above function only in what argument(s) it accepts.' `This is an overloaded member function, provided for convenience. This command can be used to generate the following standard text for an overloaded member function: 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/. This command can be put in the documentation of a class. Indicates that a comment block contains documentation for a namespace with name. See section Member Groups for an example. block containing the members of the group. The comment block should be followed by a. This command turns a comment block into a header definition of a member group. See also: section \section, section \subsection and section \page. You can refer to the main page using \ref index (if the treeview is disabled, otherwise you should use \ref main). * \subsection step1 Step 1: Opening the box If you do not want any title you can specify notitle as the argument of \mainpage. The title argument is optional and replaces the default title that doxygen normally generates. If the \mainpage command is placed in a comment block the block is used to customize the index page (in HTML) or the first chapter (in ). You can use INTERNAL_DOCS in the config file to show or hide the internal documentation. Only a new section at the same level will be visible again. If the \internal command is put inside a section (see for example \section) all subsection after the command are considered to be internal as well. This command writes the message `For internal use only' to the output and all text after an \internal command until the end of the comment block or the end of the section (whichever comes first) is marked as "internal". The arguments are equal to the \class command.
Indicates that a comment block contains documentation for an interface with name. See also: page Grouping, sections \defgroup, \addtogroup and \weakgroup 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. By putting this command in a comment block of a define or variable, the initializer is always hidden. * \exception std::out_of_range parameter is out of range.įor the corresponding HTML documentation that is generated by doxygen.īy default the value of a define and the initializer of a variable are displayed unless they are longer than 30 lines. *! \fn const char *Test::member(char c,int n) If (round) braces are used the argument extends until the end of the line on which the command was found.
If braces are used the argument is a single word. Some commands have one or more arguments. Doxygen manual: Special Commands Special CommandsĪll commands in the documentation start with a backslash ( \) or an at-sign ( If you prefer you can replace all commands starting with a backslash below, by their counterparts that start with an at-sign.
0 kommentar(er)
