* is totally senseless and you really do not need to read this, * \details This function does something which is doing nothing.
Doxygen comment after member full#
Details followĪnd finally here an example for a full documentation of a function with doxygen: /** / Brief description which ends at this dot.
If JAVADOC_AUTOBRIEF is set to YES in the configuration file, then using JavaDoc style comment blocks will automatically start a brief description which ends at the first dot followed by a space or new line. This command ends at the end of a paragraph, so the detailed description follows after an empty line. One could use the \brief command with one of the above comment blocks. * A brief description in one short sentence.įor the brief description there are also several possibilities: * \brief A brief description in one short sentence. All commands in the documentation start with a backslash () or an at-sign example /** To structure and fomat the generated documentation, Doxygen provides a large number (> 170) of special commands. Note the 2 slashes to end the normal comment block and start a special comment block. Some people like to make their comment blocks more visible in the documentation. The next alternative is to use the Qt style and add an exclamation mark (!) after the opening sequence of a C-style comment block: /*!Ī third alternative is to use a block of at least two C++ comment lines, where each line starts with an additional slash or an exclamation mark: /// The first and most common one are C style comments with an extra asterisk in the comment start sequence, e.g.: /** There are several ways to mark a comment block as a detailed description, so that this comment block is parsed by Doxygen and added as a description of the following code item to the documentation.
0 kommentar(er)
