preprocess_package_doxygen_conf#

documenteer.stackdocs.doxygen.preprocess_package_doxygen_conf(*, conf, package)#

Preprocess a Doxygen configuration for an individual package that is based on a package’s doxygen.conf.in file.

This function adds paths to the INPUT and STRIP_FROM_PATH configuration tags, and plays an equivalent role to sconsUtils to add configurations to the doxygen.conf.in template for a package.

Parameters:

  • conf (DoxygenConfiguration) – A DoxygenConfiguration for an individual package. Most likely, this configuration is based on a doxygen.conf.in file, which has not been processed by sconsUtils, and thus does not have INPUT configurations set.

  • package (Package) – Metadata about the package itself.

Return type:

None

Notes

The only default package paths that are added to the Doxygen INPUT configuration tag are:

  • include

The doc and python directories are handled exclusively by Sphinx. The src directory isn’t handled because Doxygen documentation comments are written exclusively in header files per the LSST DM standard. The examples directory is also deprecated in the Sphinx regime.

The function also addes the include directory of the package to the STRIP_FROM_PATH tag so that we don’t publish build system-specific paths for header files.