1- # Doxyfile 1.13.2
1+ # Doxyfile 1.15.0
22
33# This file describes the settings to be used by the documentation system
44# Doxygen (www.doxygen.org) for a project.
@@ -351,6 +351,20 @@ EXTENSION_MAPPING =
351351
352352MARKDOWN_SUPPORT = YES
353353
354+ # If the MARKDOWN_STRICT tag is enabled then Doxygen treats text in comments as
355+ # Markdown formatted also in cases where Doxygen's native markup format
356+ # conflicts with that of Markdown. This is only relevant in cases where
357+ # backticks are used. Doxygen's native markup style allows a single quote to end
358+ # a text fragment started with a backtick and then treat it as a piece of quoted
359+ # text, whereas in Markdown such text fragment is treated as verbatim and only
360+ # ends when a second matching backtick is found. Also, Doxygen's native markup
361+ # format requires double quotes to be escaped when they appear in a backtick
362+ # section, whereas this is not needed for Markdown.
363+ # The default value is: YES.
364+ # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
365+
366+ MARKDOWN_STRICT = YES
367+
354368# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
355369# to that level are automatically included in the table of contents, even if
356370# they do not have an id attribute.
@@ -382,8 +396,8 @@ AUTOLINK_SUPPORT = YES
382396
383397# This tag specifies a list of words that, when matching the start of a word in
384398# the documentation, will suppress auto links generation, if it is enabled via
385- # AUTOLINK_SUPPORT. This list does not affect affect links explicitly created
386- # using \# or the \link or commands.
399+ # AUTOLINK_SUPPORT. This list does not affect links explicitly created using \#
400+ # or the \link or commands.
387401# This tag requires that the tag AUTOLINK_SUPPORT is set to YES.
388402
389403AUTOLINK_IGNORE_WORDS =
@@ -500,7 +514,7 @@ LOOKUP_CACHE_SIZE = 0
500514# which effectively disables parallel processing. Please report any issues you
501515# encounter. Generating dot graphs in parallel is controlled by the
502516# DOT_NUM_THREADS setting.
503- # Minimum value: 0, maximum value: 32 , default value: 1.
517+ # Minimum value: 0, maximum value: 512 , default value: 1.
504518
505519NUM_PROC_THREADS = 1
506520
@@ -1019,9 +1033,9 @@ INPUT_FILE_ENCODING =
10191033#
10201034# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
10211035# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl,
1022- # *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx , *.l , *.cs , *.d ,
1023- # *.php, *. php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to
1024- # be provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
1036+ # *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.l , *.cs , *.d , *.php ,
1037+ # *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be
1038+ # provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
10251039# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
10261040
10271041FILE_PATTERNS = *.hpp \
@@ -1265,6 +1279,46 @@ USE_HTAGS = NO
12651279
12661280VERBATIM_HEADERS = YES
12671281
1282+ # If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the
1283+ # clang parser (see:
1284+ # http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1285+ # performance. This can be particularly helpful with template rich C++ code for
1286+ # which Doxygen's built-in parser lacks the necessary type information.
1287+ # Note: The availability of this option depends on whether or not Doxygen was
1288+ # generated with the -Duse_libclang=ON option for CMake.
1289+ # The default value is: NO.
1290+
1291+ CLANG_ASSISTED_PARSING = NO
1292+
1293+ # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1294+ # tag is set to YES then Doxygen will add the directory of each input to the
1295+ # include path.
1296+ # The default value is: YES.
1297+ # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1298+
1299+ CLANG_ADD_INC_PATHS = YES
1300+
1301+ # If clang assisted parsing is enabled you can provide the compiler with command
1302+ # line options that you would normally use when invoking the compiler. Note that
1303+ # the include paths will already be set by Doxygen for the files and directories
1304+ # specified with INPUT and INCLUDE_PATH.
1305+ # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1306+
1307+ CLANG_OPTIONS =
1308+
1309+ # If clang assisted parsing is enabled you can provide the clang parser with the
1310+ # path to the directory containing a file called compile_commands.json. This
1311+ # file is the compilation database (see:
1312+ # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1313+ # options used when the source files were built. This is equivalent to
1314+ # specifying the -p option to a clang tool, such as clang-check. These options
1315+ # will then be passed to the parser. Any options specified with CLANG_OPTIONS
1316+ # will be added as well.
1317+ # Note: The availability of this option depends on whether or not Doxygen was
1318+ # generated with the -Duse_libclang=ON option for CMake.
1319+
1320+ CLANG_DATABASE_PATH =
1321+
12681322#---------------------------------------------------------------------------
12691323# Configuration options related to the alphabetical class index
12701324#---------------------------------------------------------------------------
@@ -1698,7 +1752,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
16981752# of each HTML page. A value of NO enables the index and the value YES disables
16991753# it. Since the tabs in the index contain the same information as the navigation
17001754# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1701- # The default value is: YES .
1755+ # The default value is: NO .
17021756# This tag requires that the tag GENERATE_HTML is set to YES.
17031757
17041758DISABLE_INDEX = NO
@@ -1713,20 +1767,29 @@ DISABLE_INDEX = NO
17131767# further fine tune the look of the index (see "Fine-tuning the output"). As an
17141768# example, the default style sheet generated by Doxygen has an example that
17151769# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1716- # Since the tree basically has the same information as the tab index, you could
1717- # consider setting DISABLE_INDEX to YES when enabling this option.
1770+ # Since the tree basically has more details information than the tab index, you
1771+ # could consider setting DISABLE_INDEX to YES when enabling this option.
17181772# The default value is: YES.
17191773# This tag requires that the tag GENERATE_HTML is set to YES.
17201774
17211775GENERATE_TREEVIEW = YES
17221776
1723- # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1724- # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1725- # area (value NO) or if it should extend to the full height of the window (value
1726- # YES). Setting this to YES gives a layout similar to
1727- # https://docs.readthedocs.io with more room for contents, but less room for the
1728- # project logo, title, and description. If either GENERATE_TREEVIEW or
1729- # DISABLE_INDEX is set to NO, this option has no effect.
1777+ # When GENERATE_TREEVIEW is set to YES, the PAGE_OUTLINE_PANEL option determines
1778+ # if an additional navigation panel is shown at the right hand side of the
1779+ # screen, displaying an outline of the contents of the main page, similar to
1780+ # e.g. https://developer.android.com/reference If GENERATE_TREEVIEW is set to
1781+ # NO, this option has no effect.
1782+ # The default value is: YES.
1783+ # This tag requires that the tag GENERATE_HTML is set to YES.
1784+
1785+ PAGE_OUTLINE_PANEL = YES
1786+
1787+ # When GENERATE_TREEVIEW is set to YES, the FULL_SIDEBAR option determines if
1788+ # the side bar is limited to only the treeview area (value NO) or if it should
1789+ # extend to the full height of the window (value YES). Setting this to YES gives
1790+ # a layout similar to e.g. https://docs.readthedocs.io with more room for
1791+ # contents, but less room for the project logo, title, and description. If
1792+ # GENERATE_TREEVIEW is set to NO, this option has no effect.
17301793# The default value is: NO.
17311794# This tag requires that the tag GENERATE_HTML is set to YES.
17321795
@@ -1811,7 +1874,7 @@ USE_MATHJAX = NO
18111874# regards to the different settings, so it is possible that also other MathJax
18121875# settings have to be changed when switching between the different MathJax
18131876# versions.
1814- # Possible values are: MathJax_2 and MathJax_3 .
1877+ # Possible values are: MathJax_2, MathJax_3 and MathJax_4 .
18151878# The default value is: MathJax_2.
18161879# This tag requires that the tag USE_MATHJAX is set to YES.
18171880
@@ -1820,9 +1883,10 @@ MATHJAX_VERSION = MathJax_2
18201883# When MathJax is enabled you can set the default output format to be used for
18211884# the MathJax output. For more details about the output format see MathJax
18221885# version 2 (see:
1823- # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1886+ # https://docs.mathjax.org/en/v2.7/output.html), MathJax version 3 (see:
1887+ # https://docs.mathjax.org/en/v3.2/output/index.html) and MathJax version 4
18241888# (see:
1825- # http ://docs.mathjax.org/en/latest/web/components/ output.html ).
1889+ # https ://docs.mathjax.org/en/v4.0/ output/index.htm ).
18261890# Possible values are: HTML-CSS (which is slower, but has the best
18271891# compatibility. This is the name for Mathjax version 2, for MathJax version 3
18281892# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
@@ -1835,36 +1899,50 @@ MATHJAX_VERSION = MathJax_2
18351899MATHJAX_FORMAT = HTML-CSS
18361900
18371901# When MathJax is enabled you need to specify the location relative to the HTML
1838- # output directory using the MATHJAX_RELPATH option. The destination directory
1839- # should contain the MathJax.js script. For instance, if the mathjax directory
1840- # is located at the same level as the HTML output directory, then
1841- # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1842- # Content Delivery Network so you can quickly see the result without installing
1843- # MathJax. However, it is strongly recommended to install a local copy of
1844- # MathJax from https://www.mathjax.org before deployment. The default value is:
1902+ # output directory using the MATHJAX_RELPATH option. For Mathjax version 2 the
1903+ # destination directory should contain the MathJax.js script. For instance, if
1904+ # the mathjax directory is located at the same level as the HTML output
1905+ # directory, then MATHJAX_RELPATH should be ../mathjax.s For Mathjax versions 3
1906+ # and 4 the destination directory should contain the tex-<format>.js script
1907+ # (where <format> is either chtml or svg). The default value points to the
1908+ # MathJax Content Delivery Network so you can quickly see the result without
1909+ # installing MathJax. However, it is strongly recommended to install a local
1910+ # copy of MathJax from https://www.mathjax.org before deployment. The default
1911+ # value is:
18451912# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
18461913# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1914+ # - in case of MathJax version 4: https://cdn.jsdelivr.net/npm/mathjax@4
18471915# This tag requires that the tag USE_MATHJAX is set to YES.
18481916
18491917MATHJAX_RELPATH = http://www.mathjax.org/mathjax
18501918
18511919# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
18521920# extension names that should be enabled during MathJax rendering. For example
1853- # for MathJax version 2 (see
1854- # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1921+ # for MathJax version 2 (see https://docs.mathjax.org/en/v2.7/tex.html):
18551922# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
18561923# For example for MathJax version 3 (see
1857- # http ://docs.mathjax.org/en/latest /input/tex/extensions/index.html ):
1924+ # https ://docs.mathjax.org/en/v3.2 /input/tex/extensions/):
18581925# MATHJAX_EXTENSIONS = ams
1926+ # For example for MathJax version 4 (see
1927+ # https://docs.mathjax.org/en/v4.0/input/tex/extensions/):
1928+ # MATHJAX_EXTENSIONS = units
1929+ # Note that for Mathjax version 4 quite a few extensions are already
1930+ # automatically loaded. To disable a package in Mathjax version 4 one can use
1931+ # the package name prepended with a minus sign (- like MATHJAX_EXTENSIONS +=
1932+ # -textmacros)
18591933# This tag requires that the tag USE_MATHJAX is set to YES.
18601934
18611935MATHJAX_EXTENSIONS =
18621936
18631937# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces
1864- # of code that will be used on startup of the MathJax code. See the MathJax site
1865- # (see:
1866- # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1867- # example see the documentation.
1938+ # of code that will be used on startup of the MathJax code. See the Mathjax site
1939+ # for more details:
1940+ # - MathJax version 2 (see:
1941+ # https://docs.mathjax.org/en/v2.7/)
1942+ # - MathJax version 3 (see:
1943+ # https://docs.mathjax.org/en/v3.2/)
1944+ # - MathJax version 4 (see:
1945+ # https://docs.mathjax.org/en/v4.0/) For an example see the documentation.
18681946# This tag requires that the tag USE_MATHJAX is set to YES.
18691947
18701948MATHJAX_CODEFILE =
@@ -2527,7 +2605,7 @@ HAVE_DOT = NO
25272605# processors available in the system. You can set it explicitly to a value
25282606# larger than 0 to get control over the balance between CPU load and processing
25292607# speed.
2530- # Minimum value: 0, maximum value: 32 , default value: 0.
2608+ # Minimum value: 0, maximum value: 512 , default value: 0.
25312609# This tag requires that the tag HAVE_DOT is set to YES.
25322610
25332611DOT_NUM_THREADS = 0
@@ -2629,6 +2707,15 @@ UML_LOOK = YES
26292707
26302708UML_LIMIT_NUM_FIELDS = 10
26312709
2710+ # If the UML_LOOK tag is enabled, field labels are shown along the edge between
2711+ # two class nodes. If there are many fields and many nodes the graph may become
2712+ # too cluttered. The UML_MAX_EDGE_LABELS threshold limits the number of items to
2713+ # make the size more manageable. Set this to 0 for no limit.
2714+ # Minimum value: 0, maximum value: 100, default value: 10.
2715+ # This tag requires that the tag UML_LOOK is set to YES.
2716+
2717+ UML_MAX_EDGE_LABELS = 10
2718+
26322719# If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and
26332720# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
26342721# tag is set to YES, Doxygen will add type and arguments for attributes and
0 commit comments