Doxyfile

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

mercurial