API Reference

Header files

• src/animal.h
• src/animal_interface.h
• src/bird.h
• src/config.h
• src/example.h
• src/special_bird.h
• src/utils/exception.h

File src/animal.h

Namespaces

Type	Name
namespace	example
namespace	inner_namespace

Classes

Type	Name
class	Animal Base class for all animals from which Bird derives.
struct	Result Some random inner class of Animal.
class	Vector

Namespaces Documentation

namespace example

namespace example::inner_namespace

Classes Documentation

class example::Animal

Base class for all animals from which Bird derives.

Lorem Ipsum Donor. Some Random link with bold and_italics_ And the following is atypewritter font.

Example code:

Animal animal = Animal("Hello World", nullptr, nullptr);
std::cout << animal.get_name() << std::endl;

See also: Bird

Bug

Some random bug

Note:

Some random note

Warning:

Some random warning

Test

Some random test description

Todo

Some random todo

Template parameters:

• T Some random template paramater description which actually does not exist in the code!

Precondition:

First initialize the system.

Date:

2017-2018

Author:

Matus Novak

Author:

Hello World

Variables:

• Animal * father
  The pointer to the father.
  Can be null!

• Animal * mother
  The pointer to the mother.
  Can be null!

• std::string name

struct example::Animal::Result

Some random inner class of Animal.

Variables:

• const Animal * father = = nullptr

• const Animal * mother = = nullptr

• const std::string name

• const Type type = = Type::NONE

class example::inner_namespace::Vector

Variables:

• int x

• int y

• int z

File src/animal_interface.h

Namespaces

Type	Name
namespace	example

Classes

Type	Name
interface	AnimalInterface

Namespaces Documentation

namespace example

Classes Documentation

interface example::AnimalInterface

File src/bird.h

Namespaces

Type	Name
namespace	example

Classes

Type	Name
class	Bird

Namespaces Documentation

namespace example

Classes Documentation

class example::Bird

File src/config.h

This is a config file.

This is a detailed description

File src/example.h

File src/special_bird.h

Namespaces

Type	Name
namespace	example

Classes

Type	Name
class	SpecialBird

Namespaces Documentation

namespace example

Classes Documentation

class example::SpecialBird

File src/utils/exception.h

Namespaces

Type	Name
namespace	example

Classes

Type	Name
class	CustomException
class	NumericException

Namespaces Documentation

namespace example

Classes Documentation

class example::CustomException

Variables:

• std::string msg

class example::NumericException

Variables:

• std::string msg