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
|
Groups
======
.. cpp:namespace:: @ex_groups
Breathe has basic support for the grouping functionality that Doxygen provides.
Using the example from the Doxygen docs:
.. literalinclude:: code/groups.h
:language: cpp
If we reference this with a directive, for example:
.. code-block:: rst
.. doxygenclass:: UserDefinedGroupTest
:project: userdefined
:members:
:protected-members:
It renders as:
.. doxygenclass:: UserDefinedGroupTest
:project: userdefined
:members:
:protected-members:
.. note::
Any groups which are not named in the original source code will appear as
**Unnamed Group** in the final output. This is different to Doxygen which
will number the groups and so name them as Group1, Group2, Group3, etc.
|