doxygenenum Directive Example¶
Working Example¶
This should work:
.. doxygenenum:: NodeType
:project: tinyxml
It produces this output:
- NodeType enum
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: namespacefile
It produces this output:
- Letters enum
Values:
- A -
- 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