HELP - HowToDocument
HelpExample CodeHowToDocument
Description Public Protected Private Related All Inheritance Collaboration
 Show all inherited
Methods Brief description
 Author Example of function with different author than of the containing class.
 BriefAndDescription The brief description ends at first punctuation mark (or see BriefToNewline).
 BriefCmd 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
 BriefToNewline The brief description ends at first newline
 Bug Documenting a bug.
 CppDocCommentStyle Document using multiple lines preceeded with ///.
 Deprecated Example of deprecated function.
 ExampleInclude How to include an example.
 ExampleInline How to write an example (ie not including from file).
 ExceptionsThrown Documenting exceptions thrown by a function.
 IncludeDocFromBody Include documentation from function body.
 InlineFormattedCode How to inline formatted code in the documentation.
 Internal Making internal documentation.
 Note Making notes to the reader of the documentation.
 OrgDoxygenDocComment Using original doxygen style doc-comments.
 ParameterDocCombined<> Combining the ways to doc parameters for the template.
 Parameters Parameter documentation - normal style in CPP file.
 ParametersJavaStyle Parameter documentation - JavaDoc style.
 ParametersTemplates<> Template parameter documentation.
 Remark Making remarks to the reader of the documentation.
 ReturnValue Documenting return values.
 SeeAlso Making "See Also" sections.
 Since Information on when this entity was added to the API.
 Todo Making todo's (internal use mainly).
 Version Designating a version.
 Warning Making warning sections.
Types  
 eAnonEnumVal1 eAnonEnumVal1 anonymous enum value description.
 eAnonEnumVal2 eAnonEnumVal2 anonymous enum value description.
 eAnonEnumVal3 eAnonEnumVal3 anonymous enum value description
 Enum Enumeration documentation.