Group animals

Modules > animals

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

Files

Type	Name
file	config.h This is a config file.

Classes

Type	Name
struct	BirdOrRodent
class	example::Animal Base class for all animals from which Bird derives.
interface	example::AnimalInterface
class	example::Bird
class	example::CustomException
class	example::NumericException
class	example::SpecialBird

Public Types

Type	Name
enum	Type The 6 classes of animal kingdom.

Public Functions

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

Macros

Type	Name
define	CONFIG_HELLO (123)
define	CONFIG_WORLD ("abx")
define	PI 3.14159265358979323846
define	PRINT_PRETTY (MSG, ...) printf(MSG, \_\_VA\_ARGS\_\_)

Detailed Description

Some inner namespace.

Some random brief description.

Some detailed description here

Public Types Documentation

enum Type

The 6 classes of animal kingdom.

enum Type {
    NONE = 0,
    INSECT = 1,
    AMPHIBIAN = 2,
    BIRD = 3,
    FISH = 4,
    REPTILE = 5,
    MAMMAL = 6
};

Lorem Ipsum Donor.

---

Public Functions Documentation

function some_global_function

Some random global function that modifies Animal.

void some_global_function (
    example::Animal * animal
) 

See also: Animal

Parameters:

• animal The pointer to the animal instance

---

function some_namespace_function

Some random namespace function that modifies Animal .

void some_namespace_function (
    Animal * animal
) 

See also: Animal

Parameters:

• animal The pointer to the animal instance

---

Macro Definition Documentation

define CONFIG_HELLO

#define CONFIG_HELLO `(123)`

---

define CONFIG_WORLD

#define CONFIG_WORLD `("abx")`

---

define PI

#define PI `3.14159265358979323846`

---

define PRINT_PRETTY

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

---

---