Skip to content

API Reference

Header files

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.
class Animal
Base class for all animals from which Bird derives.
struct Result
Some random inner class of Animal.
class Vector

Types

Type Name
enum Type
The 6 classes of animal kingdom.

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.

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

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

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.

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

File src/animal_interface.h

Namespaces

Type Name
namespace example

Classes

Type Name
interface AnimalInterface
interface AnimalInterface

Namespaces Documentation

namespace example

Classes Documentation

interface example::AnimalInterface

interface example::AnimalInterface

File src/bird.h

Namespaces

Type Name
namespace example

Classes

Type Name
class Bird
class Bird

Namespaces Documentation

namespace example

Classes Documentation

class example::Bird

class example::Bird

File src/config.h

This is a config file.

This is a detailed description

Macros

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

Macros 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__)

File src/example.h

File src/special_bird.h

Namespaces

Type Name
namespace example

Classes

Type Name
class SpecialBird
class SpecialBird

Namespaces Documentation

namespace example

Classes Documentation

class example::SpecialBird

class example::SpecialBird

File src/utils/exception.h

Namespaces

Type Name
namespace example

Classes

Type Name
class CustomException
class CustomException
class NumericException
class NumericException

Namespaces Documentation

namespace example

Classes Documentation

class example::CustomException

Variables:

  • std::string msg

class example::CustomException

Variables:

  • std::string msg

class example::NumericException

Variables:

  • std::string msg

class example::NumericException

Variables:

  • std::string msg