1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
.. _enum-example:
doxygenenum Directive Example
===============================
Working Example
---------------
.. cpp:namespace:: @ex_enum_example
This should work:
.. code-block:: rst
.. doxygenenum:: NodeType
:project: tinyxml
It produces this output:
.. doxygenenum:: NodeType
:project: tinyxml
Example with Namespace
----------------------
.. cpp:namespace:: @ex_enum_namespace
This should work:
.. code-block:: rst
.. doxygenenum:: foo::ns::Letters
:project: namespace
It produces this output:
.. doxygenenum:: foo::ns::Letters
:project: namespace
Failing Example
---------------
.. cpp:namespace:: @ex_enum_failing
This intentionally fails:
.. code-block:: rst
.. doxygenenum:: made_up_enum
:project: restypedef
It produces the following warning message:
.. warning::
doxygenenum: Cannot find enum "made_up_enum" in doxygen xml output
|
