3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project.
6 # All text after a double hash (##) is considered a comment and is placed in
7 # front of the TAG it is preceding.
9 # All text after a single hash (#) is considered a comment and will be ignored.
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 (\" \").
16 #---------------------------------------------------------------------------
17 # Project related configuration options
18 #---------------------------------------------------------------------------
20 # This tag specifies the encoding used for all characters in the configuration
21 # file that follow. The default is UTF-8 which is also the encoding used for all
22 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
23 # iconv built into libc) for the transcoding. See
24 # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25 # The default value is: UTF-8.
27 DOXYFILE_ENCODING = UTF-8
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
32 # title of most generated pages and in a few other places.
33 # The default value is: My Project.
35 PROJECT_NAME = Xonotic QuakeC
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
39 # control system is used.
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 # for a project that appears at the top of each page and should give viewer a
45 # quick idea about the purpose of the project. Keep the description short.
47 PROJECT_BRIEF = The free, fast arena FPS with crisp movement and a wide array of weapons
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50 # in the documentation. The maximum height of the logo should not exceed 55
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52 # the logo to the output directory.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64 # directories (in 2 levels) under the output directory of each output format and
65 # will distribute the generated files over these directories. Enabling this
66 # option can be useful when feeding doxygen a huge amount of source files, where
67 # putting all generated files in the same directory would otherwise causes
68 # performance problems for the file system.
69 # The default value is: NO.
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 # characters to appear in the names of generated files. If set to NO, non-ASCII
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
77 # The default value is: NO.
79 ALLOW_UNICODE_NAMES = NO
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82 # documentation generated by doxygen is written. Doxygen will use this
83 # information to generate all constant output in the proper language.
84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91 # Ukrainian and Vietnamese.
92 # The default value is: English.
94 OUTPUT_LANGUAGE = English
96 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
97 # documentation generated by doxygen is written. Doxygen will use this
98 # information to generate all generated output in the proper direction.
99 # Possible values are: None, LTR, RTL and Context.
100 # The default value is: None.
102 OUTPUT_TEXT_DIRECTION = None
104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
105 # descriptions after the members that are listed in the file and class
106 # documentation (similar to Javadoc). Set to NO to disable this.
107 # The default value is: YES.
109 BRIEF_MEMBER_DESC = YES
111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
112 # description of a member or function before the detailed description
114 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
115 # brief descriptions will be completely suppressed.
116 # The default value is: YES.
120 # This tag implements a quasi-intelligent brief description abbreviator that is
121 # used to form the text in various listings. Each string in this list, if found
122 # as the leading text of the brief description, will be stripped from the text
123 # and the result, after processing the whole list, is used as the annotated
124 # text. Otherwise, the brief description is used as-is. If left blank, the
125 # following values are used ($name is automatically replaced with the name of
126 # the entity):The $name class, The $name widget, The $name file, is, provides,
127 # specifies, contains, represents, a, an and the.
131 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
132 # doxygen will generate a detailed section even if there is only a brief
134 # The default value is: NO.
136 ALWAYS_DETAILED_SEC = YES
138 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
139 # inherited members of a class in the documentation of that class as if those
140 # members were ordinary class members. Constructors, destructors and assignment
141 # operators of the base classes will not be shown.
142 # The default value is: NO.
144 INLINE_INHERITED_MEMB = YES
146 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
147 # before files name in the file list and in the header files. If set to NO the
148 # shortest path that makes the file name unique will be used
149 # The default value is: YES.
151 FULL_PATH_NAMES = YES
153 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
154 # Stripping is only done if one of the specified strings matches the left-hand
155 # part of the path. The tag can be used to show relative paths in the file list.
156 # If left blank the directory from which doxygen is run is used as the path to
159 # Note that you can specify absolute paths here, but also relative paths, which
160 # will be relative from the directory where doxygen is started.
161 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
165 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
166 # path mentioned in the documentation of a class, which tells the reader which
167 # header file to include in order to use a class. If left blank only the name of
168 # the header file containing the class definition is used. Otherwise one should
169 # specify the list of include paths that are normally passed to the compiler
172 STRIP_FROM_INC_PATH =
174 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
175 # less readable) file names. This can be useful is your file systems doesn't
176 # support long names like on DOS, Mac, or CD-ROM.
177 # The default value is: NO.
181 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
182 # first line (until the first dot) of a Javadoc-style comment as the brief
183 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
184 # style comments (thus requiring an explicit @brief command for a brief
186 # The default value is: NO.
188 JAVADOC_AUTOBRIEF = YES
190 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
193 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
194 # Javadoc-style will behave just like regular comments and it will not be
195 # interpreted by doxygen.
196 # The default value is: NO.
200 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
201 # line (until the first dot) of a Qt-style comment as the brief description. If
202 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
203 # requiring an explicit \brief command for a brief description.)
204 # The default value is: NO.
208 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
209 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
210 # a brief description. This used to be the default behavior. The new default is
211 # to treat a multi-line C++ comment block as a detailed description. Set this
212 # tag to YES if you prefer the old behavior instead.
214 # Note that setting this tag to YES also means that rational rose comments are
215 # not recognized any more.
216 # The default value is: NO.
218 MULTILINE_CPP_IS_BRIEF = NO
220 # By default Python docstrings are displayed as preformatted text and doxygen's
221 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
222 # doxygen's special commands can be used and the contents of the docstring
223 # documentation blocks is shown as doxygen documentation.
224 # The default value is: YES.
226 PYTHON_DOCSTRING = YES
228 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
229 # documentation from any documented member that it re-implements.
230 # The default value is: YES.
234 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
235 # page for each member. If set to NO, the documentation of a member will be part
236 # of the file/class/namespace that contains it.
237 # The default value is: NO.
239 SEPARATE_MEMBER_PAGES = NO
241 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
242 # uses this value to replace tabs by spaces in code fragments.
243 # Minimum value: 1, maximum value: 16, default value: 4.
247 # This tag can be used to specify a number of aliases that act as commands in
248 # the documentation. An alias has the form:
251 # "sideeffect=@par Side Effects:\n"
252 # will allow you to put the command \sideeffect (or @sideeffect) in the
253 # documentation, which will result in a user-defined paragraph with heading
254 # "Side Effects:". You can put \n's in the value part of an alias to insert
255 # newlines (in the resulting output). You can put ^^ in the value part of an
256 # alias to insert a newline as if a physical newline was in the original file.
257 # When you need a literal { or } or , in the value part of an alias you have to
258 # escape them by means of a backslash (\), this can lead to conflicts with the
259 # commands \{ and \} for these it is advised to use the version @{ and @} or use
260 # a double escape (\\{ and \\})
264 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
265 # only. Doxygen will then generate output that is more tailored for C. For
266 # instance, some of the names that are used will be different. The list of all
267 # members will be omitted, etc.
268 # The default value is: NO.
270 OPTIMIZE_OUTPUT_FOR_C = NO
272 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
273 # Python sources only. Doxygen will then generate output that is more tailored
274 # for that language. For instance, namespaces will be presented as packages,
275 # qualified scopes will look different, etc.
276 # The default value is: NO.
278 OPTIMIZE_OUTPUT_JAVA = NO
280 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
281 # sources. Doxygen will then generate output that is tailored for Fortran.
282 # The default value is: NO.
284 OPTIMIZE_FOR_FORTRAN = NO
286 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
287 # sources. Doxygen will then generate output that is tailored for VHDL.
288 # The default value is: NO.
290 OPTIMIZE_OUTPUT_VHDL = NO
292 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
293 # sources only. Doxygen will then generate output that is more tailored for that
294 # language. For instance, namespaces will be presented as modules, types will be
295 # separated into more groups, etc.
296 # The default value is: NO.
298 OPTIMIZE_OUTPUT_SLICE = NO
300 # Doxygen selects the parser to use depending on the extension of the files it
301 # parses. With this tag you can assign which parser to use for a given
302 # extension. Doxygen has a built-in mapping, but you can override or extend it
303 # using this tag. The format is ext=language, where ext is a file extension, and
304 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
305 # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
306 # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
307 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
308 # tries to guess whether the code is fixed or free formatted code, this is the
309 # default for Fortran type files). For instance to make doxygen treat .inc files
310 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
311 # use: inc=Fortran f=C.
313 # Note: For files without extension you can use no_extension as a placeholder.
315 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
316 # the files are not read by doxygen. When specifying no_extension you should add
317 # * to the FILE_PATTERNS.
319 # Note see also the list of default file extension mappings.
321 EXTENSION_MAPPING = qc=C \
325 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
326 # according to the Markdown format, which allows for more readable
327 # documentation. See https://daringfireball.net/projects/markdown/ for details.
328 # The output of markdown processing is further processed by doxygen, so you can
329 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
330 # case of backward compatibilities issues.
331 # The default value is: YES.
333 MARKDOWN_SUPPORT = YES
335 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
336 # to that level are automatically included in the table of contents, even if
337 # they do not have an id attribute.
338 # Note: This feature currently applies only to Markdown headings.
339 # Minimum value: 0, maximum value: 99, default value: 5.
340 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
342 TOC_INCLUDE_HEADINGS = 5
344 # When enabled doxygen tries to link words that correspond to documented
345 # classes, or namespaces to their corresponding documentation. Such a link can
346 # be prevented in individual cases by putting a % sign in front of the word or
347 # globally by setting AUTOLINK_SUPPORT to NO.
348 # The default value is: YES.
350 AUTOLINK_SUPPORT = YES
352 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
353 # to include (a tag file for) the STL sources as input, then you should set this
354 # tag to YES in order to let doxygen match functions declarations and
355 # definitions whose arguments contain STL classes (e.g. func(std::string);
356 # versus func(std::string) {}). This also make the inheritance and collaboration
357 # diagrams that involve STL classes more complete and accurate.
358 # The default value is: NO.
360 BUILTIN_STL_SUPPORT = NO
362 # If you use Microsoft's C++/CLI language, you should set this option to YES to
363 # enable parsing support.
364 # The default value is: NO.
368 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
369 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
370 # will parse them like normal C++ but will assume all classes use public instead
371 # of private inheritance when no explicit protection keyword is present.
372 # The default value is: NO.
376 # For Microsoft's IDL there are propget and propput attributes to indicate
377 # getter and setter methods for a property. Setting this option to YES will make
378 # doxygen to replace the get and set methods by a property in the documentation.
379 # This will only work if the methods are indeed getting or setting a simple
380 # type. If this is not the case, or you want to show the methods anyway, you
381 # should set this option to NO.
382 # The default value is: YES.
384 IDL_PROPERTY_SUPPORT = YES
386 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
387 # tag is set to YES then doxygen will reuse the documentation of the first
388 # member in the group (if any) for the other members of the group. By default
389 # all members of a group must be documented explicitly.
390 # The default value is: NO.
392 DISTRIBUTE_GROUP_DOC = NO
394 # If one adds a struct or class to a group and this option is enabled, then also
395 # any nested class or struct is added to the same group. By default this option
396 # is disabled and one has to add nested compounds explicitly via \ingroup.
397 # The default value is: NO.
399 GROUP_NESTED_COMPOUNDS = NO
401 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
402 # (for instance a group of public functions) to be put as a subgroup of that
403 # type (e.g. under the Public Functions section). Set it to NO to prevent
404 # subgrouping. Alternatively, this can be done per class using the
405 # \nosubgrouping command.
406 # The default value is: YES.
410 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
411 # are shown inside the group in which they are included (e.g. using \ingroup)
412 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
415 # Note that this feature does not work in combination with
416 # SEPARATE_MEMBER_PAGES.
417 # The default value is: NO.
419 INLINE_GROUPED_CLASSES = NO
421 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
422 # with only public data fields or simple typedef fields will be shown inline in
423 # the documentation of the scope in which they are defined (i.e. file,
424 # namespace, or group documentation), provided this scope is documented. If set
425 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
426 # Man pages) or section (for LaTeX and RTF).
427 # The default value is: NO.
429 INLINE_SIMPLE_STRUCTS = NO
431 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
432 # enum is documented as struct, union, or enum with the name of the typedef. So
433 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
434 # with name TypeT. When disabled the typedef will appear as a member of a file,
435 # namespace, or class. And the struct will be named TypeS. This can typically be
436 # useful for C code in case the coding convention dictates that all compound
437 # types are typedef'ed and only the typedef is referenced, never the tag name.
438 # The default value is: NO.
440 TYPEDEF_HIDES_STRUCT = YES
442 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
443 # cache is used to resolve symbols given their name and scope. Since this can be
444 # an expensive process and often the same symbol appears multiple times in the
445 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
446 # doxygen will become slower. If the cache is too large, memory is wasted. The
447 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
448 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
449 # symbols. At the end of a run doxygen will report the cache usage and suggest
450 # the optimal cache size from a speed point of view.
451 # Minimum value: 0, maximum value: 9, default value: 0.
453 LOOKUP_CACHE_SIZE = 0
455 # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
456 # during processing. When set to 0 doxygen will based this on the number of
457 # cores available in the system. You can set it explicitly to a value larger
458 # than 0 to get more control over the balance between CPU load and processing
459 # speed. At this moment only the input processing can be done using multiple
460 # threads. Since this is still an experimental feature the default is set to 1,
461 # which efficively disables parallel processing. Please report any issues you
462 # encounter. Generating dot graphs in parallel is controlled by the
463 # DOT_NUM_THREADS setting.
464 # Minimum value: 0, maximum value: 32, default value: 1.
468 #---------------------------------------------------------------------------
469 # Build related configuration options
470 #---------------------------------------------------------------------------
472 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
473 # documentation are documented, even if no documentation was available. Private
474 # class members and static file members will be hidden unless the
475 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
476 # Note: This will also disable the warnings about undocumented members that are
477 # normally produced when WARNINGS is set to YES.
478 # The default value is: NO.
482 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
483 # be included in the documentation.
484 # The default value is: NO.
486 EXTRACT_PRIVATE = YES
488 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
489 # methods of a class will be included in the documentation.
490 # The default value is: NO.
492 EXTRACT_PRIV_VIRTUAL = NO
494 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
495 # scope will be included in the documentation.
496 # The default value is: NO.
498 EXTRACT_PACKAGE = YES
500 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
501 # included in the documentation.
502 # The default value is: NO.
506 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
507 # locally in source files will be included in the documentation. If set to NO,
508 # only classes defined in header files are included. Does not have any effect
510 # The default value is: YES.
512 EXTRACT_LOCAL_CLASSES = YES
514 # This flag is only useful for Objective-C code. If set to YES, local methods,
515 # which are defined in the implementation section but not in the interface are
516 # included in the documentation. If set to NO, only methods in the interface are
518 # The default value is: NO.
520 EXTRACT_LOCAL_METHODS = YES
522 # If this flag is set to YES, the members of anonymous namespaces will be
523 # extracted and appear in the documentation as a namespace called
524 # 'anonymous_namespace{file}', where file will be replaced with the base name of
525 # the file that contains the anonymous namespace. By default anonymous namespace
527 # The default value is: NO.
529 EXTRACT_ANON_NSPACES = YES
531 # If this flag is set to YES, the name of an unnamed parameter in a declaration
532 # will be determined by the corresponding definition. By default unnamed
533 # parameters remain unnamed in the output.
534 # The default value is: YES.
536 RESOLVE_UNNAMED_PARAMS = YES
538 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
539 # undocumented members inside documented classes or files. If set to NO these
540 # members will be included in the various overviews, but no documentation
541 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
542 # The default value is: NO.
544 HIDE_UNDOC_MEMBERS = NO
546 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
547 # undocumented classes that are normally visible in the class hierarchy. If set
548 # to NO, these classes will be included in the various overviews. This option
549 # has no effect if EXTRACT_ALL is enabled.
550 # The default value is: NO.
552 HIDE_UNDOC_CLASSES = NO
554 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
555 # declarations. If set to NO, these declarations will be included in the
557 # The default value is: NO.
559 HIDE_FRIEND_COMPOUNDS = NO
561 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
562 # documentation blocks found inside the body of a function. If set to NO, these
563 # blocks will be appended to the function's detailed documentation block.
564 # The default value is: NO.
566 HIDE_IN_BODY_DOCS = NO
568 # The INTERNAL_DOCS tag determines if documentation that is typed after a
569 # \internal command is included. If the tag is set to NO then the documentation
570 # will be excluded. Set it to YES to include the internal documentation.
571 # The default value is: NO.
575 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
576 # able to match the capabilities of the underlying filesystem. In case the
577 # filesystem is case sensitive (i.e. it supports files in the same directory
578 # whose names only differ in casing), the option must be set to YES to properly
579 # deal with such files in case they appear in the input. For filesystems that
580 # are not case sensitive the option should be be set to NO to properly deal with
581 # output files written for symbols that only differ in casing, such as for two
582 # classes, one named CLASS and the other named Class, and to also support
583 # references to files without having to specify the exact matching casing. On
584 # Windows (including Cygwin) and MacOS, users should typically set this option
585 # to NO, whereas on Linux or other Unix flavors it should typically be set to
587 # The default value is: system dependent.
589 CASE_SENSE_NAMES = YES
591 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
592 # their full class and namespace scopes in the documentation. If set to YES, the
593 # scope will be hidden.
594 # The default value is: NO.
596 HIDE_SCOPE_NAMES = NO
598 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
599 # append additional text to a page's title, such as Class Reference. If set to
600 # YES the compound reference will be hidden.
601 # The default value is: NO.
603 HIDE_COMPOUND_REFERENCE= NO
605 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
606 # the files that are included by a file in the documentation of that file.
607 # The default value is: YES.
609 SHOW_INCLUDE_FILES = YES
611 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
612 # grouped member an include statement to the documentation, telling the reader
613 # which file to include in order to use the member.
614 # The default value is: NO.
616 SHOW_GROUPED_MEMB_INC = YES
618 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
619 # files with double quotes in the documentation rather than with sharp brackets.
620 # The default value is: NO.
622 FORCE_LOCAL_INCLUDES = NO
624 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
625 # documentation for inline members.
626 # The default value is: YES.
630 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
631 # (detailed) documentation of file and class members alphabetically by member
632 # name. If set to NO, the members will appear in declaration order.
633 # The default value is: YES.
635 SORT_MEMBER_DOCS = YES
637 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
638 # descriptions of file, namespace and class members alphabetically by member
639 # name. If set to NO, the members will appear in declaration order. Note that
640 # this will also influence the order of the classes in the class list.
641 # The default value is: NO.
643 SORT_BRIEF_DOCS = YES
645 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
646 # (brief and detailed) documentation of class members so that constructors and
647 # destructors are listed first. If set to NO the constructors will appear in the
648 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
649 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
650 # member documentation.
651 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
652 # detailed member documentation.
653 # The default value is: NO.
655 SORT_MEMBERS_CTORS_1ST = YES
657 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
658 # of group names into alphabetical order. If set to NO the group names will
659 # appear in their defined order.
660 # The default value is: NO.
662 SORT_GROUP_NAMES = NO
664 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
665 # fully-qualified names, including namespaces. If set to NO, the class list will
666 # be sorted only by class name, not including the namespace part.
667 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
668 # Note: This option applies only to the class list, not to the alphabetical
670 # The default value is: NO.
672 SORT_BY_SCOPE_NAME = NO
674 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
675 # type resolution of all parameters of a function it will reject a match between
676 # the prototype and the implementation of a member function even if there is
677 # only one candidate or it is obvious which candidate to choose by doing a
678 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
679 # accept a match between prototype and implementation in such cases.
680 # The default value is: NO.
682 STRICT_PROTO_MATCHING = NO
684 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
685 # list. This list is created by putting \todo commands in the documentation.
686 # The default value is: YES.
688 GENERATE_TODOLIST = YES
690 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
691 # list. This list is created by putting \test commands in the documentation.
692 # The default value is: YES.
694 GENERATE_TESTLIST = YES
696 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
697 # list. This list is created by putting \bug commands in the documentation.
698 # The default value is: YES.
700 GENERATE_BUGLIST = YES
702 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
703 # the deprecated list. This list is created by putting \deprecated commands in
705 # The default value is: YES.
707 GENERATE_DEPRECATEDLIST= YES
709 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
710 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
711 # ... \endcond blocks.
715 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
716 # initial value of a variable or macro / define can have for it to appear in the
717 # documentation. If the initializer consists of more lines than specified here
718 # it will be hidden. Use a value of 0 to hide initializers completely. The
719 # appearance of the value of individual variables and macros / defines can be
720 # controlled using \showinitializer or \hideinitializer command in the
721 # documentation regardless of this setting.
722 # Minimum value: 0, maximum value: 10000, default value: 30.
724 MAX_INITIALIZER_LINES = 30
726 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
727 # the bottom of the documentation of classes and structs. If set to YES, the
728 # list will mention the files that were used to generate the documentation.
729 # The default value is: YES.
731 SHOW_USED_FILES = YES
733 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
734 # will remove the Files entry from the Quick Index and from the Folder Tree View
736 # The default value is: YES.
740 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
741 # page. This will remove the Namespaces entry from the Quick Index and from the
742 # Folder Tree View (if specified).
743 # The default value is: YES.
745 SHOW_NAMESPACES = YES
747 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
748 # doxygen should invoke to get the current version for each file (typically from
749 # the version control system). Doxygen will invoke the program by executing (via
750 # popen()) the command command input-file, where command is the value of the
751 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
752 # by doxygen. Whatever the program writes to standard output is used as the file
753 # version. For an example see the documentation.
755 FILE_VERSION_FILTER =
757 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
758 # by doxygen. The layout file controls the global structure of the generated
759 # output files in an output format independent way. To create the layout file
760 # that represents doxygen's defaults, run doxygen with the -l option. You can
761 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
762 # will be used as the name of the layout file.
764 # Note that if you run doxygen from a directory containing a file called
765 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
770 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
771 # the reference definitions. This must be a list of .bib files. The .bib
772 # extension is automatically appended if omitted. This requires the bibtex tool
773 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
774 # For LaTeX the style of the bibliography can be controlled using
775 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
776 # search path. See also \cite for info how to create references.
780 #---------------------------------------------------------------------------
781 # Configuration options related to warning and progress messages
782 #---------------------------------------------------------------------------
784 # The QUIET tag can be used to turn on/off the messages that are generated to
785 # standard output by doxygen. If QUIET is set to YES this implies that the
787 # The default value is: NO.
791 # The WARNINGS tag can be used to turn on/off the warning messages that are
792 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
793 # this implies that the warnings are on.
795 # Tip: Turn warnings on while writing the documentation.
796 # The default value is: YES.
800 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
801 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
802 # will automatically be disabled.
803 # The default value is: YES.
805 WARN_IF_UNDOCUMENTED = YES
807 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
808 # potential errors in the documentation, such as not documenting some parameters
809 # in a documented function, or documenting parameters that don't exist or using
810 # markup commands wrongly.
811 # The default value is: YES.
813 WARN_IF_DOC_ERROR = YES
815 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
816 # are documented, but have no documentation for their parameters or return
817 # value. If set to NO, doxygen will only warn about wrong or incomplete
818 # parameter documentation, but not about the absence of documentation. If
819 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
820 # The default value is: NO.
822 WARN_NO_PARAMDOC = NO
824 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
825 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
826 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
827 # at the end of the doxygen process doxygen will return with a non-zero status.
828 # Possible values are: NO, YES and FAIL_ON_WARNINGS.
829 # The default value is: NO.
833 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
834 # can produce. The string should contain the $file, $line, and $text tags, which
835 # will be replaced by the file and line number from which the warning originated
836 # and the warning text. Optionally the format may contain $version, which will
837 # be replaced by the version of the file (if it could be obtained via
838 # FILE_VERSION_FILTER)
839 # The default value is: $file:$line: $text.
841 WARN_FORMAT = "$file:$line: $text"
843 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
844 # messages should be written. If left blank the output is written to standard
849 #---------------------------------------------------------------------------
850 # Configuration options related to the input files
851 #---------------------------------------------------------------------------
853 # The INPUT tag is used to specify the files and/or directories that contain
854 # documented source files. You may enter file names like myfile.cpp or
855 # directories like /usr/src/myproject. Separate the files or directories with
856 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
857 # Note: If this tag is empty the current directory is searched.
861 # This tag can be used to specify the character encoding of the source files
862 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
863 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
864 # documentation (see:
865 # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
866 # The default value is: UTF-8.
868 INPUT_ENCODING = UTF-8
870 # If the value of the INPUT tag contains directories, you can use the
871 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
872 # *.h) to filter out the source-files in the directories.
874 # Note that for custom extensions or not directly supported extensions you also
875 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
878 # Note the list of default checked file patterns might differ from the list of
879 # default file extension mappings.
881 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
882 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
883 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
884 # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
885 # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
886 # *.ucf, *.qsf and *.ice.
888 FILE_PATTERNS = *.qc \
893 # The RECURSIVE tag can be used to specify whether or not subdirectories should
894 # be searched for input files as well.
895 # The default value is: NO.
899 # The EXCLUDE tag can be used to specify files and/or directories that should be
900 # excluded from the INPUT source files. This way you can easily exclude a
901 # subdirectory from a directory tree whose root is specified with the INPUT tag.
903 # Note that relative paths are relative to the directory from which doxygen is
908 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
909 # directories that are symbolic links (a Unix file system feature) are excluded
911 # The default value is: NO.
913 EXCLUDE_SYMLINKS = NO
915 # If the value of the INPUT tag contains directories, you can use the
916 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
917 # certain files from those directories.
919 # Note that the wildcards are matched against the file with absolute path, so to
920 # exclude all test directories for example use the pattern */test/*
924 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
925 # (namespaces, classes, functions, etc.) that should be excluded from the
926 # output. The symbol name can be a fully qualified name, a word, or if the
927 # wildcard * is used, a substring. Examples: ANamespace, AClass,
928 # AClass::ANamespace, ANamespace::*Test
930 # Note that the wildcards are matched against the file with absolute path, so to
931 # exclude all test directories use the pattern */test/*
935 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
936 # that contain example code fragments that are included (see the \include
941 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
942 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
943 # *.h) to filter out the source-files in the directories. If left blank all
944 # files are included.
948 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
949 # searched for input files to be used with the \include or \dontinclude commands
950 # irrespective of the value of the RECURSIVE tag.
951 # The default value is: NO.
953 EXAMPLE_RECURSIVE = NO
955 # The IMAGE_PATH tag can be used to specify one or more files or directories
956 # that contain images that are to be included in the documentation (see the
961 # The INPUT_FILTER tag can be used to specify a program that doxygen should
962 # invoke to filter for each input file. Doxygen will invoke the filter program
963 # by executing (via popen()) the command:
965 # <filter> <input-file>
967 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
968 # name of an input file. Doxygen will then use the output that the filter
969 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
972 # Note that the filter must not add or remove lines; it is applied before the
973 # code is scanned, but not when the output code is generated. If lines are added
974 # or removed, the anchors will not be placed correctly.
976 # Note that for custom extensions or not directly supported extensions you also
977 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
978 # properly processed by doxygen.
982 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
983 # basis. Doxygen will compare the file name with each pattern and apply the
984 # filter if there is a match. The filters are a list of the form: pattern=filter
985 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
986 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
987 # patterns match the file name, INPUT_FILTER is applied.
989 # Note that for custom extensions or not directly supported extensions you also
990 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
991 # properly processed by doxygen.
995 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
996 # INPUT_FILTER) will also be used to filter the input files that are used for
997 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
998 # The default value is: NO.
1000 FILTER_SOURCE_FILES = NO
1002 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1003 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1004 # it is also possible to disable source filtering for a specific pattern using
1005 # *.ext= (so without naming a filter).
1006 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1008 FILTER_SOURCE_PATTERNS =
1010 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1011 # is part of the input, its contents will be placed on the main page
1012 # (index.html). This can be useful if you have a project on for instance GitHub
1013 # and want to reuse the introduction page also for the doxygen output.
1015 USE_MDFILE_AS_MAINPAGE =
1017 #---------------------------------------------------------------------------
1018 # Configuration options related to source browsing
1019 #---------------------------------------------------------------------------
1021 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1022 # generated. Documented entities will be cross-referenced with these sources.
1024 # Note: To get rid of all source code in the generated output, make sure that
1025 # also VERBATIM_HEADERS is set to NO.
1026 # The default value is: NO.
1028 SOURCE_BROWSER = YES
1030 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1031 # classes and enums directly into the documentation.
1032 # The default value is: NO.
1034 INLINE_SOURCES = YES
1036 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1037 # special comment blocks from generated source code fragments. Normal C, C++ and
1038 # Fortran comments will always remain visible.
1039 # The default value is: YES.
1041 STRIP_CODE_COMMENTS = YES
1043 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1044 # entity all documented functions referencing it will be listed.
1045 # The default value is: NO.
1047 REFERENCED_BY_RELATION = YES
1049 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1050 # all documented entities called/used by that function will be listed.
1051 # The default value is: NO.
1053 REFERENCES_RELATION = YES
1055 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1056 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1057 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1058 # link to the documentation.
1059 # The default value is: YES.
1061 REFERENCES_LINK_SOURCE = YES
1063 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1064 # source code will show a tooltip with additional information such as prototype,
1065 # brief description and links to the definition and documentation. Since this
1066 # will make the HTML file larger and loading of large files a bit slower, you
1067 # can opt to disable this feature.
1068 # The default value is: YES.
1069 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1071 SOURCE_TOOLTIPS = YES
1073 # If the USE_HTAGS tag is set to YES then the references to source code will
1074 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1075 # source browser. The htags tool is part of GNU's global source tagging system
1076 # (see https://www.gnu.org/software/global/global.html). You will need version
1079 # To use it do the following:
1080 # - Install the latest version of global
1081 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1082 # - Make sure the INPUT points to the root of the source tree
1083 # - Run doxygen as normal
1085 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1086 # tools must be available from the command line (i.e. in the search path).
1088 # The result: instead of the source browser generated by doxygen, the links to
1089 # source code will now point to the output of htags.
1090 # The default value is: NO.
1091 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1095 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1096 # verbatim copy of the header file for each class for which an include is
1097 # specified. Set to NO to disable this.
1098 # See also: Section \class.
1099 # The default value is: YES.
1101 VERBATIM_HEADERS = YES
1103 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1104 # clang parser (see:
1105 # http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1106 # performance. This can be particularly helpful with template rich C++ code for
1107 # which doxygen's built-in parser lacks the necessary type information.
1108 # Note: The availability of this option depends on whether or not doxygen was
1109 # generated with the -Duse_libclang=ON option for CMake.
1110 # The default value is: NO.
1112 CLANG_ASSISTED_PARSING = NO
1114 # If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
1115 # YES then doxygen will add the directory of each input to the include path.
1116 # The default value is: YES.
1118 CLANG_ADD_INC_PATHS = YES
1120 # If clang assisted parsing is enabled you can provide the compiler with command
1121 # line options that you would normally use when invoking the compiler. Note that
1122 # the include paths will already be set by doxygen for the files and directories
1123 # specified with INPUT and INCLUDE_PATH.
1124 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1128 # If clang assisted parsing is enabled you can provide the clang parser with the
1129 # path to the directory containing a file called compile_commands.json. This
1130 # file is the compilation database (see:
1131 # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1132 # options used when the source files were built. This is equivalent to
1133 # specifying the -p option to a clang tool, such as clang-check. These options
1134 # will then be passed to the parser. Any options specified with CLANG_OPTIONS
1135 # will be added as well.
1136 # Note: The availability of this option depends on whether or not doxygen was
1137 # generated with the -Duse_libclang=ON option for CMake.
1139 CLANG_DATABASE_PATH =
1141 #---------------------------------------------------------------------------
1142 # Configuration options related to the alphabetical class index
1143 #---------------------------------------------------------------------------
1145 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1146 # compounds will be generated. Enable this if the project contains a lot of
1147 # classes, structs, unions or interfaces.
1148 # The default value is: YES.
1150 ALPHABETICAL_INDEX = YES
1152 # In case all classes in a project start with a common prefix, all classes will
1153 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1154 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1155 # while generating the index headers.
1156 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1160 #---------------------------------------------------------------------------
1161 # Configuration options related to the HTML output
1162 #---------------------------------------------------------------------------
1164 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1165 # The default value is: YES.
1169 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1170 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1172 # The default directory is: html.
1173 # This tag requires that the tag GENERATE_HTML is set to YES.
1177 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1178 # generated HTML page (for example: .htm, .php, .asp).
1179 # The default value is: .html.
1180 # This tag requires that the tag GENERATE_HTML is set to YES.
1182 HTML_FILE_EXTENSION = .html
1184 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1185 # each generated HTML page. If the tag is left blank doxygen will generate a
1188 # To get valid HTML the header file that includes any scripts and style sheets
1189 # that doxygen needs, which is dependent on the configuration options used (e.g.
1190 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1191 # default header using
1192 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1194 # and then modify the file new_header.html. See also section "Doxygen usage"
1195 # for information on how to generate the default header that doxygen normally
1197 # Note: The header is subject to change so you typically have to regenerate the
1198 # default header when upgrading to a newer version of doxygen. For a description
1199 # of the possible markers and block names see the documentation.
1200 # This tag requires that the tag GENERATE_HTML is set to YES.
1204 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1205 # generated HTML page. If the tag is left blank doxygen will generate a standard
1206 # footer. See HTML_HEADER for more information on how to generate a default
1207 # footer and what special commands can be used inside the footer. See also
1208 # section "Doxygen usage" for information on how to generate the default footer
1209 # that doxygen normally uses.
1210 # This tag requires that the tag GENERATE_HTML is set to YES.
1214 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1215 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1216 # the HTML output. If left blank doxygen will generate a default style sheet.
1217 # See also section "Doxygen usage" for information on how to generate the style
1218 # sheet that doxygen normally uses.
1219 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1220 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1222 # This tag requires that the tag GENERATE_HTML is set to YES.
1226 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1227 # cascading style sheets that are included after the standard style sheets
1228 # created by doxygen. Using this option one can overrule certain style aspects.
1229 # This is preferred over using HTML_STYLESHEET since it does not replace the
1230 # standard style sheet and is therefore more robust against future updates.
1231 # Doxygen will copy the style sheet files to the output directory.
1232 # Note: The order of the extra style sheet files is of importance (e.g. the last
1233 # style sheet in the list overrules the setting of the previous ones in the
1234 # list). For an example see the documentation.
1235 # This tag requires that the tag GENERATE_HTML is set to YES.
1237 HTML_EXTRA_STYLESHEET =
1239 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1240 # other source files which should be copied to the HTML output directory. Note
1241 # that these files will be copied to the base HTML output directory. Use the
1242 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1243 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1244 # files will be copied as-is; there are no commands or markers available.
1245 # This tag requires that the tag GENERATE_HTML is set to YES.
1249 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1250 # will adjust the colors in the style sheet and background images according to
1251 # this color. Hue is specified as an angle on a colorwheel, see
1252 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1253 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1254 # purple, and 360 is red again.
1255 # Minimum value: 0, maximum value: 359, default value: 220.
1256 # This tag requires that the tag GENERATE_HTML is set to YES.
1258 HTML_COLORSTYLE_HUE = 220
1260 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1261 # in the HTML output. For a value of 0 the output will use grayscales only. A
1262 # value of 255 will produce the most vivid colors.
1263 # Minimum value: 0, maximum value: 255, default value: 100.
1264 # This tag requires that the tag GENERATE_HTML is set to YES.
1266 HTML_COLORSTYLE_SAT = 100
1268 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1269 # luminance component of the colors in the HTML output. Values below 100
1270 # gradually make the output lighter, whereas values above 100 make the output
1271 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1272 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1274 # Minimum value: 40, maximum value: 240, default value: 80.
1275 # This tag requires that the tag GENERATE_HTML is set to YES.
1277 HTML_COLORSTYLE_GAMMA = 80
1279 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1280 # page will contain the date and time when the page was generated. Setting this
1281 # to YES can help to show when doxygen was last run and thus if the
1282 # documentation is up to date.
1283 # The default value is: NO.
1284 # This tag requires that the tag GENERATE_HTML is set to YES.
1286 HTML_TIMESTAMP = YES
1288 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1289 # documentation will contain a main index with vertical navigation menus that
1290 # are dynamically created via JavaScript. If disabled, the navigation index will
1291 # consists of multiple levels of tabs that are statically embedded in every HTML
1292 # page. Disable this option to support browsers that do not have JavaScript,
1293 # like the Qt help browser.
1294 # The default value is: YES.
1295 # This tag requires that the tag GENERATE_HTML is set to YES.
1297 HTML_DYNAMIC_MENUS = YES
1299 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1300 # documentation will contain sections that can be hidden and shown after the
1302 # The default value is: NO.
1303 # This tag requires that the tag GENERATE_HTML is set to YES.
1305 HTML_DYNAMIC_SECTIONS = YES
1307 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1308 # shown in the various tree structured indices initially; the user can expand
1309 # and collapse entries dynamically later on. Doxygen will expand the tree to
1310 # such a level that at most the specified number of entries are visible (unless
1311 # a fully collapsed tree already exceeds this amount). So setting the number of
1312 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1313 # representing an infinite number of entries and will result in a full expanded
1315 # Minimum value: 0, maximum value: 9999, default value: 100.
1316 # This tag requires that the tag GENERATE_HTML is set to YES.
1318 HTML_INDEX_NUM_ENTRIES = 100
1320 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1321 # generated that can be used as input for Apple's Xcode 3 integrated development
1323 # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1324 # create a documentation set, doxygen will generate a Makefile in the HTML
1325 # output directory. Running make will produce the docset in that directory and
1326 # running make install will install the docset in
1327 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1328 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1329 # genXcode/_index.html for more information.
1330 # The default value is: NO.
1331 # This tag requires that the tag GENERATE_HTML is set to YES.
1333 GENERATE_DOCSET = NO
1335 # This tag determines the name of the docset feed. A documentation feed provides
1336 # an umbrella under which multiple documentation sets from a single provider
1337 # (such as a company or product suite) can be grouped.
1338 # The default value is: Doxygen generated docs.
1339 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1341 DOCSET_FEEDNAME = "Doxygen generated docs"
1343 # This tag specifies a string that should uniquely identify the documentation
1344 # set bundle. This should be a reverse domain-name style string, e.g.
1345 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1346 # The default value is: org.doxygen.Project.
1347 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1349 DOCSET_BUNDLE_ID = org.doxygen.Project
1351 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1352 # the documentation publisher. This should be a reverse domain-name style
1353 # string, e.g. com.mycompany.MyDocSet.documentation.
1354 # The default value is: org.doxygen.Publisher.
1355 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1357 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1359 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1360 # The default value is: Publisher.
1361 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1363 DOCSET_PUBLISHER_NAME = Publisher
1365 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1366 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1367 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1369 # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
1371 # The HTML Help Workshop contains a compiler that can convert all HTML output
1372 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1373 # files are now used as the Windows 98 help format, and will replace the old
1374 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1375 # HTML files also contain an index, a table of contents, and you can search for
1376 # words in the documentation. The HTML workshop also contains a viewer for
1377 # compressed HTML files.
1378 # The default value is: NO.
1379 # This tag requires that the tag GENERATE_HTML is set to YES.
1381 GENERATE_HTMLHELP = NO
1383 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1384 # file. You can add a path in front of the file if the result should not be
1385 # written to the html output directory.
1386 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1390 # The HHC_LOCATION tag can be used to specify the location (absolute path
1391 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1392 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1393 # The file has to be specified with full path.
1394 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1398 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1399 # (YES) or that it should be included in the main .chm file (NO).
1400 # The default value is: NO.
1401 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1405 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1406 # and project file content.
1407 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1409 CHM_INDEX_ENCODING =
1411 # The BINARY_TOC flag controls whether a binary table of contents is generated
1412 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1413 # enables the Previous and Next buttons.
1414 # The default value is: NO.
1415 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1419 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1420 # the table of contents of the HTML help documentation and to the tree view.
1421 # The default value is: NO.
1422 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1426 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1427 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1428 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1429 # (.qch) of the generated HTML documentation.
1430 # The default value is: NO.
1431 # This tag requires that the tag GENERATE_HTML is set to YES.
1435 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1436 # the file name of the resulting .qch file. The path specified is relative to
1437 # the HTML output folder.
1438 # This tag requires that the tag GENERATE_QHP is set to YES.
1442 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1443 # Project output. For more information please see Qt Help Project / Namespace
1445 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1446 # The default value is: org.doxygen.Project.
1447 # This tag requires that the tag GENERATE_QHP is set to YES.
1449 QHP_NAMESPACE = org.doxygen.Project
1451 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1452 # Help Project output. For more information please see Qt Help Project / Virtual
1454 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1455 # The default value is: doc.
1456 # This tag requires that the tag GENERATE_QHP is set to YES.
1458 QHP_VIRTUAL_FOLDER = doc
1460 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1461 # filter to add. For more information please see Qt Help Project / Custom
1463 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1464 # This tag requires that the tag GENERATE_QHP is set to YES.
1466 QHP_CUST_FILTER_NAME =
1468 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1469 # custom filter to add. For more information please see Qt Help Project / Custom
1471 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1472 # This tag requires that the tag GENERATE_QHP is set to YES.
1474 QHP_CUST_FILTER_ATTRS =
1476 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1477 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1478 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1479 # This tag requires that the tag GENERATE_QHP is set to YES.
1481 QHP_SECT_FILTER_ATTRS =
1483 # The QHG_LOCATION tag can be used to specify the location (absolute path
1484 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1485 # run qhelpgenerator on the generated .qhp file.
1486 # This tag requires that the tag GENERATE_QHP is set to YES.
1490 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1491 # generated, together with the HTML files, they form an Eclipse help plugin. To
1492 # install this plugin and make it available under the help contents menu in
1493 # Eclipse, the contents of the directory containing the HTML and XML files needs
1494 # to be copied into the plugins directory of eclipse. The name of the directory
1495 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1496 # After copying Eclipse needs to be restarted before the help appears.
1497 # The default value is: NO.
1498 # This tag requires that the tag GENERATE_HTML is set to YES.
1500 GENERATE_ECLIPSEHELP = NO
1502 # A unique identifier for the Eclipse help plugin. When installing the plugin
1503 # the directory name containing the HTML and XML files should also have this
1504 # name. Each documentation set should have its own identifier.
1505 # The default value is: org.doxygen.Project.
1506 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1508 ECLIPSE_DOC_ID = org.doxygen.Project
1510 # If you want full control over the layout of the generated HTML pages it might
1511 # be necessary to disable the index and replace it with your own. The
1512 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1513 # of each HTML page. A value of NO enables the index and the value YES disables
1514 # it. Since the tabs in the index contain the same information as the navigation
1515 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1516 # The default value is: NO.
1517 # This tag requires that the tag GENERATE_HTML is set to YES.
1521 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1522 # structure should be generated to display hierarchical information. If the tag
1523 # value is set to YES, a side panel will be generated containing a tree-like
1524 # index structure (just like the one that is generated for HTML Help). For this
1525 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1526 # (i.e. any modern browser). Windows users are probably better off using the
1527 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1528 # further fine-tune the look of the index. As an example, the default style
1529 # sheet generated by doxygen has an example that shows how to put an image at
1530 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1531 # the same information as the tab index, you could consider setting
1532 # DISABLE_INDEX to YES when enabling this option.
1533 # The default value is: NO.
1534 # This tag requires that the tag GENERATE_HTML is set to YES.
1536 GENERATE_TREEVIEW = YES
1538 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1539 # doxygen will group on one line in the generated HTML documentation.
1541 # Note that a value of 0 will completely suppress the enum values from appearing
1542 # in the overview section.
1543 # Minimum value: 0, maximum value: 20, default value: 4.
1544 # This tag requires that the tag GENERATE_HTML is set to YES.
1546 ENUM_VALUES_PER_LINE = 4
1548 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1549 # to set the initial width (in pixels) of the frame in which the tree is shown.
1550 # Minimum value: 0, maximum value: 1500, default value: 250.
1551 # This tag requires that the tag GENERATE_HTML is set to YES.
1553 TREEVIEW_WIDTH = 250
1555 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1556 # external symbols imported via tag files in a separate window.
1557 # The default value is: NO.
1558 # This tag requires that the tag GENERATE_HTML is set to YES.
1560 EXT_LINKS_IN_WINDOW = NO
1562 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1563 # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1564 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1565 # the HTML output. These images will generally look nicer at scaled resolutions.
1566 # Possible values are: png (the default) and svg (looks nicer but requires the
1567 # pdf2svg or inkscape tool).
1568 # The default value is: png.
1569 # This tag requires that the tag GENERATE_HTML is set to YES.
1571 HTML_FORMULA_FORMAT = svg
1573 # Use this tag to change the font size of LaTeX formulas included as images in
1574 # the HTML documentation. When you change the font size after a successful
1575 # doxygen run you need to manually remove any form_*.png images from the HTML
1576 # output directory to force them to be regenerated.
1577 # Minimum value: 8, maximum value: 50, default value: 10.
1578 # This tag requires that the tag GENERATE_HTML is set to YES.
1580 FORMULA_FONTSIZE = 10
1582 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1583 # generated for formulas are transparent PNGs. Transparent PNGs are not
1584 # supported properly for IE 6.0, but are supported on all modern browsers.
1586 # Note that when changing this option you need to delete any form_*.png files in
1587 # the HTML output directory before the changes have effect.
1588 # The default value is: YES.
1589 # This tag requires that the tag GENERATE_HTML is set to YES.
1591 FORMULA_TRANSPARENT = YES
1593 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1594 # to create new LaTeX commands to be used in formulas as building blocks. See
1595 # the section "Including formulas" for details.
1599 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1600 # https://www.mathjax.org) which uses client side JavaScript for the rendering
1601 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1602 # installed or if you want to formulas look prettier in the HTML output. When
1603 # enabled you may also need to install MathJax separately and configure the path
1604 # to it using the MATHJAX_RELPATH option.
1605 # The default value is: NO.
1606 # This tag requires that the tag GENERATE_HTML is set to YES.
1610 # When MathJax is enabled you can set the default output format to be used for
1611 # the MathJax output. See the MathJax site (see:
1612 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
1613 # Possible values are: HTML-CSS (which is slower, but has the best
1614 # compatibility), NativeMML (i.e. MathML) and SVG.
1615 # The default value is: HTML-CSS.
1616 # This tag requires that the tag USE_MATHJAX is set to YES.
1618 MATHJAX_FORMAT = HTML-CSS
1620 # When MathJax is enabled you need to specify the location relative to the HTML
1621 # output directory using the MATHJAX_RELPATH option. The destination directory
1622 # should contain the MathJax.js script. For instance, if the mathjax directory
1623 # is located at the same level as the HTML output directory, then
1624 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1625 # Content Delivery Network so you can quickly see the result without installing
1626 # MathJax. However, it is strongly recommended to install a local copy of
1627 # MathJax from https://www.mathjax.org before deployment.
1628 # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
1629 # This tag requires that the tag USE_MATHJAX is set to YES.
1631 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1633 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1634 # extension names that should be enabled during MathJax rendering. For example
1635 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1636 # This tag requires that the tag USE_MATHJAX is set to YES.
1638 MATHJAX_EXTENSIONS =
1640 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1641 # of code that will be used on startup of the MathJax code. See the MathJax site
1643 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1644 # example see the documentation.
1645 # This tag requires that the tag USE_MATHJAX is set to YES.
1649 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1650 # the HTML output. The underlying search engine uses javascript and DHTML and
1651 # should work on any modern browser. Note that when using HTML help
1652 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1653 # there is already a search function so this one should typically be disabled.
1654 # For large projects the javascript based search engine can be slow, then
1655 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1656 # search using the keyboard; to jump to the search box use <access key> + S
1657 # (what the <access key> is depends on the OS and browser, but it is typically
1658 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1659 # key> to jump into the search results window, the results can be navigated
1660 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1661 # the search. The filter options can be selected when the cursor is inside the
1662 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1663 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1665 # The default value is: YES.
1666 # This tag requires that the tag GENERATE_HTML is set to YES.
1670 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1671 # implemented using a web server instead of a web client using JavaScript. There
1672 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1673 # setting. When disabled, doxygen will generate a PHP script for searching and
1674 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1675 # and searching needs to be provided by external tools. See the section
1676 # "External Indexing and Searching" for details.
1677 # The default value is: NO.
1678 # This tag requires that the tag SEARCHENGINE is set to YES.
1680 SERVER_BASED_SEARCH = YES
1682 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1683 # script for searching. Instead the search results are written to an XML file
1684 # which needs to be processed by an external indexer. Doxygen will invoke an
1685 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1688 # Doxygen ships with an example indexer (doxyindexer) and search engine
1689 # (doxysearch.cgi) which are based on the open source search engine library
1691 # https://xapian.org/).
1693 # See the section "External Indexing and Searching" for details.
1694 # The default value is: NO.
1695 # This tag requires that the tag SEARCHENGINE is set to YES.
1697 EXTERNAL_SEARCH = NO
1699 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1700 # which will return the search results when EXTERNAL_SEARCH is enabled.
1702 # Doxygen ships with an example indexer (doxyindexer) and search engine
1703 # (doxysearch.cgi) which are based on the open source search engine library
1705 # https://xapian.org/). See the section "External Indexing and Searching" for
1707 # This tag requires that the tag SEARCHENGINE is set to YES.
1711 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1712 # search data is written to a file for indexing by an external tool. With the
1713 # SEARCHDATA_FILE tag the name of this file can be specified.
1714 # The default file is: searchdata.xml.
1715 # This tag requires that the tag SEARCHENGINE is set to YES.
1717 SEARCHDATA_FILE = searchdata.xml
1719 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1720 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1721 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1722 # projects and redirect the results back to the right project.
1723 # This tag requires that the tag SEARCHENGINE is set to YES.
1725 EXTERNAL_SEARCH_ID =
1727 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1728 # projects other than the one defined by this configuration file, but that are
1729 # all added to the same external search index. Each project needs to have a
1730 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1731 # to a relative location where the documentation can be found. The format is:
1732 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1733 # This tag requires that the tag SEARCHENGINE is set to YES.
1735 EXTRA_SEARCH_MAPPINGS =
1737 #---------------------------------------------------------------------------
1738 # Configuration options related to the LaTeX output
1739 #---------------------------------------------------------------------------
1741 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1742 # The default value is: YES.
1746 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1747 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1749 # The default directory is: latex.
1750 # This tag requires that the tag GENERATE_LATEX is set to YES.
1752 LATEX_OUTPUT = latex
1754 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1757 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1758 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1759 # chosen this is overwritten by pdflatex. For specific output languages the
1760 # default can have been set differently, this depends on the implementation of
1761 # the output language.
1762 # This tag requires that the tag GENERATE_LATEX is set to YES.
1764 LATEX_CMD_NAME = latex
1766 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1768 # Note: This tag is used in the Makefile / make.bat.
1769 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1771 # The default file is: makeindex.
1772 # This tag requires that the tag GENERATE_LATEX is set to YES.
1774 MAKEINDEX_CMD_NAME = makeindex
1776 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1777 # generate index for LaTeX. In case there is no backslash (\) as first character
1778 # it will be automatically added in the LaTeX code.
1779 # Note: This tag is used in the generated output file (.tex).
1780 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1781 # The default value is: makeindex.
1782 # This tag requires that the tag GENERATE_LATEX is set to YES.
1784 LATEX_MAKEINDEX_CMD = makeindex
1786 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1787 # documents. This may be useful for small projects and may help to save some
1789 # The default value is: NO.
1790 # This tag requires that the tag GENERATE_LATEX is set to YES.
1794 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1796 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1797 # 14 inches) and executive (7.25 x 10.5 inches).
1798 # The default value is: a4.
1799 # This tag requires that the tag GENERATE_LATEX is set to YES.
1803 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1804 # that should be included in the LaTeX output. The package can be specified just
1805 # by its name or with the correct syntax as to be used with the LaTeX
1806 # \usepackage command. To get the times font for instance you can specify :
1807 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1808 # To use the option intlimits with the amsmath package you can specify:
1809 # EXTRA_PACKAGES=[intlimits]{amsmath}
1810 # If left blank no extra packages will be included.
1811 # This tag requires that the tag GENERATE_LATEX is set to YES.
1815 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1816 # generated LaTeX document. The header should contain everything until the first
1817 # chapter. If it is left blank doxygen will generate a standard header. See
1818 # section "Doxygen usage" for information on how to let doxygen write the
1819 # default header to a separate file.
1821 # Note: Only use a user-defined header if you know what you are doing! The
1822 # following commands have a special meaning inside the header: $title,
1823 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1824 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1825 # string, for the replacement values of the other commands the user is referred
1827 # This tag requires that the tag GENERATE_LATEX is set to YES.
1831 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1832 # generated LaTeX document. The footer should contain everything after the last
1833 # chapter. If it is left blank doxygen will generate a standard footer. See
1834 # LATEX_HEADER for more information on how to generate a default footer and what
1835 # special commands can be used inside the footer.
1837 # Note: Only use a user-defined footer if you know what you are doing!
1838 # This tag requires that the tag GENERATE_LATEX is set to YES.
1842 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1843 # LaTeX style sheets that are included after the standard style sheets created
1844 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1845 # will copy the style sheet files to the output directory.
1846 # Note: The order of the extra style sheet files is of importance (e.g. the last
1847 # style sheet in the list overrules the setting of the previous ones in the
1849 # This tag requires that the tag GENERATE_LATEX is set to YES.
1851 LATEX_EXTRA_STYLESHEET =
1853 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1854 # other source files which should be copied to the LATEX_OUTPUT output
1855 # directory. Note that the files will be copied as-is; there are no commands or
1856 # markers available.
1857 # This tag requires that the tag GENERATE_LATEX is set to YES.
1861 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1862 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1863 # contain links (just like the HTML output) instead of page references. This
1864 # makes the output suitable for online browsing using a PDF viewer.
1865 # The default value is: YES.
1866 # This tag requires that the tag GENERATE_LATEX is set to YES.
1868 PDF_HYPERLINKS = YES
1870 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1871 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
1872 # files. Set this option to YES, to get a higher quality PDF documentation.
1874 # See also section LATEX_CMD_NAME for selecting the engine.
1875 # The default value is: YES.
1876 # This tag requires that the tag GENERATE_LATEX is set to YES.
1880 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1881 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1882 # if errors occur, instead of asking the user for help. This option is also used
1883 # when generating formulas in HTML.
1884 # The default value is: NO.
1885 # This tag requires that the tag GENERATE_LATEX is set to YES.
1887 LATEX_BATCHMODE = NO
1889 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1890 # index chapters (such as File Index, Compound Index, etc.) in the output.
1891 # The default value is: NO.
1892 # This tag requires that the tag GENERATE_LATEX is set to YES.
1894 LATEX_HIDE_INDICES = NO
1896 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1897 # code with syntax highlighting in the LaTeX output.
1899 # Note that which sources are shown also depends on other settings such as
1901 # The default value is: NO.
1902 # This tag requires that the tag GENERATE_LATEX is set to YES.
1904 LATEX_SOURCE_CODE = NO
1906 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1907 # bibliography, e.g. plainnat, or ieeetr. See
1908 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1909 # The default value is: plain.
1910 # This tag requires that the tag GENERATE_LATEX is set to YES.
1912 LATEX_BIB_STYLE = plain
1914 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1915 # page will contain the date and time when the page was generated. Setting this
1916 # to NO can help when comparing the output of multiple runs.
1917 # The default value is: NO.
1918 # This tag requires that the tag GENERATE_LATEX is set to YES.
1920 LATEX_TIMESTAMP = NO
1922 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1923 # path from which the emoji images will be read. If a relative path is entered,
1924 # it will be relative to the LATEX_OUTPUT directory. If left blank the
1925 # LATEX_OUTPUT directory will be used.
1926 # This tag requires that the tag GENERATE_LATEX is set to YES.
1928 LATEX_EMOJI_DIRECTORY =
1930 #---------------------------------------------------------------------------
1931 # Configuration options related to the RTF output
1932 #---------------------------------------------------------------------------
1934 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1935 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1937 # The default value is: NO.
1941 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1942 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1944 # The default directory is: rtf.
1945 # This tag requires that the tag GENERATE_RTF is set to YES.
1949 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1950 # documents. This may be useful for small projects and may help to save some
1952 # The default value is: NO.
1953 # This tag requires that the tag GENERATE_RTF is set to YES.
1957 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1958 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1959 # output) instead of page references. This makes the output suitable for online
1960 # browsing using Word or some other Word compatible readers that support those
1963 # Note: WordPad (write) and others do not support links.
1964 # The default value is: NO.
1965 # This tag requires that the tag GENERATE_RTF is set to YES.
1969 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1970 # configuration file, i.e. a series of assignments. You only have to provide
1971 # replacements, missing definitions are set to their default value.
1973 # See also section "Doxygen usage" for information on how to generate the
1974 # default style sheet that doxygen normally uses.
1975 # This tag requires that the tag GENERATE_RTF is set to YES.
1977 RTF_STYLESHEET_FILE =
1979 # Set optional variables used in the generation of an RTF document. Syntax is
1980 # similar to doxygen's configuration file. A template extensions file can be
1981 # generated using doxygen -e rtf extensionFile.
1982 # This tag requires that the tag GENERATE_RTF is set to YES.
1984 RTF_EXTENSIONS_FILE =
1986 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1987 # with syntax highlighting in the RTF output.
1989 # Note that which sources are shown also depends on other settings such as
1991 # The default value is: NO.
1992 # This tag requires that the tag GENERATE_RTF is set to YES.
1994 RTF_SOURCE_CODE = NO
1996 #---------------------------------------------------------------------------
1997 # Configuration options related to the man page output
1998 #---------------------------------------------------------------------------
2000 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2001 # classes and files.
2002 # The default value is: NO.
2006 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2007 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2008 # it. A directory man3 will be created inside the directory specified by
2010 # The default directory is: man.
2011 # This tag requires that the tag GENERATE_MAN is set to YES.
2015 # The MAN_EXTENSION tag determines the extension that is added to the generated
2016 # man pages. In case the manual section does not start with a number, the number
2017 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2019 # The default value is: .3.
2020 # This tag requires that the tag GENERATE_MAN is set to YES.
2024 # The MAN_SUBDIR tag determines the name of the directory created within
2025 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2026 # MAN_EXTENSION with the initial . removed.
2027 # This tag requires that the tag GENERATE_MAN is set to YES.
2031 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2032 # will generate one additional man file for each entity documented in the real
2033 # man page(s). These additional files only source the real man page, but without
2034 # them the man command would be unable to find the correct page.
2035 # The default value is: NO.
2036 # This tag requires that the tag GENERATE_MAN is set to YES.
2040 #---------------------------------------------------------------------------
2041 # Configuration options related to the XML output
2042 #---------------------------------------------------------------------------
2044 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2045 # captures the structure of the code including all documentation.
2046 # The default value is: NO.
2050 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2051 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2053 # The default directory is: xml.
2054 # This tag requires that the tag GENERATE_XML is set to YES.
2058 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2059 # listings (including syntax highlighting and cross-referencing information) to
2060 # the XML output. Note that enabling this will significantly increase the size
2061 # of the XML output.
2062 # The default value is: YES.
2063 # This tag requires that the tag GENERATE_XML is set to YES.
2065 XML_PROGRAMLISTING = YES
2067 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2068 # namespace members in file scope as well, matching the HTML output.
2069 # The default value is: NO.
2070 # This tag requires that the tag GENERATE_XML is set to YES.
2072 XML_NS_MEMB_FILE_SCOPE = NO
2074 #---------------------------------------------------------------------------
2075 # Configuration options related to the DOCBOOK output
2076 #---------------------------------------------------------------------------
2078 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2079 # that can be used to generate PDF.
2080 # The default value is: NO.
2082 GENERATE_DOCBOOK = NO
2084 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2085 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2087 # The default directory is: docbook.
2088 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2090 DOCBOOK_OUTPUT = docbook
2092 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2093 # program listings (including syntax highlighting and cross-referencing
2094 # information) to the DOCBOOK output. Note that enabling this will significantly
2095 # increase the size of the DOCBOOK output.
2096 # The default value is: NO.
2097 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2099 DOCBOOK_PROGRAMLISTING = NO
2101 #---------------------------------------------------------------------------
2102 # Configuration options for the AutoGen Definitions output
2103 #---------------------------------------------------------------------------
2105 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2106 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2107 # the structure of the code including all documentation. Note that this feature
2108 # is still experimental and incomplete at the moment.
2109 # The default value is: NO.
2111 GENERATE_AUTOGEN_DEF = NO
2113 #---------------------------------------------------------------------------
2114 # Configuration options related to the Perl module output
2115 #---------------------------------------------------------------------------
2117 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2118 # file that captures the structure of the code including all documentation.
2120 # Note that this feature is still experimental and incomplete at the moment.
2121 # The default value is: NO.
2123 GENERATE_PERLMOD = NO
2125 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2126 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2127 # output from the Perl module output.
2128 # The default value is: NO.
2129 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2133 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2134 # formatted so it can be parsed by a human reader. This is useful if you want to
2135 # understand what is going on. On the other hand, if this tag is set to NO, the
2136 # size of the Perl module output will be much smaller and Perl will parse it
2138 # The default value is: YES.
2139 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2141 PERLMOD_PRETTY = YES
2143 # The names of the make variables in the generated doxyrules.make file are
2144 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2145 # so different doxyrules.make files included by the same Makefile don't
2146 # overwrite each other's variables.
2147 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2149 PERLMOD_MAKEVAR_PREFIX =
2151 #---------------------------------------------------------------------------
2152 # Configuration options related to the preprocessor
2153 #---------------------------------------------------------------------------
2155 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2156 # C-preprocessor directives found in the sources and include files.
2157 # The default value is: YES.
2159 ENABLE_PREPROCESSING = YES
2161 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2162 # in the source code. If set to NO, only conditional compilation will be
2163 # performed. Macro expansion can be done in a controlled way by setting
2164 # EXPAND_ONLY_PREDEF to YES.
2165 # The default value is: NO.
2166 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2168 MACRO_EXPANSION = YES
2170 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2171 # the macro expansion is limited to the macros specified with the PREDEFINED and
2172 # EXPAND_AS_DEFINED tags.
2173 # The default value is: NO.
2174 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2176 EXPAND_ONLY_PREDEF = YES
2178 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2179 # INCLUDE_PATH will be searched if a #include is found.
2180 # The default value is: YES.
2181 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2183 SEARCH_INCLUDES = YES
2185 # The INCLUDE_PATH tag can be used to specify one or more directories that
2186 # contain include files that are not input files but should be processed by the
2188 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2192 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2193 # patterns (like *.h and *.hpp) to filter out the header-files in the
2194 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2196 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2198 INCLUDE_FILE_PATTERNS =
2200 # The PREDEFINED tag can be used to specify one or more macro names that are
2201 # defined before the preprocessor is started (similar to the -D option of e.g.
2202 # gcc). The argument of the tag is a list of macros of the form: name or
2203 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2204 # is assumed. To prevent a macro definition from being undefined via #undef or
2205 # recursively expanded use the := operator instead of the = operator.
2206 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2208 PREDEFINED = XONOTIC \
2213 "USING(name, T)=using name = T" \
2214 "CLASS(name, base)=class name : public base { public:" \
2215 INIT(class)=class::class() \
2216 CONSTRUCTOR(class)=class::class( \
2217 DESTRUCTOR(class)=class::~class() \
2218 "ATTRIB(class, name, T, val)=T name = val" \
2219 "ATTRIB_STRZONE(class, name, T, val)=T name = val" \
2220 "ATTRIBARRAY(class, name, T, val)=T name[val]" \
2221 "STATIC_ATTRIB(class, name, T, val)=static T name = val" \
2222 "STATIC_ATTRIB_STRZONE(class, name, T, val)=static T name = val" \
2223 "METHOD(class, name, prototype)=virtual void class::name()" \
2224 ENDCLASS(class)=}; \
2227 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2228 # tag can be used to specify a list of macro names that should be expanded. The
2229 # macro definition that is found in the sources will be used. Use the PREDEFINED
2230 # tag if you want to use a different macro definition that overrules the
2231 # definition found in the source code.
2232 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2234 EXPAND_AS_DEFINED = USING \
2242 STATIC_ATTRIB_STRZONE \
2248 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2249 # remove all references to function-like macros that are alone on a line, have
2250 # an all uppercase name, and do not end with a semicolon. Such function macros
2251 # are typically used for boiler-plate code, and will confuse the parser if not
2253 # The default value is: YES.
2254 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2256 SKIP_FUNCTION_MACROS = YES
2258 #---------------------------------------------------------------------------
2259 # Configuration options related to external references
2260 #---------------------------------------------------------------------------
2262 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2263 # file the location of the external documentation should be added. The format of
2264 # a tag file without this location is as follows:
2265 # TAGFILES = file1 file2 ...
2266 # Adding location for the tag files is done as follows:
2267 # TAGFILES = file1=loc1 "file2 = loc2" ...
2268 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2269 # section "Linking to external documentation" for more information about the use
2271 # Note: Each tag file must have a unique name (where the name does NOT include
2272 # the path). If a tag file is not located in the directory in which doxygen is
2273 # run, you must also specify the path to the tagfile here.
2277 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2278 # tag file that is based on the input files it reads. See section "Linking to
2279 # external documentation" for more information about the usage of tag files.
2283 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2284 # the class index. If set to NO, only the inherited external classes will be
2286 # The default value is: NO.
2290 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2291 # in the modules index. If set to NO, only the current project's groups will be
2293 # The default value is: YES.
2295 EXTERNAL_GROUPS = YES
2297 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2298 # the related pages index. If set to NO, only the current project's pages will
2300 # The default value is: YES.
2302 EXTERNAL_PAGES = YES
2304 #---------------------------------------------------------------------------
2305 # Configuration options related to the dot tool
2306 #---------------------------------------------------------------------------
2308 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2309 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2310 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2311 # disabled, but it is recommended to install and use dot, since it yields more
2313 # The default value is: YES.
2315 CLASS_DIAGRAMS = YES
2317 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2318 # then run dia to produce the diagram and insert it in the documentation. The
2319 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2320 # If left empty dia is assumed to be found in the default search path.
2324 # If set to YES the inheritance and collaboration graphs will hide inheritance
2325 # and usage relations if the target is undocumented or is not a class.
2326 # The default value is: YES.
2328 HIDE_UNDOC_RELATIONS = NO
2330 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2331 # available from the path. This tool is part of Graphviz (see:
2332 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2333 # Bell Labs. The other options in this section have no effect if this option is
2335 # The default value is: YES.
2339 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2340 # to run in parallel. When set to 0 doxygen will base this on the number of
2341 # processors available in the system. You can set it explicitly to a value
2342 # larger than 0 to get control over the balance between CPU load and processing
2344 # Minimum value: 0, maximum value: 32, default value: 0.
2345 # This tag requires that the tag HAVE_DOT is set to YES.
2349 # When you want a differently looking font in the dot files that doxygen
2350 # generates you can specify the font name using DOT_FONTNAME. You need to make
2351 # sure dot is able to find the font, which can be done by putting it in a
2352 # standard location or by setting the DOTFONTPATH environment variable or by
2353 # setting DOT_FONTPATH to the directory containing the font.
2354 # The default value is: Helvetica.
2355 # This tag requires that the tag HAVE_DOT is set to YES.
2357 DOT_FONTNAME = Helvetica
2359 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2361 # Minimum value: 4, maximum value: 24, default value: 10.
2362 # This tag requires that the tag HAVE_DOT is set to YES.
2366 # By default doxygen will tell dot to use the default font as specified with
2367 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2368 # the path where dot can find it using this tag.
2369 # This tag requires that the tag HAVE_DOT is set to YES.
2373 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2374 # each documented class showing the direct and indirect inheritance relations.
2375 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2376 # The default value is: YES.
2377 # This tag requires that the tag HAVE_DOT is set to YES.
2381 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2382 # graph for each documented class showing the direct and indirect implementation
2383 # dependencies (inheritance, containment, and class references variables) of the
2384 # class with other documented classes.
2385 # The default value is: YES.
2386 # This tag requires that the tag HAVE_DOT is set to YES.
2388 COLLABORATION_GRAPH = YES
2390 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2391 # groups, showing the direct groups dependencies.
2392 # The default value is: YES.
2393 # This tag requires that the tag HAVE_DOT is set to YES.
2397 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2398 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2400 # The default value is: NO.
2401 # This tag requires that the tag HAVE_DOT is set to YES.
2405 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2406 # class node. If there are many fields or methods and many nodes the graph may
2407 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2408 # number of items for each type to make the size more manageable. Set this to 0
2409 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2410 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2411 # but if the number exceeds 15, the total amount of fields shown is limited to
2413 # Minimum value: 0, maximum value: 100, default value: 10.
2414 # This tag requires that the tag UML_LOOK is set to YES.
2416 UML_LIMIT_NUM_FIELDS = 10
2418 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2419 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2420 # tag is set to YES, doxygen will add type and arguments for attributes and
2421 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2422 # will not generate fields with class member information in the UML graphs. The
2423 # class diagrams will look similar to the default class diagrams but using UML
2424 # notation for the relationships.
2425 # Possible values are: NO, YES and NONE.
2426 # The default value is: NO.
2427 # This tag requires that the tag UML_LOOK is set to YES.
2429 DOT_UML_DETAILS = NO
2431 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2432 # to display on a single line. If the actual line length exceeds this threshold
2433 # significantly it will wrapped across multiple lines. Some heuristics are apply
2434 # to avoid ugly line breaks.
2435 # Minimum value: 0, maximum value: 1000, default value: 17.
2436 # This tag requires that the tag HAVE_DOT is set to YES.
2438 DOT_WRAP_THRESHOLD = 17
2440 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2441 # collaboration graphs will show the relations between templates and their
2443 # The default value is: NO.
2444 # This tag requires that the tag HAVE_DOT is set to YES.
2446 TEMPLATE_RELATIONS = NO
2448 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2449 # YES then doxygen will generate a graph for each documented file showing the
2450 # direct and indirect include dependencies of the file with other documented
2452 # The default value is: YES.
2453 # This tag requires that the tag HAVE_DOT is set to YES.
2457 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2458 # set to YES then doxygen will generate a graph for each documented file showing
2459 # the direct and indirect include dependencies of the file with other documented
2461 # The default value is: YES.
2462 # This tag requires that the tag HAVE_DOT is set to YES.
2464 INCLUDED_BY_GRAPH = YES
2466 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2467 # dependency graph for every global function or class method.
2469 # Note that enabling this option will significantly increase the time of a run.
2470 # So in most cases it will be better to enable call graphs for selected
2471 # functions only using the \callgraph command. Disabling a call graph can be
2472 # accomplished by means of the command \hidecallgraph.
2473 # The default value is: NO.
2474 # This tag requires that the tag HAVE_DOT is set to YES.
2478 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2479 # dependency graph for every global function or class method.
2481 # Note that enabling this option will significantly increase the time of a run.
2482 # So in most cases it will be better to enable caller graphs for selected
2483 # functions only using the \callergraph command. Disabling a caller graph can be
2484 # accomplished by means of the command \hidecallergraph.
2485 # The default value is: NO.
2486 # This tag requires that the tag HAVE_DOT is set to YES.
2490 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2491 # hierarchy of all classes instead of a textual one.
2492 # The default value is: YES.
2493 # This tag requires that the tag HAVE_DOT is set to YES.
2495 GRAPHICAL_HIERARCHY = YES
2497 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2498 # dependencies a directory has on other directories in a graphical way. The
2499 # dependency relations are determined by the #include relations between the
2500 # files in the directories.
2501 # The default value is: YES.
2502 # This tag requires that the tag HAVE_DOT is set to YES.
2504 DIRECTORY_GRAPH = YES
2506 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2507 # generated by dot. For an explanation of the image formats see the section
2508 # output formats in the documentation of the dot tool (Graphviz (see:
2509 # http://www.graphviz.org/)).
2510 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2511 # to make the SVG files visible in IE 9+ (other browsers do not have this
2513 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2514 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2515 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2516 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2517 # png:gdiplus:gdiplus.
2518 # The default value is: png.
2519 # This tag requires that the tag HAVE_DOT is set to YES.
2521 DOT_IMAGE_FORMAT = svg
2523 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2524 # enable generation of interactive SVG images that allow zooming and panning.
2526 # Note that this requires a modern browser other than Internet Explorer. Tested
2527 # and working are Firefox, Chrome, Safari, and Opera.
2528 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2529 # the SVG files visible. Older versions of IE do not have SVG support.
2530 # The default value is: NO.
2531 # This tag requires that the tag HAVE_DOT is set to YES.
2533 INTERACTIVE_SVG = YES
2535 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2536 # found. If left blank, it is assumed the dot tool can be found in the path.
2537 # This tag requires that the tag HAVE_DOT is set to YES.
2541 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2542 # contain dot files that are included in the documentation (see the \dotfile
2544 # This tag requires that the tag HAVE_DOT is set to YES.
2548 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2549 # contain msc files that are included in the documentation (see the \mscfile
2554 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2555 # contain dia files that are included in the documentation (see the \diafile
2560 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2561 # path where java can find the plantuml.jar file. If left blank, it is assumed
2562 # PlantUML is not used or called during a preprocessing step. Doxygen will
2563 # generate a warning when it encounters a \startuml command in this case and
2564 # will not generate output for the diagram.
2568 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2569 # configuration file for plantuml.
2573 # When using plantuml, the specified paths are searched for files specified by
2574 # the !include statement in a plantuml block.
2576 PLANTUML_INCLUDE_PATH =
2578 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2579 # that will be shown in the graph. If the number of nodes in a graph becomes
2580 # larger than this value, doxygen will truncate the graph, which is visualized
2581 # by representing a node as a red box. Note that doxygen if the number of direct
2582 # children of the root node in a graph is already larger than
2583 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2584 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2585 # Minimum value: 0, maximum value: 10000, default value: 50.
2586 # This tag requires that the tag HAVE_DOT is set to YES.
2588 DOT_GRAPH_MAX_NODES = 500
2590 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2591 # generated by dot. A depth value of 3 means that only nodes reachable from the
2592 # root by following a path via at most 3 edges will be shown. Nodes that lay
2593 # further from the root node will be omitted. Note that setting this option to 1
2594 # or 2 may greatly reduce the computation time needed for large code bases. Also
2595 # note that the size of a graph can be further restricted by
2596 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2597 # Minimum value: 0, maximum value: 1000, default value: 0.
2598 # This tag requires that the tag HAVE_DOT is set to YES.
2600 MAX_DOT_GRAPH_DEPTH = 0
2602 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2603 # background. This is disabled by default, because dot on Windows does not seem
2604 # to support this out of the box.
2606 # Warning: Depending on the platform used, enabling this option may lead to
2607 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2609 # The default value is: NO.
2610 # This tag requires that the tag HAVE_DOT is set to YES.
2612 DOT_TRANSPARENT = YES
2614 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2615 # files in one run (i.e. multiple -o and -T options on the command line). This
2616 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2617 # this, this feature is disabled by default.
2618 # The default value is: NO.
2619 # This tag requires that the tag HAVE_DOT is set to YES.
2621 DOT_MULTI_TARGETS = YES
2623 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2624 # explaining the meaning of the various boxes and arrows in the dot generated
2626 # The default value is: YES.
2627 # This tag requires that the tag HAVE_DOT is set to YES.
2629 GENERATE_LEGEND = YES
2631 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2632 # files that are used to generate the various graphs.
2634 # Note: This setting is not only used for dot files but also for msc and
2635 # plantuml temporary files.
2636 # The default value is: YES.