OrangesDoxygen¶
This module provides functions for working with Doxygen documentation.
- oranges_create_doxygen_target¶
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.
- oranges_create_doxyfile (<outputPath>¶
- [PROJECT <projectName>]¶
- [VERSION <projectVersion>]¶
- [DESCRIPTION <briefDescription>]¶
- [INPUT_PATHS <paths...>]¶
- [FILE_PATTERNS <patterns...>]¶
- [EXCLUDE <files...>]¶
- [EXCLUDE_PATTERNS <patterns...>]¶
- [PREDEFINED_MACROS <macros...>]¶
- [EXAMPLE_PATH <paths...>]¶
- [EXAMPLE_PATTERNS <patterns...>]¶
- [LOGO <imagePath>]¶
- [IMAGE_PATH <paths...>]¶
- [OUTPUT <outDir>]¶
- [COMMAND_ALIASES <doxygenAlias...>]¶
- [EXTENSION_MAPPINGS <mapping...>]¶
- [INTERNAL_DOCS] | [INTERNAL_DOCS_VAR <variable>]¶
- [ENABLED_SECTIONS <sectionName...>]¶
- [LAYOUT_FILE <filepath>]¶
- [BIB_FILES <files...>]¶
- [LOG_FILE <filepath>]¶
- [USE_DOXYGEN_AWESOME]¶
- [HTML_EXTRA_STYLESHEETS <filepaths...>]¶
- [HTML_EXTRA_FILES <filepaths...>]¶
- [LATEX_EXTRA_STYLESHEETS <filepaths...>]¶
- [LATEX_EXTRA_FILES <filepaths...>])¶
Generates a Doxyfile, writing it to the <outputPath>
.
Options:
# TODO