Doxygen

Guidance last updated: 19 October 2026

Doxygen is a tool for building documentation from source code containing docstrings. The generated documentation takes the form of, for example, inter-related HTML pages for C++ source code.

See the generated documentation for Doxygen’s C-style comment example for an example of the output.

Usage

After connecting to Stanage (see Establishing a SSH connection), start an interactive session:

salloc

You can load a specific version with the following command:

module load Doxygen/1.14.0-GCCcore-14.3.0
module load Doxygen/1.14.0-GCCcore-14.2.0
module load Doxygen/1.11.0-GCCcore-13.3.0
module load Doxygen/1.9.8-GCCcore-13.2.0
module load Doxygen/1.9.7-GCCcore-12.3.0
module load Doxygen/1.9.5-GCCcore-12.2.0

The module also loads the matching GCCcore runtime and libiconv dependencies.

Generate HTML documentation

This example generates documentation for C code containing docstrings. Within an interactive session, load Doxygen/1.14.0-GCCcore-14.3.0. In a new directory, save the following example as example.h:

/** @file example.h
 *  @brief Example arithmetic function.
 */

/** Adds two integers.
 *  @param a First integer.
 *  @param b Second integer.
 *  @return The sum of a and b.
 */
int add(int a, int b);

In the same directory, save the following text as Doxyfile. It configures Doxygen to generate HTML documentation without requiring LaTeX or Graphviz:

PROJECT_NAME = "Doxygen example"
INPUT = example.h
OUTPUT_DIRECTORY = docs
GENERATE_HTML = YES
GENERATE_LATEX = NO
HAVE_DOT = NO
QUIET = YES

Run Doxygen from that directory:

doxygen Doxyfile

The generated documentation starts at docs/html/index.html and includes the add function and its parameter descriptions. Download the whole docs/html directory to view it in a local web browser. For other configuration options, see the Doxygen getting-started guide.

Installation notes

Doxygen was installed using Easybuild, build details can be found in $EBROOTDOXYGEN/easybuild with a given module loaded.

Direct dependencies for latest version of Doxygen