Debian Codegraph @

Doxyfile

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