doxygenenum Directive Example¶
Working Example¶
This should work:
.. doxygenenum:: NodeType
:project: tinyxml
It produces this output:
-
enum
TiXmlNode::
NodeType
The types of XML nodes supported by TinyXml.
(All the unsupported types are picked up by UNKNOWN.)
Values:
-
DOCUMENT
-
ELEMENT
-
COMMENT
-
UNKNOWN
-
TEXT
-
DECLARATION
-
TYPECOUNT
-
Example with Namespace¶
This should work:
.. doxygenenum:: foo::ns::Letters
:project: namespace
It produces this output:
-
enum
foo::ns::
Letters
Values:
-
A
A documented enumeration constant.
-
B
-
C
-
Failing Example¶
This intentionally fails:
.. doxygenenum:: made_up_enum
:project: restypedef
It produces the following warning message:
Warning
doxygenenum: Cannot find enum “made_up_enum” in doxygen xml output