Example Class Reference

Example class using Doxygen features. More...

#include <example.hpp>

Public Member Functions
	Example ()
	Default constructor.
	Example (const std::string &name)
	Construct with a name.
bool	setName (const std::string &name)
	Set the name.
std::string	getName () const
	Get the name.
void	addValue (int value)
	Add a value to the list.
std::vector< int >	getValues () const
	Get all values.

Static Public Member Functions
static int	add (int x, int y)
	Static utility function.

Public Attributes
Color	color
	Public member variable.

Detailed Description

Example class using Doxygen features.

This class demonstrates documentation for constructors, methods, members, and more.

Constructor & Destructor Documentation

Example() [1/2]

Example::Example

(

)

Default constructor.

Example() [2/2]

Example::Example ( const std::string & name )

explicit

Construct with a name.

Parameters

name	The name to assign.

Member Function Documentation

add()

int Example::add ( int x, int y )

static

Static utility function.

Parameters

x	First integer.
y	Second integer.

Returns

The sum of x and y.

Note

This is a static method.

addValue()

void Example::addValue

(

int

value

)

Add a value to the list.

Parameters

value

The value to add.

Exceptions

std::invalid_argument

if value is negative.

getName()

std::string Example::getName

(

)

const

Get the name.

Returns

The current name.

See also

setName()

getValues()

std::vector< int > Example::getValues

(

)

const

Get all values.

Returns

Vector of values.

setName()

bool Example::setName

(

const std::string &

name

)

Set the name.

Parameters

name	The new name.

Returns

True if the name was set.

See also

getName()

Member Data Documentation

color

Color Example::color

Public member variable.

---

The documentation for this class was generated from the following files:

• src/example.hpp
• src/example.cpp