Doxygen

Prerequisite

Make sure doxygen (http://www.doxygen.org) and Graphviz (http://www.graphviz.org) are installed and can be located through the PATH environment variable.

Introduction

Some of our source code has doxygen markup. Documentation using this and the source code with call graphs embedded in for each function can be generated using doxygen. Make sure you have all the prerequisite installed. Without Graphviz, no call graphs will be included.

Follow the instructions as outlined in Installation Guide for installing and configuring (or alternatively using CMake) RDM. Then run doxygen from the top build directory:

$ doxygen

or alternatively if you chose to use CMake:

$ make doc

or alternatively if you chose to use CMake:

C:\> make doc