spl-core 4.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. spl_core/__init__.py +1 -0
  2. spl_core/common/__init__.py +0 -0
  3. spl_core/common/cmake.py +52 -0
  4. spl_core/common/path.py +17 -0
  5. spl_core/gcov_maid/__init__.py +0 -0
  6. spl_core/gcov_maid/gcov_maid.py +48 -0
  7. spl_core/kconfig/__init__.py +0 -0
  8. spl_core/kconfig/kconfig.py +271 -0
  9. spl_core/project_creator/__init__.py +0 -0
  10. spl_core/project_creator/creator.py +133 -0
  11. spl_core/project_creator/templates/project/cookiecutter.json +14 -0
  12. spl_core/project_creator/templates/project/{{cookiecutter.name}}/.flake8 +2 -0
  13. spl_core/project_creator/templates/project/{{cookiecutter.name}}/.gitignore +33 -0
  14. spl_core/project_creator/templates/project/{{cookiecutter.name}}/.vscode/cmake-kits.json +11 -0
  15. spl_core/project_creator/templates/project/{{cookiecutter.name}}/.vscode/cmake-variants.json +18 -0
  16. spl_core/project_creator/templates/project/{{cookiecutter.name}}/.vscode/extensions.json +18 -0
  17. spl_core/project_creator/templates/project/{{cookiecutter.name}}/.vscode/launch.json +37 -0
  18. spl_core/project_creator/templates/project/{{cookiecutter.name}}/.vscode/settings.json +45 -0
  19. spl_core/project_creator/templates/project/{{cookiecutter.name}}/.vscode/tasks.json +93 -0
  20. spl_core/project_creator/templates/project/{{cookiecutter.name}}/CMakeLists.txt +43 -0
  21. spl_core/project_creator/templates/project/{{cookiecutter.name}}/KConfig +23 -0
  22. spl_core/project_creator/templates/project/{{cookiecutter.name}}/LICENSE +21 -0
  23. spl_core/project_creator/templates/project/{{cookiecutter.name}}/Pipfile +33 -0
  24. spl_core/project_creator/templates/project/{{cookiecutter.name}}/README.md +7 -0
  25. spl_core/project_creator/templates/project/{{cookiecutter.name}}/build.bat +1 -0
  26. spl_core/project_creator/templates/project/{{cookiecutter.name}}/build.ps1 +245 -0
  27. spl_core/project_creator/templates/project/{{cookiecutter.name}}/conf.py +200 -0
  28. spl_core/project_creator/templates/project/{{cookiecutter.name}}/doc/Doxyfile.in +2774 -0
  29. spl_core/project_creator/templates/project/{{cookiecutter.name}}/doc/common/index.rst +5 -0
  30. spl_core/project_creator/templates/project/{{cookiecutter.name}}/doc/components/index.rst +23 -0
  31. spl_core/project_creator/templates/project/{{cookiecutter.name}}/doc/doxygen-awesome/LICENSE +21 -0
  32. spl_core/project_creator/templates/project/{{cookiecutter.name}}/doc/doxygen-awesome/doxygen-awesome.css +2530 -0
  33. spl_core/project_creator/templates/project/{{cookiecutter.name}}/doc/software_architecture/index.rst +2 -0
  34. spl_core/project_creator/templates/project/{{cookiecutter.name}}/doc/software_requirements/index.rst +7 -0
  35. spl_core/project_creator/templates/project/{{cookiecutter.name}}/doc/test_report_template.txt +46 -0
  36. spl_core/project_creator/templates/project/{{cookiecutter.name}}/index.rst +38 -0
  37. spl_core/project_creator/templates/project/{{cookiecutter.name}}/install-mandatory.bat +1 -0
  38. spl_core/project_creator/templates/project/{{cookiecutter.name}}/pytest.ini +9 -0
  39. spl_core/project_creator/templates/project/{{cookiecutter.name}}/scoopfile.json +47 -0
  40. spl_core/project_creator/templates/project/{{cookiecutter.name}}/test/test_build.py +39 -0
  41. spl_core/project_creator/templates/project/{{cookiecutter.name}}/test/test_unittests.py +28 -0
  42. spl_core/project_creator/templates/project/{{cookiecutter.name}}/test/utils.py +26 -0
  43. spl_core/project_creator/templates/project/{{cookiecutter.name}}/tools/setup/git-config.ps1 +8 -0
  44. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/CMakeLists.txt +3 -0
  45. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/doc/_images/screenshot.png +0 -0
  46. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/doc/design.rst +25 -0
  47. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/doc/index.rst +8 -0
  48. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/src/component.c +31 -0
  49. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/src/component.h +1 -0
  50. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/test/test_component.cc +60 -0
  51. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/main/CMakeLists.txt +2 -0
  52. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/main/doc/index.rst +14 -0
  53. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/main/src/main.c +17 -0
  54. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_tools -%} tools {%- endif %}/toolchains/clang/toolchain.cmake +8 -0
  55. spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_tools -%} tools {%- endif %}/toolchains/gcc/toolchain.cmake +3 -0
  56. spl_core/project_creator/templates/variant/cookiecutter.json +4 -0
  57. spl_core/project_creator/templates/variant/{{cookiecutter.flavor}}/{{cookiecutter.subsystem}}/config.cmake +1 -0
  58. spl_core/project_creator/templates/variant/{{cookiecutter.flavor}}/{{cookiecutter.subsystem}}/config.txt +1 -0
  59. spl_core/project_creator/templates/variant/{{cookiecutter.flavor}}/{{cookiecutter.subsystem}}/parts.cmake +2 -0
  60. spl_core/project_creator/variant.py +23 -0
  61. spl_core/project_creator/workspace_artifacts.py +36 -0
  62. spl_core-4.0.0.dist-info/LICENSE +22 -0
  63. spl_core-4.0.0.dist-info/METADATA +62 -0
  64. spl_core-4.0.0.dist-info/RECORD +65 -0
  65. spl_core-4.0.0.dist-info/WHEEL +4 -0
