Unlike most other documentation systems, doxygen also allows you to put the documentation of members (including global functions) in front of the definition. * a normal member taking two arguments and returning an integer value. * A more elaborate description of the destructor. * A more elaborate description of the constructor. If you enable this option and want to put a dot in the middle of a sentence without ending it, you should put a backslash and a space after it. To enable this behaviour you should set JAVADOC_AUTOBRIEF to YES in the configuration file. 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.
A more elaborate description of the constructor.Ī more elaborate description of the destructor.
0 kommentar(er)
