Products Support Documentation Download
Using Doxygen

Prerequisite

Make sure Doxygen (http://www.doxygen.org) and Graphviz (http://www.graphviz.org) are installed and can be found 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.

Unix

Follow the instructions as outlined in UNIX, Linux, or OS X Development Host 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

Windows

Follow the instructions as outlined in Windows Development Host for installing RDM and optionally use CMake.

Then run doxygen from the top install directory:

$ doxygen

or alternatively if you chose to use CMake:

$ make doc