Debian Codegraph @

docs/doxygen-awesome-css/Doxyfile

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