This is not according the JavaDoc specification however, where the first sentence of the documentation block is automatically treated as a brief description. Both the brief and the detailed descriptions are optional for the Qt style.īy default a JavaDoc style documentation block behaves the same way as a Qt style documentation block. By default the brief descriptions become the first sentence of the detailed descriptions (but this can be changed by setting the REPEAT_BRIEF tag to NO). The brief descriptions are included in the member overview of a class, namespace or file and are printed using a small italic font (this description can be hidden by setting BRIEF_MEMBER_DESC to NO in the config file). The one-line comments contain a brief description, whereas the multi-line comment blocks contain a more detailed description. Virtual void testMeToo(char c1,char c2) = 0 įor the corresponding HTML documentation that is generated by doxygen. \sa Test(), ~Test(), testMeToo() and publicVar() ! A normal member taking two arguments and returning an integer value. Source and more info on the Doxygen homepage Installation or Setupĭetailed instructions on getting doxygen set up or installed.A more elaborate description of the constructor.Ī more elaborate description of the destructor. ** More detailed description inside the code */ * \retval ERR_SUCCESS The function is successfully executed * \return The error return code of the function. * \param c Description of the parameter c. * \param b Description of the parameter b. * so you do not really need to read this section. There is nothing which really needs your notice, * \note This text shall only show you, how such a \"note\" section * because this text is basically saying nothing.
* is totally senseless and you really do not need to read this, * \details This function does something which is doing nothing.
#CODEBLOCKS CODE COMPLETION DOXYGEN COMMENT 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. Since the Documentation for doxygen is new, you may need to create initial versions of those related topics. It should also mention any large subjects within doxygen, and link out to the related topics. This section provides an overview of what doxygen is, and why a developer might want to use it.
0 kommentar(er)
