Debian Codegraph @

doc/Doxyfile

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