Snippets - Functions

::: doxy.<project>.function

This tag generates full function documentation.

Parameter	Description	Required
name	The name of the function.	Yes

Tag usageTag result

::: doxy.animal.function
    name: int main(int argc, char const *argv[])

function main

int main (
    int argc,
    char const * argv
) 

---

::: doxy.<project>.function error message

Tag usageTag result

::: doxy.animal.function
    name: mEin

MkDoxy Error: Incorrect function configuration

Did not find Function with name: mEin

Available functions:

int main(int argc, char const *argv[])

Snippet

::: doxy.animal.function
name: mEin
indent_level: 4

::: doxy.<project>.namespace.function

This tag generates full function documentation.

Parameter	Description	Required
namespace	The name of the amespace.	Yes
name	The name of the function.	Yes

Tag usageTag result

::: doxy.animal.namespace.function
    namespace: example
    name: void some_namespace_function(Animal* animal)

MkDoxy Error: Incorrect namespace function configuration

Did not find Namespace with name: example and function: void some_namespace_function(Animal* animal)

Available classes and methods:

 Animal(Type type, const std::string &name, Animal *mother=nullptr, Animal *father=nullptr)
 Animal(const Animal &other)=delete
 Animal(Animal &&animal) noexcept
Animal * find_child_by_name(Animal *parent)
Animal * find_parent_by_name(Animal *child)
const std::string & get_name() const
int get_num_of_eyes() const override
int get_num_of_limbs() const override
Parents get_parents() const
bool has_tail() const override
void make_sound()=0
void move()
 operator bool() const
Animal & operator=(const Animal &other)=delete
Animal & operator=(Animal &&other) noexcept
void some_inline_member_function(Animal *animal)
void swap(Animal &other) noexcept
 ~Animal()=default
int get_num_of_eyes() const =0
int get_num_of_limbs() const =0
bool has_tail() const =0
 Bird(const std::string &name, Bird *mother=nullptr, Bird *father=nullptr)
 Bird(const Bird &other)=delete
 Bird(Bird &&Bird) noexcept
void make_sound() override
void move() override
Bird & operator=(const Bird &other)=delete
Bird & operator=(Bird &&other) noexcept
void swap(Bird &other) noexcept
 ~Bird()=default
 CustomException(const std::string &msg)
const char * what() const
 NumericException(const std::string &msg)
const char * what() const
 SpecialBird(const std::string &name, SpecialBird *mother=nullptr, SpecialBird *father=nullptr)
 SpecialBird(const SpecialBird &other)=delete
 SpecialBird(SpecialBird &&SpecialBird) noexcept
void do_something_special()
SpecialBird & operator=(const SpecialBird &other)=delete
SpecialBird & operator=(SpecialBird &&other) noexcept
void swap(SpecialBird &other) noexcept
 ~SpecialBird()=default

Snippet

::: doxy.animal.namespace.function
namespace: example
name: void some_namespace_function(Animal* animal)
indent_level: 4

::: doxy.<project>.function error message

Tag usageTag result

::: doxy.animal.namespace.function
    namespace: example
    name: void no_function()

MkDoxy Error: Incorrect function configuration

Did not find Function with name: void no_function()

Available functions:

int main(int argc, char const *argv[])

Snippet

::: doxy.animal.function
namespace: example
name: void no_function()
indent_level: 4