oranges_create_doxygen_target¶
include (OrangesDoxygen)
View the full docs for this module
.
oranges_create_doxygen_target (<targetName> DOXYFILE <DoxyfilePath> [OUTPUT_DIR <outputDirPath>] [PROJECT <projectName>] [ALL] [NO_VERSION_DISPLAY] [NO_LATEX])
Creates a target named <targetName>
to that executes Doxygen when built.
Options:
DOXYFILE
Path to the Doxyfile to use with Doxygen. If a relative path is given, is is evaluated relative to
${PROJECT_SOURCE_DIR}
.OUTPUT_DIR
The output directory to write the documentation to. If not given, defaults to
${PROJECT_SOURCE_DIR}/doc
. If a relative path is given, it is evaluated relative to${PROJECT_SOURCE_DIR}
.PROJECT
Name of the project being documented. Defaults to
${PROJECT_NAME}
.ALL
When this flag is present, the created custom target will be added to the default “all” build.
NO_VERSION_DISPLAY
When not given, Doxygen’s version is displayed before building the documentation. Pass this flag to disable this.
NO_LATEX
When not given, pdflatex is run after running Doxygen to generate the PDF Latex documentation. Pass this flag to disable this.