Example with Full Description¶

This should work:

.. doxygenstruct:: CoordStruct
   :project: restypedef

It produces this output:

struct CoordStruct

A coordinate pair.

Public Members

float x

The x coordinate

float y

The y coordinate

Example with Outline¶

This should work:

.. doxygenstruct:: CoordStruct
   :project: restypedef
   :outline:

It produces this output:

struct CoordStruct

Public Members

float x

float y

Example with Namespace¶

This should work:

.. doxygenstruct:: foo::ns::FooStruct
   :project: namespacefile

It produces this output:

struct foo::ns::FooStruct

#include <namespacefile.h>

Documentation here.

Failing Example¶

This intentionally fails:

.. doxygenstruct:: made_up_struct
   :project: restypedef

It produces the following warning message: