Skip to content

Commit 9500217

Browse files
authored
Update Doxygen to 1.9.6 (#111)
This is the latest doxygen version and does not contain the parameter bug 1.9.5 had
1 parent 9dbe241 commit 9500217

File tree

1 file changed

+91
-47
lines changed

1 file changed

+91
-47
lines changed

docs/doxygen/config.doxyfile

Lines changed: 91 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.9.4
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.
@@ -19,7 +19,8 @@
1919
# configuration file:
2020
# doxygen -x [configFile]
2121
# Use doxygen to compare the used configuration file with the template
22-
# configuration file without replacing the environment variables:
22+
# configuration file without replacing the environment variables or CMake type
23+
# replacement variables:
2324
# doxygen -x_noenv [configFile]
2425

2526
#---------------------------------------------------------------------------
@@ -85,7 +86,7 @@ CREATE_SUBDIRS = NO
8586
# level increment doubles the number of directories, resulting in 4096
8687
# directories at level 8 which is the default and also the maximum value. The
8788
# sub-directories are organized in 2 levels, the first level always has a fixed
88-
# numer of 16 directories.
89+
# number of 16 directories.
8990
# Minimum value: 0, maximum value: 8, default value: 8.
9091
# This tag requires that the tag CREATE_SUBDIRS is set to YES.
9192

@@ -567,7 +568,8 @@ HIDE_UNDOC_MEMBERS = NO
567568
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
568569
# undocumented classes that are normally visible in the class hierarchy. If set
569570
# to NO, these classes will be included in the various overviews. This option
570-
# 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.
571573
# The default value is: NO.
572574

573575
HIDE_UNDOC_CLASSES = NO
@@ -605,7 +607,8 @@ INTERNAL_DOCS = NO
605607
# Windows (including Cygwin) and MacOS, users should typically set this option
606608
# to NO, whereas on Linux or other Unix flavors it should typically be set to
607609
# YES.
608-
# The default value is: system dependent.
610+
# Possible values are: SYSTEM, NO and YES.
611+
# The default value is: SYSTEM.
609612

610613
CASE_SENSE_NAMES = NO
611614

@@ -857,6 +860,14 @@ WARN_IF_INCOMPLETE_DOC = YES
857860

858861
WARN_NO_PARAMDOC = NO
859862

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+
860871
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
861872
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
862873
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
@@ -916,10 +927,21 @@ INPUT = ./docs/doxygen \
916927
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
917928
# documentation (see:
918929
# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
930+
# See also: INPUT_FILE_ENCODING
919931
# The default value is: UTF-8.
920932

921933
INPUT_ENCODING = UTF-8
922934

935+
# This tag can be used to specify the character encoding of the source files
936+
# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
937+
# character encoding on a per file pattern basis. Doxygen will compare the file
938+
# name with each pattern and apply the encoding instead of the default
939+
# INPUT_ENCODING) if there is a match. The character encodings are a list of the
940+
# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
941+
# "INPUT_ENCODING" for further information on supported encodings.
942+
943+
INPUT_FILE_ENCODING =
944+
923945
# If the value of the INPUT tag contains directories, you can use the
924946
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
925947
# *.h) to filter out the source-files in the directories.
@@ -1026,6 +1048,11 @@ IMAGE_PATH = ./docs/plantuml/images
10261048
# code is scanned, but not when the output code is generated. If lines are added
10271049
# or removed, the anchors will not be placed correctly.
10281050
#
1051+
# Note that doxygen will use the data processed and written to standard output
1052+
# for further processing, therefore nothing else, like debug statements or used
1053+
# commands (so in case of a Windows batch file always use @echo OFF), should be
1054+
# written to standard output.
1055+
#
10291056
# Note that for custom extensions or not directly supported extensions you also
10301057
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
10311058
# properly processed by doxygen.
@@ -1067,6 +1094,15 @@ FILTER_SOURCE_PATTERNS =
10671094

10681095
USE_MDFILE_AS_MAINPAGE =
10691096

1097+
# The Fortran standard specifies that for fixed formatted Fortran code all
1098+
# characters from position 72 are to be considered as comment. A common
1099+
# extension is to allow longer lines before the automatic comment starts. The
1100+
# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1101+
# be processed before the automatic comment starts.
1102+
# Minimum value: 7, maximum value: 10000, default value: 72.
1103+
1104+
FORTRAN_COMMENT_AFTER = 72
1105+
10701106
#---------------------------------------------------------------------------
10711107
# Configuration options related to source browsing
10721108
#---------------------------------------------------------------------------
@@ -1164,10 +1200,11 @@ VERBATIM_HEADERS = YES
11641200

11651201
ALPHABETICAL_INDEX = YES
11661202

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

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

12521294
HTML_EXTRA_STYLESHEET = ./docs/doxygen/style.css
@@ -1261,6 +1303,19 @@ HTML_EXTRA_STYLESHEET = ./docs/doxygen/style.css
12611303

12621304
HTML_EXTRA_FILES =
12631305

1306+
# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1307+
# should be rendered with a dark or light theme.
1308+
# Possible values are: LIGHT always generate light mode output, DARK always
1309+
# generate dark mode output, AUTO_LIGHT automatically set the mode according to
1310+
# the user preference, use light mode if no preference is set (the default),
1311+
# AUTO_DARK automatically set the mode according to the user preference, use
1312+
# dark mode if no preference is set and TOGGLE allow to user to switch between
1313+
# light and dark mode via a button.
1314+
# The default value is: AUTO_LIGHT.
1315+
# This tag requires that the tag GENERATE_HTML is set to YES.
1316+
1317+
HTML_COLORSTYLE = AUTO_LIGHT
1318+
12641319
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
12651320
# will adjust the colors in the style sheet and background images according to
12661321
# this color. Hue is specified as an angle on a color-wheel, see
@@ -1624,17 +1679,6 @@ HTML_FORMULA_FORMAT = png
16241679

16251680
FORMULA_FONTSIZE = 10
16261681

1627-
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1628-
# generated for formulas are transparent PNGs. Transparent PNGs are not
1629-
# supported properly for IE 6.0, but are supported on all modern browsers.
1630-
#
1631-
# Note that when changing this option you need to delete any form_*.png files in
1632-
# the HTML output directory before the changes have effect.
1633-
# The default value is: YES.
1634-
# This tag requires that the tag GENERATE_HTML is set to YES.
1635-
1636-
FORMULA_TRANSPARENT = YES
1637-
16381682
# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
16391683
# to create new LaTeX commands to be used in formulas as building blocks. See
16401684
# the section "Including formulas" for details.
@@ -2350,26 +2394,38 @@ HAVE_DOT = NO
23502394

23512395
DOT_NUM_THREADS = 0
23522396

2353-
# When you want a differently looking font in the dot files that doxygen
2354-
# generates you can specify the font name using DOT_FONTNAME. You need to make
2355-
# sure dot is able to find the font, which can be done by putting it in a
2356-
# standard location or by setting the DOTFONTPATH environment variable or by
2357-
# setting DOT_FONTPATH to the directory containing the font.
2358-
# The default value is: Helvetica.
2397+
# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2398+
# subgraphs. When you want a differently looking font in the dot files that
2399+
# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2400+
# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2401+
# Edge and Graph Attributes specification</a> You need to make sure dot is able
2402+
# to find the font, which can be done by putting it in a standard location or by
2403+
# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2404+
# directory containing the font. Default graphviz fontsize is 14.
2405+
# The default value is: fontname=Helvetica,fontsize=10.
2406+
# This tag requires that the tag HAVE_DOT is set to YES.
2407+
2408+
DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
2409+
2410+
# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2411+
# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2412+
# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2413+
# arrows shapes.</a>
2414+
# The default value is: labelfontname=Helvetica,labelfontsize=10.
23592415
# This tag requires that the tag HAVE_DOT is set to YES.
23602416

2361-
DOT_FONTNAME = Helvetica
2417+
DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
23622418

2363-
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2364-
# dot graphs.
2365-
# Minimum value: 4, maximum value: 24, default value: 10.
2419+
# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2420+
# around nodes set 'shape=plain' or 'shape=plaintext' <a
2421+
# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2422+
# The default value is: shape=box,height=0.2,width=0.4.
23662423
# This tag requires that the tag HAVE_DOT is set to YES.
23672424

2368-
DOT_FONTSIZE = 10
2425+
DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
23692426

2370-
# By default doxygen will tell dot to use the default font as specified with
2371-
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2372-
# the path where dot can find it using this tag.
2427+
# You can set the path where dot can find font specified with fontname in
2428+
# DOT_COMMON_ATTR and others dot attributes.
23732429
# This tag requires that the tag HAVE_DOT is set to YES.
23742430

23752431
DOT_FONTPATH =
@@ -2612,18 +2668,6 @@ DOT_GRAPH_MAX_NODES = 50
26122668

26132669
MAX_DOT_GRAPH_DEPTH = 0
26142670

2615-
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2616-
# background. This is disabled by default, because dot on Windows does not seem
2617-
# to support this out of the box.
2618-
#
2619-
# Warning: Depending on the platform used, enabling this option may lead to
2620-
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2621-
# read).
2622-
# The default value is: NO.
2623-
# This tag requires that the tag HAVE_DOT is set to YES.
2624-
2625-
DOT_TRANSPARENT = NO
2626-
26272671
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
26282672
# files in one run (i.e. multiple -o and -T options on the command line). This
26292673
# makes dot run faster, but since only newer versions of dot (>1.8.10) support

0 commit comments

Comments
 (0)