QOF
0.7.5
|
All declarations for:
This will enable doxygen to link all parameter types to the declarations every time the type is used in a function - very helpful to new developers.
If your declarations are in separate files, like private header files, a simple block can still be linked into doxygen as long as the file is identified to doxygen using a '\file' section:
\file filename.h
\brief one-liner summary of the file purpose
\author the usual copyright statement
Every doxygen comment block starts with an adapted comment marker. You can use an extra slash /// or an extra asterisk. Blocks end in the usual way. Doxygen accepts commands using a backslash.
To put a description with each function or structure, use '\brief' End the brief description with a blank line. The rest of the documentation will then be shown in the body of the doxygen page.
Commands may begin with \ or @
-# Start a line with a hyphen to start a list - the indent determines the
nesting of the list:
End the list with a blank line. Use :: at the start of a function or structure to link to the page for that function in the doxygen documentation. e.g. qof_class_foreach
Use the param command to describe function parameters in the text.
Use the 'back reference' to document enumerator values:
enum testenum {
enum_one **< less than marker tells doxygen to use this line to document enum_one.
To edit the doxygen configuration, you can use:
cd src/doc
doxywizard doxygen.cfg &