HELP - Enum
HelpExample CodeHowToDocumentEnum
Description Source Call Graph
HowToDocument::Enum ( Public Enumeration )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
Enumeration documentation.
 
Enummeration Values Table
Enummeration Values Description
 eEnumVal1 eEnumVal1 enum value description.
 eEnumVal2 eEnumVal2 enum value description.
 eEnumVal3 eEnumVal3 enum value description
Description
Enumeration documentation. This must usually be done in the header file. The enumeration will appear on the overview list ("Public", "Protected, "Private tabs ) for classes, on directory "Globals" (if not part of a class) etc. The individual enum values, are shown in a table on the doc-page for the enumeration as is shown above.

Anonymous enumerations
Anonymous enumerations are not shown on any of the above lists. However the enum values are instead shown on all of these lists. This is quite useful if for instance one uses anonymous enum values as integer constants in classes.

This is how it looks in the source:
/** 
Enumeration documentation. This must usually be done in the header file.
enum Enum      { eEnumVal1,    ///< eEnumVal1 enum #value# description.
                 eEnumVal2,    ///< eEnumVal2 enum #value# description.
                 eEnumVal3     ///< eEnumVal3 enum #value# description
};
*/



 
Source
The documentation for this Member was generated from the following file:
  • HowtoDocument.h