mirror of
https://github.com/TheLartians/ModernCppStarter.git
synced 2025-10-31 10:11:34 +01:00
0f7ae8a3b7
* Use m.css for generating doxygen docs * pass CMake variables to Doxygen * Setup config for Pages section * show not explicitly documented objects * update patch comment * update comment on M_SHOW_UNDOCUMENTED Co-authored-by: Lars Melchior <TheLartians@users.noreply.github.com>
31 lines
1 KiB
Text
31 lines
1 KiB
Text
# Configuration for Doxygen for use with CMake
|
|
# Only options that deviate from the default are included
|
|
# To create a new Doxyfile containing all available options, call `doxygen -g`
|
|
|
|
# Get Project name and version from CMake
|
|
PROJECT_NAME = @DOXYGEN_PROJECT_NAME@
|
|
PROJECT_NUMBER = @DOXYGEN_PROJECT_VERSION@
|
|
|
|
# Add sources
|
|
INPUT = @DOXYGEN_PROJECT_ROOT@/README.md @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@/documentation/pages
|
|
EXTRACT_ALL = YES
|
|
RECURSIVE = YES
|
|
OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIRECTORY@
|
|
|
|
# Use the README as a main page
|
|
USE_MDFILE_AS_MAINPAGE = @DOXYGEN_PROJECT_ROOT@/README.md
|
|
|
|
# set relative include paths
|
|
FULL_PATH_NAMES = YES
|
|
STRIP_FROM_PATH = @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@
|
|
|
|
# We use m.css to generate the html documentation, so we only need XML output
|
|
GENERATE_XML = YES
|
|
GENERATE_HTML = NO
|
|
GENERATE_LATEX = NO
|
|
XML_PROGRAMLISTING = NO
|
|
CREATE_SUBDIRS = NO
|
|
|
|
# Include all directories, files and namespaces in the documentation
|
|
# Disable to include only explicitly documented objects
|
|
M_SHOW_UNDOCUMENTED = YES
|