Breathe

Breathe is an extension for Sphinx that reads Doxygen XML, which is generated from source code comments, and makes it possible to use the contents of the XML inside regular RST files.

As an example the API documentation of file derived.hpp can be seen below.

Enums

enum class_type

Defines some known class types.

Values:

INTERFACE

Has no implementation.

ABSTRACT

Has some implementation.

NORMAL

Has only implementation.

Functions

std::string class_types_to_string(class_type t)

Convert class_type to a string representation.

Return

The string variant.

Parameters

• t: The type to translate.

struct range

#include <derived.hpp>

struct containing a min and a max.

Public Members

std::uint8_t min

The minimum value.

std::uint8_t max

The maximum value.

class derived : public base

#include <derived.hpp>

Class that derives from an abstract base.

Public Functions

derived()

Default constructor.

~derived()

derived(const derived &d)

Default copy constructor.

Parameters

• d:

derived(derived &&d)

Default move constructor.

Parameters

• d:

derived &operator=(const derived &d)

Default copy assignment operator.

Return

Parameters

• d:

derived &operator=(derived &&d)

Default move assignment operator.

Return

Parameters

• d:

void init()

Implemented function.