How to use Doxygen to generate documentation for our code
This How To introduces the Doxygen documentation system and gives some guidelines to use it to document Kratos code
What is Doxygen?
Doxygen is system that can be used to produce documentation for our code. It reads our source code looking for comments that follow a special format, and uses that information to generate our documentation.
To document our work, all that is required is to follow some basic guidelines while writing our code. Every time we release a new Kratos version, we will run Doxygen using our code and post the result in our Doxygen Documentation page. An alternate possibility is to run Doxygen periodically on the svn source and upload the result.
Basic instructions to document C++ code
Class documentation: Short description and long description
Other useful commands
Grouping into modules
The todo list
Documenting Kratos classes
Using the header templates
What to document?
Our aim for Kratos would be, at least, having a complete documentation for all classes and public methods. An important detail is ensuring