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
|
.. _enumvalue-example:
doxygenenumvalue Directive Example
==================================
Working Example
---------------
.. cpp:namespace:: @ex_enumvalue_example
This should work:
.. code-block:: rst
.. doxygenenumvalue:: TIXML_NO_ERROR
:project: tinyxml
It produces this output:
.. doxygenenumvalue:: TIXML_NO_ERROR
:project: tinyxml
Example with Namespace
----------------------
.. cpp:namespace:: @ex_enumvalue_namespace
This should work:
.. code-block:: rst
.. doxygenenumvalue:: foo::ns::A
:project: namespace
It produces this output:
.. doxygenenumvalue:: foo::ns::A
:project: namespace
Failing Example
---------------
.. cpp:namespace:: @ex_enumvalue_failing
This intentionally fails:
.. code-block:: rst
.. doxygenenumvalue:: made_up_enumvalue
:project: restypedef
It produces the following warning message:
.. warning::
doxygenenumvalue: Cannot find enumvalue "made_up_enumvalue" in doxygen xml output
|