Embedded ReStructuredText¶

class TestClass¶

#include <rst.h>

first class inside of namespace

Public Functions

virtual void function() const = 0¶

Inserting additional reStructuredText information.

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

This is just a standard verbatim block with code:

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

Note

This reStructuredText has been handled correctly.

virtual void rawVerbatim() const = 0¶

Inserting additional reStructuredText information.

Note

This reStructuredText has been handled correctly.

virtual void rawLeadingAsteriskVerbatim() const = 0¶

Inserting additional reStructuredText information.

Some example code:

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

virtual void rawLeadingSlashesVerbatim(int something) const = 0¶

Some kind of method

@param something a parameter
@returns the same value provided in something param

@verbatim embed:rst:leading-slashes

/// .. code-block:: c /// :linenos: /// /// bool foo(bool something) { /// return something; /// }; /// ///

virtual void rawInlineVerbatim() const = 0¶: Inserting an inline reStructuredText snippet. Linking to another function: TestClass::rawVerbatim()