File: groups.rst

package info (click to toggle)
breathe 4.36.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,224 kB
  • sloc: python: 12,703; cpp: 1,737; makefile: 523; xml: 168; sh: 54; ansic: 52
file content (35 lines) | stat: -rw-r--r-- 768 bytes parent folder | download | duplicates (4)
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.