Build doxygen documentation

The API documentation of the C++ source code is generated from the source code using doxygen.

Build

In order to build the API documentation, you need to install doxygen. Once installed from the root of the repository:

cd SRCC
doxygen docs/Doxyfile

This will build the documentation in the SRCC/docs/html directory.

View

Simply open the SRCC/docs/html/index.html file in your browser or consult the latest online documentation.

Dependencies

The doxygen theme used by this repository is Doxygen Awesome.