mirrors/wormhole
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Doxygen options

Browse source 
FossilOrigin-Name: a46a179a7888b6a75456da427c1c46daf4b837814accc9c950b05fffa27a0253
This commit is contained in:
nekobit 2022-10-21 04:28:51 +00:00
parent aa3632ecb1
commit 7e91a4a4ce
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
Doxyfile
View file

@ -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.

4
README.md
View file

@ -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.