@@ -0,0 +1,2774 @@
1
+ # Doxyfile 1.9.7
2
+
3
+ # This file describes the settings to be used by the documentation system
4
+ # doxygen (www.doxygen.org) for a project.
5
+ #
6
+ # All text after a double hash (##) is considered a comment and is placed in
7
+ # front of the TAG it is preceding.
8
+ #
9
+ # All text after a single hash (#) is considered a comment and will be ignored.
10
+ # The format is:
11
+ # TAG = value [value, ...]
12
+ # For lists, items can also be appended using:
13
+ # TAG += value [value, ...]
14
+ # Values that contain spaces should be placed between quotes (\" \").
15
+ #
16
+ # Note:
17
+ #
18
+ # Use doxygen to compare the used configuration file with the template
19
+ # configuration file:
20
+ # doxygen -x [configFile]
21
+ # Use doxygen to compare the used configuration file with the template
22
+ # configuration file without replacing the environment variables or CMake type
23
+ # replacement variables:
24
+ # doxygen -x_noenv [configFile]
25
+
26
+ #---------------------------------------------------------------------------
27
+ # Project related configuration options
28
+ #---------------------------------------------------------------------------
29
+
30
+ # This tag specifies the encoding used for all characters in the configuration
31
+ # file that follow. The default is UTF-8 which is also the encoding used for all
32
+ # text before the first occurrence of this tag. Doxygen uses libiconv (or the
33
+ # iconv built into libc) for the transcoding. See
34
+ # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
35
+ # The default value is: UTF-8.
36
+
37
+ DOXYFILE_ENCODING = UTF-8
38
+
39
+ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
40
+ # double-quotes, unless you are using Doxywizard) that should identify the
41
+ # project for which the documentation is generated. This name is used in the
42
+ # title of most generated pages and in a few other places.
43
+ # The default value is: My Project.
44
+
45
+ PROJECT_NAME = "Source Code"
46
+
47
+ # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
48
+ # could be handy for archiving the generated documentation or if some version
49
+ # control system is used.
50
+
51
+ PROJECT_NUMBER =
52
+
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
55
+ # quick idea about the purpose of the project. Keep the description short.
56
+
57
+ PROJECT_BRIEF =
58
+
59
+ # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
60
+ # in the documentation. The maximum height of the logo should not exceed 55
61
+ # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
62
+ # the logo to the output directory.
63
+
64
+ PROJECT_LOGO =
65
+
66
+ # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
67
+ # into which the generated documentation will be written. If a relative path is
68
+ # entered, it will be relative to the location where doxygen was started. If
69
+ # left blank the current directory will be used.
70
+
71
+ OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIRECTORY@
72
+
73
+ # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
74
+ # sub-directories (in 2 levels) under the output directory of each output format
75
+ # and will distribute the generated files over these directories. Enabling this
76
+ # option can be useful when feeding doxygen a huge amount of source files, where
77
+ # putting all generated files in the same directory would otherwise causes
78
+ # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
79
+ # control the number of sub-directories.
80
+ # The default value is: NO.
81
+
82
+ CREATE_SUBDIRS = NO
83
+
84
+ # Controls the number of sub-directories that will be created when
85
+ # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
86
+ # level increment doubles the number of directories, resulting in 4096
87
+ # directories at level 8 which is the default and also the maximum value. The
88
+ # sub-directories are organized in 2 levels, the first level always has a fixed
89
+ # number of 16 directories.
90
+ # Minimum value: 0, maximum value: 8, default value: 8.
91
+ # This tag requires that the tag CREATE_SUBDIRS is set to YES.
92
+
93
+ CREATE_SUBDIRS_LEVEL = 8
94
+
95
+ # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
96
+ # characters to appear in the names of generated files. If set to NO, non-ASCII
97
+ # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
98
+ # U+3044.
99
+ # The default value is: NO.
100
+
101
+ ALLOW_UNICODE_NAMES = NO
102
+
103
+ # The OUTPUT_LANGUAGE tag is used to specify the language in which all
104
+ # documentation generated by doxygen is written. Doxygen will use this
105
+ # information to generate all constant output in the proper language.
106
+ # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
107
+ # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
108
+ # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
109
+ # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
110
+ # English messages), Korean, Korean-en (Korean with English messages), Latvian,
111
+ # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
112
+ # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
113
+ # Swedish, Turkish, Ukrainian and Vietnamese.
114
+ # The default value is: English.
115
+
116
+ OUTPUT_LANGUAGE = English
117
+
118
+ # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
119
+ # descriptions after the members that are listed in the file and class
120
+ # documentation (similar to Javadoc). Set to NO to disable this.
121
+ # The default value is: YES.
122
+
123
+ BRIEF_MEMBER_DESC = NO
124
+
125
+ # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
126
+ # description of a member or function before the detailed description
127
+ #
128
+ # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
129
+ # brief descriptions will be completely suppressed.
130
+ # The default value is: YES.
131
+
132
+ REPEAT_BRIEF = NO
133
+
134
+ # This tag implements a quasi-intelligent brief description abbreviator that is
135
+ # used to form the text in various listings. Each string in this list, if found
136
+ # as the leading text of the brief description, will be stripped from the text
137
+ # and the result, after processing the whole list, is used as the annotated
138
+ # text. Otherwise, the brief description is used as-is. If left blank, the
139
+ # following values are used ($name is automatically replaced with the name of
140
+ # the entity):The $name class, The $name widget, The $name file, is, provides,
141
+ # specifies, contains, represents, a, an and the.
142
+
143
+ ABBREVIATE_BRIEF = "The $name class" \
144
+ "The $name widget" \
145
+ "The $name file" \
146
+ is \
147
+ provides \
148
+ specifies \
149
+ contains \
150
+ represents \
151
+ a \
152
+ an \
153
+ the
154
+
155
+ # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
156
+ # doxygen will generate a detailed section even if there is only a brief
157
+ # description.
158
+ # The default value is: NO.
159
+
160
+ ALWAYS_DETAILED_SEC = NO
161
+
162
+ # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
163
+ # inherited members of a class in the documentation of that class as if those
164
+ # members were ordinary class members. Constructors, destructors and assignment
165
+ # operators of the base classes will not be shown.
166
+ # The default value is: NO.
167
+
168
+ INLINE_INHERITED_MEMB = NO
169
+
170
+ # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
171
+ # before files name in the file list and in the header files. If set to NO the
172
+ # shortest path that makes the file name unique will be used
173
+ # The default value is: YES.
174
+
175
+ FULL_PATH_NAMES = NO
176
+
177
+ # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
178
+ # Stripping is only done if one of the specified strings matches the left-hand
179
+ # part of the path. The tag can be used to show relative paths in the file list.
180
+ # If left blank the directory from which doxygen is run is used as the path to
181
+ # strip.
182
+ #
183
+ # Note that you can specify absolute paths here, but also relative paths, which
184
+ # will be relative from the directory where doxygen is started.
185
+ # This tag requires that the tag FULL_PATH_NAMES is set to YES.
186
+
187
+ STRIP_FROM_PATH =
188
+
189
+ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
190
+ # path mentioned in the documentation of a class, which tells the reader which
191
+ # header file to include in order to use a class. If left blank only the name of
192
+ # the header file containing the class definition is used. Otherwise one should
193
+ # specify the list of include paths that are normally passed to the compiler
194
+ # using the -I flag.
195
+
196
+ STRIP_FROM_INC_PATH =
197
+
198
+ # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
199
+ # less readable) file names. This can be useful is your file systems doesn't
200
+ # support long names like on DOS, Mac, or CD-ROM.
201
+ # The default value is: NO.
202
+
203
+ SHORT_NAMES = NO
204
+
205
+ # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
206
+ # first line (until the first dot) of a Javadoc-style comment as the brief
207
+ # description. If set to NO, the Javadoc-style will behave just like regular Qt-
208
+ # style comments (thus requiring an explicit @brief command for a brief
209
+ # description.)
210
+ # The default value is: NO.
211
+
212
+ JAVADOC_AUTOBRIEF = NO
213
+
214
+ # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
215
+ # such as
216
+ # /***************
217
+ # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
218
+ # Javadoc-style will behave just like regular comments and it will not be
219
+ # interpreted by doxygen.
220
+ # The default value is: NO.
221
+
222
+ JAVADOC_BANNER = NO
223
+
224
+ # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
225
+ # line (until the first dot) of a Qt-style comment as the brief description. If
226
+ # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
227
+ # requiring an explicit \brief command for a brief description.)
228
+ # The default value is: NO.
229
+
230
+ QT_AUTOBRIEF = NO
231
+
232
+ # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
233
+ # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
234
+ # a brief description. This used to be the default behavior. The new default is
235
+ # to treat a multi-line C++ comment block as a detailed description. Set this
236
+ # tag to YES if you prefer the old behavior instead.
237
+ #
238
+ # Note that setting this tag to YES also means that rational rose comments are
239
+ # not recognized any more.
240
+ # The default value is: NO.
241
+
242
+ MULTILINE_CPP_IS_BRIEF = NO
243
+
244
+ # By default Python docstrings are displayed as preformatted text and doxygen's
245
+ # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
246
+ # doxygen's special commands can be used and the contents of the docstring
247
+ # documentation blocks is shown as doxygen documentation.
248
+ # The default value is: YES.
249
+
250
+ PYTHON_DOCSTRING = YES
251
+
252
+ # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
253
+ # documentation from any documented member that it re-implements.
254
+ # The default value is: YES.
255
+
256
+ INHERIT_DOCS = NO
257
+
258
+ # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
259
+ # page for each member. If set to NO, the documentation of a member will be part
260
+ # of the file/class/namespace that contains it.
261
+ # The default value is: NO.
262
+
263
+ SEPARATE_MEMBER_PAGES = NO
264
+
265
+ # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
266
+ # uses this value to replace tabs by spaces in code fragments.
267
+ # Minimum value: 1, maximum value: 16, default value: 4.
268
+
269
+ TAB_SIZE = 4
270
+
271
+ # This tag can be used to specify a number of aliases that act as commands in
272
+ # the documentation. An alias has the form:
273
+ # name=value
274
+ # For example adding
275
+ # "sideeffect=@par Side Effects:^^"
276
+ # will allow you to put the command \sideeffect (or @sideeffect) in the
277
+ # documentation, which will result in a user-defined paragraph with heading
278
+ # "Side Effects:". Note that you cannot put \n's in the value part of an alias
279
+ # to insert newlines (in the resulting output). You can put ^^ in the value part
280
+ # of an alias to insert a newline as if a physical newline was in the original
281
+ # file. When you need a literal { or } or , in the value part of an alias you
282
+ # have to escape them by means of a backslash (\), this can lead to conflicts
283
+ # with the commands \{ and \} for these it is advised to use the version @{ and
284
+ # @} or use a double escape (\\{ and \\})
285
+
286
+ ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \
287
+ endrst=\endverbatim
288
+
289
+ # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
290
+ # only. Doxygen will then generate output that is more tailored for C. For
291
+ # instance, some of the names that are used will be different. The list of all
292
+ # members will be omitted, etc.
293
+ # The default value is: NO.
294
+
295
+ OPTIMIZE_OUTPUT_FOR_C = YES
296
+
297
+ # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
298
+ # Python sources only. Doxygen will then generate output that is more tailored
299
+ # for that language. For instance, namespaces will be presented as packages,
300
+ # qualified scopes will look different, etc.
301
+ # The default value is: NO.
302
+
303
+ OPTIMIZE_OUTPUT_JAVA = NO
304
+
305
+ # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
306
+ # sources. Doxygen will then generate output that is tailored for Fortran.
307
+ # The default value is: NO.
308
+
309
+ OPTIMIZE_FOR_FORTRAN = NO
310
+
311
+ # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
312
+ # sources. Doxygen will then generate output that is tailored for VHDL.
313
+ # The default value is: NO.
314
+
315
+ OPTIMIZE_OUTPUT_VHDL = NO
316
+
317
+ # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
318
+ # sources only. Doxygen will then generate output that is more tailored for that
319
+ # language. For instance, namespaces will be presented as modules, types will be
320
+ # separated into more groups, etc.
321
+ # The default value is: NO.
322
+
323
+ OPTIMIZE_OUTPUT_SLICE = NO
324
+
325
+ # Doxygen selects the parser to use depending on the extension of the files it
326
+ # parses. With this tag you can assign which parser to use for a given
327
+ # extension. Doxygen has a built-in mapping, but you can override or extend it
328
+ # using this tag. The format is ext=language, where ext is a file extension, and
329
+ # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
330
+ # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
331
+ # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
332
+ # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
333
+ # tries to guess whether the code is fixed or free formatted code, this is the
334
+ # default for Fortran type files). For instance to make doxygen treat .inc files
335
+ # as Fortran files (default is PHP), and .f files as C (default is Fortran),
336
+ # use: inc=Fortran f=C.
337
+ #
338
+ # Note: For files without extension you can use no_extension as a placeholder.
339
+ #
340
+ # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
341
+ # the files are not read by doxygen. When specifying no_extension you should add
342
+ # * to the FILE_PATTERNS.
343
+ #
344
+ # Note see also the list of default file extension mappings.
345
+
346
+ EXTENSION_MAPPING =
347
+
348
+ # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
349
+ # according to the Markdown format, which allows for more readable
350
+ # documentation. See https://daringfireball.net/projects/markdown/ for details.
351
+ # The output of markdown processing is further processed by doxygen, so you can
352
+ # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
353
+ # case of backward compatibilities issues.
354
+ # The default value is: YES.
355
+
356
+ MARKDOWN_SUPPORT = YES
357
+
358
+ # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
359
+ # to that level are automatically included in the table of contents, even if
360
+ # they do not have an id attribute.
361
+ # Note: This feature currently applies only to Markdown headings.
362
+ # Minimum value: 0, maximum value: 99, default value: 5.
363
+ # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
364
+
365
+ TOC_INCLUDE_HEADINGS = 5
366
+
367
+ # The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
368
+ # generate identifiers for the Markdown headings. Note: Every identifier is
369
+ # unique.
370
+ # Possible values are: DOXYGEN Use a fixed 'autotoc_md' string followed by a
371
+ # sequence number starting at 0. and GITHUB Use the lower case version of title
372
+ # with any whitespace replaced by '-' and punctations characters removed..
373
+ # The default value is: DOXYGEN.
374
+ # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
375
+
376
+ MARKDOWN_ID_STYLE = DOXYGEN
377
+
378
+ # When enabled doxygen tries to link words that correspond to documented
379
+ # classes, or namespaces to their corresponding documentation. Such a link can
380
+ # be prevented in individual cases by putting a % sign in front of the word or
381
+ # globally by setting AUTOLINK_SUPPORT to NO.
382
+ # The default value is: YES.
383
+
384
+ AUTOLINK_SUPPORT = YES
385
+
386
+ # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
387
+ # to include (a tag file for) the STL sources as input, then you should set this
388
+ # tag to YES in order to let doxygen match functions declarations and
389
+ # definitions whose arguments contain STL classes (e.g. func(std::string);
390
+ # versus func(std::string) {}). This also make the inheritance and collaboration
391
+ # diagrams that involve STL classes more complete and accurate.
392
+ # The default value is: NO.
393
+
394
+ BUILTIN_STL_SUPPORT = NO
395
+
396
+ # If you use Microsoft's C++/CLI language, you should set this option to YES to
397
+ # enable parsing support.
398
+ # The default value is: NO.
399
+
400
+ CPP_CLI_SUPPORT = NO
401
+
402
+ # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
403
+ # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
404
+ # will parse them like normal C++ but will assume all classes use public instead
405
+ # of private inheritance when no explicit protection keyword is present.
406
+ # The default value is: NO.
407
+
408
+ SIP_SUPPORT = NO
409
+
410
+ # For Microsoft's IDL there are propget and propput attributes to indicate
411
+ # getter and setter methods for a property. Setting this option to YES will make
412
+ # doxygen to replace the get and set methods by a property in the documentation.
413
+ # This will only work if the methods are indeed getting or setting a simple
414
+ # type. If this is not the case, or you want to show the methods anyway, you
415
+ # should set this option to NO.
416
+ # The default value is: YES.
417
+
418
+ IDL_PROPERTY_SUPPORT = YES
419
+
420
+ # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
421
+ # tag is set to YES then doxygen will reuse the documentation of the first
422
+ # member in the group (if any) for the other members of the group. By default
423
+ # all members of a group must be documented explicitly.
424
+ # The default value is: NO.
425
+
426
+ DISTRIBUTE_GROUP_DOC = NO
427
+
428
+ # If one adds a struct or class to a group and this option is enabled, then also
429
+ # any nested class or struct is added to the same group. By default this option
430
+ # is disabled and one has to add nested compounds explicitly via \ingroup.
431
+ # The default value is: NO.
432
+
433
+ GROUP_NESTED_COMPOUNDS = NO
434
+
435
+ # Set the SUBGROUPING tag to YES to allow class member groups of the same type
436
+ # (for instance a group of public functions) to be put as a subgroup of that
437
+ # type (e.g. under the Public Functions section). Set it to NO to prevent
438
+ # subgrouping. Alternatively, this can be done per class using the
439
+ # \nosubgrouping command.
440
+ # The default value is: YES.
441
+
442
+ SUBGROUPING = YES
443
+
444
+ # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
445
+ # are shown inside the group in which they are included (e.g. using \ingroup)
446
+ # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
447
+ # and RTF).
448
+ #
449
+ # Note that this feature does not work in combination with
450
+ # SEPARATE_MEMBER_PAGES.
451
+ # The default value is: NO.
452
+
453
+ INLINE_GROUPED_CLASSES = NO
454
+
455
+ # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
456
+ # with only public data fields or simple typedef fields will be shown inline in
457
+ # the documentation of the scope in which they are defined (i.e. file,
458
+ # namespace, or group documentation), provided this scope is documented. If set
459
+ # to NO, structs, classes, and unions are shown on a separate page (for HTML and
460
+ # Man pages) or section (for LaTeX and RTF).
461
+ # The default value is: NO.
462
+
463
+ INLINE_SIMPLE_STRUCTS = NO
464
+
465
+ # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
466
+ # enum is documented as struct, union, or enum with the name of the typedef. So
467
+ # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
468
+ # with name TypeT. When disabled the typedef will appear as a member of a file,
469
+ # namespace, or class. And the struct will be named TypeS. This can typically be
470
+ # useful for C code in case the coding convention dictates that all compound
471
+ # types are typedef'ed and only the typedef is referenced, never the tag name.
472
+ # The default value is: NO.
473
+
474
+ TYPEDEF_HIDES_STRUCT = NO
475
+
476
+ # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
477
+ # cache is used to resolve symbols given their name and scope. Since this can be
478
+ # an expensive process and often the same symbol appears multiple times in the
479
+ # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
480
+ # doxygen will become slower. If the cache is too large, memory is wasted. The
481
+ # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
482
+ # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
483
+ # symbols. At the end of a run doxygen will report the cache usage and suggest
484
+ # the optimal cache size from a speed point of view.
485
+ # Minimum value: 0, maximum value: 9, default value: 0.
486
+
487
+ LOOKUP_CACHE_SIZE = 0
488
+
489
+ # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
490
+ # during processing. When set to 0 doxygen will based this on the number of
491
+ # cores available in the system. You can set it explicitly to a value larger
492
+ # than 0 to get more control over the balance between CPU load and processing
493
+ # speed. At this moment only the input processing can be done using multiple
494
+ # threads. Since this is still an experimental feature the default is set to 1,
495
+ # which effectively disables parallel processing. Please report any issues you
496
+ # encounter. Generating dot graphs in parallel is controlled by the
497
+ # DOT_NUM_THREADS setting.
498
+ # Minimum value: 0, maximum value: 32, default value: 1.
499
+
500
+ NUM_PROC_THREADS = 1
501
+
502
+ # If the TIMESTAMP tag is set different from NO then each generated page will
503
+ # contain the date or date and time when the page was generated. Setting this to
504
+ # NO can help when comparing the output of multiple runs.
505
+ # Possible values are: YES, NO, DATETIME and DATE.
506
+ # The default value is: NO.
507
+
508
+ TIMESTAMP = NO
509
+
510
+ #---------------------------------------------------------------------------
511
+ # Build related configuration options
512
+ #---------------------------------------------------------------------------
513
+
514
+ # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
515
+ # documentation are documented, even if no documentation was available. Private
516
+ # class members and static file members will be hidden unless the
517
+ # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
518
+ # Note: This will also disable the warnings about undocumented members that are
519
+ # normally produced when WARNINGS is set to YES.
520
+ # The default value is: NO.
521
+
522
+ EXTRACT_ALL = NO
523
+
524
+ # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
525
+ # be included in the documentation.
526
+ # The default value is: NO.
527
+
528
+ EXTRACT_PRIVATE = YES
529
+
530
+ # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
531
+ # methods of a class will be included in the documentation.
532
+ # The default value is: NO.
533
+
534
+ EXTRACT_PRIV_VIRTUAL = NO
535
+
536
+ # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
537
+ # scope will be included in the documentation.
538
+ # The default value is: NO.
539
+
540
+ EXTRACT_PACKAGE = NO
541
+
542
+ # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
543
+ # included in the documentation.
544
+ # The default value is: NO.
545
+
546
+ EXTRACT_STATIC = YES
547
+
548
+ # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
549
+ # locally in source files will be included in the documentation. If set to NO,
550
+ # only classes defined in header files are included. Does not have any effect
551
+ # for Java sources.
552
+ # The default value is: YES.
553
+
554
+ EXTRACT_LOCAL_CLASSES = YES
555
+
556
+ # This flag is only useful for Objective-C code. If set to YES, local methods,
557
+ # which are defined in the implementation section but not in the interface are
558
+ # included in the documentation. If set to NO, only methods in the interface are
559
+ # included.
560
+ # The default value is: NO.
561
+
562
+ EXTRACT_LOCAL_METHODS = NO
563
+
564
+ # If this flag is set to YES, the members of anonymous namespaces will be
565
+ # extracted and appear in the documentation as a namespace called
566
+ # 'anonymous_namespace{file}', where file will be replaced with the base name of
567
+ # the file that contains the anonymous namespace. By default anonymous namespace
568
+ # are hidden.
569
+ # The default value is: NO.
570
+
571
+ EXTRACT_ANON_NSPACES = NO
572
+
573
+ # If this flag is set to YES, the name of an unnamed parameter in a declaration
574
+ # will be determined by the corresponding definition. By default unnamed
575
+ # parameters remain unnamed in the output.
576
+ # The default value is: YES.
577
+
578
+ RESOLVE_UNNAMED_PARAMS = YES
579
+
580
+ # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
581
+ # undocumented members inside documented classes or files. If set to NO these
582
+ # members will be included in the various overviews, but no documentation
583
+ # section is generated. This option has no effect if EXTRACT_ALL is enabled.
584
+ # The default value is: NO.
585
+
586
+ HIDE_UNDOC_MEMBERS = YES
587
+
588
+ # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
589
+ # undocumented classes that are normally visible in the class hierarchy. If set
590
+ # to NO, these classes will be included in the various overviews. This option
591
+ # will also hide undocumented C++ concepts if enabled. This option has no effect
592
+ # if EXTRACT_ALL is enabled.
593
+ # The default value is: NO.
594
+
595
+ HIDE_UNDOC_CLASSES = YES
596
+
597
+ # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
598
+ # declarations. If set to NO, these declarations will be included in the
599
+ # documentation.
600
+ # The default value is: NO.
601
+
602
+ HIDE_FRIEND_COMPOUNDS = YES
603
+
604
+ # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
605
+ # documentation blocks found inside the body of a function. If set to NO, these
606
+ # blocks will be appended to the function's detailed documentation block.
607
+ # The default value is: NO.
608
+
609
+ HIDE_IN_BODY_DOCS = NO
610
+
611
+ # The INTERNAL_DOCS tag determines if documentation that is typed after a
612
+ # \internal command is included. If the tag is set to NO then the documentation
613
+ # will be excluded. Set it to YES to include the internal documentation.
614
+ # The default value is: NO.
615
+
616
+ INTERNAL_DOCS = NO
617
+
618
+ # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
619
+ # able to match the capabilities of the underlying filesystem. In case the
620
+ # filesystem is case sensitive (i.e. it supports files in the same directory
621
+ # whose names only differ in casing), the option must be set to YES to properly
622
+ # deal with such files in case they appear in the input. For filesystems that
623
+ # are not case sensitive the option should be set to NO to properly deal with
624
+ # output files written for symbols that only differ in casing, such as for two
625
+ # classes, one named CLASS and the other named Class, and to also support
626
+ # references to files without having to specify the exact matching casing. On
627
+ # Windows (including Cygwin) and MacOS, users should typically set this option
628
+ # to NO, whereas on Linux or other Unix flavors it should typically be set to
629
+ # YES.
630
+ # Possible values are: SYSTEM, NO and YES.
631
+ # The default value is: SYSTEM.
632
+
633
+ CASE_SENSE_NAMES = YES
634
+
635
+ # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
636
+ # their full class and namespace scopes in the documentation. If set to YES, the
637
+ # scope will be hidden.
638
+ # The default value is: NO.
639
+
640
+ HIDE_SCOPE_NAMES = NO
641
+
642
+ # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
643
+ # append additional text to a page's title, such as Class Reference. If set to
644
+ # YES the compound reference will be hidden.
645
+ # The default value is: NO.
646
+
647
+ HIDE_COMPOUND_REFERENCE= NO
648
+
649
+ # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
650
+ # will show which file needs to be included to use the class.
651
+ # The default value is: YES.
652
+
653
+ SHOW_HEADERFILE = YES
654
+
655
+ # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
656
+ # the files that are included by a file in the documentation of that file.
657
+ # The default value is: YES.
658
+
659
+ SHOW_INCLUDE_FILES = YES
660
+
661
+ # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
662
+ # grouped member an include statement to the documentation, telling the reader
663
+ # which file to include in order to use the member.
664
+ # The default value is: NO.
665
+
666
+ SHOW_GROUPED_MEMB_INC = NO
667
+
668
+ # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
669
+ # files with double quotes in the documentation rather than with sharp brackets.
670
+ # The default value is: NO.
671
+
672
+ FORCE_LOCAL_INCLUDES = NO
673
+
674
+ # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
675
+ # documentation for inline members.
676
+ # The default value is: YES.
677
+
678
+ INLINE_INFO = YES
679
+
680
+ # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
681
+ # (detailed) documentation of file and class members alphabetically by member
682
+ # name. If set to NO, the members will appear in declaration order.
683
+ # The default value is: YES.
684
+
685
+ SORT_MEMBER_DOCS = YES
686
+
687
+ # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
688
+ # descriptions of file, namespace and class members alphabetically by member
689
+ # name. If set to NO, the members will appear in declaration order. Note that
690
+ # this will also influence the order of the classes in the class list.
691
+ # The default value is: NO.
692
+
693
+ SORT_BRIEF_DOCS = NO
694
+
695
+ # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
696
+ # (brief and detailed) documentation of class members so that constructors and
697
+ # destructors are listed first. If set to NO the constructors will appear in the
698
+ # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
699
+ # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
700
+ # member documentation.
701
+ # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
702
+ # detailed member documentation.
703
+ # The default value is: NO.
704
+
705
+ SORT_MEMBERS_CTORS_1ST = NO
706
+
707
+ # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
708
+ # of group names into alphabetical order. If set to NO the group names will
709
+ # appear in their defined order.
710
+ # The default value is: NO.
711
+
712
+ SORT_GROUP_NAMES = NO
713
+
714
+ # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
715
+ # fully-qualified names, including namespaces. If set to NO, the class list will
716
+ # be sorted only by class name, not including the namespace part.
717
+ # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
718
+ # Note: This option applies only to the class list, not to the alphabetical
719
+ # list.
720
+ # The default value is: NO.
721
+
722
+ SORT_BY_SCOPE_NAME = NO
723
+
724
+ # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
725
+ # type resolution of all parameters of a function it will reject a match between
726
+ # the prototype and the implementation of a member function even if there is
727
+ # only one candidate or it is obvious which candidate to choose by doing a
728
+ # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
729
+ # accept a match between prototype and implementation in such cases.
730
+ # The default value is: NO.
731
+
732
+ STRICT_PROTO_MATCHING = NO
733
+
734
+ # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
735
+ # list. This list is created by putting \todo commands in the documentation.
736
+ # The default value is: YES.
737
+
738
+ GENERATE_TODOLIST = YES
739
+
740
+ # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
741
+ # list. This list is created by putting \test commands in the documentation.
742
+ # The default value is: YES.
743
+
744
+ GENERATE_TESTLIST = YES
745
+
746
+ # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
747
+ # list. This list is created by putting \bug commands in the documentation.
748
+ # The default value is: YES.
749
+
750
+ GENERATE_BUGLIST = YES
751
+
752
+ # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
753
+ # the deprecated list. This list is created by putting \deprecated commands in
754
+ # the documentation.
755
+ # The default value is: YES.
756
+
757
+ GENERATE_DEPRECATEDLIST= YES
758
+
759
+ # The ENABLED_SECTIONS tag can be used to enable conditional documentation
760
+ # sections, marked by \if <section_label> ... \endif and \cond <section_label>
761
+ # ... \endcond blocks.
762
+
763
+ ENABLED_SECTIONS =
764
+
765
+ # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
766
+ # initial value of a variable or macro / define can have for it to appear in the
767
+ # documentation. If the initializer consists of more lines than specified here
768
+ # it will be hidden. Use a value of 0 to hide initializers completely. The
769
+ # appearance of the value of individual variables and macros / defines can be
770
+ # controlled using \showinitializer or \hideinitializer command in the
771
+ # documentation regardless of this setting.
772
+ # Minimum value: 0, maximum value: 10000, default value: 30.
773
+
774
+ MAX_INITIALIZER_LINES = 30
775
+
776
+ # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
777
+ # the bottom of the documentation of classes and structs. If set to YES, the
778
+ # list will mention the files that were used to generate the documentation.
779
+ # The default value is: YES.
780
+
781
+ SHOW_USED_FILES = YES
782
+
783
+ # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
784
+ # will remove the Files entry from the Quick Index and from the Folder Tree View
785
+ # (if specified).
786
+ # The default value is: YES.
787
+
788
+ SHOW_FILES = YES
789
+
790
+ # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
791
+ # page. This will remove the Namespaces entry from the Quick Index and from the
792
+ # Folder Tree View (if specified).
793
+ # The default value is: YES.
794
+
795
+ SHOW_NAMESPACES = YES
796
+
797
+ # The FILE_VERSION_FILTER tag can be used to specify a program or script that
798
+ # doxygen should invoke to get the current version for each file (typically from
799
+ # the version control system). Doxygen will invoke the program by executing (via
800
+ # popen()) the command command input-file, where command is the value of the
801
+ # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
802
+ # by doxygen. Whatever the program writes to standard output is used as the file
803
+ # version. For an example see the documentation.
804
+
805
+ FILE_VERSION_FILTER =
806
+
807
+ # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
808
+ # by doxygen. The layout file controls the global structure of the generated
809
+ # output files in an output format independent way. To create the layout file
810
+ # that represents doxygen's defaults, run doxygen with the -l option. You can
811
+ # optionally specify a file name after the option, if omitted DoxygenLayout.xml
812
+ # will be used as the name of the layout file. See also section "Changing the
813
+ # layout of pages" for information.
814
+ #
815
+ # Note that if you run doxygen from a directory containing a file called
816
+ # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
817
+ # tag is left empty.
818
+
819
+ LAYOUT_FILE =
820
+
821
+ # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
822
+ # the reference definitions. This must be a list of .bib files. The .bib
823
+ # extension is automatically appended if omitted. This requires the bibtex tool
824
+ # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
825
+ # For LaTeX the style of the bibliography can be controlled using
826
+ # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
827
+ # search path. See also \cite for info how to create references.
828
+
829
+ CITE_BIB_FILES =
830
+
831
+ #---------------------------------------------------------------------------
832
+ # Configuration options related to warning and progress messages
833
+ #---------------------------------------------------------------------------
834
+
835
+ # The QUIET tag can be used to turn on/off the messages that are generated to
836
+ # standard output by doxygen. If QUIET is set to YES this implies that the
837
+ # messages are off.
838
+ # The default value is: NO.
839
+
840
+ QUIET = NO
841
+
842
+ # The WARNINGS tag can be used to turn on/off the warning messages that are
843
+ # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
844
+ # this implies that the warnings are on.
845
+ #
846
+ # Tip: Turn warnings on while writing the documentation.
847
+ # The default value is: YES.
848
+
849
+ WARNINGS = YES
850
+
851
+ # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
852
+ # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
853
+ # will automatically be disabled.
854
+ # The default value is: YES.
855
+
856
+ WARN_IF_UNDOCUMENTED = YES
857
+
858
+ # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
859
+ # potential errors in the documentation, such as documenting some parameters in
860
+ # a documented function twice, or documenting parameters that don't exist or
861
+ # using markup commands wrongly.
862
+ # The default value is: YES.
863
+
864
+ WARN_IF_DOC_ERROR = YES
865
+
866
+ # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
867
+ # function parameter documentation. If set to NO, doxygen will accept that some
868
+ # parameters have no documentation without warning.
869
+ # The default value is: YES.
870
+
871
+ WARN_IF_INCOMPLETE_DOC = YES
872
+
873
+ # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
874
+ # are documented, but have no documentation for their parameters or return
875
+ # value. If set to NO, doxygen will only warn about wrong parameter
876
+ # documentation, but not about the absence of documentation. If EXTRACT_ALL is
877
+ # set to YES then this flag will automatically be disabled. See also
878
+ # WARN_IF_INCOMPLETE_DOC
879
+ # The default value is: NO.
880
+
881
+ WARN_NO_PARAMDOC = NO
882
+
883
+ # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
884
+ # undocumented enumeration values. If set to NO, doxygen will accept
885
+ # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
886
+ # will automatically be disabled.
887
+ # The default value is: NO.
888
+
889
+ WARN_IF_UNDOC_ENUM_VAL = NO
890
+
891
+ # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
892
+ # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
893
+ # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
894
+ # at the end of the doxygen process doxygen will return with a non-zero status.
895
+ # If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves
896
+ # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
897
+ # write the warning messages in between other messages but write them at the end
898
+ # of a run, in case a WARN_LOGFILE is defined the warning messages will be
899
+ # besides being in the defined file also be shown at the end of a run, unless
900
+ # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
901
+ # the behavior will remain as with the setting FAIL_ON_WARNINGS.
902
+ # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
903
+ # The default value is: NO.
904
+
905
+ WARN_AS_ERROR = NO
906
+
907
+ # The WARN_FORMAT tag determines the format of the warning messages that doxygen
908
+ # can produce. The string should contain the $file, $line, and $text tags, which
909
+ # will be replaced by the file and line number from which the warning originated
910
+ # and the warning text. Optionally the format may contain $version, which will
911
+ # be replaced by the version of the file (if it could be obtained via
912
+ # FILE_VERSION_FILTER)
913
+ # See also: WARN_LINE_FORMAT
914
+ # The default value is: $file:$line: $text.
915
+
916
+ WARN_FORMAT = "$file:$line: $text"
917
+
918
+ # In the $text part of the WARN_FORMAT command it is possible that a reference
919
+ # to a more specific place is given. To make it easier to jump to this place
920
+ # (outside of doxygen) the user can define a custom "cut" / "paste" string.
921
+ # Example:
922
+ # WARN_LINE_FORMAT = "'vi $file +$line'"
923
+ # See also: WARN_FORMAT
924
+ # The default value is: at line $line of file $file.
925
+
926
+ WARN_LINE_FORMAT = "at line $line of file $file"
927
+
928
+ # The WARN_LOGFILE tag can be used to specify a file to which warning and error
929
+ # messages should be written. If left blank the output is written to standard
930
+ # error (stderr). In case the file specified cannot be opened for writing the
931
+ # warning and error messages are written to standard error. When as file - is
932
+ # specified the warning and error messages are written to standard output
933
+ # (stdout).
934
+
935
+ WARN_LOGFILE =
936
+
937
+ #---------------------------------------------------------------------------
938
+ # Configuration options related to the input files
939
+ #---------------------------------------------------------------------------
940
+
941
+ # The INPUT tag is used to specify the files and/or directories that contain
942
+ # documented source files. You may enter file names like myfile.cpp or
943
+ # directories like /usr/src/myproject. Separate the files or directories with
944
+ # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
945
+ # Note: If this tag is empty the current directory is searched.
946
+
947
+ INPUT = @DOXYGEN_INPUT@
948
+
949
+
950
+ # This tag can be used to specify the character encoding of the source files
951
+ # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
952
+ # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
953
+ # documentation (see:
954
+ # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
955
+ # See also: INPUT_FILE_ENCODING
956
+ # The default value is: UTF-8.
957
+
958
+ INPUT_ENCODING = UTF-8
959
+
960
+ # This tag can be used to specify the character encoding of the source files
961
+ # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
962
+ # character encoding on a per file pattern basis. Doxygen will compare the file
963
+ # name with each pattern and apply the encoding instead of the default
964
+ # INPUT_ENCODING) if there is a match. The character encodings are a list of the
965
+ # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
966
+ # "INPUT_ENCODING" for further information on supported encodings.
967
+
968
+ INPUT_FILE_ENCODING =
969
+
970
+ # If the value of the INPUT tag contains directories, you can use the
971
+ # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
972
+ # *.h) to filter out the source-files in the directories.
973
+ #
974
+ # Note that for custom extensions or not directly supported extensions you also
975
+ # need to set EXTENSION_MAPPING for the extension otherwise the files are not
976
+ # read by doxygen.
977
+ #
978
+ # Note the list of default checked file patterns might differ from the list of
979
+ # default file extension mappings.
980
+ #
981
+ # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
982
+ # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
983
+ # *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
984
+ # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
985
+ # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
986
+ # *.vhdl, *.ucf, *.qsf and *.ice.
987
+
988
+ FILE_PATTERNS = *.c \
989
+ *.cc \
990
+ *.cxx \
991
+ *.cpp \
992
+ *.c++ \
993
+ *.java \
994
+ *.ii \
995
+ *.ixx \
996
+ *.ipp \
997
+ *.i++ \
998
+ *.inl \
999
+ *.idl \
1000
+ *.ddl \
1001
+ *.odl \
1002
+ *.h \
1003
+ *.hh \
1004
+ *.hxx \
1005
+ *.hpp \
1006
+ *.h++ \
1007
+ *.cs \
1008
+ *.d \
1009
+ *.php \
1010
+ *.php4 \
1011
+ *.php5 \
1012
+ *.phtml \
1013
+ *.inc \
1014
+ *.m \
1015
+ *.markdown \
1016
+ *.md \
1017
+ *.mm \
1018
+ *.dox \
1019
+ *.doc \
1020
+ *.txt \
1021
+ *.py \
1022
+ *.pyw \
1023
+ *.f90 \
1024
+ *.f95 \
1025
+ *.f03 \
1026
+ *.f08 \
1027
+ *.f \
1028
+ *.for \
1029
+ *.tcl \
1030
+ *.vhd \
1031
+ *.vhdl \
1032
+ *.ucf \
1033
+ *.qsf \
1034
+ *.ice
1035
+
1036
+ # The RECURSIVE tag can be used to specify whether or not subdirectories should
1037
+ # be searched for input files as well.
1038
+ # The default value is: NO.
1039
+
1040
+ RECURSIVE = NO
1041
+
1042
+ # The EXCLUDE tag can be used to specify files and/or directories that should be
1043
+ # excluded from the INPUT source files. This way you can easily exclude a
1044
+ # subdirectory from a directory tree whose root is specified with the INPUT tag.
1045
+ #
1046
+ # Note that relative paths are relative to the directory from which doxygen is
1047
+ # run.
1048
+
1049
+ EXCLUDE =
1050
+
1051
+ # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1052
+ # directories that are symbolic links (a Unix file system feature) are excluded
1053
+ # from the input.
1054
+ # The default value is: NO.
1055
+
1056
+ EXCLUDE_SYMLINKS = NO
1057
+
1058
+ # If the value of the INPUT tag contains directories, you can use the
1059
+ # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1060
+ # certain files from those directories.
1061
+ #
1062
+ # Note that the wildcards are matched against the file with absolute path, so to
1063
+ # exclude all test directories for example use the pattern */test/*
1064
+
1065
+ EXCLUDE_PATTERNS =
1066
+
1067
+ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1068
+ # (namespaces, classes, functions, etc.) that should be excluded from the
1069
+ # output. The symbol name can be a fully qualified name, a word, or if the
1070
+ # wildcard * is used, a substring. Examples: ANamespace, AClass,
1071
+ # ANamespace::AClass, ANamespace::*Test
1072
+
1073
+ EXCLUDE_SYMBOLS =
1074
+
1075
+ # The EXAMPLE_PATH tag can be used to specify one or more files or directories
1076
+ # that contain example code fragments that are included (see the \include
1077
+ # command).
1078
+
1079
+ EXAMPLE_PATH =
1080
+
1081
+ # If the value of the EXAMPLE_PATH tag contains directories, you can use the
1082
+ # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1083
+ # *.h) to filter out the source-files in the directories. If left blank all
1084
+ # files are included.
1085
+
1086
+ EXAMPLE_PATTERNS = *
1087
+
1088
+ # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1089
+ # searched for input files to be used with the \include or \dontinclude commands
1090
+ # irrespective of the value of the RECURSIVE tag.
1091
+ # The default value is: NO.
1092
+
1093
+ EXAMPLE_RECURSIVE = NO
1094
+
1095
+ # The IMAGE_PATH tag can be used to specify one or more files or directories
1096
+ # that contain images that are to be included in the documentation (see the
1097
+ # \image command).
1098
+
1099
+ IMAGE_PATH =
1100
+
1101
+ # The INPUT_FILTER tag can be used to specify a program that doxygen should
1102
+ # invoke to filter for each input file. Doxygen will invoke the filter program
1103
+ # by executing (via popen()) the command:
1104
+ #
1105
+ # <filter> <input-file>
1106
+ #
1107
+ # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1108
+ # name of an input file. Doxygen will then use the output that the filter
1109
+ # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1110
+ # will be ignored.
1111
+ #
1112
+ # Note that the filter must not add or remove lines; it is applied before the
1113
+ # code is scanned, but not when the output code is generated. If lines are added
1114
+ # or removed, the anchors will not be placed correctly.
1115
+ #
1116
+ # Note that doxygen will use the data processed and written to standard output
1117
+ # for further processing, therefore nothing else, like debug statements or used
1118
+ # commands (so in case of a Windows batch file always use @echo OFF), should be
1119
+ # written to standard output.
1120
+ #
1121
+ # Note that for custom extensions or not directly supported extensions you also
1122
+ # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1123
+ # properly processed by doxygen.
1124
+
1125
+ INPUT_FILTER =
1126
+
1127
+ # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1128
+ # basis. Doxygen will compare the file name with each pattern and apply the
1129
+ # filter if there is a match. The filters are a list of the form: pattern=filter
1130
+ # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1131
+ # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1132
+ # patterns match the file name, INPUT_FILTER is applied.
1133
+ #
1134
+ # Note that for custom extensions or not directly supported extensions you also
1135
+ # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1136
+ # properly processed by doxygen.
1137
+
1138
+ FILTER_PATTERNS =
1139
+
1140
+ # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1141
+ # INPUT_FILTER) will also be used to filter the input files that are used for
1142
+ # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1143
+ # The default value is: NO.
1144
+
1145
+ FILTER_SOURCE_FILES = NO
1146
+
1147
+ # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1148
+ # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1149
+ # it is also possible to disable source filtering for a specific pattern using
1150
+ # *.ext= (so without naming a filter).
1151
+ # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1152
+
1153
+ FILTER_SOURCE_PATTERNS =
1154
+
1155
+ # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1156
+ # is part of the input, its contents will be placed on the main page
1157
+ # (index.html). This can be useful if you have a project on for instance GitHub
1158
+ # and want to reuse the introduction page also for the doxygen output.
1159
+
1160
+ USE_MDFILE_AS_MAINPAGE =
1161
+
1162
+ # The Fortran standard specifies that for fixed formatted Fortran code all
1163
+ # characters from position 72 are to be considered as comment. A common
1164
+ # extension is to allow longer lines before the automatic comment starts. The
1165
+ # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1166
+ # be processed before the automatic comment starts.
1167
+ # Minimum value: 7, maximum value: 10000, default value: 72.
1168
+
1169
+ FORTRAN_COMMENT_AFTER = 72
1170
+
1171
+ #---------------------------------------------------------------------------
1172
+ # Configuration options related to source browsing
1173
+ #---------------------------------------------------------------------------
1174
+
1175
+ # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1176
+ # generated. Documented entities will be cross-referenced with these sources.
1177
+ #
1178
+ # Note: To get rid of all source code in the generated output, make sure that
1179
+ # also VERBATIM_HEADERS is set to NO.
1180
+ # The default value is: NO.
1181
+
1182
+ SOURCE_BROWSER = YES
1183
+
1184
+ # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1185
+ # classes and enums directly into the documentation.
1186
+ # The default value is: NO.
1187
+
1188
+ INLINE_SOURCES = YES
1189
+
1190
+ # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1191
+ # special comment blocks from generated source code fragments. Normal C, C++ and
1192
+ # Fortran comments will always remain visible.
1193
+ # The default value is: YES.
1194
+
1195
+ STRIP_CODE_COMMENTS = YES
1196
+
1197
+ # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1198
+ # entity all documented functions referencing it will be listed.
1199
+ # The default value is: NO.
1200
+
1201
+ REFERENCED_BY_RELATION = NO
1202
+
1203
+ # If the REFERENCES_RELATION tag is set to YES then for each documented function
1204
+ # all documented entities called/used by that function will be listed.
1205
+ # The default value is: NO.
1206
+
1207
+ REFERENCES_RELATION = NO
1208
+
1209
+ # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1210
+ # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1211
+ # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1212
+ # link to the documentation.
1213
+ # The default value is: YES.
1214
+
1215
+ REFERENCES_LINK_SOURCE = YES
1216
+
1217
+ # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1218
+ # source code will show a tooltip with additional information such as prototype,
1219
+ # brief description and links to the definition and documentation. Since this
1220
+ # will make the HTML file larger and loading of large files a bit slower, you
1221
+ # can opt to disable this feature.
1222
+ # The default value is: YES.
1223
+ # This tag requires that the tag SOURCE_BROWSER is set to YES.
1224
+
1225
+ SOURCE_TOOLTIPS = YES
1226
+
1227
+ # If the USE_HTAGS tag is set to YES then the references to source code will
1228
+ # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1229
+ # source browser. The htags tool is part of GNU's global source tagging system
1230
+ # (see https://www.gnu.org/software/global/global.html). You will need version
1231
+ # 4.8.6 or higher.
1232
+ #
1233
+ # To use it do the following:
1234
+ # - Install the latest version of global
1235
+ # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1236
+ # - Make sure the INPUT points to the root of the source tree
1237
+ # - Run doxygen as normal
1238
+ #
1239
+ # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1240
+ # tools must be available from the command line (i.e. in the search path).
1241
+ #
1242
+ # The result: instead of the source browser generated by doxygen, the links to
1243
+ # source code will now point to the output of htags.
1244
+ # The default value is: NO.
1245
+ # This tag requires that the tag SOURCE_BROWSER is set to YES.
1246
+
1247
+ USE_HTAGS = NO
1248
+
1249
+ # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1250
+ # verbatim copy of the header file for each class for which an include is
1251
+ # specified. Set to NO to disable this.
1252
+ # See also: Section \class.
1253
+ # The default value is: YES.
1254
+
1255
+ VERBATIM_HEADERS = YES
1256
+
1257
+ #---------------------------------------------------------------------------
1258
+ # Configuration options related to the alphabetical class index
1259
+ #---------------------------------------------------------------------------
1260
+
1261
+ # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1262
+ # compounds will be generated. Enable this if the project contains a lot of
1263
+ # classes, structs, unions or interfaces.
1264
+ # The default value is: YES.
1265
+
1266
+ ALPHABETICAL_INDEX = YES
1267
+
1268
+ # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1269
+ # that should be ignored while generating the index headers. The IGNORE_PREFIX
1270
+ # tag works for classes, function and member names. The entity will be placed in
1271
+ # the alphabetical list under the first letter of the entity name that remains
1272
+ # after removing the prefix.
1273
+ # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1274
+
1275
+ IGNORE_PREFIX =
1276
+
1277
+ #---------------------------------------------------------------------------
1278
+ # Configuration options related to the HTML output
1279
+ #---------------------------------------------------------------------------
1280
+
1281
+ # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1282
+ # The default value is: YES.
1283
+
1284
+ GENERATE_HTML = YES
1285
+
1286
+ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1287
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1288
+ # it.
1289
+ # The default directory is: html.
1290
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1291
+
1292
+ HTML_OUTPUT = html
1293
+
1294
+ # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1295
+ # generated HTML page (for example: .htm, .php, .asp).
1296
+ # The default value is: .html.
1297
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1298
+
1299
+ HTML_FILE_EXTENSION = .html
1300
+
1301
+ # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1302
+ # each generated HTML page. If the tag is left blank doxygen will generate a
1303
+ # standard header.
1304
+ #
1305
+ # To get valid HTML the header file that includes any scripts and style sheets
1306
+ # that doxygen needs, which is dependent on the configuration options used (e.g.
1307
+ # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1308
+ # default header using
1309
+ # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1310
+ # YourConfigFile
1311
+ # and then modify the file new_header.html. See also section "Doxygen usage"
1312
+ # for information on how to generate the default header that doxygen normally
1313
+ # uses.
1314
+ # Note: The header is subject to change so you typically have to regenerate the
1315
+ # default header when upgrading to a newer version of doxygen. For a description
1316
+ # of the possible markers and block names see the documentation.
1317
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1318
+
1319
+ HTML_HEADER =
1320
+
1321
+ # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1322
+ # generated HTML page. If the tag is left blank doxygen will generate a standard
1323
+ # footer. See HTML_HEADER for more information on how to generate a default
1324
+ # footer and what special commands can be used inside the footer. See also
1325
+ # section "Doxygen usage" for information on how to generate the default footer
1326
+ # that doxygen normally uses.
1327
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1328
+
1329
+ HTML_FOOTER =
1330
+
1331
+ # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1332
+ # sheet that is used by each HTML page. It can be used to fine-tune the look of
1333
+ # the HTML output. If left blank doxygen will generate a default style sheet.
1334
+ # See also section "Doxygen usage" for information on how to generate the style
1335
+ # sheet that doxygen normally uses.
1336
+ # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1337
+ # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1338
+ # obsolete.
1339
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1340
+
1341
+ HTML_STYLESHEET =
1342
+
1343
+ # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1344
+ # cascading style sheets that are included after the standard style sheets
1345
+ # created by doxygen. Using this option one can overrule certain style aspects.
1346
+ # This is preferred over using HTML_STYLESHEET since it does not replace the
1347
+ # standard style sheet and is therefore more robust against future updates.
1348
+ # Doxygen will copy the style sheet files to the output directory.
1349
+ # Note: The order of the extra style sheet files is of importance (e.g. the last
1350
+ # style sheet in the list overrules the setting of the previous ones in the
1351
+ # list).
1352
+ # Note: Since the styling of scrollbars can currently not be overruled in
1353
+ # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1354
+ # one or more extra stylesheets have been specified. So if scrollbar
1355
+ # customization is desired it has to be added explicitly. For an example see the
1356
+ # documentation.
1357
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1358
+
1359
+ HTML_EXTRA_STYLESHEET = @DOXYGEN_AWESOME_PATH@/doxygen-awesome.css
1360
+
1361
+ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1362
+ # other source files which should be copied to the HTML output directory. Note
1363
+ # that these files will be copied to the base HTML output directory. Use the
1364
+ # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1365
+ # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1366
+ # files will be copied as-is; there are no commands or markers available.
1367
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1368
+
1369
+ HTML_EXTRA_FILES =
1370
+
1371
+ # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1372
+ # should be rendered with a dark or light theme.
1373
+ # Possible values are: LIGHT always generate light mode output, DARK always
1374
+ # generate dark mode output, AUTO_LIGHT automatically set the mode according to
1375
+ # the user preference, use light mode if no preference is set (the default),
1376
+ # AUTO_DARK automatically set the mode according to the user preference, use
1377
+ # dark mode if no preference is set and TOGGLE allow to user to switch between
1378
+ # light and dark mode via a button.
1379
+ # The default value is: AUTO_LIGHT.
1380
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1381
+
1382
+ HTML_COLORSTYLE = AUTO_LIGHT
1383
+
1384
+ # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1385
+ # will adjust the colors in the style sheet and background images according to
1386
+ # this color. Hue is specified as an angle on a color-wheel, see
1387
+ # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1388
+ # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1389
+ # purple, and 360 is red again.
1390
+ # Minimum value: 0, maximum value: 359, default value: 220.
1391
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1392
+
1393
+ HTML_COLORSTYLE_HUE = 220
1394
+
1395
+ # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1396
+ # in the HTML output. For a value of 0 the output will use gray-scales only. A
1397
+ # value of 255 will produce the most vivid colors.
1398
+ # Minimum value: 0, maximum value: 255, default value: 100.
1399
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1400
+
1401
+ HTML_COLORSTYLE_SAT = 100
1402
+
1403
+ # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1404
+ # luminance component of the colors in the HTML output. Values below 100
1405
+ # gradually make the output lighter, whereas values above 100 make the output
1406
+ # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1407
+ # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1408
+ # change the gamma.
1409
+ # Minimum value: 40, maximum value: 240, default value: 80.
1410
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1411
+
1412
+ HTML_COLORSTYLE_GAMMA = 80
1413
+
1414
+ # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1415
+ # documentation will contain a main index with vertical navigation menus that
1416
+ # are dynamically created via JavaScript. If disabled, the navigation index will
1417
+ # consists of multiple levels of tabs that are statically embedded in every HTML
1418
+ # page. Disable this option to support browsers that do not have JavaScript,
1419
+ # like the Qt help browser.
1420
+ # The default value is: YES.
1421
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1422
+
1423
+ HTML_DYNAMIC_MENUS = YES
1424
+
1425
+ # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1426
+ # documentation will contain sections that can be hidden and shown after the
1427
+ # page has loaded.
1428
+ # The default value is: NO.
1429
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1430
+
1431
+ HTML_DYNAMIC_SECTIONS = NO
1432
+
1433
+ # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1434
+ # shown in the various tree structured indices initially; the user can expand
1435
+ # and collapse entries dynamically later on. Doxygen will expand the tree to
1436
+ # such a level that at most the specified number of entries are visible (unless
1437
+ # a fully collapsed tree already exceeds this amount). So setting the number of
1438
+ # entries 1 will produce a full collapsed tree by default. 0 is a special value
1439
+ # representing an infinite number of entries and will result in a full expanded
1440
+ # tree by default.
1441
+ # Minimum value: 0, maximum value: 9999, default value: 100.
1442
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1443
+
1444
+ HTML_INDEX_NUM_ENTRIES = 100
1445
+
1446
+ # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1447
+ # generated that can be used as input for Apple's Xcode 3 integrated development
1448
+ # environment (see:
1449
+ # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1450
+ # create a documentation set, doxygen will generate a Makefile in the HTML
1451
+ # output directory. Running make will produce the docset in that directory and
1452
+ # running make install will install the docset in
1453
+ # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1454
+ # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1455
+ # genXcode/_index.html for more information.
1456
+ # The default value is: NO.
1457
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1458
+
1459
+ GENERATE_DOCSET = NO
1460
+
1461
+ # This tag determines the name of the docset feed. A documentation feed provides
1462
+ # an umbrella under which multiple documentation sets from a single provider
1463
+ # (such as a company or product suite) can be grouped.
1464
+ # The default value is: Doxygen generated docs.
1465
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1466
+
1467
+ DOCSET_FEEDNAME = "Doxygen generated docs"
1468
+
1469
+ # This tag determines the URL of the docset feed. A documentation feed provides
1470
+ # an umbrella under which multiple documentation sets from a single provider
1471
+ # (such as a company or product suite) can be grouped.
1472
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1473
+
1474
+ DOCSET_FEEDURL =
1475
+
1476
+ # This tag specifies a string that should uniquely identify the documentation
1477
+ # set bundle. This should be a reverse domain-name style string, e.g.
1478
+ # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1479
+ # The default value is: org.doxygen.Project.
1480
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1481
+
1482
+ DOCSET_BUNDLE_ID = org.doxygen.Project
1483
+
1484
+ # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1485
+ # the documentation publisher. This should be a reverse domain-name style
1486
+ # string, e.g. com.mycompany.MyDocSet.documentation.
1487
+ # The default value is: org.doxygen.Publisher.
1488
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1489
+
1490
+ DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1491
+
1492
+ # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1493
+ # The default value is: Publisher.
1494
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1495
+
1496
+ DOCSET_PUBLISHER_NAME = Publisher
1497
+
1498
+ # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1499
+ # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1500
+ # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1501
+ # on Windows. In the beginning of 2021 Microsoft took the original page, with
1502
+ # a.o. the download links, offline the HTML help workshop was already many years
1503
+ # in maintenance mode). You can download the HTML help workshop from the web
1504
+ # archives at Installation executable (see:
1505
+ # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
1506
+ # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1507
+ #
1508
+ # The HTML Help Workshop contains a compiler that can convert all HTML output
1509
+ # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1510
+ # files are now used as the Windows 98 help format, and will replace the old
1511
+ # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1512
+ # HTML files also contain an index, a table of contents, and you can search for
1513
+ # words in the documentation. The HTML workshop also contains a viewer for
1514
+ # compressed HTML files.
1515
+ # The default value is: NO.
1516
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1517
+
1518
+ GENERATE_HTMLHELP = NO
1519
+
1520
+ # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1521
+ # file. You can add a path in front of the file if the result should not be
1522
+ # written to the html output directory.
1523
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1524
+
1525
+ CHM_FILE =
1526
+
1527
+ # The HHC_LOCATION tag can be used to specify the location (absolute path
1528
+ # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1529
+ # doxygen will try to run the HTML help compiler on the generated index.hhp.
1530
+ # The file has to be specified with full path.
1531
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1532
+
1533
+ HHC_LOCATION =
1534
+
1535
+ # The GENERATE_CHI flag controls if a separate .chi index file is generated
1536
+ # (YES) or that it should be included in the main .chm file (NO).
1537
+ # The default value is: NO.
1538
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1539
+
1540
+ GENERATE_CHI = NO
1541
+
1542
+ # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1543
+ # and project file content.
1544
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1545
+
1546
+ CHM_INDEX_ENCODING =
1547
+
1548
+ # The BINARY_TOC flag controls whether a binary table of contents is generated
1549
+ # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1550
+ # enables the Previous and Next buttons.
1551
+ # The default value is: NO.
1552
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1553
+
1554
+ BINARY_TOC = NO
1555
+
1556
+ # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1557
+ # the table of contents of the HTML help documentation and to the tree view.
1558
+ # The default value is: NO.
1559
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1560
+
1561
+ TOC_EXPAND = NO
1562
+
1563
+ # The SITEMAP_URL tag is used to specify the full URL of the place where the
1564
+ # generated documentation will be placed on the server by the user during the
1565
+ # deployment of the documentation. The generated sitemap is called sitemap.xml
1566
+ # and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
1567
+ # is specified no sitemap is generated. For information about the sitemap
1568
+ # protocol see https://www.sitemaps.org
1569
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1570
+
1571
+ SITEMAP_URL =
1572
+
1573
+ # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1574
+ # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1575
+ # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1576
+ # (.qch) of the generated HTML documentation.
1577
+ # The default value is: NO.
1578
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1579
+
1580
+ GENERATE_QHP = NO
1581
+
1582
+ # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1583
+ # the file name of the resulting .qch file. The path specified is relative to
1584
+ # the HTML output folder.
1585
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1586
+
1587
+ QCH_FILE =
1588
+
1589
+ # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1590
+ # Project output. For more information please see Qt Help Project / Namespace
1591
+ # (see:
1592
+ # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1593
+ # The default value is: org.doxygen.Project.
1594
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1595
+
1596
+ QHP_NAMESPACE = org.doxygen.Project
1597
+
1598
+ # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1599
+ # Help Project output. For more information please see Qt Help Project / Virtual
1600
+ # Folders (see:
1601
+ # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1602
+ # The default value is: doc.
1603
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1604
+
1605
+ QHP_VIRTUAL_FOLDER = doc
1606
+
1607
+ # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1608
+ # filter to add. For more information please see Qt Help Project / Custom
1609
+ # Filters (see:
1610
+ # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1611
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1612
+
1613
+ QHP_CUST_FILTER_NAME =
1614
+
1615
+ # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1616
+ # custom filter to add. For more information please see Qt Help Project / Custom
1617
+ # Filters (see:
1618
+ # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1619
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1620
+
1621
+ QHP_CUST_FILTER_ATTRS =
1622
+
1623
+ # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1624
+ # project's filter section matches. Qt Help Project / Filter Attributes (see:
1625
+ # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1626
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1627
+
1628
+ QHP_SECT_FILTER_ATTRS =
1629
+
1630
+ # The QHG_LOCATION tag can be used to specify the location (absolute path
1631
+ # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1632
+ # run qhelpgenerator on the generated .qhp file.
1633
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1634
+
1635
+ QHG_LOCATION =
1636
+
1637
+ # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1638
+ # generated, together with the HTML files, they form an Eclipse help plugin. To
1639
+ # install this plugin and make it available under the help contents menu in
1640
+ # Eclipse, the contents of the directory containing the HTML and XML files needs
1641
+ # to be copied into the plugins directory of eclipse. The name of the directory
1642
+ # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1643
+ # After copying Eclipse needs to be restarted before the help appears.
1644
+ # The default value is: NO.
1645
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1646
+
1647
+ GENERATE_ECLIPSEHELP = NO
1648
+
1649
+ # A unique identifier for the Eclipse help plugin. When installing the plugin
1650
+ # the directory name containing the HTML and XML files should also have this
1651
+ # name. Each documentation set should have its own identifier.
1652
+ # The default value is: org.doxygen.Project.
1653
+ # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1654
+
1655
+ ECLIPSE_DOC_ID = org.doxygen.Project
1656
+
1657
+ # If you want full control over the layout of the generated HTML pages it might
1658
+ # be necessary to disable the index and replace it with your own. The
1659
+ # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1660
+ # of each HTML page. A value of NO enables the index and the value YES disables
1661
+ # it. Since the tabs in the index contain the same information as the navigation
1662
+ # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1663
+ # The default value is: NO.
1664
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1665
+
1666
+ DISABLE_INDEX = NO
1667
+
1668
+ # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1669
+ # structure should be generated to display hierarchical information. If the tag
1670
+ # value is set to YES, a side panel will be generated containing a tree-like
1671
+ # index structure (just like the one that is generated for HTML Help). For this
1672
+ # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1673
+ # (i.e. any modern browser). Windows users are probably better off using the
1674
+ # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1675
+ # further fine tune the look of the index (see "Fine-tuning the output"). As an
1676
+ # example, the default style sheet generated by doxygen has an example that
1677
+ # shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1678
+ # Since the tree basically has the same information as the tab index, you could
1679
+ # consider setting DISABLE_INDEX to YES when enabling this option.
1680
+ # The default value is: NO.
1681
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1682
+
1683
+ GENERATE_TREEVIEW = NO
1684
+
1685
+ # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1686
+ # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1687
+ # area (value NO) or if it should extend to the full height of the window (value
1688
+ # YES). Setting this to YES gives a layout similar to
1689
+ # https://docs.readthedocs.io with more room for contents, but less room for the
1690
+ # project logo, title, and description. If either GENERATE_TREEVIEW or
1691
+ # DISABLE_INDEX is set to NO, this option has no effect.
1692
+ # The default value is: NO.
1693
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1694
+
1695
+ FULL_SIDEBAR = NO
1696
+
1697
+ # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1698
+ # doxygen will group on one line in the generated HTML documentation.
1699
+ #
1700
+ # Note that a value of 0 will completely suppress the enum values from appearing
1701
+ # in the overview section.
1702
+ # Minimum value: 0, maximum value: 20, default value: 4.
1703
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1704
+
1705
+ ENUM_VALUES_PER_LINE = 4
1706
+
1707
+ # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1708
+ # to set the initial width (in pixels) of the frame in which the tree is shown.
1709
+ # Minimum value: 0, maximum value: 1500, default value: 250.
1710
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1711
+
1712
+ TREEVIEW_WIDTH = 250
1713
+
1714
+ # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1715
+ # external symbols imported via tag files in a separate window.
1716
+ # The default value is: NO.
1717
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1718
+
1719
+ EXT_LINKS_IN_WINDOW = NO
1720
+
1721
+ # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1722
+ # addresses.
1723
+ # The default value is: YES.
1724
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1725
+
1726
+ OBFUSCATE_EMAILS = YES
1727
+
1728
+ # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1729
+ # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1730
+ # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1731
+ # the HTML output. These images will generally look nicer at scaled resolutions.
1732
+ # Possible values are: png (the default) and svg (looks nicer but requires the
1733
+ # pdf2svg or inkscape tool).
1734
+ # The default value is: png.
1735
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1736
+
1737
+ HTML_FORMULA_FORMAT = png
1738
+
1739
+ # Use this tag to change the font size of LaTeX formulas included as images in
1740
+ # the HTML documentation. When you change the font size after a successful
1741
+ # doxygen run you need to manually remove any form_*.png images from the HTML
1742
+ # output directory to force them to be regenerated.
1743
+ # Minimum value: 8, maximum value: 50, default value: 10.
1744
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1745
+
1746
+ FORMULA_FONTSIZE = 10
1747
+
1748
+ # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1749
+ # to create new LaTeX commands to be used in formulas as building blocks. See
1750
+ # the section "Including formulas" for details.
1751
+
1752
+ FORMULA_MACROFILE =
1753
+
1754
+ # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1755
+ # https://www.mathjax.org) which uses client side JavaScript for the rendering
1756
+ # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1757
+ # installed or if you want to formulas look prettier in the HTML output. When
1758
+ # enabled you may also need to install MathJax separately and configure the path
1759
+ # to it using the MATHJAX_RELPATH option.
1760
+ # The default value is: NO.
1761
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1762
+
1763
+ USE_MATHJAX = NO
1764
+
1765
+ # With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1766
+ # Note that the different versions of MathJax have different requirements with
1767
+ # regards to the different settings, so it is possible that also other MathJax
1768
+ # settings have to be changed when switching between the different MathJax
1769
+ # versions.
1770
+ # Possible values are: MathJax_2 and MathJax_3.
1771
+ # The default value is: MathJax_2.
1772
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1773
+
1774
+ MATHJAX_VERSION = MathJax_2
1775
+
1776
+ # When MathJax is enabled you can set the default output format to be used for
1777
+ # the MathJax output. For more details about the output format see MathJax
1778
+ # version 2 (see:
1779
+ # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1780
+ # (see:
1781
+ # http://docs.mathjax.org/en/latest/web/components/output.html).
1782
+ # Possible values are: HTML-CSS (which is slower, but has the best
1783
+ # compatibility. This is the name for Mathjax version 2, for MathJax version 3
1784
+ # this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1785
+ # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1786
+ # is the name for Mathjax version 3, for MathJax version 2 this will be
1787
+ # translated into HTML-CSS) and SVG.
1788
+ # The default value is: HTML-CSS.
1789
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1790
+
1791
+ MATHJAX_FORMAT = HTML-CSS
1792
+
1793
+ # When MathJax is enabled you need to specify the location relative to the HTML
1794
+ # output directory using the MATHJAX_RELPATH option. The destination directory
1795
+ # should contain the MathJax.js script. For instance, if the mathjax directory
1796
+ # is located at the same level as the HTML output directory, then
1797
+ # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1798
+ # Content Delivery Network so you can quickly see the result without installing
1799
+ # MathJax. However, it is strongly recommended to install a local copy of
1800
+ # MathJax from https://www.mathjax.org before deployment. The default value is:
1801
+ # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1802
+ # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1803
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1804
+
1805
+ MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
1806
+
1807
+ # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1808
+ # extension names that should be enabled during MathJax rendering. For example
1809
+ # for MathJax version 2 (see
1810
+ # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1811
+ # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1812
+ # For example for MathJax version 3 (see
1813
+ # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
1814
+ # MATHJAX_EXTENSIONS = ams
1815
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1816
+
1817
+ MATHJAX_EXTENSIONS =
1818
+
1819
+ # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1820
+ # of code that will be used on startup of the MathJax code. See the MathJax site
1821
+ # (see:
1822
+ # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1823
+ # example see the documentation.
1824
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1825
+
1826
+ MATHJAX_CODEFILE =
1827
+
1828
+ # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1829
+ # the HTML output. The underlying search engine uses javascript and DHTML and
1830
+ # should work on any modern browser. Note that when using HTML help
1831
+ # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1832
+ # there is already a search function so this one should typically be disabled.
1833
+ # For large projects the javascript based search engine can be slow, then
1834
+ # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1835
+ # search using the keyboard; to jump to the search box use <access key> + S
1836
+ # (what the <access key> is depends on the OS and browser, but it is typically
1837
+ # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1838
+ # key> to jump into the search results window, the results can be navigated
1839
+ # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1840
+ # the search. The filter options can be selected when the cursor is inside the
1841
+ # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1842
+ # to select a filter and <Enter> or <escape> to activate or cancel the filter
1843
+ # option.
1844
+ # The default value is: YES.
1845
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1846
+
1847
+ SEARCHENGINE = NO
1848
+
1849
+ # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1850
+ # implemented using a web server instead of a web client using JavaScript. There
1851
+ # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1852
+ # setting. When disabled, doxygen will generate a PHP script for searching and
1853
+ # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1854
+ # and searching needs to be provided by external tools. See the section
1855
+ # "External Indexing and Searching" for details.
1856
+ # The default value is: NO.
1857
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1858
+
1859
+ SERVER_BASED_SEARCH = NO
1860
+
1861
+ # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1862
+ # script for searching. Instead the search results are written to an XML file
1863
+ # which needs to be processed by an external indexer. Doxygen will invoke an
1864
+ # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1865
+ # search results.
1866
+ #
1867
+ # Doxygen ships with an example indexer (doxyindexer) and search engine
1868
+ # (doxysearch.cgi) which are based on the open source search engine library
1869
+ # Xapian (see:
1870
+ # https://xapian.org/).
1871
+ #
1872
+ # See the section "External Indexing and Searching" for details.
1873
+ # The default value is: NO.
1874
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1875
+
1876
+ EXTERNAL_SEARCH = NO
1877
+
1878
+ # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1879
+ # which will return the search results when EXTERNAL_SEARCH is enabled.
1880
+ #
1881
+ # Doxygen ships with an example indexer (doxyindexer) and search engine
1882
+ # (doxysearch.cgi) which are based on the open source search engine library
1883
+ # Xapian (see:
1884
+ # https://xapian.org/). See the section "External Indexing and Searching" for
1885
+ # details.
1886
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1887
+
1888
+ SEARCHENGINE_URL =
1889
+
1890
+ # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1891
+ # search data is written to a file for indexing by an external tool. With the
1892
+ # SEARCHDATA_FILE tag the name of this file can be specified.
1893
+ # The default file is: searchdata.xml.
1894
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1895
+
1896
+ SEARCHDATA_FILE = searchdata.xml
1897
+
1898
+ # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1899
+ # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1900
+ # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1901
+ # projects and redirect the results back to the right project.
1902
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1903
+
1904
+ EXTERNAL_SEARCH_ID =
1905
+
1906
+ # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1907
+ # projects other than the one defined by this configuration file, but that are
1908
+ # all added to the same external search index. Each project needs to have a
1909
+ # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1910
+ # to a relative location where the documentation can be found. The format is:
1911
+ # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1912
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1913
+
1914
+ EXTRA_SEARCH_MAPPINGS =
1915
+
1916
+ #---------------------------------------------------------------------------
1917
+ # Configuration options related to the LaTeX output
1918
+ #---------------------------------------------------------------------------
1919
+
1920
+ # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1921
+ # The default value is: YES.
1922
+
1923
+ GENERATE_LATEX = NO
1924
+
1925
+ # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1926
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1927
+ # it.
1928
+ # The default directory is: latex.
1929
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1930
+
1931
+ LATEX_OUTPUT = latex
1932
+
1933
+ # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1934
+ # invoked.
1935
+ #
1936
+ # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1937
+ # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1938
+ # chosen this is overwritten by pdflatex. For specific output languages the
1939
+ # default can have been set differently, this depends on the implementation of
1940
+ # the output language.
1941
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1942
+
1943
+ LATEX_CMD_NAME =
1944
+
1945
+ # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1946
+ # index for LaTeX.
1947
+ # Note: This tag is used in the Makefile / make.bat.
1948
+ # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1949
+ # (.tex).
1950
+ # The default file is: makeindex.
1951
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1952
+
1953
+ MAKEINDEX_CMD_NAME = makeindex
1954
+
1955
+ # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1956
+ # generate index for LaTeX. In case there is no backslash (\) as first character
1957
+ # it will be automatically added in the LaTeX code.
1958
+ # Note: This tag is used in the generated output file (.tex).
1959
+ # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1960
+ # The default value is: makeindex.
1961
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1962
+
1963
+ LATEX_MAKEINDEX_CMD = makeindex
1964
+
1965
+ # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1966
+ # documents. This may be useful for small projects and may help to save some
1967
+ # trees in general.
1968
+ # The default value is: NO.
1969
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1970
+
1971
+ COMPACT_LATEX = NO
1972
+
1973
+ # The PAPER_TYPE tag can be used to set the paper type that is used by the
1974
+ # printer.
1975
+ # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1976
+ # 14 inches) and executive (7.25 x 10.5 inches).
1977
+ # The default value is: a4.
1978
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1979
+
1980
+ PAPER_TYPE = a4
1981
+
1982
+ # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1983
+ # that should be included in the LaTeX output. The package can be specified just
1984
+ # by its name or with the correct syntax as to be used with the LaTeX
1985
+ # \usepackage command. To get the times font for instance you can specify :
1986
+ # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1987
+ # To use the option intlimits with the amsmath package you can specify:
1988
+ # EXTRA_PACKAGES=[intlimits]{amsmath}
1989
+ # If left blank no extra packages will be included.
1990
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1991
+
1992
+ EXTRA_PACKAGES =
1993
+
1994
+ # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
1995
+ # the generated LaTeX document. The header should contain everything until the
1996
+ # first chapter. If it is left blank doxygen will generate a standard header. It
1997
+ # is highly recommended to start with a default header using
1998
+ # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
1999
+ # and then modify the file new_header.tex. See also section "Doxygen usage" for
2000
+ # information on how to generate the default header that doxygen normally uses.
2001
+ #
2002
+ # Note: Only use a user-defined header if you know what you are doing!
2003
+ # Note: The header is subject to change so you typically have to regenerate the
2004
+ # default header when upgrading to a newer version of doxygen. The following
2005
+ # commands have a special meaning inside the header (and footer): For a
2006
+ # description of the possible markers and block names see the documentation.
2007
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2008
+
2009
+ LATEX_HEADER =
2010
+
2011
+ # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2012
+ # the generated LaTeX document. The footer should contain everything after the
2013
+ # last chapter. If it is left blank doxygen will generate a standard footer. See
2014
+ # LATEX_HEADER for more information on how to generate a default footer and what
2015
+ # special commands can be used inside the footer. See also section "Doxygen
2016
+ # usage" for information on how to generate the default footer that doxygen
2017
+ # normally uses. Note: Only use a user-defined footer if you know what you are
2018
+ # doing!
2019
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2020
+
2021
+ LATEX_FOOTER =
2022
+
2023
+ # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2024
+ # LaTeX style sheets that are included after the standard style sheets created
2025
+ # by doxygen. Using this option one can overrule certain style aspects. Doxygen
2026
+ # will copy the style sheet files to the output directory.
2027
+ # Note: The order of the extra style sheet files is of importance (e.g. the last
2028
+ # style sheet in the list overrules the setting of the previous ones in the
2029
+ # list).
2030
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2031
+
2032
+ LATEX_EXTRA_STYLESHEET =
2033
+
2034
+ # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2035
+ # other source files which should be copied to the LATEX_OUTPUT output
2036
+ # directory. Note that the files will be copied as-is; there are no commands or
2037
+ # markers available.
2038
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2039
+
2040
+ LATEX_EXTRA_FILES =
2041
+
2042
+ # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2043
+ # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2044
+ # contain links (just like the HTML output) instead of page references. This
2045
+ # makes the output suitable for online browsing using a PDF viewer.
2046
+ # The default value is: YES.
2047
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2048
+
2049
+ PDF_HYPERLINKS = YES
2050
+
2051
+ # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2052
+ # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2053
+ # files. Set this option to YES, to get a higher quality PDF documentation.
2054
+ #
2055
+ # See also section LATEX_CMD_NAME for selecting the engine.
2056
+ # The default value is: YES.
2057
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2058
+
2059
+ USE_PDFLATEX = YES
2060
+
2061
+ # The LATEX_BATCHMODE tag ignals the behavior of LaTeX in case of an error.
2062
+ # Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
2063
+ # mode nothing is printed on the terminal, errors are scrolled as if <return> is
2064
+ # hit at every error; missing files that TeX tries to input or request from
2065
+ # keyboard input (\read on a not open input stream) cause the job to abort,
2066
+ # NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2067
+ # but there is no possibility of user interaction just like in batch mode,
2068
+ # SCROLL In scroll mode, TeX will stop only for missing files to input or if
2069
+ # keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2070
+ # each error, asking for user intervention.
2071
+ # The default value is: NO.
2072
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2073
+
2074
+ LATEX_BATCHMODE = NO
2075
+
2076
+ # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2077
+ # index chapters (such as File Index, Compound Index, etc.) in the output.
2078
+ # The default value is: NO.
2079
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2080
+
2081
+ LATEX_HIDE_INDICES = NO
2082
+
2083
+ # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2084
+ # bibliography, e.g. plainnat, or ieeetr. See
2085
+ # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2086
+ # The default value is: plain.
2087
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2088
+
2089
+ LATEX_BIB_STYLE = plain
2090
+
2091
+ # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2092
+ # path from which the emoji images will be read. If a relative path is entered,
2093
+ # it will be relative to the LATEX_OUTPUT directory. If left blank the
2094
+ # LATEX_OUTPUT directory will be used.
2095
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2096
+
2097
+ LATEX_EMOJI_DIRECTORY =
2098
+
2099
+ #---------------------------------------------------------------------------
2100
+ # Configuration options related to the RTF output
2101
+ #---------------------------------------------------------------------------
2102
+
2103
+ # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2104
+ # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2105
+ # readers/editors.
2106
+ # The default value is: NO.
2107
+
2108
+ GENERATE_RTF = NO
2109
+
2110
+ # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2111
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2112
+ # it.
2113
+ # The default directory is: rtf.
2114
+ # This tag requires that the tag GENERATE_RTF is set to YES.
2115
+
2116
+ RTF_OUTPUT = rtf
2117
+
2118
+ # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2119
+ # documents. This may be useful for small projects and may help to save some
2120
+ # trees in general.
2121
+ # The default value is: NO.
2122
+ # This tag requires that the tag GENERATE_RTF is set to YES.
2123
+
2124
+ COMPACT_RTF = NO
2125
+
2126
+ # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2127
+ # contain hyperlink fields. The RTF file will contain links (just like the HTML
2128
+ # output) instead of page references. This makes the output suitable for online
2129
+ # browsing using Word or some other Word compatible readers that support those
2130
+ # fields.
2131
+ #
2132
+ # Note: WordPad (write) and others do not support links.
2133
+ # The default value is: NO.
2134
+ # This tag requires that the tag GENERATE_RTF is set to YES.
2135
+
2136
+ RTF_HYPERLINKS = NO
2137
+
2138
+ # Load stylesheet definitions from file. Syntax is similar to doxygen's
2139
+ # configuration file, i.e. a series of assignments. You only have to provide
2140
+ # replacements, missing definitions are set to their default value.
2141
+ #
2142
+ # See also section "Doxygen usage" for information on how to generate the
2143
+ # default style sheet that doxygen normally uses.
2144
+ # This tag requires that the tag GENERATE_RTF is set to YES.
2145
+
2146
+ RTF_STYLESHEET_FILE =
2147
+
2148
+ # Set optional variables used in the generation of an RTF document. Syntax is
2149
+ # similar to doxygen's configuration file. A template extensions file can be
2150
+ # generated using doxygen -e rtf extensionFile.
2151
+ # This tag requires that the tag GENERATE_RTF is set to YES.
2152
+
2153
+ RTF_EXTENSIONS_FILE =
2154
+
2155
+ #---------------------------------------------------------------------------
2156
+ # Configuration options related to the man page output
2157
+ #---------------------------------------------------------------------------
2158
+
2159
+ # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2160
+ # classes and files.
2161
+ # The default value is: NO.
2162
+
2163
+ GENERATE_MAN = NO
2164
+
2165
+ # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2166
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2167
+ # it. A directory man3 will be created inside the directory specified by
2168
+ # MAN_OUTPUT.
2169
+ # The default directory is: man.
2170
+ # This tag requires that the tag GENERATE_MAN is set to YES.
2171
+
2172
+ MAN_OUTPUT = man
2173
+
2174
+ # The MAN_EXTENSION tag determines the extension that is added to the generated
2175
+ # man pages. In case the manual section does not start with a number, the number
2176
+ # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2177
+ # optional.
2178
+ # The default value is: .3.
2179
+ # This tag requires that the tag GENERATE_MAN is set to YES.
2180
+
2181
+ MAN_EXTENSION = .3
2182
+
2183
+ # The MAN_SUBDIR tag determines the name of the directory created within
2184
+ # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2185
+ # MAN_EXTENSION with the initial . removed.
2186
+ # This tag requires that the tag GENERATE_MAN is set to YES.
2187
+
2188
+ MAN_SUBDIR =
2189
+
2190
+ # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2191
+ # will generate one additional man file for each entity documented in the real
2192
+ # man page(s). These additional files only source the real man page, but without
2193
+ # them the man command would be unable to find the correct page.
2194
+ # The default value is: NO.
2195
+ # This tag requires that the tag GENERATE_MAN is set to YES.
2196
+
2197
+ MAN_LINKS = NO
2198
+
2199
+ #---------------------------------------------------------------------------
2200
+ # Configuration options related to the XML output
2201
+ #---------------------------------------------------------------------------
2202
+
2203
+ # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2204
+ # captures the structure of the code including all documentation.
2205
+ # The default value is: NO.
2206
+
2207
+ GENERATE_XML = YES
2208
+
2209
+ # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2210
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2211
+ # it.
2212
+ # The default directory is: xml.
2213
+ # This tag requires that the tag GENERATE_XML is set to YES.
2214
+
2215
+ XML_OUTPUT = xml
2216
+
2217
+ # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2218
+ # listings (including syntax highlighting and cross-referencing information) to
2219
+ # the XML output. Note that enabling this will significantly increase the size
2220
+ # of the XML output.
2221
+ # The default value is: YES.
2222
+ # This tag requires that the tag GENERATE_XML is set to YES.
2223
+
2224
+ XML_PROGRAMLISTING = YES
2225
+
2226
+ # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2227
+ # namespace members in file scope as well, matching the HTML output.
2228
+ # The default value is: NO.
2229
+ # This tag requires that the tag GENERATE_XML is set to YES.
2230
+
2231
+ XML_NS_MEMB_FILE_SCOPE = NO
2232
+
2233
+ #---------------------------------------------------------------------------
2234
+ # Configuration options related to the DOCBOOK output
2235
+ #---------------------------------------------------------------------------
2236
+
2237
+ # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2238
+ # that can be used to generate PDF.
2239
+ # The default value is: NO.
2240
+
2241
+ GENERATE_DOCBOOK = NO
2242
+
2243
+ # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2244
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2245
+ # front of it.
2246
+ # The default directory is: docbook.
2247
+ # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2248
+
2249
+ DOCBOOK_OUTPUT = docbook
2250
+
2251
+ #---------------------------------------------------------------------------
2252
+ # Configuration options for the AutoGen Definitions output
2253
+ #---------------------------------------------------------------------------
2254
+
2255
+ # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2256
+ # AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
2257
+ # the structure of the code including all documentation. Note that this feature
2258
+ # is still experimental and incomplete at the moment.
2259
+ # The default value is: NO.
2260
+
2261
+ GENERATE_AUTOGEN_DEF = NO
2262
+
2263
+ #---------------------------------------------------------------------------
2264
+ # Configuration options related to the Perl module output
2265
+ #---------------------------------------------------------------------------
2266
+
2267
+ # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2268
+ # file that captures the structure of the code including all documentation.
2269
+ #
2270
+ # Note that this feature is still experimental and incomplete at the moment.
2271
+ # The default value is: NO.
2272
+
2273
+ GENERATE_PERLMOD = NO
2274
+
2275
+ # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2276
+ # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2277
+ # output from the Perl module output.
2278
+ # The default value is: NO.
2279
+ # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2280
+
2281
+ PERLMOD_LATEX = NO
2282
+
2283
+ # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2284
+ # formatted so it can be parsed by a human reader. This is useful if you want to
2285
+ # understand what is going on. On the other hand, if this tag is set to NO, the
2286
+ # size of the Perl module output will be much smaller and Perl will parse it
2287
+ # just the same.
2288
+ # The default value is: YES.
2289
+ # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2290
+
2291
+ PERLMOD_PRETTY = YES
2292
+
2293
+ # The names of the make variables in the generated doxyrules.make file are
2294
+ # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2295
+ # so different doxyrules.make files included by the same Makefile don't
2296
+ # overwrite each other's variables.
2297
+ # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2298
+
2299
+ PERLMOD_MAKEVAR_PREFIX =
2300
+
2301
+ #---------------------------------------------------------------------------
2302
+ # Configuration options related to the preprocessor
2303
+ #---------------------------------------------------------------------------
2304
+
2305
+ # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2306
+ # C-preprocessor directives found in the sources and include files.
2307
+ # The default value is: YES.
2308
+
2309
+ ENABLE_PREPROCESSING = YES
2310
+
2311
+ # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2312
+ # in the source code. If set to NO, only conditional compilation will be
2313
+ # performed. Macro expansion can be done in a controlled way by setting
2314
+ # EXPAND_ONLY_PREDEF to YES.
2315
+ # The default value is: NO.
2316
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2317
+
2318
+ MACRO_EXPANSION = YES
2319
+
2320
+ # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2321
+ # the macro expansion is limited to the macros specified with the PREDEFINED and
2322
+ # EXPAND_AS_DEFINED tags.
2323
+ # The default value is: NO.
2324
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2325
+
2326
+ EXPAND_ONLY_PREDEF = NO
2327
+
2328
+ # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2329
+ # INCLUDE_PATH will be searched if a #include is found.
2330
+ # The default value is: YES.
2331
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2332
+
2333
+ SEARCH_INCLUDES = YES
2334
+
2335
+ # The INCLUDE_PATH tag can be used to specify one or more directories that
2336
+ # contain include files that are not input files but should be processed by the
2337
+ # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2338
+ # RECURSIVE has no effect here.
2339
+ # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2340
+
2341
+ INCLUDE_PATH = @DOXYGEN_INCLUDE_PATH@
2342
+
2343
+ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2344
+ # patterns (like *.h and *.hpp) to filter out the header-files in the
2345
+ # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2346
+ # used.
2347
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2348
+
2349
+ INCLUDE_FILE_PATTERNS =
2350
+
2351
+ # The PREDEFINED tag can be used to specify one or more macro names that are
2352
+ # defined before the preprocessor is started (similar to the -D option of e.g.
2353
+ # gcc). The argument of the tag is a list of macros of the form: name or
2354
+ # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2355
+ # is assumed. To prevent a macro definition from being undefined via #undef or
2356
+ # recursively expanded use the := operator instead of the = operator.
2357
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2358
+
2359
+ PREDEFINED =
2360
+
2361
+ # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2362
+ # tag can be used to specify a list of macro names that should be expanded. The
2363
+ # macro definition that is found in the sources will be used. Use the PREDEFINED
2364
+ # tag if you want to use a different macro definition that overrules the
2365
+ # definition found in the source code.
2366
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2367
+
2368
+ EXPAND_AS_DEFINED =
2369
+
2370
+ # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2371
+ # remove all references to function-like macros that are alone on a line, have
2372
+ # an all uppercase name, and do not end with a semicolon. Such function macros
2373
+ # are typically used for boiler-plate code, and will confuse the parser if not
2374
+ # removed.
2375
+ # The default value is: YES.
2376
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2377
+
2378
+ SKIP_FUNCTION_MACROS = YES
2379
+
2380
+ #---------------------------------------------------------------------------
2381
+ # Configuration options related to external references
2382
+ #---------------------------------------------------------------------------
2383
+
2384
+ # The TAGFILES tag can be used to specify one or more tag files. For each tag
2385
+ # file the location of the external documentation should be added. The format of
2386
+ # a tag file without this location is as follows:
2387
+ # TAGFILES = file1 file2 ...
2388
+ # Adding location for the tag files is done as follows:
2389
+ # TAGFILES = file1=loc1 "file2 = loc2" ...
2390
+ # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2391
+ # section "Linking to external documentation" for more information about the use
2392
+ # of tag files.
2393
+ # Note: Each tag file must have a unique name (where the name does NOT include
2394
+ # the path). If a tag file is not located in the directory in which doxygen is
2395
+ # run, you must also specify the path to the tagfile here.
2396
+
2397
+ # TAGFILES = swunit.tag=swunit.tag
2398
+
2399
+ # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2400
+ # tag file that is based on the input files it reads. See section "Linking to
2401
+ # external documentation" for more information about the usage of tag files.
2402
+
2403
+ GENERATE_TAGFILE = @DOXYGEN_OUTPUT_DIRECTORY@/html/tagfile.xml
2404
+
2405
+ # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2406
+ # the class index. If set to NO, only the inherited external classes will be
2407
+ # listed.
2408
+ # The default value is: NO.
2409
+
2410
+ ALLEXTERNALS = NO
2411
+
2412
+ # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2413
+ # in the modules index. If set to NO, only the current project's groups will be
2414
+ # listed.
2415
+ # The default value is: YES.
2416
+
2417
+ EXTERNAL_GROUPS = YES
2418
+
2419
+ # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2420
+ # the related pages index. If set to NO, only the current project's pages will
2421
+ # be listed.
2422
+ # The default value is: YES.
2423
+
2424
+ EXTERNAL_PAGES = YES
2425
+
2426
+ #---------------------------------------------------------------------------
2427
+ # Configuration options related to diagram generator tools
2428
+ #---------------------------------------------------------------------------
2429
+
2430
+ # If set to YES the inheritance and collaboration graphs will hide inheritance
2431
+ # and usage relations if the target is undocumented or is not a class.
2432
+ # The default value is: YES.
2433
+
2434
+ HIDE_UNDOC_RELATIONS = YES
2435
+
2436
+ # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2437
+ # available from the path. This tool is part of Graphviz (see:
2438
+ # https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2439
+ # Bell Labs. The other options in this section have no effect if this option is
2440
+ # set to NO
2441
+ # The default value is: NO.
2442
+
2443
+ HAVE_DOT = YES
2444
+
2445
+ # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2446
+ # to run in parallel. When set to 0 doxygen will base this on the number of
2447
+ # processors available in the system. You can set it explicitly to a value
2448
+ # larger than 0 to get control over the balance between CPU load and processing
2449
+ # speed.
2450
+ # Minimum value: 0, maximum value: 32, default value: 0.
2451
+ # This tag requires that the tag HAVE_DOT is set to YES.
2452
+
2453
+ DOT_NUM_THREADS = 0
2454
+
2455
+ # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2456
+ # subgraphs. When you want a differently looking font in the dot files that
2457
+ # doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2458
+ # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2459
+ # Edge and Graph Attributes specification</a> You need to make sure dot is able
2460
+ # to find the font, which can be done by putting it in a standard location or by
2461
+ # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2462
+ # directory containing the font. Default graphviz fontsize is 14.
2463
+ # The default value is: fontname=Helvetica,fontsize=10.
2464
+ # This tag requires that the tag HAVE_DOT is set to YES.
2465
+
2466
+ DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
2467
+
2468
+ # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2469
+ # add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2470
+ # href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2471
+ # arrows shapes.</a>
2472
+ # The default value is: labelfontname=Helvetica,labelfontsize=10.
2473
+ # This tag requires that the tag HAVE_DOT is set to YES.
2474
+
2475
+ DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
2476
+
2477
+ # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2478
+ # around nodes set 'shape=plain' or 'shape=plaintext' <a
2479
+ # href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2480
+ # The default value is: shape=box,height=0.2,width=0.4.
2481
+ # This tag requires that the tag HAVE_DOT is set to YES.
2482
+
2483
+ DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
2484
+
2485
+ # You can set the path where dot can find font specified with fontname in
2486
+ # DOT_COMMON_ATTR and others dot attributes.
2487
+ # This tag requires that the tag HAVE_DOT is set to YES.
2488
+
2489
+ DOT_FONTPATH =
2490
+
2491
+ # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
2492
+ # generate a graph for each documented class showing the direct and indirect
2493
+ # inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
2494
+ # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2495
+ # the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
2496
+ # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2497
+ # If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2498
+ # relations will be shown as texts / links.
2499
+ # Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
2500
+ # The default value is: YES.
2501
+
2502
+ CLASS_GRAPH = NO
2503
+
2504
+ # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2505
+ # graph for each documented class showing the direct and indirect implementation
2506
+ # dependencies (inheritance, containment, and class references variables) of the
2507
+ # class with other documented classes.
2508
+ # The default value is: YES.
2509
+ # This tag requires that the tag HAVE_DOT is set to YES.
2510
+
2511
+ COLLABORATION_GRAPH = YES
2512
+
2513
+ # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2514
+ # groups, showing the direct groups dependencies. See also the chapter Grouping
2515
+ # in the manual.
2516
+ # The default value is: YES.
2517
+ # This tag requires that the tag HAVE_DOT is set to YES.
2518
+
2519
+ GROUP_GRAPHS = YES
2520
+
2521
+ # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2522
+ # collaboration diagrams in a style similar to the OMG's Unified Modeling
2523
+ # Language.
2524
+ # The default value is: NO.
2525
+ # This tag requires that the tag HAVE_DOT is set to YES.
2526
+
2527
+ UML_LOOK = NO
2528
+
2529
+ # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2530
+ # class node. If there are many fields or methods and many nodes the graph may
2531
+ # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2532
+ # number of items for each type to make the size more manageable. Set this to 0
2533
+ # for no limit. Note that the threshold may be exceeded by 50% before the limit
2534
+ # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2535
+ # but if the number exceeds 15, the total amount of fields shown is limited to
2536
+ # 10.
2537
+ # Minimum value: 0, maximum value: 100, default value: 10.
2538
+ # This tag requires that the tag UML_LOOK is set to YES.
2539
+
2540
+ UML_LIMIT_NUM_FIELDS = 10
2541
+
2542
+ # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2543
+ # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2544
+ # tag is set to YES, doxygen will add type and arguments for attributes and
2545
+ # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2546
+ # will not generate fields with class member information in the UML graphs. The
2547
+ # class diagrams will look similar to the default class diagrams but using UML
2548
+ # notation for the relationships.
2549
+ # Possible values are: NO, YES and NONE.
2550
+ # The default value is: NO.
2551
+ # This tag requires that the tag UML_LOOK is set to YES.
2552
+
2553
+ DOT_UML_DETAILS = NO
2554
+
2555
+ # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2556
+ # to display on a single line. If the actual line length exceeds this threshold
2557
+ # significantly it will wrapped across multiple lines. Some heuristics are apply
2558
+ # to avoid ugly line breaks.
2559
+ # Minimum value: 0, maximum value: 1000, default value: 17.
2560
+ # This tag requires that the tag HAVE_DOT is set to YES.
2561
+
2562
+ DOT_WRAP_THRESHOLD = 17
2563
+
2564
+ # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2565
+ # collaboration graphs will show the relations between templates and their
2566
+ # instances.
2567
+ # The default value is: NO.
2568
+ # This tag requires that the tag HAVE_DOT is set to YES.
2569
+
2570
+ TEMPLATE_RELATIONS = NO
2571
+
2572
+ # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2573
+ # YES then doxygen will generate a graph for each documented file showing the
2574
+ # direct and indirect include dependencies of the file with other documented
2575
+ # files.
2576
+ # The default value is: YES.
2577
+ # This tag requires that the tag HAVE_DOT is set to YES.
2578
+
2579
+ INCLUDE_GRAPH = YES
2580
+
2581
+ # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2582
+ # set to YES then doxygen will generate a graph for each documented file showing
2583
+ # the direct and indirect include dependencies of the file with other documented
2584
+ # files.
2585
+ # The default value is: YES.
2586
+ # This tag requires that the tag HAVE_DOT is set to YES.
2587
+
2588
+ INCLUDED_BY_GRAPH = YES
2589
+
2590
+ # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2591
+ # dependency graph for every global function or class method.
2592
+ #
2593
+ # Note that enabling this option will significantly increase the time of a run.
2594
+ # So in most cases it will be better to enable call graphs for selected
2595
+ # functions only using the \callgraph command. Disabling a call graph can be
2596
+ # accomplished by means of the command \hidecallgraph.
2597
+ # The default value is: NO.
2598
+ # This tag requires that the tag HAVE_DOT is set to YES.
2599
+
2600
+ CALL_GRAPH = NO
2601
+
2602
+ # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2603
+ # dependency graph for every global function or class method.
2604
+ #
2605
+ # Note that enabling this option will significantly increase the time of a run.
2606
+ # So in most cases it will be better to enable caller graphs for selected
2607
+ # functions only using the \callergraph command. Disabling a caller graph can be
2608
+ # accomplished by means of the command \hidecallergraph.
2609
+ # The default value is: NO.
2610
+ # This tag requires that the tag HAVE_DOT is set to YES.
2611
+
2612
+ CALLER_GRAPH = NO
2613
+
2614
+ # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2615
+ # hierarchy of all classes instead of a textual one.
2616
+ # The default value is: YES.
2617
+ # This tag requires that the tag HAVE_DOT is set to YES.
2618
+
2619
+ GRAPHICAL_HIERARCHY = YES
2620
+
2621
+ # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2622
+ # dependencies a directory has on other directories in a graphical way. The
2623
+ # dependency relations are determined by the #include relations between the
2624
+ # files in the directories.
2625
+ # The default value is: YES.
2626
+ # This tag requires that the tag HAVE_DOT is set to YES.
2627
+
2628
+ DIRECTORY_GRAPH = YES
2629
+
2630
+ # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2631
+ # of child directories generated in directory dependency graphs by dot.
2632
+ # Minimum value: 1, maximum value: 25, default value: 1.
2633
+ # This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2634
+
2635
+ DIR_GRAPH_MAX_DEPTH = 1
2636
+
2637
+ # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2638
+ # generated by dot. For an explanation of the image formats see the section
2639
+ # output formats in the documentation of the dot tool (Graphviz (see:
2640
+ # https://www.graphviz.org/)).
2641
+ # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2642
+ # to make the SVG files visible in IE 9+ (other browsers do not have this
2643
+ # requirement).
2644
+ # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2645
+ # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2646
+ # png:gdiplus:gdiplus.
2647
+ # The default value is: png.
2648
+ # This tag requires that the tag HAVE_DOT is set to YES.
2649
+
2650
+ DOT_IMAGE_FORMAT = svg
2651
+
2652
+ # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2653
+ # enable generation of interactive SVG images that allow zooming and panning.
2654
+ #
2655
+ # Note that this requires a modern browser other than Internet Explorer. Tested
2656
+ # and working are Firefox, Chrome, Safari, and Opera.
2657
+ # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2658
+ # the SVG files visible. Older versions of IE do not have SVG support.
2659
+ # The default value is: NO.
2660
+ # This tag requires that the tag HAVE_DOT is set to YES.
2661
+
2662
+ INTERACTIVE_SVG = YES
2663
+
2664
+ # The DOT_PATH tag can be used to specify the path where the dot tool can be
2665
+ # found. If left blank, it is assumed the dot tool can be found in the path.
2666
+ # This tag requires that the tag HAVE_DOT is set to YES.
2667
+
2668
+ DOT_PATH =
2669
+
2670
+ # The DOTFILE_DIRS tag can be used to specify one or more directories that
2671
+ # contain dot files that are included in the documentation (see the \dotfile
2672
+ # command).
2673
+ # This tag requires that the tag HAVE_DOT is set to YES.
2674
+
2675
+ DOTFILE_DIRS =
2676
+
2677
+ # You can include diagrams made with dia in doxygen documentation. Doxygen will
2678
+ # then run dia to produce the diagram and insert it in the documentation. The
2679
+ # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2680
+ # If left empty dia is assumed to be found in the default search path.
2681
+
2682
+ DIA_PATH =
2683
+
2684
+ # The DIAFILE_DIRS tag can be used to specify one or more directories that
2685
+ # contain dia files that are included in the documentation (see the \diafile
2686
+ # command).
2687
+
2688
+ DIAFILE_DIRS =
2689
+
2690
+ # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2691
+ # path where java can find the plantuml.jar file or to the filename of jar file
2692
+ # to be used. If left blank, it is assumed PlantUML is not used or called during
2693
+ # a preprocessing step. Doxygen will generate a warning when it encounters a
2694
+ # \startuml command in this case and will not generate output for the diagram.
2695
+
2696
+ PLANTUML_JAR_PATH =
2697
+
2698
+ # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2699
+ # configuration file for plantuml.
2700
+
2701
+ PLANTUML_CFG_FILE =
2702
+
2703
+ # When using plantuml, the specified paths are searched for files specified by
2704
+ # the !include statement in a plantuml block.
2705
+
2706
+ PLANTUML_INCLUDE_PATH =
2707
+
2708
+ # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2709
+ # that will be shown in the graph. If the number of nodes in a graph becomes
2710
+ # larger than this value, doxygen will truncate the graph, which is visualized
2711
+ # by representing a node as a red box. Note that doxygen if the number of direct
2712
+ # children of the root node in a graph is already larger than
2713
+ # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2714
+ # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2715
+ # Minimum value: 0, maximum value: 10000, default value: 50.
2716
+ # This tag requires that the tag HAVE_DOT is set to YES.
2717
+
2718
+ DOT_GRAPH_MAX_NODES = 50
2719
+
2720
+ # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2721
+ # generated by dot. A depth value of 3 means that only nodes reachable from the
2722
+ # root by following a path via at most 3 edges will be shown. Nodes that lay
2723
+ # further from the root node will be omitted. Note that setting this option to 1
2724
+ # or 2 may greatly reduce the computation time needed for large code bases. Also
2725
+ # note that the size of a graph can be further restricted by
2726
+ # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2727
+ # Minimum value: 0, maximum value: 1000, default value: 0.
2728
+ # This tag requires that the tag HAVE_DOT is set to YES.
2729
+
2730
+ MAX_DOT_GRAPH_DEPTH = 0
2731
+
2732
+ # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2733
+ # files in one run (i.e. multiple -o and -T options on the command line). This
2734
+ # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2735
+ # this, this feature is disabled by default.
2736
+ # The default value is: NO.
2737
+ # This tag requires that the tag HAVE_DOT is set to YES.
2738
+
2739
+ DOT_MULTI_TARGETS = NO
2740
+
2741
+ # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2742
+ # explaining the meaning of the various boxes and arrows in the dot generated
2743
+ # graphs.
2744
+ # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
2745
+ # graphical representation for inheritance and collaboration diagrams is used.
2746
+ # The default value is: YES.
2747
+ # This tag requires that the tag HAVE_DOT is set to YES.
2748
+
2749
+ GENERATE_LEGEND = YES
2750
+
2751
+ # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2752
+ # files that are used to generate the various graphs.
2753
+ #
2754
+ # Note: This setting is not only used for dot files but also for msc temporary
2755
+ # files.
2756
+ # The default value is: YES.
2757
+
2758
+ DOT_CLEANUP = YES
2759
+
2760
+ # You can define message sequence charts within doxygen comments using the \msc
2761
+ # command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
2762
+ # use a built-in version of mscgen tool to produce the charts. Alternatively,
2763
+ # the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
2764
+ # specifying prog as the value, doxygen will call the tool as prog -T
2765
+ # <outfile_format> -o <outputfile> <inputfile>. The external tool should support
2766
+ # output file formats "png", "eps", "svg", and "ismap".
2767
+
2768
+ MSCGEN_TOOL =
2769
+
2770
+ # The MSCFILE_DIRS tag can be used to specify one or more directories that
2771
+ # contain msc files that are included in the documentation (see the \mscfile
2772
+ # command).
2773
+
2774
+ MSCFILE_DIRS =