- documenteer.stackdocs.doxygen.preprocess_package_doxygen_conf(*, conf, package)#
Preprocess a Doxygen configuration for an individual package that is based on a package’s
This function adds paths to the
STRIP_FROM_PATHconfiguration tags, and plays an equivalent role to sconsUtils to add configurations to the
doxygen.conf.intemplate for a package.
DoxygenConfiguration) – A DoxygenConfiguration for an individual package. Most likely, this configuration is based on a
doxygen.conf.infile, which has not been processed by
sconsUtils, and thus does not have INPUT configurations set.
Package) – Metadata about the package itself.
- Return type:
The only default package paths that are added to the Doxygen
INPUTconfiguration tag are:
pythondirectories are handled exclusively by Sphinx. The
srcdirectory isn’t handled because Doxygen documentation comments are written exclusively in header files per the LSST DM standard. The
examplesdirectory is also deprecated in the Sphinx regime.
The function also addes the
includedirectory of the package to the
STRIP_FROM_PATHtag so that we don’t publish build system-specific paths for header files.