Breathe 'latest' documentation

Specific Examples Test Suite

«  TinyXML Test Suite   ::   Contents   ::   Embedded ReStructuredText  »

Specific Examples Test Suite

Typedef Examples

class TestClass

Public Types

typedef void* MemberTypedef

A typedef defined in a class.

class TypeDefTest
namespace testnamespace

Typedefs

typedef char* AnotherTypedef
file typedef.h

Typedefs

typedef TypeDefTest(* TypeDefTestFuncPtr)(void)
typedef void*(* voidFuncPtr)(float, int)
typedef void* voidPointer
typedef float* floatPointer
typedef float floatingPointNumber
typedef int TestTypedef

Namespaced Function Examples

virtual void testnamespace::NamespacedClassTest::function() const = 0

namespaced class function

void testnamespace::ClassTest::function()

second namespaced class function

void testnamespace::ClassTest::anotherFunction()

second namespaced class other function

void ClassTest::function(int myParameter)

non-namespaced class function

More details in the header file.

More documentation in the impl file

void ClassTest::anotherFunction()

non-namespaced class other function

More documentation in the impl file

Alias Example

void frob_foos(void * Frobs)

Foo frob routine.

bob this something else
Side Effects
Frobs any foos.
Return
Frobs any foos.
bob this something else
Side Effects
Frobs any foos.
Parameters
  • Frobs -

    any foos.

Fixed Width Font

class Out

Public Functions

Out()

Constructor for Out object

~Out()

Destructor for Out object

Function Overloads

void f(int, int)

Function which takes two int arguments.

void f(double, double)

Function which takes two double arguments.

void test::g(int, int)

Another function which takes two int arguments.

void test::g(double, double)

Another function which takes two double arguments.

void h(std::string, MyType)

Another function which takes a custom type.

void h(std::string, MyOtherType o)

Another function which takes another custom type.

void h(std::string, const int myint)

Another function which takes a const basic type.

template <typename T, typename U>
void h(std::string, const T m, const U n)

Another function which takes a const basic type.

Program Listing

class Vector

Vector class

Vector center() const

The center of the InteractionBox in device coordinates (millimeters). This point is equidistant from all sides of the box.

Vector boxCenter = interactionBox.center();
Vector max = interactionBox.max();
Vector diff = max - boxCenter;

Return
The InteractionBox center in device coordinates.
Since
1.0

Image

class ImageClass

This is a class with an image in the description.

It renders like this:

_images/imageExample.png

Breathe & Sphinx should automatically copy the image from the doxygen output directory into the _images folder of the Sphinx output.

Array Parameter

int foo(int a)

My function.

int bar(int n, int a)

My other function.

«  TinyXML Test Suite   ::   Contents   ::   Embedded ReStructuredText  »