mirror of
https://github.com/TheLartians/ModernCppStarter.git
synced 2025-09-01 06:30:52 +02:00
update comment on M_SHOW_UNDOCUMENTED
This commit is contained in:
parent
910b077214
commit
6665c5d5c1
1 changed files with 5 additions and 4 deletions
|
@ -12,13 +12,13 @@ EXTRACT_ALL = YES
|
||||||
RECURSIVE = YES
|
RECURSIVE = YES
|
||||||
OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIRECTORY@
|
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
|
# set relative include paths
|
||||||
FULL_PATH_NAMES = YES
|
FULL_PATH_NAMES = YES
|
||||||
STRIP_FROM_PATH = @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@
|
STRIP_FROM_PATH = @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@
|
||||||
|
|
||||||
# Use the README as a main page
|
|
||||||
USE_MDFILE_AS_MAINPAGE = @DOXYGEN_PROJECT_ROOT@/README.md
|
|
||||||
|
|
||||||
# We use m.css to generate the html documentation, so we only need XML output
|
# We use m.css to generate the html documentation, so we only need XML output
|
||||||
GENERATE_XML = YES
|
GENERATE_XML = YES
|
||||||
GENERATE_HTML = NO
|
GENERATE_HTML = NO
|
||||||
|
@ -26,5 +26,6 @@ GENERATE_LATEX = NO
|
||||||
XML_PROGRAMLISTING = NO
|
XML_PROGRAMLISTING = NO
|
||||||
CREATE_SUBDIRS = NO
|
CREATE_SUBDIRS = NO
|
||||||
|
|
||||||
# without this option m.css will hide all files, namespaces etc. without explicit documentation
|
# Include all directories, files and namespaces in the documentation
|
||||||
|
# Disable to include only explicitly documented objects
|
||||||
M_SHOW_UNDOCUMENTED = YES
|
M_SHOW_UNDOCUMENTED = YES
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue