Documentation

Documentation is of paramount importance for users, developers, testers, software architects and students. We use Doxygen, a tool for writing software reference documentation. The documentation is written within the C++ code, in form of comments, and is thus relatively easy to generate (since it can be written along with the source code) and keep up to date. Doxygen scans the code, extracts the documentation and dumps it in HTML, LATEX, RTF or XML formats, cross-referencing documentation and code, so that the reader of a document can easily refer to the actual code. It also automatically generates dependency graphs, inheritance diagrams, and collaboration diagrams.

See the building guide for instructions about of to generate documentation with Doxygen.