From 7e91a4a4cee88c523d6bccfa1a8397f0eb50a3fb Mon Sep 17 00:00:00 2001 From: nekobit Date: Fri, 21 Oct 2022 04:28:51 +0000 Subject: [PATCH] Doxygen options FossilOrigin-Name: a46a179a7888b6a75456da427c1c46daf4b837814accc9c950b05fffa27a0253 --- Doxyfile | 8 ++++---- README.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Doxyfile b/Doxyfile index f56f71a..1c6afe0 100644 --- a/Doxyfile +++ b/Doxyfile @@ -874,7 +874,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = src +INPUT = src docs README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1072,7 +1072,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -1549,7 +1549,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -DISABLE_INDEX = YES +DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag @@ -1578,7 +1578,7 @@ GENERATE_TREEVIEW = YES # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -FULL_SIDEBAR = YES +FULL_SIDEBAR = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. diff --git a/README.md b/README.md index 0c70e59..0d9145b 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Wormhole uses CMake as the primary build system. Create a build directory, then run CMake to generate the build files, followed by your build mechanism (GNU Make). -###### Release mode +### Release mode $ mkdir build; cd build $ cmake -DCMAKE_BUILD_TYPE=Release .. @@ -56,7 +56,7 @@ your build mechanism (GNU Make). Following the [Installing](#Installing) steps afterwards. -###### Debug mode +### Debug mode When compiled with debug mode, debug logs will show up by default, extra asserts will be done, and the program can be debugged.