DuneDoxygen¶
Support for building module documentation with Doxygen.
- add_doxygen_target¶
Create a Doxygen build target for the current module.
add_doxygen_target( [TARGET <target-suffix>] [DEPENDS <files>...] [OUTPUT <path>] )
TARGETSuffix of the generated build target. The default is the current module name.
DEPENDSAdditional dependencies of the generated Doxygen build step, for example a manually maintained
mainpage.txtfile.OUTPUTOutput path produced by the Doxygen run. The default is the generated
htmldirectory in the current binary directory.
This command creates a module-specific
doxygen_<target>target and adds it as a dependency of the top-leveldoxygenanddoctargets. During installation, the generated Doxygen output is copied into${CMAKE_INSTALL_DOCDIR}/doxygen.
- DUNE_MATHJAX_DISABLE_LOCAL¶
If set to
TRUE, local MathJax discovery is disabled and Doxygen will not use an installed MathJax2 copy from the system.
- DUNE_MATHJAX_DISABLE_CDN¶
If set to
TRUE, MathJax will not be loaded from the content delivery network when no local MathJax2 installation is available.