Snippets - Functions¶
::: doxy.<project>.function
¶
This tag generates full function documentation.
Parameter | Description | Required |
---|---|---|
name |
The name of the function. | Yes |
::: 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¶
::: 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