An animal group example

This is a brief description to the animals group. More...

Collaboration diagram for An animal group example:

Directories
directory	src
	This is a directory.
directory	utils
	This is a directory.

Files
file	config.h
	This is a config file.

Classes
class	example::Animal
	Base class for all animals from which Bird derives. More...
class	example::Bird
class	example::SpecialBird
class	example::CustomException
class	example::NumericException
interface	example::AnimalInterface

Macros
#define	CONFIG_HELLO   (123)
#define	CONFIG_WORLD   ("abx")
#define	PI   3.14159265358979323846
#define	PRINT_PRETTY(MSG, ...)   printf(MSG, __VA_ARGS__)

Enumerations
enum	example::Animal::Type {   example::Animal::NONE = 0, example::Animal::INSECT = 1, example::Animal::AMPHIBIAN = 2, example::Animal::BIRD = 3,   example::Animal::FISH = 4, example::Animal::REPTILE = 5, example::Animal::MAMMAL = 6 }
	The 6 classes of animal kingdom. More...

Functions
void	example::some_namespace_function (Animal *animal)
	Some random namespace function that modifies Animal. More...
void	some_global_function (example::Animal *animal)
	Some random global function that modifies Animal. More...

Detailed Description

This is a brief description to the animals group.

Some inner namespace.

Some random brief description.

Some detailed description here

Macro Definition Documentation

CONFIG_HELLO

#define CONFIG_HELLO   (123)

CONFIG_WORLD

#define CONFIG_WORLD   ("abx")

PI

#define PI   3.14159265358979323846

PRINT_PRETTY

#define PRINT_PRETTY	(		MSG,
			...
	)		printf(MSG, __VA_ARGS__)

Enumeration Type Documentation

Type

enum example::Animal::Type

The 6 classes of animal kingdom.

Lorem Ipsum Donor.

Enumerator
NONE
INSECT
AMPHIBIAN
BIRD
FISH
REPTILE
MAMMAL

Function Documentation

some_global_function()

void some_global_function

(

example::Animal *

animal

)

Some random global function that modifies Animal.

See also

Animal

Parameters

animal

The pointer to the animal instance

some_namespace_function()

void example::some_namespace_function

(

Animal *

animal

)

Some random namespace function that modifies Animal.

See also

Animal

Parameters

animal

The pointer to the animal instance