Typedef Examples¶

class TypeDefTest

file typedef.h

Typedefs

typedef TypeDefTest (* TypeDefTestFuncPtr)(void)

typedef void *(* voidFuncPtr)(float, int)

typedef void * voidPointer

typedef float * floatPointer

typedef float floatingPointNumber

Namespaced Function Examples¶

void function()

namespaced class function

void function()

second namespaced class function

void anotherFunction()

second namespaced class other function

void function()

non-namespaced class function

void anotherFunction()

non-namespaced class other function

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 g(int, int)

Another function which takes two int arguments.

void 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)

Another function which takes another custom type.

void h(std::string, int)

Another function which takes a basic type.

Program Listing¶

class Vector

Vector class

Vector center()

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:

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