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:

void some_global_function(example::Animal *animal)
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)

function some_namespace_function

Some random namespace function that modifies Animal .

void example::some_namespace_function (
    Animal * animal
) 

See also: Animal

Parameters:

• animal The pointer to the animal instance

---

::: 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:

void some_global_function(example::Animal *animal)
int main(int argc, char const *argv[])

Snippet

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