|
1 |
| -# Doxyfile 1.9.4 |
| 1 | +# Doxyfile 1.9.5 |
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.
|
|
19 | 19 | # configuration file:
|
20 | 20 | # doxygen -x [configFile]
|
21 | 21 | # 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: |
23 | 24 | # doxygen -x_noenv [configFile]
|
24 | 25 |
|
25 | 26 | #---------------------------------------------------------------------------
|
@@ -595,7 +596,8 @@ INTERNAL_DOCS = NO
|
595 | 596 | # Windows (including Cygwin) and MacOS, users should typically set this option
|
596 | 597 | # to NO, whereas on Linux or other Unix flavors it should typically be set to
|
597 | 598 | # YES.
|
598 |
| -# The default value is: system dependent. |
| 599 | +# Possible values are: SYSTEM, NO and YES. |
| 600 | +# The default value is: SYSTEM. |
599 | 601 |
|
600 | 602 | CASE_SENSE_NAMES = YES
|
601 | 603 |
|
@@ -905,10 +907,21 @@ INPUT = include/evmc/ \
|
905 | 907 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
|
906 | 908 | # documentation (see:
|
907 | 909 | # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
|
| 910 | +# See also: INPUT_FILE_ENCODING |
908 | 911 | # The default value is: UTF-8.
|
909 | 912 |
|
910 | 913 | INPUT_ENCODING = UTF-8
|
911 | 914 |
|
| 915 | +# This tag can be used to specify the character encoding of the source files |
| 916 | +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify |
| 917 | +# character encoding on a per file pattern basis. Doxygen will compare the file |
| 918 | +# name with each pattern and apply the encoding instead of the default |
| 919 | +# INPUT_ENCODING) if there is a match. The character encodings are a list of the |
| 920 | +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding |
| 921 | +# "INPUT_ENCODING" for further information on supported encodings. |
| 922 | + |
| 923 | +INPUT_FILE_ENCODING = |
| 924 | + |
912 | 925 | # If the value of the INPUT tag contains directories, you can use the
|
913 | 926 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
|
914 | 927 | # *.h) to filter out the source-files in the directories.
|
@@ -1013,6 +1026,11 @@ IMAGE_PATH =
|
1013 | 1026 | # code is scanned, but not when the output code is generated. If lines are added
|
1014 | 1027 | # or removed, the anchors will not be placed correctly.
|
1015 | 1028 | #
|
| 1029 | +# Note that doxygen will use the data processed and written to standard output |
| 1030 | +# for further processing, therefore nothing else, like debug statements or used |
| 1031 | +# commands (so in case of a Windows batch file always use @echo OFF), should be |
| 1032 | +# written to standard output. |
| 1033 | +# |
1016 | 1034 | # Note that for custom extensions or not directly supported extensions you also
|
1017 | 1035 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not
|
1018 | 1036 | # properly processed by doxygen.
|
@@ -1054,6 +1072,15 @@ FILTER_SOURCE_PATTERNS =
|
1054 | 1072 |
|
1055 | 1073 | USE_MDFILE_AS_MAINPAGE =
|
1056 | 1074 |
|
| 1075 | +# The Fortran standard specifies that for fixed formatted Fortran code all |
| 1076 | +# characters from position 72 are to be considered as comment. A common |
| 1077 | +# extension is to allow longer lines before the automatic comment starts. The |
| 1078 | +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can |
| 1079 | +# be processed before the automatic comment starts. |
| 1080 | +# Minimum value: 7, maximum value: 10000, default value: 72. |
| 1081 | + |
| 1082 | +FORTRAN_COMMENT_AFTER = 72 |
| 1083 | + |
1057 | 1084 | #---------------------------------------------------------------------------
|
1058 | 1085 | # Configuration options related to source browsing
|
1059 | 1086 | #---------------------------------------------------------------------------
|
@@ -1140,46 +1167,6 @@ USE_HTAGS = NO
|
1140 | 1167 |
|
1141 | 1168 | VERBATIM_HEADERS = YES
|
1142 | 1169 |
|
1143 |
| -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the |
1144 |
| -# clang parser (see: |
1145 |
| -# http://clang.llvm.org/) for more accurate parsing at the cost of reduced |
1146 |
| -# performance. This can be particularly helpful with template rich C++ code for |
1147 |
| -# which doxygen's built-in parser lacks the necessary type information. |
1148 |
| -# Note: The availability of this option depends on whether or not doxygen was |
1149 |
| -# generated with the -Duse_libclang=ON option for CMake. |
1150 |
| -# The default value is: NO. |
1151 |
| - |
1152 |
| -CLANG_ASSISTED_PARSING = NO |
1153 |
| - |
1154 |
| -# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS |
1155 |
| -# tag is set to YES then doxygen will add the directory of each input to the |
1156 |
| -# include path. |
1157 |
| -# The default value is: YES. |
1158 |
| -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
1159 |
| - |
1160 |
| -CLANG_ADD_INC_PATHS = YES |
1161 |
| - |
1162 |
| -# If clang assisted parsing is enabled you can provide the compiler with command |
1163 |
| -# line options that you would normally use when invoking the compiler. Note that |
1164 |
| -# the include paths will already be set by doxygen for the files and directories |
1165 |
| -# specified with INPUT and INCLUDE_PATH. |
1166 |
| -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
1167 |
| - |
1168 |
| -CLANG_OPTIONS = |
1169 |
| - |
1170 |
| -# If clang assisted parsing is enabled you can provide the clang parser with the |
1171 |
| -# path to the directory containing a file called compile_commands.json. This |
1172 |
| -# file is the compilation database (see: |
1173 |
| -# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the |
1174 |
| -# options used when the source files were built. This is equivalent to |
1175 |
| -# specifying the -p option to a clang tool, such as clang-check. These options |
1176 |
| -# will then be passed to the parser. Any options specified with CLANG_OPTIONS |
1177 |
| -# will be added as well. |
1178 |
| -# Note: The availability of this option depends on whether or not doxygen was |
1179 |
| -# generated with the -Duse_libclang=ON option for CMake. |
1180 |
| - |
1181 |
| -CLANG_DATABASE_PATH = |
1182 |
| - |
1183 | 1170 | #---------------------------------------------------------------------------
|
1184 | 1171 | # Configuration options related to the alphabetical class index
|
1185 | 1172 | #---------------------------------------------------------------------------
|
@@ -1288,6 +1275,23 @@ HTML_EXTRA_STYLESHEET =
|
1288 | 1275 |
|
1289 | 1276 | HTML_EXTRA_FILES =
|
1290 | 1277 |
|
| 1278 | +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output |
| 1279 | +# should be rendered with a dark or light theme. Default setting AUTO_LIGHT |
| 1280 | +# enables light output unless the user preference is dark output. Other options |
| 1281 | +# are DARK to always use dark mode, LIGHT to always use light mode, AUTO_DARK to |
| 1282 | +# default to dark mode unless the user prefers light mode, and TOGGLE to let the |
| 1283 | +# user toggle between dark and light mode via a button. |
| 1284 | +# Possible values are: LIGHT Always generate light output., DARK Always generate |
| 1285 | +# dark output., AUTO_LIGHT Automatically set the mode according to the user |
| 1286 | +# preference, use light mode if no preference is set (the default)., AUTO_DARK |
| 1287 | +# Automatically set the mode according to the user preference, use dark mode if |
| 1288 | +# no preference is set. and TOGGLE Allow to user to switch between light and |
| 1289 | +# dark mode via a button.. |
| 1290 | +# The default value is: AUTO_LIGHT. |
| 1291 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
| 1292 | + |
| 1293 | +HTML_COLORSTYLE = AUTO_LIGHT |
| 1294 | + |
1291 | 1295 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
|
1292 | 1296 | # will adjust the colors in the style sheet and background images according to
|
1293 | 1297 | # this color. Hue is specified as an angle on a color-wheel, see
|
@@ -1651,17 +1655,6 @@ HTML_FORMULA_FORMAT = png
|
1651 | 1655 |
|
1652 | 1656 | FORMULA_FONTSIZE = 10
|
1653 | 1657 |
|
1654 |
| -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images |
1655 |
| -# generated for formulas are transparent PNGs. Transparent PNGs are not |
1656 |
| -# supported properly for IE 6.0, but are supported on all modern browsers. |
1657 |
| -# |
1658 |
| -# Note that when changing this option you need to delete any form_*.png files in |
1659 |
| -# the HTML output directory before the changes have effect. |
1660 |
| -# The default value is: YES. |
1661 |
| -# This tag requires that the tag GENERATE_HTML is set to YES. |
1662 |
| - |
1663 |
| -FORMULA_TRANSPARENT = YES |
1664 |
| - |
1665 | 1658 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
|
1666 | 1659 | # to create new LaTeX commands to be used in formulas as building blocks. See
|
1667 | 1660 | # the section "Including formulas" for details.
|
@@ -1723,8 +1716,8 @@ MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
1723 | 1716 |
|
1724 | 1717 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
|
1725 | 1718 | # extension names that should be enabled during MathJax rendering. For example
|
1726 |
| -# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html |
1727 |
| -# #tex-and-latex-extensions): |
| 1719 | +# for MathJax version 2 (see |
| 1720 | +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): |
1728 | 1721 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
|
1729 | 1722 | # For example for MathJax version 3 (see
|
1730 | 1723 | # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
|
@@ -2377,26 +2370,38 @@ HAVE_DOT = NO
|
2377 | 2370 |
|
2378 | 2371 | DOT_NUM_THREADS = 0
|
2379 | 2372 |
|
2380 |
| -# When you want a differently looking font in the dot files that doxygen |
2381 |
| -# generates you can specify the font name using DOT_FONTNAME. You need to make |
2382 |
| -# sure dot is able to find the font, which can be done by putting it in a |
2383 |
| -# standard location or by setting the DOTFONTPATH environment variable or by |
2384 |
| -# setting DOT_FONTPATH to the directory containing the font. |
2385 |
| -# The default value is: Helvetica. |
| 2373 | +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of |
| 2374 | +# subgraphs. When you want a differently looking font in the dot files that |
| 2375 | +# doxygen generates you can specify fontname, fontcolor and fontsize attributes. |
| 2376 | +# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node, |
| 2377 | +# Edge and Graph Attributes specification</a> You need to make sure dot is able |
| 2378 | +# to find the font, which can be done by putting it in a standard location or by |
| 2379 | +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the |
| 2380 | +# directory containing the font. Default graphviz fontsize is 14. |
| 2381 | +# The default value is: fontname=Helvetica,fontsize=10. |
2386 | 2382 | # This tag requires that the tag HAVE_DOT is set to YES.
|
2387 | 2383 |
|
2388 |
| -DOT_FONTNAME = Helvetica |
| 2384 | +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" |
2389 | 2385 |
|
2390 |
| -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of |
2391 |
| -# dot graphs. |
2392 |
| -# Minimum value: 4, maximum value: 24, default value: 10. |
| 2386 | +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can |
| 2387 | +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a |
| 2388 | +# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about |
| 2389 | +# arrows shapes.</a> |
| 2390 | +# The default value is: labelfontname=Helvetica,labelfontsize=10. |
2393 | 2391 | # This tag requires that the tag HAVE_DOT is set to YES.
|
2394 | 2392 |
|
2395 |
| -DOT_FONTSIZE = 10 |
| 2393 | +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" |
2396 | 2394 |
|
2397 |
| -# By default doxygen will tell dot to use the default font as specified with |
2398 |
| -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set |
2399 |
| -# the path where dot can find it using this tag. |
| 2395 | +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes |
| 2396 | +# around nodes set 'shape=plain' or 'shape=plaintext' <a |
| 2397 | +# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a> |
| 2398 | +# The default value is: shape=box,height=0.2,width=0.4. |
| 2399 | +# This tag requires that the tag HAVE_DOT is set to YES. |
| 2400 | + |
| 2401 | +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" |
| 2402 | + |
| 2403 | +# You can set the path where dot can find font specified with fontname in |
| 2404 | +# DOT_COMMON_ATTR and others dot attributes. |
2400 | 2405 | # This tag requires that the tag HAVE_DOT is set to YES.
|
2401 | 2406 |
|
2402 | 2407 | DOT_FONTPATH =
|
@@ -2639,18 +2644,6 @@ DOT_GRAPH_MAX_NODES = 50
|
2639 | 2644 |
|
2640 | 2645 | MAX_DOT_GRAPH_DEPTH = 0
|
2641 | 2646 |
|
2642 |
| -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
2643 |
| -# background. This is disabled by default, because dot on Windows does not seem |
2644 |
| -# to support this out of the box. |
2645 |
| -# |
2646 |
| -# Warning: Depending on the platform used, enabling this option may lead to |
2647 |
| -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to |
2648 |
| -# read). |
2649 |
| -# The default value is: NO. |
2650 |
| -# This tag requires that the tag HAVE_DOT is set to YES. |
2651 |
| - |
2652 |
| -DOT_TRANSPARENT = NO |
2653 |
| - |
2654 | 2647 | # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
|
2655 | 2648 | # files in one run (i.e. multiple -o and -T options on the command line). This
|
2656 | 2649 | # makes dot run faster, but since only newer versions of dot (>1.8.10) support
|
|
0 commit comments