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 (\" \").
18 # Use doxygen to compare the used configuration file with the template
20 # doxygen -x [configFile]
21 # Use doxygen to compare the used configuration file with the template
22 # configuration file without replacing the environment variables or CMake type
23 # replacement variables:
24 # doxygen -x_noenv [configFile]
26 #---------------------------------------------------------------------------
27 # Project related configuration options
28 #---------------------------------------------------------------------------
30 # This tag specifies the encoding used for all characters in the configuration
31 # file that follow. The default is UTF-8 which is also the encoding used for all
32 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
33 # iconv built into libc) for the transcoding. See
34 # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
35 # The default value is: UTF-8.
37 DOXYFILE_ENCODING = UTF-8
39 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
40 # double-quotes, unless you are using Doxywizard) that should identify the
41 # project for which the documentation is generated. This name is used in the
42 # title of most generated pages and in a few other places.
43 # The default value is: My Project.
47 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
48 # could be handy for archiving the generated documentation or if some version
49 # control system is used.
51 PROJECT_NUMBER = Snapshot
53 # Using the PROJECT_BRIEF tag one can provide an optional one line description
54 # for a project that appears at the top of each page and should give viewer a
55 # quick idea about the purpose of the project. Keep the description short.
59 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
60 # in the documentation. The maximum height of the logo should not exceed 55
61 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
62 # the logo to the output directory.
66 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
67 # into which the generated documentation will be written. If a relative path is
68 # entered, it will be relative to the location where doxygen was started. If
69 # left blank the current directory will be used.
73 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
74 # sub-directories (in 2 levels) under the output directory of each output format
75 # and will distribute the generated files over these directories. Enabling this
76 # option can be useful when feeding doxygen a huge amount of source files, where
77 # putting all generated files in the same directory would otherwise causes
78 # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
79 # control the number of sub-directories.
80 # The default value is: NO.
84 # Controls the number of sub-directories that will be created when
85 # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
86 # level increment doubles the number of directories, resulting in 4096
87 # directories at level 8 which is the default and also the maximum value. The
88 # sub-directories are organized in 2 levels, the first level always has a fixed
89 # numer of 16 directories.
90 # Minimum value: 0, maximum value: 8, default value: 8.
91 # This tag requires that the tag CREATE_SUBDIRS is set to YES.
93 CREATE_SUBDIRS_LEVEL = 8
95 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
96 # characters to appear in the names of generated files. If set to NO, non-ASCII
97 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
99 # The default value is: NO.
101 ALLOW_UNICODE_NAMES = NO
103 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
104 # documentation generated by doxygen is written. Doxygen will use this
105 # information to generate all constant output in the proper language.
106 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
107 # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
108 # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
109 # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
110 # English messages), Korean, Korean-en (Korean with English messages), Latvian,
111 # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
112 # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
113 # Swedish, Turkish, Ukrainian and Vietnamese.
114 # The default value is: English.
116 OUTPUT_LANGUAGE = English
118 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
119 # descriptions after the members that are listed in the file and class
120 # documentation (similar to Javadoc). Set to NO to disable this.
121 # The default value is: YES.
123 BRIEF_MEMBER_DESC = YES
125 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
126 # description of a member or function before the detailed description
128 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
129 # brief descriptions will be completely suppressed.
130 # The default value is: YES.
134 # This tag implements a quasi-intelligent brief description abbreviator that is
135 # used to form the text in various listings. Each string in this list, if found
136 # as the leading text of the brief description, will be stripped from the text
137 # and the result, after processing the whole list, is used as the annotated
138 # text. Otherwise, the brief description is used as-is. If left blank, the
139 # following values are used ($name is automatically replaced with the name of
140 # the entity):The $name class, The $name widget, The $name file, is, provides,
141 # specifies, contains, represents, a, an and the.
145 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
146 # doxygen will generate a detailed section even if there is only a brief
148 # The default value is: NO.
150 ALWAYS_DETAILED_SEC = NO
152 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
153 # inherited members of a class in the documentation of that class as if those
154 # members were ordinary class members. Constructors, destructors and assignment
155 # operators of the base classes will not be shown.
156 # The default value is: NO.
158 INLINE_INHERITED_MEMB = NO
160 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
161 # before files name in the file list and in the header files. If set to NO the
162 # shortest path that makes the file name unique will be used
163 # The default value is: YES.
167 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
168 # Stripping is only done if one of the specified strings matches the left-hand
169 # part of the path. The tag can be used to show relative paths in the file list.
170 # If left blank the directory from which doxygen is run is used as the path to
173 # Note that you can specify absolute paths here, but also relative paths, which
174 # will be relative from the directory where doxygen is started.
175 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
179 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
180 # path mentioned in the documentation of a class, which tells the reader which
181 # header file to include in order to use a class. If left blank only the name of
182 # the header file containing the class definition is used. Otherwise one should
183 # specify the list of include paths that are normally passed to the compiler
186 STRIP_FROM_INC_PATH =
188 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
189 # less readable) file names. This can be useful is your file systems doesn't
190 # support long names like on DOS, Mac, or CD-ROM.
191 # The default value is: NO.
195 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
196 # first line (until the first dot) of a Javadoc-style comment as the brief
197 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
198 # style comments (thus requiring an explicit @brief command for a brief
200 # The default value is: NO.
202 JAVADOC_AUTOBRIEF = NO
204 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
207 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
208 # Javadoc-style will behave just like regular comments and it will not be
209 # interpreted by doxygen.
210 # The default value is: NO.
214 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
215 # line (until the first dot) of a Qt-style comment as the brief description. If
216 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
217 # requiring an explicit \brief command for a brief description.)
218 # The default value is: NO.
222 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
223 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
224 # a brief description. This used to be the default behavior. The new default is
225 # to treat a multi-line C++ comment block as a detailed description. Set this
226 # tag to YES if you prefer the old behavior instead.
228 # Note that setting this tag to YES also means that rational rose comments are
229 # not recognized any more.
230 # The default value is: NO.
232 MULTILINE_CPP_IS_BRIEF = NO
234 # By default Python docstrings are displayed as preformatted text and doxygen's
235 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
236 # doxygen's special commands can be used and the contents of the docstring
237 # documentation blocks is shown as doxygen documentation.
238 # The default value is: YES.
240 PYTHON_DOCSTRING = YES
242 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
243 # documentation from any documented member that it re-implements.
244 # The default value is: YES.
248 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
249 # page for each member. If set to NO, the documentation of a member will be part
250 # of the file/class/namespace that contains it.
251 # The default value is: NO.
253 SEPARATE_MEMBER_PAGES = NO
255 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
256 # uses this value to replace tabs by spaces in code fragments.
257 # Minimum value: 1, maximum value: 16, default value: 4.
261 # This tag can be used to specify a number of aliases that act as commands in
262 # the documentation. An alias has the form:
265 # "sideeffect=@par Side Effects:^^"
266 # will allow you to put the command \sideeffect (or @sideeffect) in the
267 # documentation, which will result in a user-defined paragraph with heading
268 # "Side Effects:". Note that you cannot put \n's in the value part of an alias
269 # to insert newlines (in the resulting output). You can put ^^ in the value part
270 # of an alias to insert a newline as if a physical newline was in the original
271 # file. When you need a literal { or } or , in the value part of an alias you
272 # have to escape them by means of a backslash (\), this can lead to conflicts
273 # with the commands \{ and \} for these it is advised to use the version @{ and
274 # @} or use a double escape (\\{ and \\})
278 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
279 # only. Doxygen will then generate output that is more tailored for C. For
280 # instance, some of the names that are used will be different. The list of all
281 # members will be omitted, etc.
282 # The default value is: NO.
284 OPTIMIZE_OUTPUT_FOR_C = NO
286 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
287 # Python sources only. Doxygen will then generate output that is more tailored
288 # for that language. For instance, namespaces will be presented as packages,
289 # qualified scopes will look different, etc.
290 # The default value is: NO.
292 OPTIMIZE_OUTPUT_JAVA = NO
294 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
295 # sources. Doxygen will then generate output that is tailored for Fortran.
296 # The default value is: NO.
298 OPTIMIZE_FOR_FORTRAN = NO
300 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
301 # sources. Doxygen will then generate output that is tailored for VHDL.
302 # The default value is: NO.
304 OPTIMIZE_OUTPUT_VHDL = NO
306 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
307 # sources only. Doxygen will then generate output that is more tailored for that
308 # language. For instance, namespaces will be presented as modules, types will be
309 # separated into more groups, etc.
310 # The default value is: NO.
312 OPTIMIZE_OUTPUT_SLICE = NO
314 # Doxygen selects the parser to use depending on the extension of the files it
315 # parses. With this tag you can assign which parser to use for a given
316 # extension. Doxygen has a built-in mapping, but you can override or extend it
317 # using this tag. The format is ext=language, where ext is a file extension, and
318 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
319 # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
320 # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
321 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
322 # tries to guess whether the code is fixed or free formatted code, this is the
323 # default for Fortran type files). For instance to make doxygen treat .inc files
324 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
325 # use: inc=Fortran f=C.
327 # Note: For files without extension you can use no_extension as a placeholder.
329 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
330 # the files are not read by doxygen. When specifying no_extension you should add
331 # * to the FILE_PATTERNS.
333 # Note see also the list of default file extension mappings.
337 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
338 # according to the Markdown format, which allows for more readable
339 # documentation. See https://daringfireball.net/projects/markdown/ for details.
340 # The output of markdown processing is further processed by doxygen, so you can
341 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
342 # case of backward compatibilities issues.
343 # The default value is: YES.
345 MARKDOWN_SUPPORT = YES
347 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
348 # to that level are automatically included in the table of contents, even if
349 # they do not have an id attribute.
350 # Note: This feature currently applies only to Markdown headings.
351 # Minimum value: 0, maximum value: 99, default value: 5.
352 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
354 TOC_INCLUDE_HEADINGS = 0
356 # When enabled doxygen tries to link words that correspond to documented
357 # classes, or namespaces to their corresponding documentation. Such a link can
358 # be prevented in individual cases by putting a % sign in front of the word or
359 # globally by setting AUTOLINK_SUPPORT to NO.
360 # The default value is: YES.
362 AUTOLINK_SUPPORT = YES
364 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
365 # to include (a tag file for) the STL sources as input, then you should set this
366 # tag to YES in order to let doxygen match functions declarations and
367 # definitions whose arguments contain STL classes (e.g. func(std::string);
368 # versus func(std::string) {}). This also make the inheritance and collaboration
369 # diagrams that involve STL classes more complete and accurate.
370 # The default value is: NO.
372 BUILTIN_STL_SUPPORT = YES
374 # If you use Microsoft's C++/CLI language, you should set this option to YES to
375 # enable parsing support.
376 # The default value is: NO.
380 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
381 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
382 # will parse them like normal C++ but will assume all classes use public instead
383 # of private inheritance when no explicit protection keyword is present.
384 # The default value is: NO.
388 # For Microsoft's IDL there are propget and propput attributes to indicate
389 # getter and setter methods for a property. Setting this option to YES will make
390 # doxygen to replace the get and set methods by a property in the documentation.
391 # This will only work if the methods are indeed getting or setting a simple
392 # type. If this is not the case, or you want to show the methods anyway, you
393 # should set this option to NO.
394 # The default value is: YES.
396 IDL_PROPERTY_SUPPORT = YES
398 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
399 # tag is set to YES then doxygen will reuse the documentation of the first
400 # member in the group (if any) for the other members of the group. By default
401 # all members of a group must be documented explicitly.
402 # The default value is: NO.
404 DISTRIBUTE_GROUP_DOC = YES
406 # If one adds a struct or class to a group and this option is enabled, then also
407 # any nested class or struct is added to the same group. By default this option
408 # is disabled and one has to add nested compounds explicitly via \ingroup.
409 # The default value is: NO.
411 GROUP_NESTED_COMPOUNDS = NO
413 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
414 # (for instance a group of public functions) to be put as a subgroup of that
415 # type (e.g. under the Public Functions section). Set it to NO to prevent
416 # subgrouping. Alternatively, this can be done per class using the
417 # \nosubgrouping command.
418 # The default value is: YES.
422 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
423 # are shown inside the group in which they are included (e.g. using \ingroup)
424 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
427 # Note that this feature does not work in combination with
428 # SEPARATE_MEMBER_PAGES.
429 # The default value is: NO.
431 INLINE_GROUPED_CLASSES = NO
433 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
434 # with only public data fields or simple typedef fields will be shown inline in
435 # the documentation of the scope in which they are defined (i.e. file,
436 # namespace, or group documentation), provided this scope is documented. If set
437 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
438 # Man pages) or section (for LaTeX and RTF).
439 # The default value is: NO.
441 INLINE_SIMPLE_STRUCTS = NO
443 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
444 # enum is documented as struct, union, or enum with the name of the typedef. So
445 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
446 # with name TypeT. When disabled the typedef will appear as a member of a file,
447 # namespace, or class. And the struct will be named TypeS. This can typically be
448 # useful for C code in case the coding convention dictates that all compound
449 # types are typedef'ed and only the typedef is referenced, never the tag name.
450 # The default value is: NO.
452 TYPEDEF_HIDES_STRUCT = NO
454 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
455 # cache is used to resolve symbols given their name and scope. Since this can be
456 # an expensive process and often the same symbol appears multiple times in the
457 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
458 # doxygen will become slower. If the cache is too large, memory is wasted. The
459 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
460 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
461 # symbols. At the end of a run doxygen will report the cache usage and suggest
462 # the optimal cache size from a speed point of view.
463 # Minimum value: 0, maximum value: 9, default value: 0.
465 LOOKUP_CACHE_SIZE = 0
467 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
468 # during processing. When set to 0 doxygen will based this on the number of
469 # cores available in the system. You can set it explicitly to a value larger
470 # than 0 to get more control over the balance between CPU load and processing
471 # speed. At this moment only the input processing can be done using multiple
472 # threads. Since this is still an experimental feature the default is set to 1,
473 # which effectively disables parallel processing. Please report any issues you
474 # encounter. Generating dot graphs in parallel is controlled by the
475 # DOT_NUM_THREADS setting.
476 # Minimum value: 0, maximum value: 32, default value: 1.
480 #---------------------------------------------------------------------------
481 # Build related configuration options
482 #---------------------------------------------------------------------------
484 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
485 # documentation are documented, even if no documentation was available. Private
486 # class members and static file members will be hidden unless the
487 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
488 # Note: This will also disable the warnings about undocumented members that are
489 # normally produced when WARNINGS is set to YES.
490 # The default value is: NO.
494 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
495 # be included in the documentation.
496 # The default value is: NO.
498 EXTRACT_PRIVATE = YES
500 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
501 # methods of a class will be included in the documentation.
502 # The default value is: NO.
504 EXTRACT_PRIV_VIRTUAL = NO
506 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
507 # scope will be included in the documentation.
508 # The default value is: NO.
512 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
513 # included in the documentation.
514 # The default value is: NO.
518 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
519 # locally in source files will be included in the documentation. If set to NO,
520 # only classes defined in header files are included. Does not have any effect
522 # The default value is: YES.
524 EXTRACT_LOCAL_CLASSES = YES
526 # This flag is only useful for Objective-C code. If set to YES, local methods,
527 # which are defined in the implementation section but not in the interface are
528 # included in the documentation. If set to NO, only methods in the interface are
530 # The default value is: NO.
532 EXTRACT_LOCAL_METHODS = NO
534 # If this flag is set to YES, the members of anonymous namespaces will be
535 # extracted and appear in the documentation as a namespace called
536 # 'anonymous_namespace{file}', where file will be replaced with the base name of
537 # the file that contains the anonymous namespace. By default anonymous namespace
539 # The default value is: NO.
541 EXTRACT_ANON_NSPACES = NO
543 # If this flag is set to YES, the name of an unnamed parameter in a declaration
544 # will be determined by the corresponding definition. By default unnamed
545 # parameters remain unnamed in the output.
546 # The default value is: YES.
548 RESOLVE_UNNAMED_PARAMS = YES
550 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
551 # undocumented members inside documented classes or files. If set to NO these
552 # members will be included in the various overviews, but no documentation
553 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
554 # The default value is: NO.
556 HIDE_UNDOC_MEMBERS = NO
558 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
559 # undocumented classes that are normally visible in the class hierarchy. If set
560 # to NO, these classes will be included in the various overviews. This option
561 # has no effect if EXTRACT_ALL is enabled.
562 # The default value is: NO.
564 HIDE_UNDOC_CLASSES = NO
566 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
567 # declarations. If set to NO, these declarations will be included in the
569 # The default value is: NO.
571 HIDE_FRIEND_COMPOUNDS = NO
573 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
574 # documentation blocks found inside the body of a function. If set to NO, these
575 # blocks will be appended to the function's detailed documentation block.
576 # The default value is: NO.
578 HIDE_IN_BODY_DOCS = NO
580 # The INTERNAL_DOCS tag determines if documentation that is typed after a
581 # \internal command is included. If the tag is set to NO then the documentation
582 # will be excluded. Set it to YES to include the internal documentation.
583 # The default value is: NO.
587 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
588 # able to match the capabilities of the underlying filesystem. In case the
589 # filesystem is case sensitive (i.e. it supports files in the same directory
590 # whose names only differ in casing), the option must be set to YES to properly
591 # deal with such files in case they appear in the input. For filesystems that
592 # are not case sensitive the option should be set to NO to properly deal with
593 # output files written for symbols that only differ in casing, such as for two
594 # classes, one named CLASS and the other named Class, and to also support
595 # references to files without having to specify the exact matching casing. On
596 # Windows (including Cygwin) and MacOS, users should typically set this option
597 # to NO, whereas on Linux or other Unix flavors it should typically be set to
599 # Possible values are: SYSTEM, NO and YES.
600 # The default value is: SYSTEM.
602 CASE_SENSE_NAMES = YES
604 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
605 # their full class and namespace scopes in the documentation. If set to YES, the
606 # scope will be hidden.
607 # The default value is: NO.
609 HIDE_SCOPE_NAMES = NO
611 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
612 # append additional text to a page's title, such as Class Reference. If set to
613 # YES the compound reference will be hidden.
614 # The default value is: NO.
616 HIDE_COMPOUND_REFERENCE= NO
618 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
619 # will show which file needs to be included to use the class.
620 # The default value is: YES.
622 SHOW_HEADERFILE = YES
624 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
625 # the files that are included by a file in the documentation of that file.
626 # The default value is: YES.
628 SHOW_INCLUDE_FILES = YES
630 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
631 # grouped member an include statement to the documentation, telling the reader
632 # which file to include in order to use the member.
633 # The default value is: NO.
635 SHOW_GROUPED_MEMB_INC = NO
637 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
638 # files with double quotes in the documentation rather than with sharp brackets.
639 # The default value is: NO.
641 FORCE_LOCAL_INCLUDES = NO
643 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
644 # documentation for inline members.
645 # The default value is: YES.
649 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
650 # (detailed) documentation of file and class members alphabetically by member
651 # name. If set to NO, the members will appear in declaration order.
652 # The default value is: YES.
654 SORT_MEMBER_DOCS = YES
656 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
657 # descriptions of file, namespace and class members alphabetically by member
658 # name. If set to NO, the members will appear in declaration order. Note that
659 # this will also influence the order of the classes in the class list.
660 # The default value is: NO.
664 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
665 # (brief and detailed) documentation of class members so that constructors and
666 # destructors are listed first. If set to NO the constructors will appear in the
667 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
668 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
669 # member documentation.
670 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
671 # detailed member documentation.
672 # The default value is: NO.
674 SORT_MEMBERS_CTORS_1ST = NO
676 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
677 # of group names into alphabetical order. If set to NO the group names will
678 # appear in their defined order.
679 # The default value is: NO.
681 SORT_GROUP_NAMES = NO
683 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
684 # fully-qualified names, including namespaces. If set to NO, the class list will
685 # be sorted only by class name, not including the namespace part.
686 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
687 # Note: This option applies only to the class list, not to the alphabetical
689 # The default value is: NO.
691 SORT_BY_SCOPE_NAME = NO
693 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
694 # type resolution of all parameters of a function it will reject a match between
695 # the prototype and the implementation of a member function even if there is
696 # only one candidate or it is obvious which candidate to choose by doing a
697 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
698 # accept a match between prototype and implementation in such cases.
699 # The default value is: NO.
701 STRICT_PROTO_MATCHING = NO
703 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
704 # list. This list is created by putting \todo commands in the documentation.
705 # The default value is: YES.
707 GENERATE_TODOLIST = YES
709 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
710 # list. This list is created by putting \test commands in the documentation.
711 # The default value is: YES.
713 GENERATE_TESTLIST = YES
715 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
716 # list. This list is created by putting \bug commands in the documentation.
717 # The default value is: YES.
719 GENERATE_BUGLIST = YES
721 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
722 # the deprecated list. This list is created by putting \deprecated commands in
724 # The default value is: YES.
726 GENERATE_DEPRECATEDLIST= YES
728 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
729 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
730 # ... \endcond blocks.
734 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
735 # initial value of a variable or macro / define can have for it to appear in the
736 # documentation. If the initializer consists of more lines than specified here
737 # it will be hidden. Use a value of 0 to hide initializers completely. The
738 # appearance of the value of individual variables and macros / defines can be
739 # controlled using \showinitializer or \hideinitializer command in the
740 # documentation regardless of this setting.
741 # Minimum value: 0, maximum value: 10000, default value: 30.
743 MAX_INITIALIZER_LINES = 30
745 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
746 # the bottom of the documentation of classes and structs. If set to YES, the
747 # list will mention the files that were used to generate the documentation.
748 # The default value is: YES.
750 SHOW_USED_FILES = YES
752 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
753 # will remove the Files entry from the Quick Index and from the Folder Tree View
755 # The default value is: YES.
759 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
760 # page. This will remove the Namespaces entry from the Quick Index and from the
761 # Folder Tree View (if specified).
762 # The default value is: YES.
764 SHOW_NAMESPACES = YES
766 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
767 # doxygen should invoke to get the current version for each file (typically from
768 # the version control system). Doxygen will invoke the program by executing (via
769 # popen()) the command command input-file, where command is the value of the
770 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
771 # by doxygen. Whatever the program writes to standard output is used as the file
772 # version. For an example see the documentation.
774 FILE_VERSION_FILTER =
776 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
777 # by doxygen. The layout file controls the global structure of the generated
778 # output files in an output format independent way. To create the layout file
779 # that represents doxygen's defaults, run doxygen with the -l option. You can
780 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
781 # will be used as the name of the layout file. See also section "Changing the
782 # layout of pages" for information.
784 # Note that if you run doxygen from a directory containing a file called
785 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
790 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
791 # the reference definitions. This must be a list of .bib files. The .bib
792 # extension is automatically appended if omitted. This requires the bibtex tool
793 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
794 # For LaTeX the style of the bibliography can be controlled using
795 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
796 # search path. See also \cite for info how to create references.
800 #---------------------------------------------------------------------------
801 # Configuration options related to warning and progress messages
802 #---------------------------------------------------------------------------
804 # The QUIET tag can be used to turn on/off the messages that are generated to
805 # standard output by doxygen. If QUIET is set to YES this implies that the
807 # The default value is: NO.
811 # The WARNINGS tag can be used to turn on/off the warning messages that are
812 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
813 # this implies that the warnings are on.
815 # Tip: Turn warnings on while writing the documentation.
816 # The default value is: YES.
820 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
821 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
822 # will automatically be disabled.
823 # The default value is: YES.
825 WARN_IF_UNDOCUMENTED = YES
827 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
828 # potential errors in the documentation, such as documenting some parameters in
829 # a documented function twice, or documenting parameters that don't exist or
830 # using markup commands wrongly.
831 # The default value is: YES.
833 WARN_IF_DOC_ERROR = YES
835 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
836 # function parameter documentation. If set to NO, doxygen will accept that some
837 # parameters have no documentation without warning.
838 # The default value is: YES.
840 WARN_IF_INCOMPLETE_DOC = YES
842 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
843 # are documented, but have no documentation for their parameters or return
844 # value. If set to NO, doxygen will only warn about wrong parameter
845 # documentation, but not about the absence of documentation. If EXTRACT_ALL is
846 # set to YES then this flag will automatically be disabled. See also
847 # WARN_IF_INCOMPLETE_DOC
848 # The default value is: NO.
850 WARN_NO_PARAMDOC = NO
852 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
853 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
854 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
855 # at the end of the doxygen process doxygen will return with a non-zero status.
856 # Possible values are: NO, YES and FAIL_ON_WARNINGS.
857 # The default value is: NO.
861 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
862 # can produce. The string should contain the $file, $line, and $text tags, which
863 # will be replaced by the file and line number from which the warning originated
864 # and the warning text. Optionally the format may contain $version, which will
865 # be replaced by the version of the file (if it could be obtained via
866 # FILE_VERSION_FILTER)
867 # See also: WARN_LINE_FORMAT
868 # The default value is: $file:$line: $text.
870 WARN_FORMAT = "$file:$line: $text"
872 # In the $text part of the WARN_FORMAT command it is possible that a reference
873 # to a more specific place is given. To make it easier to jump to this place
874 # (outside of doxygen) the user can define a custom "cut" / "paste" string.
876 # WARN_LINE_FORMAT = "'vi $file +$line'"
877 # See also: WARN_FORMAT
878 # The default value is: at line $line of file $file.
880 WARN_LINE_FORMAT = "at line $line of file $file"
882 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
883 # messages should be written. If left blank the output is written to standard
884 # error (stderr). In case the file specified cannot be opened for writing the
885 # warning and error messages are written to standard error. When as file - is
886 # specified the warning and error messages are written to standard output
891 #---------------------------------------------------------------------------
892 # Configuration options related to the input files
893 #---------------------------------------------------------------------------
895 # The INPUT tag is used to specify the files and/or directories that contain
896 # documented source files. You may enter file names like myfile.cpp or
897 # directories like /usr/src/myproject. Separate the files or directories with
898 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
899 # Note: If this tag is empty the current directory is searched.
903 # This tag can be used to specify the character encoding of the source files
904 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
905 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
906 # documentation (see:
907 # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
908 # See also: INPUT_FILE_ENCODING
909 # The default value is: UTF-8.
911 INPUT_ENCODING = UTF-8
913 # This tag can be used to specify the character encoding of the source files
914 # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
915 # character encoding on a per file pattern basis. Doxygen will compare the file
916 # name with each pattern and apply the encoding instead of the default
917 # INPUT_ENCODING) if there is a match. The character encodings are a list of the
918 # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
919 # "INPUT_ENCODING" for further information on supported encodings.
921 INPUT_FILE_ENCODING =
923 # If the value of the INPUT tag contains directories, you can use the
924 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
925 # *.h) to filter out the source-files in the directories.
927 # Note that for custom extensions or not directly supported extensions you also
928 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
931 # Note the list of default checked file patterns might differ from the list of
932 # default file extension mappings.
934 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
935 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
936 # *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
937 # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
938 # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
939 # *.vhdl, *.ucf, *.qsf and *.ice.
941 FILE_PATTERNS = *.cpp \
947 # The RECURSIVE tag can be used to specify whether or not subdirectories should
948 # be searched for input files as well.
949 # The default value is: NO.
953 # The EXCLUDE tag can be used to specify files and/or directories that should be
954 # excluded from the INPUT source files. This way you can easily exclude a
955 # subdirectory from a directory tree whose root is specified with the INPUT tag.
957 # Note that relative paths are relative to the directory from which doxygen is
962 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
963 # directories that are symbolic links (a Unix file system feature) are excluded
965 # The default value is: NO.
967 EXCLUDE_SYMLINKS = NO
969 # If the value of the INPUT tag contains directories, you can use the
970 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
971 # certain files from those directories.
973 # Note that the wildcards are matched against the file with absolute path, so to
974 # exclude all test directories for example use the pattern */test/*
978 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
979 # (namespaces, classes, functions, etc.) that should be excluded from the
980 # output. The symbol name can be a fully qualified name, a word, or if the
981 # wildcard * is used, a substring. Examples: ANamespace, AClass,
982 # ANamespace::AClass, ANamespace::*Test
984 # Note that the wildcards are matched against the file with absolute path, so to
985 # exclude all test directories use the pattern */test/*
989 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
990 # that contain example code fragments that are included (see the \include
995 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
996 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
997 # *.h) to filter out the source-files in the directories. If left blank all
998 # files are included.
1002 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1003 # searched for input files to be used with the \include or \dontinclude commands
1004 # irrespective of the value of the RECURSIVE tag.
1005 # The default value is: NO.
1007 EXAMPLE_RECURSIVE = NO
1009 # The IMAGE_PATH tag can be used to specify one or more files or directories
1010 # that contain images that are to be included in the documentation (see the
1015 # The INPUT_FILTER tag can be used to specify a program that doxygen should
1016 # invoke to filter for each input file. Doxygen will invoke the filter program
1017 # by executing (via popen()) the command:
1019 # <filter> <input-file>
1021 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1022 # name of an input file. Doxygen will then use the output that the filter
1023 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1026 # Note that the filter must not add or remove lines; it is applied before the
1027 # code is scanned, but not when the output code is generated. If lines are added
1028 # or removed, the anchors will not be placed correctly.
1030 # Note that doxygen will use the data processed and written to standard output
1031 # for further processing, therefore nothing else, like debug statements or used
1032 # commands (so in case of a Windows batch file always use @echo OFF), should be
1033 # written to standard output.
1035 # Note that for custom extensions or not directly supported extensions you also
1036 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1037 # properly processed by doxygen.
1041 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1042 # basis. Doxygen will compare the file name with each pattern and apply the
1043 # filter if there is a match. The filters are a list of the form: pattern=filter
1044 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1045 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1046 # patterns match the file name, INPUT_FILTER is applied.
1048 # Note that for custom extensions or not directly supported extensions you also
1049 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1050 # properly processed by doxygen.
1054 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1055 # INPUT_FILTER) will also be used to filter the input files that are used for
1056 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1057 # The default value is: NO.
1059 FILTER_SOURCE_FILES = NO
1061 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1062 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1063 # it is also possible to disable source filtering for a specific pattern using
1064 # *.ext= (so without naming a filter).
1065 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1067 FILTER_SOURCE_PATTERNS =
1069 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1070 # is part of the input, its contents will be placed on the main page
1071 # (index.html). This can be useful if you have a project on for instance GitHub
1072 # and want to reuse the introduction page also for the doxygen output.
1074 USE_MDFILE_AS_MAINPAGE =
1076 # The Fortran standard specifies that for fixed formatted Fortran code all
1077 # characters from position 72 are to be considered as comment. A common
1078 # extension is to allow longer lines before the automatic comment starts. The
1079 # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1080 # be processed before the automatic comment starts.
1081 # Minimum value: 7, maximum value: 10000, default value: 72.
1083 FORTRAN_COMMENT_AFTER = 72
1085 #---------------------------------------------------------------------------
1086 # Configuration options related to source browsing
1087 #---------------------------------------------------------------------------
1089 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1090 # generated. Documented entities will be cross-referenced with these sources.
1092 # Note: To get rid of all source code in the generated output, make sure that
1093 # also VERBATIM_HEADERS is set to NO.
1094 # The default value is: NO.
1096 SOURCE_BROWSER = YES
1098 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1099 # classes and enums directly into the documentation.
1100 # The default value is: NO.
1102 INLINE_SOURCES = YES
1104 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1105 # special comment blocks from generated source code fragments. Normal C, C++ and
1106 # Fortran comments will always remain visible.
1107 # The default value is: YES.
1109 STRIP_CODE_COMMENTS = NO
1111 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1112 # entity all documented functions referencing it will be listed.
1113 # The default value is: NO.
1115 REFERENCED_BY_RELATION = NO
1117 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1118 # all documented entities called/used by that function will be listed.
1119 # The default value is: NO.
1121 REFERENCES_RELATION = NO
1123 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1124 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1125 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1126 # link to the documentation.
1127 # The default value is: YES.
1129 REFERENCES_LINK_SOURCE = YES
1131 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1132 # source code will show a tooltip with additional information such as prototype,
1133 # brief description and links to the definition and documentation. Since this
1134 # will make the HTML file larger and loading of large files a bit slower, you
1135 # can opt to disable this feature.
1136 # The default value is: YES.
1137 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1139 SOURCE_TOOLTIPS = YES
1141 # If the USE_HTAGS tag is set to YES then the references to source code will
1142 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1143 # source browser. The htags tool is part of GNU's global source tagging system
1144 # (see https://www.gnu.org/software/global/global.html). You will need version
1147 # To use it do the following:
1148 # - Install the latest version of global
1149 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1150 # - Make sure the INPUT points to the root of the source tree
1151 # - Run doxygen as normal
1153 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1154 # tools must be available from the command line (i.e. in the search path).
1156 # The result: instead of the source browser generated by doxygen, the links to
1157 # source code will now point to the output of htags.
1158 # The default value is: NO.
1159 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1163 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1164 # verbatim copy of the header file for each class for which an include is
1165 # specified. Set to NO to disable this.
1166 # See also: Section \class.
1167 # The default value is: YES.
1169 VERBATIM_HEADERS = YES
1171 #---------------------------------------------------------------------------
1172 # Configuration options related to the alphabetical class index
1173 #---------------------------------------------------------------------------
1175 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1176 # compounds will be generated. Enable this if the project contains a lot of
1177 # classes, structs, unions or interfaces.
1178 # The default value is: YES.
1180 ALPHABETICAL_INDEX = YES
1182 # In case all classes in a project start with a common prefix, all classes will
1183 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1184 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1185 # while generating the index headers.
1186 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1188 IGNORE_PREFIX = ACEXML_
1190 #---------------------------------------------------------------------------
1191 # Configuration options related to the HTML output
1192 #---------------------------------------------------------------------------
1194 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1195 # The default value is: YES.
1199 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1200 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1202 # The default directory is: html.
1203 # This tag requires that the tag GENERATE_HTML is set to YES.
1205 HTML_OUTPUT = html/libacexml-doc
1207 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1208 # generated HTML page (for example: .htm, .php, .asp).
1209 # The default value is: .html.
1210 # This tag requires that the tag GENERATE_HTML is set to YES.
1212 HTML_FILE_EXTENSION = .html
1214 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1215 # each generated HTML page. If the tag is left blank doxygen will generate a
1218 # To get valid HTML the header file that includes any scripts and style sheets
1219 # that doxygen needs, which is dependent on the configuration options used (e.g.
1220 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1221 # default header using
1222 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1224 # and then modify the file new_header.html. See also section "Doxygen usage"
1225 # for information on how to generate the default header that doxygen normally
1227 # Note: The header is subject to change so you typically have to regenerate the
1228 # default header when upgrading to a newer version of doxygen. For a description
1229 # of the possible markers and block names see the documentation.
1230 # This tag requires that the tag GENERATE_HTML is set to YES.
1234 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1235 # generated HTML page. If the tag is left blank doxygen will generate a standard
1236 # footer. See HTML_HEADER for more information on how to generate a default
1237 # footer and what special commands can be used inside the footer. See also
1238 # section "Doxygen usage" for information on how to generate the default footer
1239 # that doxygen normally uses.
1240 # This tag requires that the tag GENERATE_HTML is set to YES.
1244 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1245 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1246 # the HTML output. If left blank doxygen will generate a default style sheet.
1247 # See also section "Doxygen usage" for information on how to generate the style
1248 # sheet that doxygen normally uses.
1249 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1250 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1252 # This tag requires that the tag GENERATE_HTML is set to YES.
1256 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1257 # cascading style sheets that are included after the standard style sheets
1258 # created by doxygen. Using this option one can overrule certain style aspects.
1259 # This is preferred over using HTML_STYLESHEET since it does not replace the
1260 # standard style sheet and is therefore more robust against future updates.
1261 # Doxygen will copy the style sheet files to the output directory.
1262 # Note: The order of the extra style sheet files is of importance (e.g. the last
1263 # style sheet in the list overrules the setting of the previous ones in the
1264 # list). For an example see the documentation.
1265 # This tag requires that the tag GENERATE_HTML is set to YES.
1267 HTML_EXTRA_STYLESHEET =
1269 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1270 # other source files which should be copied to the HTML output directory. Note
1271 # that these files will be copied to the base HTML output directory. Use the
1272 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1273 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1274 # files will be copied as-is; there are no commands or markers available.
1275 # This tag requires that the tag GENERATE_HTML is set to YES.
1279 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1280 # should be rendered with a dark or light theme. Default setting AUTO_LIGHT
1281 # enables light output unless the user preference is dark output. Other options
1282 # are DARK to always use dark mode, LIGHT to always use light mode, AUTO_DARK to
1283 # default to dark mode unless the user prefers light mode, and TOGGLE to let the
1284 # user toggle between dark and light mode via a button.
1285 # Possible values are: LIGHT Always generate light output., DARK Always generate
1286 # dark output., AUTO_LIGHT Automatically set the mode according to the user
1287 # preference, use light mode if no preference is set (the default)., AUTO_DARK
1288 # Automatically set the mode according to the user preference, use dark mode if
1289 # no preference is set. and TOGGLE Allow to user to switch between light and
1290 # dark mode via a button..
1291 # The default value is: AUTO_LIGHT.
1292 # This tag requires that the tag GENERATE_HTML is set to YES.
1294 HTML_COLORSTYLE = AUTO_LIGHT
1296 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1297 # will adjust the colors in the style sheet and background images according to
1298 # this color. Hue is specified as an angle on a color-wheel, see
1299 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1300 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1301 # purple, and 360 is red again.
1302 # Minimum value: 0, maximum value: 359, default value: 220.
1303 # This tag requires that the tag GENERATE_HTML is set to YES.
1305 HTML_COLORSTYLE_HUE = 220
1307 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1308 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1309 # value of 255 will produce the most vivid colors.
1310 # Minimum value: 0, maximum value: 255, default value: 100.
1311 # This tag requires that the tag GENERATE_HTML is set to YES.
1313 HTML_COLORSTYLE_SAT = 100
1315 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1316 # luminance component of the colors in the HTML output. Values below 100
1317 # gradually make the output lighter, whereas values above 100 make the output
1318 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1319 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1321 # Minimum value: 40, maximum value: 240, default value: 80.
1322 # This tag requires that the tag GENERATE_HTML is set to YES.
1324 HTML_COLORSTYLE_GAMMA = 80
1326 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1327 # page will contain the date and time when the page was generated. Setting this
1328 # to YES can help to show when doxygen was last run and thus if the
1329 # documentation is up to date.
1330 # The default value is: NO.
1331 # This tag requires that the tag GENERATE_HTML is set to YES.
1335 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1336 # documentation will contain a main index with vertical navigation menus that
1337 # are dynamically created via JavaScript. If disabled, the navigation index will
1338 # consists of multiple levels of tabs that are statically embedded in every HTML
1339 # page. Disable this option to support browsers that do not have JavaScript,
1340 # like the Qt help browser.
1341 # The default value is: YES.
1342 # This tag requires that the tag GENERATE_HTML is set to YES.
1344 HTML_DYNAMIC_MENUS = YES
1346 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1347 # documentation will contain sections that can be hidden and shown after the
1349 # The default value is: NO.
1350 # This tag requires that the tag GENERATE_HTML is set to YES.
1352 HTML_DYNAMIC_SECTIONS = NO
1354 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1355 # shown in the various tree structured indices initially; the user can expand
1356 # and collapse entries dynamically later on. Doxygen will expand the tree to
1357 # such a level that at most the specified number of entries are visible (unless
1358 # a fully collapsed tree already exceeds this amount). So setting the number of
1359 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1360 # representing an infinite number of entries and will result in a full expanded
1362 # Minimum value: 0, maximum value: 9999, default value: 100.
1363 # This tag requires that the tag GENERATE_HTML is set to YES.
1365 HTML_INDEX_NUM_ENTRIES = 100
1367 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1368 # generated that can be used as input for Apple's Xcode 3 integrated development
1370 # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1371 # create a documentation set, doxygen will generate a Makefile in the HTML
1372 # output directory. Running make will produce the docset in that directory and
1373 # running make install will install the docset in
1374 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1375 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1376 # genXcode/_index.html for more information.
1377 # The default value is: NO.
1378 # This tag requires that the tag GENERATE_HTML is set to YES.
1380 GENERATE_DOCSET = NO
1382 # This tag determines the name of the docset feed. A documentation feed provides
1383 # an umbrella under which multiple documentation sets from a single provider
1384 # (such as a company or product suite) can be grouped.
1385 # The default value is: Doxygen generated docs.
1386 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1388 DOCSET_FEEDNAME = "Doxygen generated docs"
1390 # This tag determines the URL of the docset feed. A documentation feed provides
1391 # an umbrella under which multiple documentation sets from a single provider
1392 # (such as a company or product suite) can be grouped.
1393 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1397 # This tag specifies a string that should uniquely identify the documentation
1398 # set bundle. This should be a reverse domain-name style string, e.g.
1399 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1400 # The default value is: org.doxygen.Project.
1401 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1403 DOCSET_BUNDLE_ID = org.doxygen.Project
1405 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1406 # the documentation publisher. This should be a reverse domain-name style
1407 # string, e.g. com.mycompany.MyDocSet.documentation.
1408 # The default value is: org.doxygen.Publisher.
1409 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1411 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1413 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1414 # The default value is: Publisher.
1415 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1417 DOCSET_PUBLISHER_NAME = Publisher
1419 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1420 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1421 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1422 # on Windows. In the beginning of 2021 Microsoft took the original page, with
1423 # a.o. the download links, offline the HTML help workshop was already many years
1424 # in maintenance mode). You can download the HTML help workshop from the web
1425 # archives at Installation executable (see:
1426 # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
1427 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1429 # The HTML Help Workshop contains a compiler that can convert all HTML output
1430 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1431 # files are now used as the Windows 98 help format, and will replace the old
1432 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1433 # HTML files also contain an index, a table of contents, and you can search for
1434 # words in the documentation. The HTML workshop also contains a viewer for
1435 # compressed HTML files.
1436 # The default value is: NO.
1437 # This tag requires that the tag GENERATE_HTML is set to YES.
1439 GENERATE_HTMLHELP = NO
1441 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1442 # file. You can add a path in front of the file if the result should not be
1443 # written to the html output directory.
1444 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1448 # The HHC_LOCATION tag can be used to specify the location (absolute path
1449 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1450 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1451 # The file has to be specified with full path.
1452 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1456 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1457 # (YES) or that it should be included in the main .chm file (NO).
1458 # The default value is: NO.
1459 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1463 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1464 # and project file content.
1465 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1467 CHM_INDEX_ENCODING =
1469 # The BINARY_TOC flag controls whether a binary table of contents is generated
1470 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1471 # enables the Previous and Next buttons.
1472 # The default value is: NO.
1473 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1477 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1478 # the table of contents of the HTML help documentation and to the tree view.
1479 # The default value is: NO.
1480 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1484 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1485 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1486 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1487 # (.qch) of the generated HTML documentation.
1488 # The default value is: NO.
1489 # This tag requires that the tag GENERATE_HTML is set to YES.
1493 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1494 # the file name of the resulting .qch file. The path specified is relative to
1495 # the HTML output folder.
1496 # This tag requires that the tag GENERATE_QHP is set to YES.
1500 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1501 # Project output. For more information please see Qt Help Project / Namespace
1503 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1504 # The default value is: org.doxygen.Project.
1505 # This tag requires that the tag GENERATE_QHP is set to YES.
1507 QHP_NAMESPACE = org.doxygen.Project
1509 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1510 # Help Project output. For more information please see Qt Help Project / Virtual
1512 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1513 # The default value is: doc.
1514 # This tag requires that the tag GENERATE_QHP is set to YES.
1516 QHP_VIRTUAL_FOLDER = doc
1518 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1519 # filter to add. For more information please see Qt Help Project / Custom
1521 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1522 # This tag requires that the tag GENERATE_QHP is set to YES.
1524 QHP_CUST_FILTER_NAME =
1526 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1527 # custom filter to add. For more information please see Qt Help Project / Custom
1529 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1530 # This tag requires that the tag GENERATE_QHP is set to YES.
1532 QHP_CUST_FILTER_ATTRS =
1534 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1535 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1536 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1537 # This tag requires that the tag GENERATE_QHP is set to YES.
1539 QHP_SECT_FILTER_ATTRS =
1541 # The QHG_LOCATION tag can be used to specify the location (absolute path
1542 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1543 # run qhelpgenerator on the generated .qhp file.
1544 # This tag requires that the tag GENERATE_QHP is set to YES.
1548 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1549 # generated, together with the HTML files, they form an Eclipse help plugin. To
1550 # install this plugin and make it available under the help contents menu in
1551 # Eclipse, the contents of the directory containing the HTML and XML files needs
1552 # to be copied into the plugins directory of eclipse. The name of the directory
1553 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1554 # After copying Eclipse needs to be restarted before the help appears.
1555 # The default value is: NO.
1556 # This tag requires that the tag GENERATE_HTML is set to YES.
1558 GENERATE_ECLIPSEHELP = NO
1560 # A unique identifier for the Eclipse help plugin. When installing the plugin
1561 # the directory name containing the HTML and XML files should also have this
1562 # name. Each documentation set should have its own identifier.
1563 # The default value is: org.doxygen.Project.
1564 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1566 ECLIPSE_DOC_ID = org.doxygen.Project
1568 # If you want full control over the layout of the generated HTML pages it might
1569 # be necessary to disable the index and replace it with your own. The
1570 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1571 # of each HTML page. A value of NO enables the index and the value YES disables
1572 # it. Since the tabs in the index contain the same information as the navigation
1573 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1574 # The default value is: NO.
1575 # This tag requires that the tag GENERATE_HTML is set to YES.
1579 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1580 # structure should be generated to display hierarchical information. If the tag
1581 # value is set to YES, a side panel will be generated containing a tree-like
1582 # index structure (just like the one that is generated for HTML Help). For this
1583 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1584 # (i.e. any modern browser). Windows users are probably better off using the
1585 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1586 # further fine tune the look of the index (see "Fine-tuning the output"). As an
1587 # example, the default style sheet generated by doxygen has an example that
1588 # shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1589 # Since the tree basically has the same information as the tab index, you could
1590 # consider setting DISABLE_INDEX to YES when enabling this option.
1591 # The default value is: NO.
1592 # This tag requires that the tag GENERATE_HTML is set to YES.
1594 GENERATE_TREEVIEW = NO
1596 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1597 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1598 # area (value NO) or if it should extend to the full height of the window (value
1599 # YES). Setting this to YES gives a layout similar to
1600 # https://docs.readthedocs.io with more room for contents, but less room for the
1601 # project logo, title, and description. If either GENERATE_TREEVIEW or
1602 # DISABLE_INDEX is set to NO, this option has no effect.
1603 # The default value is: NO.
1604 # This tag requires that the tag GENERATE_HTML is set to YES.
1608 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1609 # doxygen will group on one line in the generated HTML documentation.
1611 # Note that a value of 0 will completely suppress the enum values from appearing
1612 # in the overview section.
1613 # Minimum value: 0, maximum value: 20, default value: 4.
1614 # This tag requires that the tag GENERATE_HTML is set to YES.
1616 ENUM_VALUES_PER_LINE = 4
1618 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1619 # to set the initial width (in pixels) of the frame in which the tree is shown.
1620 # Minimum value: 0, maximum value: 1500, default value: 250.
1621 # This tag requires that the tag GENERATE_HTML is set to YES.
1623 TREEVIEW_WIDTH = 250
1625 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1626 # external symbols imported via tag files in a separate window.
1627 # The default value is: NO.
1628 # This tag requires that the tag GENERATE_HTML is set to YES.
1630 EXT_LINKS_IN_WINDOW = NO
1632 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1634 # The default value is: YES.
1635 # This tag requires that the tag GENERATE_HTML is set to YES.
1637 OBFUSCATE_EMAILS = YES
1639 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1640 # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1641 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1642 # the HTML output. These images will generally look nicer at scaled resolutions.
1643 # Possible values are: png (the default) and svg (looks nicer but requires the
1644 # pdf2svg or inkscape tool).
1645 # The default value is: png.
1646 # This tag requires that the tag GENERATE_HTML is set to YES.
1648 HTML_FORMULA_FORMAT = png
1650 # Use this tag to change the font size of LaTeX formulas included as images in
1651 # the HTML documentation. When you change the font size after a successful
1652 # doxygen run you need to manually remove any form_*.png images from the HTML
1653 # output directory to force them to be regenerated.
1654 # Minimum value: 8, maximum value: 50, default value: 10.
1655 # This tag requires that the tag GENERATE_HTML is set to YES.
1657 FORMULA_FONTSIZE = 10
1659 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1660 # to create new LaTeX commands to be used in formulas as building blocks. See
1661 # the section "Including formulas" for details.
1665 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1666 # https://www.mathjax.org) which uses client side JavaScript for the rendering
1667 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1668 # installed or if you want to formulas look prettier in the HTML output. When
1669 # enabled you may also need to install MathJax separately and configure the path
1670 # to it using the MATHJAX_RELPATH option.
1671 # The default value is: NO.
1672 # This tag requires that the tag GENERATE_HTML is set to YES.
1676 # With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1677 # Note that the different versions of MathJax have different requirements with
1678 # regards to the different settings, so it is possible that also other MathJax
1679 # settings have to be changed when switching between the different MathJax
1681 # Possible values are: MathJax_2 and MathJax_3.
1682 # The default value is: MathJax_2.
1683 # This tag requires that the tag USE_MATHJAX is set to YES.
1685 MATHJAX_VERSION = MathJax_2
1687 # When MathJax is enabled you can set the default output format to be used for
1688 # the MathJax output. For more details about the output format see MathJax
1690 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1692 # http://docs.mathjax.org/en/latest/web/components/output.html).
1693 # Possible values are: HTML-CSS (which is slower, but has the best
1694 # compatibility. This is the name for Mathjax version 2, for MathJax version 3
1695 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1696 # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1697 # is the name for Mathjax version 3, for MathJax version 2 this will be
1698 # translated into HTML-CSS) and SVG.
1699 # The default value is: HTML-CSS.
1700 # This tag requires that the tag USE_MATHJAX is set to YES.
1702 MATHJAX_FORMAT = HTML-CSS
1704 # When MathJax is enabled you need to specify the location relative to the HTML
1705 # output directory using the MATHJAX_RELPATH option. The destination directory
1706 # should contain the MathJax.js script. For instance, if the mathjax directory
1707 # is located at the same level as the HTML output directory, then
1708 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1709 # Content Delivery Network so you can quickly see the result without installing
1710 # MathJax. However, it is strongly recommended to install a local copy of
1711 # MathJax from https://www.mathjax.org before deployment. The default value is:
1712 # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1713 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1714 # This tag requires that the tag USE_MATHJAX is set to YES.
1716 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1718 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1719 # extension names that should be enabled during MathJax rendering. For example
1720 # for MathJax version 2 (see
1721 # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1722 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1723 # For example for MathJax version 3 (see
1724 # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
1725 # MATHJAX_EXTENSIONS = ams
1726 # This tag requires that the tag USE_MATHJAX is set to YES.
1728 MATHJAX_EXTENSIONS =
1730 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1731 # of code that will be used on startup of the MathJax code. See the MathJax site
1733 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1734 # example see the documentation.
1735 # This tag requires that the tag USE_MATHJAX is set to YES.
1739 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1740 # the HTML output. The underlying search engine uses javascript and DHTML and
1741 # should work on any modern browser. Note that when using HTML help
1742 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1743 # there is already a search function so this one should typically be disabled.
1744 # For large projects the javascript based search engine can be slow, then
1745 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1746 # search using the keyboard; to jump to the search box use <access key> + S
1747 # (what the <access key> is depends on the OS and browser, but it is typically
1748 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1749 # key> to jump into the search results window, the results can be navigated
1750 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1751 # the search. The filter options can be selected when the cursor is inside the
1752 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1753 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1755 # The default value is: YES.
1756 # This tag requires that the tag GENERATE_HTML is set to YES.
1760 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1761 # implemented using a web server instead of a web client using JavaScript. There
1762 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1763 # setting. When disabled, doxygen will generate a PHP script for searching and
1764 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1765 # and searching needs to be provided by external tools. See the section
1766 # "External Indexing and Searching" for details.
1767 # The default value is: NO.
1768 # This tag requires that the tag SEARCHENGINE is set to YES.
1770 SERVER_BASED_SEARCH = NO
1772 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1773 # script for searching. Instead the search results are written to an XML file
1774 # which needs to be processed by an external indexer. Doxygen will invoke an
1775 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1778 # Doxygen ships with an example indexer (doxyindexer) and search engine
1779 # (doxysearch.cgi) which are based on the open source search engine library
1781 # https://xapian.org/).
1783 # See the section "External Indexing and Searching" for details.
1784 # The default value is: NO.
1785 # This tag requires that the tag SEARCHENGINE is set to YES.
1787 EXTERNAL_SEARCH = NO
1789 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1790 # which will return the search results when EXTERNAL_SEARCH is enabled.
1792 # Doxygen ships with an example indexer (doxyindexer) and search engine
1793 # (doxysearch.cgi) which are based on the open source search engine library
1795 # https://xapian.org/). See the section "External Indexing and Searching" for
1797 # This tag requires that the tag SEARCHENGINE is set to YES.
1801 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1802 # search data is written to a file for indexing by an external tool. With the
1803 # SEARCHDATA_FILE tag the name of this file can be specified.
1804 # The default file is: searchdata.xml.
1805 # This tag requires that the tag SEARCHENGINE is set to YES.
1807 SEARCHDATA_FILE = searchdata.xml
1809 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1810 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1811 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1812 # projects and redirect the results back to the right project.
1813 # This tag requires that the tag SEARCHENGINE is set to YES.
1815 EXTERNAL_SEARCH_ID =
1817 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1818 # projects other than the one defined by this configuration file, but that are
1819 # all added to the same external search index. Each project needs to have a
1820 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1821 # to a relative location where the documentation can be found. The format is:
1822 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1823 # This tag requires that the tag SEARCHENGINE is set to YES.
1825 EXTRA_SEARCH_MAPPINGS =
1827 #---------------------------------------------------------------------------
1828 # Configuration options related to the LaTeX output
1829 #---------------------------------------------------------------------------
1831 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1832 # The default value is: YES.
1836 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1837 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1839 # The default directory is: latex.
1840 # This tag requires that the tag GENERATE_LATEX is set to YES.
1842 LATEX_OUTPUT = latex
1844 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1847 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1848 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1849 # chosen this is overwritten by pdflatex. For specific output languages the
1850 # default can have been set differently, this depends on the implementation of
1851 # the output language.
1852 # This tag requires that the tag GENERATE_LATEX is set to YES.
1854 LATEX_CMD_NAME = latex
1856 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1858 # Note: This tag is used in the Makefile / make.bat.
1859 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1861 # The default file is: makeindex.
1862 # This tag requires that the tag GENERATE_LATEX is set to YES.
1864 MAKEINDEX_CMD_NAME = makeindex
1866 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1867 # generate index for LaTeX. In case there is no backslash (\) as first character
1868 # it will be automatically added in the LaTeX code.
1869 # Note: This tag is used in the generated output file (.tex).
1870 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1871 # The default value is: makeindex.
1872 # This tag requires that the tag GENERATE_LATEX is set to YES.
1874 LATEX_MAKEINDEX_CMD = makeindex
1876 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1877 # documents. This may be useful for small projects and may help to save some
1879 # The default value is: NO.
1880 # This tag requires that the tag GENERATE_LATEX is set to YES.
1884 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1886 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1887 # 14 inches) and executive (7.25 x 10.5 inches).
1888 # The default value is: a4.
1889 # This tag requires that the tag GENERATE_LATEX is set to YES.
1893 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1894 # that should be included in the LaTeX output. The package can be specified just
1895 # by its name or with the correct syntax as to be used with the LaTeX
1896 # \usepackage command. To get the times font for instance you can specify :
1897 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1898 # To use the option intlimits with the amsmath package you can specify:
1899 # EXTRA_PACKAGES=[intlimits]{amsmath}
1900 # If left blank no extra packages will be included.
1901 # This tag requires that the tag GENERATE_LATEX is set to YES.
1905 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
1906 # the generated LaTeX document. The header should contain everything until the
1907 # first chapter. If it is left blank doxygen will generate a standard header. It
1908 # is highly recommended to start with a default header using
1909 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
1910 # and then modify the file new_header.tex. See also section "Doxygen usage" for
1911 # information on how to generate the default header that doxygen normally uses.
1913 # Note: Only use a user-defined header if you know what you are doing!
1914 # Note: The header is subject to change so you typically have to regenerate the
1915 # default header when upgrading to a newer version of doxygen. The following
1916 # commands have a special meaning inside the header (and footer): For a
1917 # description of the possible markers and block names see the documentation.
1918 # This tag requires that the tag GENERATE_LATEX is set to YES.
1922 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
1923 # the generated LaTeX document. The footer should contain everything after the
1924 # last chapter. If it is left blank doxygen will generate a standard footer. See
1925 # LATEX_HEADER for more information on how to generate a default footer and what
1926 # special commands can be used inside the footer. See also section "Doxygen
1927 # usage" for information on how to generate the default footer that doxygen
1928 # normally uses. Note: Only use a user-defined footer if you know what you are
1930 # This tag requires that the tag GENERATE_LATEX is set to YES.
1934 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1935 # LaTeX style sheets that are included after the standard style sheets created
1936 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1937 # will copy the style sheet files to the output directory.
1938 # Note: The order of the extra style sheet files is of importance (e.g. the last
1939 # style sheet in the list overrules the setting of the previous ones in the
1941 # This tag requires that the tag GENERATE_LATEX is set to YES.
1943 LATEX_EXTRA_STYLESHEET =
1945 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1946 # other source files which should be copied to the LATEX_OUTPUT output
1947 # directory. Note that the files will be copied as-is; there are no commands or
1948 # markers available.
1949 # This tag requires that the tag GENERATE_LATEX is set to YES.
1953 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1954 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1955 # contain links (just like the HTML output) instead of page references. This
1956 # makes the output suitable for online browsing using a PDF viewer.
1957 # The default value is: YES.
1958 # This tag requires that the tag GENERATE_LATEX is set to YES.
1962 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1963 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
1964 # files. Set this option to YES, to get a higher quality PDF documentation.
1966 # See also section LATEX_CMD_NAME for selecting the engine.
1967 # The default value is: YES.
1968 # This tag requires that the tag GENERATE_LATEX is set to YES.
1972 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1973 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1974 # if errors occur, instead of asking the user for help.
1975 # The default value is: NO.
1976 # This tag requires that the tag GENERATE_LATEX is set to YES.
1978 LATEX_BATCHMODE = NO
1980 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1981 # index chapters (such as File Index, Compound Index, etc.) in the output.
1982 # The default value is: NO.
1983 # This tag requires that the tag GENERATE_LATEX is set to YES.
1985 LATEX_HIDE_INDICES = NO
1987 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1988 # bibliography, e.g. plainnat, or ieeetr. See
1989 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1990 # The default value is: plain.
1991 # This tag requires that the tag GENERATE_LATEX is set to YES.
1993 LATEX_BIB_STYLE = plain
1995 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1996 # page will contain the date and time when the page was generated. Setting this
1997 # to NO can help when comparing the output of multiple runs.
1998 # The default value is: NO.
1999 # This tag requires that the tag GENERATE_LATEX is set to YES.
2001 LATEX_TIMESTAMP = NO
2003 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2004 # path from which the emoji images will be read. If a relative path is entered,
2005 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2006 # LATEX_OUTPUT directory will be used.
2007 # This tag requires that the tag GENERATE_LATEX is set to YES.
2009 LATEX_EMOJI_DIRECTORY =
2011 #---------------------------------------------------------------------------
2012 # Configuration options related to the RTF output
2013 #---------------------------------------------------------------------------
2015 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2016 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2018 # The default value is: NO.
2022 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2023 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2025 # The default directory is: rtf.
2026 # This tag requires that the tag GENERATE_RTF is set to YES.
2030 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2031 # documents. This may be useful for small projects and may help to save some
2033 # The default value is: NO.
2034 # This tag requires that the tag GENERATE_RTF is set to YES.
2038 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2039 # contain hyperlink fields. The RTF file will contain links (just like the HTML
2040 # output) instead of page references. This makes the output suitable for online
2041 # browsing using Word or some other Word compatible readers that support those
2044 # Note: WordPad (write) and others do not support links.
2045 # The default value is: NO.
2046 # This tag requires that the tag GENERATE_RTF is set to YES.
2050 # Load stylesheet definitions from file. Syntax is similar to doxygen's
2051 # configuration file, i.e. a series of assignments. You only have to provide
2052 # replacements, missing definitions are set to their default value.
2054 # See also section "Doxygen usage" for information on how to generate the
2055 # default style sheet that doxygen normally uses.
2056 # This tag requires that the tag GENERATE_RTF is set to YES.
2058 RTF_STYLESHEET_FILE =
2060 # Set optional variables used in the generation of an RTF document. Syntax is
2061 # similar to doxygen's configuration file. A template extensions file can be
2062 # generated using doxygen -e rtf extensionFile.
2063 # This tag requires that the tag GENERATE_RTF is set to YES.
2065 RTF_EXTENSIONS_FILE =
2067 #---------------------------------------------------------------------------
2068 # Configuration options related to the man page output
2069 #---------------------------------------------------------------------------
2071 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2072 # classes and files.
2073 # The default value is: NO.
2077 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2078 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2079 # it. A directory man3 will be created inside the directory specified by
2081 # The default directory is: man.
2082 # This tag requires that the tag GENERATE_MAN is set to YES.
2086 # The MAN_EXTENSION tag determines the extension that is added to the generated
2087 # man pages. In case the manual section does not start with a number, the number
2088 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2090 # The default value is: .3.
2091 # This tag requires that the tag GENERATE_MAN is set to YES.
2095 # The MAN_SUBDIR tag determines the name of the directory created within
2096 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2097 # MAN_EXTENSION with the initial . removed.
2098 # This tag requires that the tag GENERATE_MAN is set to YES.
2102 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2103 # will generate one additional man file for each entity documented in the real
2104 # man page(s). These additional files only source the real man page, but without
2105 # them the man command would be unable to find the correct page.
2106 # The default value is: NO.
2107 # This tag requires that the tag GENERATE_MAN is set to YES.
2111 #---------------------------------------------------------------------------
2112 # Configuration options related to the XML output
2113 #---------------------------------------------------------------------------
2115 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2116 # captures the structure of the code including all documentation.
2117 # The default value is: NO.
2121 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2122 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2124 # The default directory is: xml.
2125 # This tag requires that the tag GENERATE_XML is set to YES.
2129 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2130 # listings (including syntax highlighting and cross-referencing information) to
2131 # the XML output. Note that enabling this will significantly increase the size
2132 # of the XML output.
2133 # The default value is: YES.
2134 # This tag requires that the tag GENERATE_XML is set to YES.
2136 XML_PROGRAMLISTING = YES
2138 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2139 # namespace members in file scope as well, matching the HTML output.
2140 # The default value is: NO.
2141 # This tag requires that the tag GENERATE_XML is set to YES.
2143 XML_NS_MEMB_FILE_SCOPE = NO
2145 #---------------------------------------------------------------------------
2146 # Configuration options related to the DOCBOOK output
2147 #---------------------------------------------------------------------------
2149 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2150 # that can be used to generate PDF.
2151 # The default value is: NO.
2153 GENERATE_DOCBOOK = NO
2155 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2156 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2158 # The default directory is: docbook.
2159 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2161 DOCBOOK_OUTPUT = docbook
2163 #---------------------------------------------------------------------------
2164 # Configuration options for the AutoGen Definitions output
2165 #---------------------------------------------------------------------------
2167 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2168 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2169 # the structure of the code including all documentation. Note that this feature
2170 # is still experimental and incomplete at the moment.
2171 # The default value is: NO.
2173 GENERATE_AUTOGEN_DEF = NO
2175 #---------------------------------------------------------------------------
2176 # Configuration options related to the Perl module output
2177 #---------------------------------------------------------------------------
2179 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2180 # file that captures the structure of the code including all documentation.
2182 # Note that this feature is still experimental and incomplete at the moment.
2183 # The default value is: NO.
2185 GENERATE_PERLMOD = NO
2187 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2188 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2189 # output from the Perl module output.
2190 # The default value is: NO.
2191 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2195 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2196 # formatted so it can be parsed by a human reader. This is useful if you want to
2197 # understand what is going on. On the other hand, if this tag is set to NO, the
2198 # size of the Perl module output will be much smaller and Perl will parse it
2200 # The default value is: YES.
2201 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2203 PERLMOD_PRETTY = YES
2205 # The names of the make variables in the generated doxyrules.make file are
2206 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2207 # so different doxyrules.make files included by the same Makefile don't
2208 # overwrite each other's variables.
2209 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2211 PERLMOD_MAKEVAR_PREFIX =
2213 #---------------------------------------------------------------------------
2214 # Configuration options related to the preprocessor
2215 #---------------------------------------------------------------------------
2217 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2218 # C-preprocessor directives found in the sources and include files.
2219 # The default value is: YES.
2221 ENABLE_PREPROCESSING = YES
2223 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2224 # in the source code. If set to NO, only conditional compilation will be
2225 # performed. Macro expansion can be done in a controlled way by setting
2226 # EXPAND_ONLY_PREDEF to YES.
2227 # The default value is: NO.
2228 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2230 MACRO_EXPANSION = NO
2232 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2233 # the macro expansion is limited to the macros specified with the PREDEFINED and
2234 # EXPAND_AS_DEFINED tags.
2235 # The default value is: NO.
2236 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2238 EXPAND_ONLY_PREDEF = NO
2240 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2241 # INCLUDE_PATH will be searched if a #include is found.
2242 # The default value is: YES.
2243 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2245 SEARCH_INCLUDES = YES
2247 # The INCLUDE_PATH tag can be used to specify one or more directories that
2248 # contain include files that are not input files but should be processed by the
2249 # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2250 # RECURSIVE has no effect here.
2251 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2255 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2256 # patterns (like *.h and *.hpp) to filter out the header-files in the
2257 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2259 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2261 INCLUDE_FILE_PATTERNS =
2263 # The PREDEFINED tag can be used to specify one or more macro names that are
2264 # defined before the preprocessor is started (similar to the -D option of e.g.
2265 # gcc). The argument of the tag is a list of macros of the form: name or
2266 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2267 # is assumed. To prevent a macro definition from being undefined via #undef or
2268 # recursively expanded use the := operator instead of the = operator.
2269 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2271 PREDEFINED = __ACE_INLINE__ \
2272 ACE_TEMPLATES_REQUIRE_SOURCE \
2273 ACE_BEGIN_VERSIONED_NAMESPACE_DECL \
2274 ACE_END_VERSIONED_NAMESPACE_DECL \
2277 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2278 # tag can be used to specify a list of macro names that should be expanded. The
2279 # macro definition that is found in the sources will be used. Use the PREDEFINED
2280 # tag if you want to use a different macro definition that overrules the
2281 # definition found in the source code.
2282 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2284 EXPAND_AS_DEFINED = ACE_UNIMPLEMENTED_FUNC \
2285 ACE_CACHE_MAP_MANAGER
2287 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2288 # remove all references to function-like macros that are alone on a line, have
2289 # an all uppercase name, and do not end with a semicolon. Such function macros
2290 # are typically used for boiler-plate code, and will confuse the parser if not
2292 # The default value is: YES.
2293 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2295 SKIP_FUNCTION_MACROS = YES
2297 #---------------------------------------------------------------------------
2298 # Configuration options related to external references
2299 #---------------------------------------------------------------------------
2301 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2302 # file the location of the external documentation should be added. The format of
2303 # a tag file without this location is as follows:
2304 # TAGFILES = file1 file2 ...
2305 # Adding location for the tag files is done as follows:
2306 # TAGFILES = file1=loc1 "file2 = loc2" ...
2307 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2308 # section "Linking to external documentation" for more information about the use
2310 # Note: Each tag file must have a unique name (where the name does NOT include
2311 # the path). If a tag file is not located in the directory in which doxygen is
2312 # run, you must also specify the path to the tagfile here.
2314 TAGFILES = html/libace-doc/ACE.tag=../ace
2316 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2317 # tag file that is based on the input files it reads. See section "Linking to
2318 # external documentation" for more information about the usage of tag files.
2320 GENERATE_TAGFILE = html/libacexml-doc/ACEXML.tag
2322 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2323 # the class index. If set to NO, only the inherited external classes will be
2325 # The default value is: NO.
2329 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2330 # in the modules index. If set to NO, only the current project's groups will be
2332 # The default value is: YES.
2334 EXTERNAL_GROUPS = YES
2336 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2337 # the related pages index. If set to NO, only the current project's pages will
2339 # The default value is: YES.
2341 EXTERNAL_PAGES = YES
2343 #---------------------------------------------------------------------------
2344 # Configuration options related to the dot tool
2345 #---------------------------------------------------------------------------
2347 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2348 # then run dia to produce the diagram and insert it in the documentation. The
2349 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2350 # If left empty dia is assumed to be found in the default search path.
2354 # If set to YES the inheritance and collaboration graphs will hide inheritance
2355 # and usage relations if the target is undocumented or is not a class.
2356 # The default value is: YES.
2358 HIDE_UNDOC_RELATIONS = YES
2360 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2361 # available from the path. This tool is part of Graphviz (see:
2362 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2363 # Bell Labs. The other options in this section have no effect if this option is
2365 # The default value is: NO.
2369 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2370 # to run in parallel. When set to 0 doxygen will base this on the number of
2371 # processors available in the system. You can set it explicitly to a value
2372 # larger than 0 to get control over the balance between CPU load and processing
2374 # Minimum value: 0, maximum value: 32, default value: 0.
2375 # This tag requires that the tag HAVE_DOT is set to YES.
2379 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2380 # subgraphs. When you want a differently looking font in the dot files that
2381 # doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2382 # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2383 # Edge and Graph Attributes specification</a> You need to make sure dot is able
2384 # to find the font, which can be done by putting it in a standard location or by
2385 # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2386 # directory containing the font. Default graphviz fontsize is 14.
2387 # The default value is: fontname=Helvetica,fontsize=10.
2388 # This tag requires that the tag HAVE_DOT is set to YES.
2390 DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
2392 # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2393 # add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2394 # href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2395 # arrows shapes.</a>
2396 # The default value is: labelfontname=Helvetica,labelfontsize=10.
2397 # This tag requires that the tag HAVE_DOT is set to YES.
2399 DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
2401 # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2402 # around nodes set 'shape=plain' or 'shape=plaintext' <a
2403 # href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2404 # The default value is: shape=box,height=0.2,width=0.4.
2405 # This tag requires that the tag HAVE_DOT is set to YES.
2407 DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
2409 # You can set the path where dot can find font specified with fontname in
2410 # DOT_COMMON_ATTR and others dot attributes.
2411 # This tag requires that the tag HAVE_DOT is set to YES.
2415 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
2416 # graph for each documented class showing the direct and indirect inheritance
2417 # relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
2418 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2419 # to TEXT the direct and indirect inheritance relations will be shown as texts /
2421 # Possible values are: NO, YES, TEXT and GRAPH.
2422 # The default value is: YES.
2426 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2427 # graph for each documented class showing the direct and indirect implementation
2428 # dependencies (inheritance, containment, and class references variables) of the
2429 # class with other documented classes.
2430 # The default value is: YES.
2431 # This tag requires that the tag HAVE_DOT is set to YES.
2433 COLLABORATION_GRAPH = YES
2435 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2436 # groups, showing the direct groups dependencies. See also the chapter Grouping
2438 # The default value is: YES.
2439 # This tag requires that the tag HAVE_DOT is set to YES.
2443 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2444 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2446 # The default value is: NO.
2447 # This tag requires that the tag HAVE_DOT is set to YES.
2451 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2452 # class node. If there are many fields or methods and many nodes the graph may
2453 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2454 # number of items for each type to make the size more manageable. Set this to 0
2455 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2456 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2457 # but if the number exceeds 15, the total amount of fields shown is limited to
2459 # Minimum value: 0, maximum value: 100, default value: 10.
2460 # This tag requires that the tag UML_LOOK is set to YES.
2462 UML_LIMIT_NUM_FIELDS = 10
2464 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2465 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2466 # tag is set to YES, doxygen will add type and arguments for attributes and
2467 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2468 # will not generate fields with class member information in the UML graphs. The
2469 # class diagrams will look similar to the default class diagrams but using UML
2470 # notation for the relationships.
2471 # Possible values are: NO, YES and NONE.
2472 # The default value is: NO.
2473 # This tag requires that the tag UML_LOOK is set to YES.
2475 DOT_UML_DETAILS = NO
2477 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2478 # to display on a single line. If the actual line length exceeds this threshold
2479 # significantly it will wrapped across multiple lines. Some heuristics are apply
2480 # to avoid ugly line breaks.
2481 # Minimum value: 0, maximum value: 1000, default value: 17.
2482 # This tag requires that the tag HAVE_DOT is set to YES.
2484 DOT_WRAP_THRESHOLD = 17
2486 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2487 # collaboration graphs will show the relations between templates and their
2489 # The default value is: NO.
2490 # This tag requires that the tag HAVE_DOT is set to YES.
2492 TEMPLATE_RELATIONS = NO
2494 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2495 # YES then doxygen will generate a graph for each documented file showing the
2496 # direct and indirect include dependencies of the file with other documented
2498 # The default value is: YES.
2499 # This tag requires that the tag HAVE_DOT is set to YES.
2503 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2504 # set to YES then doxygen will generate a graph for each documented file showing
2505 # the direct and indirect include dependencies of the file with other documented
2507 # The default value is: YES.
2508 # This tag requires that the tag HAVE_DOT is set to YES.
2510 INCLUDED_BY_GRAPH = NO
2512 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2513 # dependency graph for every global function or class method.
2515 # Note that enabling this option will significantly increase the time of a run.
2516 # So in most cases it will be better to enable call graphs for selected
2517 # functions only using the \callgraph command. Disabling a call graph can be
2518 # accomplished by means of the command \hidecallgraph.
2519 # The default value is: NO.
2520 # This tag requires that the tag HAVE_DOT is set to YES.
2524 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2525 # dependency graph for every global function or class method.
2527 # Note that enabling this option will significantly increase the time of a run.
2528 # So in most cases it will be better to enable caller graphs for selected
2529 # functions only using the \callergraph command. Disabling a caller graph can be
2530 # accomplished by means of the command \hidecallergraph.
2531 # The default value is: NO.
2532 # This tag requires that the tag HAVE_DOT is set to YES.
2536 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2537 # hierarchy of all classes instead of a textual one.
2538 # The default value is: YES.
2539 # This tag requires that the tag HAVE_DOT is set to YES.
2541 GRAPHICAL_HIERARCHY = YES
2543 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2544 # dependencies a directory has on other directories in a graphical way. The
2545 # dependency relations are determined by the #include relations between the
2546 # files in the directories.
2547 # The default value is: YES.
2548 # This tag requires that the tag HAVE_DOT is set to YES.
2550 DIRECTORY_GRAPH = YES
2552 # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2553 # of child directories generated in directory dependency graphs by dot.
2554 # Minimum value: 1, maximum value: 25, default value: 1.
2555 # This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2557 DIR_GRAPH_MAX_DEPTH = 1
2559 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2560 # generated by dot. For an explanation of the image formats see the section
2561 # output formats in the documentation of the dot tool (Graphviz (see:
2562 # http://www.graphviz.org/)).
2563 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2564 # to make the SVG files visible in IE 9+ (other browsers do not have this
2566 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2567 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2568 # png:gdiplus:gdiplus.
2569 # The default value is: png.
2570 # This tag requires that the tag HAVE_DOT is set to YES.
2572 DOT_IMAGE_FORMAT = png
2574 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2575 # enable generation of interactive SVG images that allow zooming and panning.
2577 # Note that this requires a modern browser other than Internet Explorer. Tested
2578 # and working are Firefox, Chrome, Safari, and Opera.
2579 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2580 # the SVG files visible. Older versions of IE do not have SVG support.
2581 # The default value is: NO.
2582 # This tag requires that the tag HAVE_DOT is set to YES.
2584 INTERACTIVE_SVG = NO
2586 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2587 # found. If left blank, it is assumed the dot tool can be found in the path.
2588 # This tag requires that the tag HAVE_DOT is set to YES.
2592 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2593 # contain dot files that are included in the documentation (see the \dotfile
2595 # This tag requires that the tag HAVE_DOT is set to YES.
2599 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2600 # contain msc files that are included in the documentation (see the \mscfile
2605 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2606 # contain dia files that are included in the documentation (see the \diafile
2611 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2612 # path where java can find the plantuml.jar file or to the filename of jar file
2613 # to be used. If left blank, it is assumed PlantUML is not used or called during
2614 # a preprocessing step. Doxygen will generate a warning when it encounters a
2615 # \startuml command in this case and will not generate output for the diagram.
2619 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2620 # configuration file for plantuml.
2624 # When using plantuml, the specified paths are searched for files specified by
2625 # the !include statement in a plantuml block.
2627 PLANTUML_INCLUDE_PATH =
2629 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2630 # that will be shown in the graph. If the number of nodes in a graph becomes
2631 # larger than this value, doxygen will truncate the graph, which is visualized
2632 # by representing a node as a red box. Note that doxygen if the number of direct
2633 # children of the root node in a graph is already larger than
2634 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2635 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2636 # Minimum value: 0, maximum value: 10000, default value: 50.
2637 # This tag requires that the tag HAVE_DOT is set to YES.
2639 DOT_GRAPH_MAX_NODES = 50
2641 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2642 # generated by dot. A depth value of 3 means that only nodes reachable from the
2643 # root by following a path via at most 3 edges will be shown. Nodes that lay
2644 # further from the root node will be omitted. Note that setting this option to 1
2645 # or 2 may greatly reduce the computation time needed for large code bases. Also
2646 # note that the size of a graph can be further restricted by
2647 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2648 # Minimum value: 0, maximum value: 1000, default value: 0.
2649 # This tag requires that the tag HAVE_DOT is set to YES.
2651 MAX_DOT_GRAPH_DEPTH = 3
2653 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2654 # files in one run (i.e. multiple -o and -T options on the command line). This
2655 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2656 # this, this feature is disabled by default.
2657 # The default value is: NO.
2658 # This tag requires that the tag HAVE_DOT is set to YES.
2660 DOT_MULTI_TARGETS = YES
2662 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2663 # explaining the meaning of the various boxes and arrows in the dot generated
2665 # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
2666 # graphical representation for inheritance and collaboration diagrams is used.
2667 # The default value is: YES.
2668 # This tag requires that the tag HAVE_DOT is set to YES.
2670 GENERATE_LEGEND = YES
2672 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2673 # files that are used to generate the various graphs.
2675 # Note: This setting is not only used for dot files but also for msc temporary
2677 # The default value is: YES.