Skip to content

Development Environment / Doxygen

Doxygen is a software tool for generating documentation from code comments. This minimizes the need to create code documentation outside of code. Doxygen also creates diagrams that illustrate how code modules call each other. See the following resources:

This documentation includes the following sections:


Install Doxygen

Linux

This documentation will be completed when resources are available for Linux development and testing.

Windows

Download the Doxygen Windows installer from the download page, which will have a name similar to doxygen-1.8.13-setup.exe. Run the installer as administrator and complete the following steps.

install Doxygen 1

install Doxygen 2

install Doxygen 3

install Doxygen 4

install Doxygen 5

install Doxygen 6

install Doxygen 7

install Doxygen 8

Install GraphViz

The GraphViz software is needed to create the graphs showing how code modules call each other. Use the following to download a Windows version of GraphViz:

After downloading, run the installer program as follows.

install GraphViz 1

install GraphViz 1

install GraphViz 1

Configure Doxygen Project

A Doxygen project is configured as part of the Initial Project Setup / Doxygen - do not do now since it has previously been completed and saved in the repository.