doxygengroup Directive Example¶

The doxygengroup directive renders the contents of the doxygen group as well as the group name and any documentation for the group itself.

Example¶

This should work:

.. doxygengroup:: mygroup
   :project: group

It produces this output:

group mygroup

This is the first group.

Functions

void groupedFunction(): This function is in MyGroup.

class GroupedClassTest

#include <group.h>

first class inside of namespace

Private Functions

void function(): namespaced class function

The directive also accepts a :content-only: option which changes the output to only include the content of the group and not the group name or description. So this:

.. doxygengroup:: mygroup
   :project: group
   :content-only:

Produces this output:

void groupedFunction(): This function is in MyGroup.

class GroupedClassTest

#include <group.h>

first class inside of namespace

Private Functions

void function(): namespaced class function

Failing Example¶

This intentionally fails:

.. doxygengroup:: madeupgroup
   :project: group

It produces the following warning message:

Warning

Cannot find file “madeupgroup” in doxygen xml output for project “group” from directory: ../../examples/specific/group/xml/

Breathe v2.0.0 documentation