Documenting the code

We are using Doxygen as documentation system.

You can check it at its webpage Doxygen page

Install Doxygen on your system an check the version with the flag --version.

doxygen --version

Doxygen uses a Doxyfile file to configure the documentation system, this file (Doxyfile) is already on the original files. So you don't need to create it, but you can modify it.

Doxigen is configured to use dot, a graphics creation tool, so make sure you have it installed on your system.

dot is part of the graphivz package.

Graphviz page project

Check dot version with:

git -V

The style of the comments will be defined in this page. Please review the manual to know your options on documenting the code.

Download manual