1
- # Doxyfile 1.12 .0
1
+ # Doxyfile 1.13 .0
2
2
3
3
# This file describes the settings to be used by the documentation system
4
4
# Doxygen (www.doxygen.org) for a project.
@@ -51,7 +51,7 @@ PROJECT_NAME = "${PROJECT_NAME}"
51
51
PROJECT_NUMBER = "${PROJECT_VERSION}${PROJECT_VERSION_SUFFIX}"
52
52
53
53
# Using the PROJECT_BRIEF tag one can provide an optional one line description
54
- # for a project that appears at the top of each page and should give viewer a
54
+ # for a project that appears at the top of each page and should give viewers a
55
55
# quick idea about the purpose of the project. Keep the description short.
56
56
57
57
PROJECT_BRIEF = "${DOX_PROJECT_BRIEF}"
@@ -80,7 +80,7 @@ OUTPUT_DIRECTORY =
80
80
# sub-directories (in 2 levels) under the output directory of each output format
81
81
# and will distribute the generated files over these directories. Enabling this
82
82
# option can be useful when feeding Doxygen a huge amount of source files, where
83
- # putting all generated files in the same directory would otherwise causes
83
+ # putting all generated files in the same directory would otherwise cause
84
84
# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
85
85
# control the number of sub-directories.
86
86
# The default value is: NO.
@@ -202,17 +202,17 @@ STRIP_FROM_PATH =
202
202
STRIP_FROM_INC_PATH =
203
203
204
204
# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but
205
- # less readable) file names. This can be useful is your file systems doesn't
205
+ # less readable) file names. This can be useful if your file system doesn't
206
206
# support long names like on DOS, Mac, or CD-ROM.
207
207
# The default value is: NO.
208
208
209
209
SHORT_NAMES = NO
210
210
211
211
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the
212
- # first line (until the first dot) of a Javadoc-style comment as the brief
213
- # description. If set to NO, the Javadoc-style will behave just like regular Qt -
214
- # style comments (thus requiring an explicit @brief command for a brief
215
- # description.)
212
+ # first line (until the first dot, question mark or exclamation mark) of a
213
+ # Javadoc-style comment as the brief description. If set to NO, the Javadoc-
214
+ # style will behave just like regular Qt-style comments (thus requiring an
215
+ # explicit @brief command for a brief description.)
216
216
# The default value is: NO.
217
217
218
218
JAVADOC_AUTOBRIEF = NO
@@ -228,9 +228,10 @@ JAVADOC_AUTOBRIEF = NO
228
228
JAVADOC_BANNER = NO
229
229
230
230
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first
231
- # line (until the first dot) of a Qt-style comment as the brief description. If
232
- # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
233
- # requiring an explicit \brief command for a brief description.)
231
+ # line (until the first dot, question mark or exclamation mark) of a Qt-style
232
+ # comment as the brief description. If set to NO, the Qt-style will behave just
233
+ # like regular Qt-style comments (thus requiring an explicit \brief command for
234
+ # a brief description.)
234
235
# The default value is: NO.
235
236
236
237
QT_AUTOBRIEF = YES
@@ -384,11 +385,20 @@ MARKDOWN_ID_STYLE = DOXYGEN
384
385
# When enabled Doxygen tries to link words that correspond to documented
385
386
# classes, or namespaces to their corresponding documentation. Such a link can
386
387
# be prevented in individual cases by putting a % sign in front of the word or
387
- # globally by setting AUTOLINK_SUPPORT to NO.
388
+ # globally by setting AUTOLINK_SUPPORT to NO. Words listed in the
389
+ # AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking.
388
390
# The default value is: YES.
389
391
390
392
AUTOLINK_SUPPORT = YES
391
393
394
+ # This tag specifies a list of words that, when matching the start of a word in
395
+ # the documentation, will suppress auto links generation, if it is enabled via
396
+ # AUTOLINK_SUPPORT. This list does not affect affect links explicitly created
397
+ # using \# or the \link or commands.
398
+ # This tag requires that the tag AUTOLINK_SUPPORT is set to YES.
399
+
400
+ AUTOLINK_IGNORE_WORDS =
401
+
392
402
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
393
403
# to include (a tag file for) the STL sources as input, then you should set this
394
404
# tag to YES in order to let Doxygen match functions declarations and
@@ -600,6 +610,14 @@ HIDE_UNDOC_MEMBERS = NO
600
610
601
611
HIDE_UNDOC_CLASSES = NO
602
612
613
+ # If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all
614
+ # undocumented namespaces that are normally visible in the namespace hierarchy.
615
+ # If set to NO, these namespaces will be included in the various overviews. This
616
+ # option has no effect if EXTRACT_ALL is enabled.
617
+ # The default value is: YES.
618
+
619
+ HIDE_UNDOC_NAMESPACES = YES
620
+
603
621
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend
604
622
# declarations. If set to NO, these declarations will be included in the
605
623
# documentation.
@@ -984,10 +1002,10 @@ INPUT = \
984
1002
INPUT_ENCODING = UTF-8
985
1003
986
1004
# This tag can be used to specify the character encoding of the source files
987
- # that Doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
1005
+ # that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify
988
1006
# character encoding on a per file pattern basis. Doxygen will compare the file
989
1007
# name with each pattern and apply the encoding instead of the default
990
- # INPUT_ENCODING) if there is a match. The character encodings are a list of the
1008
+ # INPUT_ENCODING if there is a match. The character encodings are a list of the
991
1009
# form: pattern=encoding (like *.php=ISO-8859-1).
992
1010
# See also: INPUT_ENCODING for further information on supported encodings.
993
1011
@@ -1139,6 +1157,15 @@ FILTER_SOURCE_PATTERNS =
1139
1157
1140
1158
USE_MDFILE_AS_MAINPAGE = "${CMAKE_SOURCE_DIR}/${DOX_INPUT_DOC}/mainpage.md"
1141
1159
1160
+ # If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub-
1161
+ # directories of the project's root, is used as the documentation for that sub-
1162
+ # directory, except when the README.md starts with a \dir, \page or \mainpage
1163
+ # command. If set to NO, the README.md file needs to start with an explicit \dir
1164
+ # command in order to be used as directory documentation.
1165
+ # The default value is: YES.
1166
+
1167
+ IMPLICIT_DIR_DOCS = YES
1168
+
1142
1169
# The Fortran standard specifies that for fixed formatted Fortran code all
1143
1170
# characters from position 72 are to be considered as comment. A common
1144
1171
# extension is to allow longer lines before the automatic comment starts. The
@@ -1550,9 +1577,9 @@ DOCSET_PUBLISHER_NAME = Publisher
1550
1577
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1551
1578
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1552
1579
# on Windows. In the beginning of 2021 Microsoft took the original page, with
1553
- # a.o. the download links, offline the HTML help workshop was already many years
1554
- # in maintenance mode). You can download the HTML help workshop from the web
1555
- # archives at Installation executable (see:
1580
+ # a.o. the download links, offline ( the HTML help workshop was already many
1581
+ # years in maintenance mode). You can download the HTML help workshop from the
1582
+ # web archives at Installation executable (see:
1556
1583
# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
1557
1584
# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1558
1585
#
@@ -1711,7 +1738,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
1711
1738
# of each HTML page. A value of NO enables the index and the value YES disables
1712
1739
# it. Since the tabs in the index contain the same information as the navigation
1713
1740
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1714
- # The default value is: NO .
1741
+ # The default value is: YES .
1715
1742
# This tag requires that the tag GENERATE_HTML is set to YES.
1716
1743
1717
1744
DISABLE_INDEX = NO
@@ -1728,7 +1755,7 @@ DISABLE_INDEX = NO
1728
1755
# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1729
1756
# Since the tree basically has the same information as the tab index, you could
1730
1757
# consider setting DISABLE_INDEX to YES when enabling this option.
1731
- # The default value is: NO .
1758
+ # The default value is: YES .
1732
1759
# This tag requires that the tag GENERATE_HTML is set to YES.
1733
1760
1734
1761
GENERATE_TREEVIEW = YES
@@ -2140,10 +2167,10 @@ LATEX_HIDE_INDICES = NO
2140
2167
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2141
2168
# bibliography, e.g. plainnat, or ieeetr. See
2142
2169
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2143
- # The default value is: plain .
2170
+ # The default value is: plainnat .
2144
2171
# This tag requires that the tag GENERATE_LATEX is set to YES.
2145
2172
2146
- LATEX_BIB_STYLE = plain
2173
+ LATEX_BIB_STYLE = plainnat
2147
2174
2148
2175
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2149
2176
# path from which the emoji images will be read. If a relative path is entered,
@@ -2814,6 +2841,12 @@ PLANTUML_CFG_FILE =
2814
2841
2815
2842
PLANTUML_INCLUDE_PATH =
2816
2843
2844
+ # The PLANTUMLFILE_DIRS tag can be used to specify one or more directories that
2845
+ # contain PlantUml files that are included in the documentation (see the
2846
+ # \plantumlfile command).
2847
+
2848
+ PLANTUMLFILE_DIRS =
2849
+
2817
2850
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2818
2851
# that will be shown in the graph. If the number of nodes in a graph becomes
2819
2852
# larger than this value, Doxygen will truncate the graph, which is visualized
0 commit comments