Embedded ReStructuredText¶

class TestClass¶

#include <rst.h>

first class inside of namespace

Public Functions

void function() const = 0¶

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() const = 0¶

Inserting additional reStructuredText information.

Note

This reStructuredText has been handled correctly.

void rawLeadingAsteriskVerbatim() const = 0¶

Inserting additional reStructuredText information.

Some example code:

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

void rawLeadingSlashesVerbatim(int something) const = 0¶

Some kind of method.

bool foo(bool something) {
    return something;
};

Return

the same value provided in something param

Parameters