From 6665c5d5c1a99c414e26dd481ccc2a42217ede55 Mon Sep 17 00:00:00 2001 From: Lars Melchior Date: Wed, 29 Jul 2020 12:40:42 +0200 Subject: [PATCH] update comment on M_SHOW_UNDOCUMENTED --- documentation/Doxyfile | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/documentation/Doxyfile b/documentation/Doxyfile index 6313209..2c33e00 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -12,13 +12,13 @@ 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@ -# 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 GENERATE_XML = YES GENERATE_HTML = NO @@ -26,5 +26,6 @@ GENERATE_LATEX = NO XML_PROGRAMLISTING = 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