run_doxygen

documenteer.stackdocs.doxygen.run_doxygen(*, conf, root_dir)

Run Doxygen.

Parameters

  • conf (DoxygenConfiguration) – A DoxygenConfiguration that configures the Doxygen build.

  • root_dir (Path) – The directory that is considered the root of the Doxygen build. This is the directory where the Doxygen configuration is written as doxygen.conf.

Returns

The shell status code returned by the doxygen executable.

Return type

status