Skip to content

Commit 48e7cad

Browse files
authored
Upgrade doxygen to 1.9.6 (#163)
Doxygen 1.9.5 can report false positives around function parameters. 1.9.6 does not have this bug.
1 parent 825066b commit 48e7cad

File tree

1 file changed

+32
-61
lines changed

1 file changed

+32
-61
lines changed

docs/doxygen/config.doxyfile

Lines changed: 32 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.9.5
1+
# Doxyfile 1.9.6
22

33
# This file describes the settings to be used by the documentation system
44
# doxygen (www.doxygen.org) for a project.
@@ -86,7 +86,7 @@ CREATE_SUBDIRS = NO
8686
# level increment doubles the number of directories, resulting in 4096
8787
# directories at level 8 which is the default and also the maximum value. The
8888
# sub-directories are organized in 2 levels, the first level always has a fixed
89-
# numer of 16 directories.
89+
# number of 16 directories.
9090
# Minimum value: 0, maximum value: 8, default value: 8.
9191
# This tag requires that the tag CREATE_SUBDIRS is set to YES.
9292

@@ -568,7 +568,8 @@ HIDE_UNDOC_MEMBERS = NO
568568
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
569569
# undocumented classes that are normally visible in the class hierarchy. If set
570570
# to NO, these classes will be included in the various overviews. This option
571-
# has no effect if EXTRACT_ALL is enabled.
571+
# will also hide undocumented C++ concepts if enabled. This option has no effect
572+
# if EXTRACT_ALL is enabled.
572573
# The default value is: NO.
573574

574575
HIDE_UNDOC_CLASSES = NO
@@ -859,6 +860,14 @@ WARN_IF_INCOMPLETE_DOC = YES
859860

860861
WARN_NO_PARAMDOC = NO
861862

863+
# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
864+
# undocumented enumeration values. If set to NO, doxygen will accept
865+
# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
866+
# will automatically be disabled.
867+
# The default value is: NO.
868+
869+
WARN_IF_UNDOC_ENUM_VAL = NO
870+
862871
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
863872
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
864873
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
@@ -1182,46 +1191,6 @@ USE_HTAGS = NO
11821191

11831192
VERBATIM_HEADERS = YES
11841193

1185-
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1186-
# clang parser (see:
1187-
# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1188-
# performance. This can be particularly helpful with template rich C++ code for
1189-
# which doxygen's built-in parser lacks the necessary type information.
1190-
# Note: The availability of this option depends on whether or not doxygen was
1191-
# generated with the -Duse_libclang=ON option for CMake.
1192-
# The default value is: NO.
1193-
1194-
CLANG_ASSISTED_PARSING = NO
1195-
1196-
# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1197-
# tag is set to YES then doxygen will add the directory of each input to the
1198-
# include path.
1199-
# The default value is: YES.
1200-
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1201-
1202-
CLANG_ADD_INC_PATHS = YES
1203-
1204-
# If clang assisted parsing is enabled you can provide the compiler with command
1205-
# line options that you would normally use when invoking the compiler. Note that
1206-
# the include paths will already be set by doxygen for the files and directories
1207-
# specified with INPUT and INCLUDE_PATH.
1208-
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1209-
1210-
CLANG_OPTIONS =
1211-
1212-
# If clang assisted parsing is enabled you can provide the clang parser with the
1213-
# path to the directory containing a file called compile_commands.json. This
1214-
# file is the compilation database (see:
1215-
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1216-
# options used when the source files were built. This is equivalent to
1217-
# specifying the -p option to a clang tool, such as clang-check. These options
1218-
# will then be passed to the parser. Any options specified with CLANG_OPTIONS
1219-
# will be added as well.
1220-
# Note: The availability of this option depends on whether or not doxygen was
1221-
# generated with the -Duse_libclang=ON option for CMake.
1222-
1223-
CLANG_DATABASE_PATH =
1224-
12251194
#---------------------------------------------------------------------------
12261195
# Configuration options related to the alphabetical class index
12271196
#---------------------------------------------------------------------------
@@ -1233,10 +1202,11 @@ CLANG_DATABASE_PATH =
12331202

12341203
ALPHABETICAL_INDEX = YES
12351204

1236-
# In case all classes in a project start with a common prefix, all classes will
1237-
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1238-
# can be used to specify a prefix (or a list of prefixes) that should be ignored
1239-
# while generating the index headers.
1205+
# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1206+
# that should be ignored while generating the index headers. The IGNORE_PREFIX
1207+
# tag works for classes, function and member names. The entity will be placed in
1208+
# the alphabetical list under the first letter of the entity name that remains
1209+
# after removing the prefix.
12401210
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
12411211

12421212
IGNORE_PREFIX =
@@ -1315,7 +1285,12 @@ HTML_STYLESHEET =
13151285
# Doxygen will copy the style sheet files to the output directory.
13161286
# Note: The order of the extra style sheet files is of importance (e.g. the last
13171287
# style sheet in the list overrules the setting of the previous ones in the
1318-
# list). For an example see the documentation.
1288+
# list).
1289+
# Note: Since the styling of scrollbars can currently not be overruled in
1290+
# Webkit/Chromium, the styling will be left out of the default doxygen.css if
1291+
# one or more extra stylesheets have been specified. So if scrollbar
1292+
# customization is desired it has to be added explicitly. For an example see the
1293+
# documentation.
13191294
# This tag requires that the tag GENERATE_HTML is set to YES.
13201295

13211296
HTML_EXTRA_STYLESHEET = ./docs/doxygen/style.css
@@ -1331,17 +1306,13 @@ HTML_EXTRA_STYLESHEET = ./docs/doxygen/style.css
13311306
HTML_EXTRA_FILES =
13321307

13331308
# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1334-
# should be rendered with a dark or light theme. Default setting AUTO_LIGHT
1335-
# enables light output unless the user preference is dark output. Other options
1336-
# are DARK to always use dark mode, LIGHT to always use light mode, AUTO_DARK to
1337-
# default to dark mode unless the user prefers light mode, and TOGGLE to let the
1338-
# user toggle between dark and light mode via a button.
1339-
# Possible values are: LIGHT Always generate light output., DARK Always generate
1340-
# dark output., AUTO_LIGHT Automatically set the mode according to the user
1341-
# preference, use light mode if no preference is set (the default)., AUTO_DARK
1342-
# Automatically set the mode according to the user preference, use dark mode if
1343-
# no preference is set. and TOGGLE Allow to user to switch between light and
1344-
# dark mode via a button..
1309+
# should be rendered with a dark or light theme.
1310+
# Possible values are: LIGHT always generate light mode output, DARK always
1311+
# generate dark mode output, AUTO_LIGHT automatically set the mode according to
1312+
# the user preference, use light mode if no preference is set (the default),
1313+
# AUTO_DARK automatically set the mode according to the user preference, use
1314+
# dark mode if no preference is set and TOGGLE allow to user to switch between
1315+
# light and dark mode via a button.
13451316
# The default value is: AUTO_LIGHT.
13461317
# This tag requires that the tag GENERATE_HTML is set to YES.
13471318

@@ -1771,8 +1742,8 @@ MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
17711742

17721743
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
17731744
# extension names that should be enabled during MathJax rendering. For example
1774-
# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html
1775-
# #tex-and-latex-extensions):
1745+
# for MathJax version 2 (see
1746+
# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
17761747
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
17771748
# For example for MathJax version 3 (see
17781749
# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):

0 commit comments

Comments
 (0)