doxygenfunction Directive Example¶
Working Example¶
This should work:
.. doxygenfunction:: open
:project: structcmd
It produces this output:
- int open(const char * pathname, int flags)
Opens a file descriptor.
Detailed description.
- Parameters
- pathname -
The name of the descriptor.
- flags -
Opening flags.
- pathname -
Failing Example¶
This intentionally fails:
.. doxygenfunction:: made_up_function
:project: structcmd
It produces the following warning message:
Warning
doxygenfunction: Cannot find function “made_up_function” in doxygen xml output