doxygenunion Directive Example

Working Example

This should work:

.. doxygenunion:: SeparateUnion
   :project: union

It produces this output:

union SeparateUnion

#include <union.h>

A union of two values.

Public Members

int size

The size of the thing.

float depth

How deep it is.

Example with Namespace

This should work:

.. doxygenunion:: foo::MyUnion
   :project: union

It produces this output:

union foo::MyUnion

#include <union.h>

A union of two values.

Public Members

int someInt

The int of it all.

float someFloat

The float side of things.

Failing Example

This intentionally fails:

.. doxygenunion:: made_up_union
   :project: union

It produces the following warning message:

Warning

doxygenunion: Cannot find union “made_up_union” in doxygen XML output for project “union” from directory: ../../examples/specific/union/xml/