Methods | Brief description |
![]() |
Example of function with different author than of the containing class. |
![]() |
The brief description ends at first punctuation mark (or see BriefToNewline). |
![]() |
This is a brief description which spans several lines of text. It continues until a blank line or until a new section command is encountered |
![]() |
The brief description ends at first newline |
![]() |
Documenting a bug. |
![]() |
Document using multiple lines preceeded with ///. |
![]() |
Example of deprecated function. |
![]() |
How to include an example. |
![]() |
How to write an example (ie not including from file). |
![]() |
Documenting exceptions thrown by a function. |
![]() |
Include documentation from function body. |
![]() |
How to inline formatted code in the documentation. |
![]() |
Making internal documentation. |
![]() |
Making notes to the reader of the documentation. |
![]() |
Using original doxygen style doc-comments. |
![]() |
Combining the ways to doc parameters for the template. |
![]() |
Parameter documentation - normal style in CPP file. |
![]() |
Parameter documentation - JavaDoc style. |
![]() |
Template parameter documentation. |
![]() |
Making remarks to the reader of the documentation. |
![]() |
Documenting return values. |
![]() |
Making "See Also" sections. |
![]() |
Making todo's (internal use mainly). |
![]() |
Designating a version. |
![]() |
Making warning sections. |
Types | |
![]() |
eAnonEnumVal1 anonymous enum value description. |
![]() |
eAnonEnumVal2 anonymous enum value description. |
![]() |
eAnonEnumVal3 anonymous enum value description |
![]() |
Enumeration documentation. |