Debian Codegraph @

src/plugins/contrib/source_exporter/wxPdfDocument/docs/Doxyfile

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