Doxygen - Documentation

The documentation of the code will be done using the Doxygen tool, and the documentation of the tool itself will be used as a basis for structuring the comments of classes, methods and files.

Install

Run the following command to install the tool in ubuntu

sudo apt-get install doxygen

To verify the installation run

doxygen --help

Doxygen commands

Generate documentation:

doxygen sample_text.conf -u

Open documentation in browser:

xdg-open Documentation/index.html