Breathe v2.0.0 documentation

Embedded ReStructuredText

«  Specific Examples Test Suite   ::   Contents   ::   Inline Parameter Documentation  »

Embedded ReStructuredText

class TestClass
#include <rst.h>

first class inside of namespace

Public Functions
void function()

Inserting additional reStructuredText information.

This is some funky non-XML compliant text: <& !><

Note

This reStructuredText has been handled correctly.

This is just a standard verbatim block with code:

    child = 0;
    while( child = parent->IterateChildren( child ) )

void rawVerbatim()

Inserting additional reStructuredText information.

Note

This reStructuredText has been handled correctly.

void rawLeadingAsteriskVerbatim()

Inserting additional reStructuredText information.

Some example code:

int example(int x) {
    return x * 2;
}

void testFunction()

Brief description.

file rst.h

«  Specific Examples Test Suite   ::   Contents   ::   Inline Parameter Documentation  »