API documentation

API documentation

The RIOTNerf project features an API documentation that can be generated using doxygen.

Installing doxygen

To install doxygen use

sudo apt-get install doxygen-gui

Launching doxygen

To launch doxygen you can simply use

doxywizard

as the application should be on your path after successful installation.

Generating the API documentation

To generate the API documentation lauch doxygen as shown above. You may use the Doxyfile distributed in this repository. Change any settings you want, set the output directory for the documentation and start generating it. This process may take some time.

Using the API documentation

To use the HTML documentation open the index.html file.