DocumentationExample Class Reference

This is a class for showing how to document your code using doxygen. More...

#include <DocumentationExample.h>

Public Member Functions
	DocumentationExample ()
	A constructor. A more elaborate description of the constructor. More...
	~DocumentationExample ()
	A destructor. A more elaborate description of the destructor. More...
int	ExampleCastCharToInt (int number, const char *name)
	Casts the char at position number to an int and returns it. More...
bool	TestWithin (std::string itsAString, int theInt) throw (std::out_of_range)
	Tests whether an integer is within the bounds of a string. More...

Public Attributes
int	zero
	The public definition of zero. More...

Detailed Description

This is a class for showing how to document your code using doxygen.

The more detailed description is needed for some more elaborate description. Here you can describe anything anyone might ever want to know about your class. Of especial interest might be to mention what it can be used for or what its main purpose is. If you want you can even use pictures (you might want take a look at the doxygen documentation for that).

Definition at line 21 of file DocumentationExample.h.

Constructor & Destructor Documentation

DocumentationExample()

DocumentationExample::DocumentationExample

(

)

A constructor. A more elaborate description of the constructor.

~DocumentationExample()

DocumentationExample::~DocumentationExample

(

)

A destructor. A more elaborate description of the destructor.

Member Function Documentation

ExampleCastCharToInt()

int DocumentationExample::ExampleCastCharToInt	(	int	number,
		const char *	name
	)

Casts the char at position number to an int and returns it.

This function will take an int number and a char pointer name, then will try to access the int a position number and cast it to an int and return it. No verification is done within the function to ensure, that it is a valid position.

Parameters

number	The position of the char to be cast. This should never be below 0 and not above the length of the char array.
name	A constant character pointer.

Returns

The char value of the character at position number casted to int

TestWithin()

bool DocumentationExample::TestWithin	(	std::string	itsAString,
		int	theInt
	)
throw	(	std::out_of_range
	)

Tests whether an integer is within the bounds of a string.

This will perform a check whether an int is bigger than an arbitrary zero and smaller than the length of the string.

Parameters

itsAString	The string to be checked as reference
theInt	The position to be checked for

Exceptions

std::out_of_range

parameter is out of range.

See also

zero()

Returns

True if character is in range, should never return false but throw an exception instead.

Member Data Documentation

zero

int DocumentationExample::zero

The public definition of zero.

This variable is used to determine what will be regarded as zero.

Definition at line 66 of file DocumentationExample.h.

---

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

• DocumentationExample.h