The Higher Education and Research forge

Home My Page Projects Code Snippets Project Openings MMD
Summary Activity Forums Tracker Lists Tasks Docs Surveys News SCM Files

SCM Repository

c05633dce61be65df59c62eddf4484f19f9bab45
1 # Doxyfile 1.8.17
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project.
5 #
6 # All text after a double hash (##) is considered a comment and is placed in
7 # front of the TAG it is preceding.
8 #
9 # All text after a single hash (#) is considered a comment and will be ignored.
10 # The format is:
11 # TAG = value [value, ...]
12 # For lists, items can also be appended using:
13 # TAG += value [value, ...]
14 # Values that contain spaces should be placed between quotes (\" \").
16 #---------------------------------------------------------------------------
17 # Project related configuration options
18 #---------------------------------------------------------------------------
20 # This tag specifies the encoding used for all characters in the configuration
21 # file that follow. The default is UTF-8 which is also the encoding used for all
22 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
23 # iconv built into libc) for the transcoding. See
24 # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25 # The default value is: UTF-8.
27 DOXYFILE_ENCODING      = UTF-8
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
32 # title of most generated pages and in a few other places.
33 # The default value is: My Project.
35 PROJECT_NAME           = MMD
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
39 # control system is used.
41 PROJECT_NUMBER         = 0.0.1
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 # for a project that appears at the top of each page and should give viewer a
45 # quick idea about the purpose of the project. Keep the description short.
47 PROJECT_BRIEF          =
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50 # in the documentation. The maximum height of the logo should not exceed 55
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52 # the logo to the output directory.
54 PROJECT_LOGO           =
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
61 OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@/doc_doxygen/
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64 # directories (in 2 levels) under the output directory of each output format and
65 # will distribute the generated files over these directories. Enabling this
66 # option can be useful when feeding doxygen a huge amount of source files, where
67 # putting all generated files in the same directory would otherwise causes
68 # performance problems for the file system.
69 # The default value is: NO.
71 CREATE_SUBDIRS         = NO
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 # characters to appear in the names of generated files. If set to NO, non-ASCII
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76 # U+3044.
77 # The default value is: NO.
79 ALLOW_UNICODE_NAMES    = NO
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82 # documentation generated by doxygen is written. Doxygen will use this
83 # information to generate all constant output in the proper language.
84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91 # Ukrainian and Vietnamese.
92 # The default value is: English.
94 OUTPUT_LANGUAGE        = French
96 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
97 # documentation generated by doxygen is written. Doxygen will use this
98 # information to generate all generated output in the proper direction.
99 # Possible values are: None, LTR, RTL and Context.
100 # The default value is: None.
102 OUTPUT_TEXT_DIRECTION  = None
104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
105 # descriptions after the members that are listed in the file and class
106 # documentation (similar to Javadoc). Set to NO to disable this.
107 # The default value is: YES.
109 BRIEF_MEMBER_DESC      = YES
111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
112 # description of a member or function before the detailed description
114 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
115 # brief descriptions will be completely suppressed.
116 # The default value is: YES.
118 REPEAT_BRIEF           = YES
120 # This tag implements a quasi-intelligent brief description abbreviator that is
121 # used to form the text in various listings. Each string in this list, if found
122 # as the leading text of the brief description, will be stripped from the text
123 # and the result, after processing the whole list, is used as the annotated
124 # text. Otherwise, the brief description is used as-is. If left blank, the
125 # following values are used ($name is automatically replaced with the name of
126 # the entity):The $name class, The $name widget, The $name file, is, provides,
127 # specifies, contains, represents, a, an and the.
129 ABBREVIATE_BRIEF       =
131 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
132 # doxygen will generate a detailed section even if there is only a brief
133 # description.
134 # The default value is: NO.
136 ALWAYS_DETAILED_SEC    = NO
138 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
139 # inherited members of a class in the documentation of that class as if those
140 # members were ordinary class members. Constructors, destructors and assignment
141 # operators of the base classes will not be shown.
142 # The default value is: NO.
144 INLINE_INHERITED_MEMB  = NO
146 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
147 # before files name in the file list and in the header files. If set to NO the
148 # shortest path that makes the file name unique will be used
149 # The default value is: YES.
151 FULL_PATH_NAMES        = YES
153 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
154 # Stripping is only done if one of the specified strings matches the left-hand
155 # part of the path. The tag can be used to show relative paths in the file list.
156 # If left blank the directory from which doxygen is run is used as the path to
157 # strip.
159 # Note that you can specify absolute paths here, but also relative paths, which
160 # will be relative from the directory where doxygen is started.
161 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
163 STRIP_FROM_PATH        =
165 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
166 # path mentioned in the documentation of a class, which tells the reader which
167 # header file to include in order to use a class. If left blank only the name of
168 # the header file containing the class definition is used. Otherwise one should
169 # specify the list of include paths that are normally passed to the compiler
170 # using the -I flag.
172 STRIP_FROM_INC_PATH    =
174 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
175 # less readable) file names. This can be useful is your file systems doesn't
176 # support long names like on DOS, Mac, or CD-ROM.
177 # The default value is: NO.
179 SHORT_NAMES            = NO
181 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
182 # first line (until the first dot) of a Javadoc-style comment as the brief
183 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
184 # style comments (thus requiring an explicit @brief command for a brief
185 # description.)
186 # The default value is: NO.
188 JAVADOC_AUTOBRIEF      = NO
190 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
191 # such as
192 # /***************
193 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
194 # Javadoc-style will behave just like regular comments and it will not be
195 # interpreted by doxygen.
196 # The default value is: NO.
198 JAVADOC_BANNER         = NO
200 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
201 # line (until the first dot) of a Qt-style comment as the brief description. If
202 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
203 # requiring an explicit \brief command for a brief description.)
204 # The default value is: NO.
206 QT_AUTOBRIEF           = NO
208 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
209 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
210 # a brief description. This used to be the default behavior. The new default is
211 # to treat a multi-line C++ comment block as a detailed description. Set this
212 # tag to YES if you prefer the old behavior instead.
214 # Note that setting this tag to YES also means that rational rose comments are
215 # not recognized any more.
216 # The default value is: NO.
218 MULTILINE_CPP_IS_BRIEF = NO
220 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
221 # documentation from any documented member that it re-implements.
222 # The default value is: YES.
224 INHERIT_DOCS           = YES
226 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
227 # page for each member. If set to NO, the documentation of a member will be part
228 # of the file/class/namespace that contains it.
229 # The default value is: NO.
231 SEPARATE_MEMBER_PAGES  = NO
233 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
234 # uses this value to replace tabs by spaces in code fragments.
235 # Minimum value: 1, maximum value: 16, default value: 4.
237 TAB_SIZE               = 4
239 # This tag can be used to specify a number of aliases that act as commands in
240 # the documentation. An alias has the form:
241 # name=value
242 # For example adding
243 # "sideeffect=@par Side Effects:\n"
244 # will allow you to put the command \sideeffect (or @sideeffect) in the
245 # documentation, which will result in a user-defined paragraph with heading
246 # "Side Effects:". You can put \n's in the value part of an alias to insert
247 # newlines (in the resulting output). You can put ^^ in the value part of an
248 # alias to insert a newline as if a physical newline was in the original file.
249 # When you need a literal { or } or , in the value part of an alias you have to
250 # escape them by means of a backslash (\), this can lead to conflicts with the
251 # commands \{ and \} for these it is advised to use the version @{ and @} or use
252 # a double escape (\\{ and \\})
254 ALIASES                =
256 # This tag can be used to specify a number of word-keyword mappings (TCL only).
257 # A mapping has the form "name=value". For example adding "class=itcl::class"
258 # will allow you to use the command class in the itcl::class meaning.
260 TCL_SUBST              =
262 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
263 # only. Doxygen will then generate output that is more tailored for C. For
264 # instance, some of the names that are used will be different. The list of all
265 # members will be omitted, etc.
266 # The default value is: NO.
268 OPTIMIZE_OUTPUT_FOR_C  = YES
270 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
271 # Python sources only. Doxygen will then generate output that is more tailored
272 # for that language. For instance, namespaces will be presented as packages,
273 # qualified scopes will look different, etc.
274 # The default value is: NO.
276 OPTIMIZE_OUTPUT_JAVA   = NO
278 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
279 # sources. Doxygen will then generate output that is tailored for Fortran.
280 # The default value is: NO.
282 OPTIMIZE_FOR_FORTRAN   = NO
284 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
285 # sources. Doxygen will then generate output that is tailored for VHDL.
286 # The default value is: NO.
288 OPTIMIZE_OUTPUT_VHDL   = NO
290 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
291 # sources only. Doxygen will then generate output that is more tailored for that
292 # language. For instance, namespaces will be presented as modules, types will be
293 # separated into more groups, etc.
294 # The default value is: NO.
296 OPTIMIZE_OUTPUT_SLICE  = NO
298 # Doxygen selects the parser to use depending on the extension of the files it
299 # parses. With this tag you can assign which parser to use for a given
300 # extension. Doxygen has a built-in mapping, but you can override or extend it
301 # using this tag. The format is ext=language, where ext is a file extension, and
302 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
303 # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
304 # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
305 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
306 # tries to guess whether the code is fixed or free formatted code, this is the
307 # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
308 # .inc files as Fortran files (default is PHP), and .f files as C (default is
309 # Fortran), use: inc=Fortran f=C.
311 # Note: For files without extension you can use no_extension as a placeholder.
313 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
314 # the files are not read by doxygen.
316 EXTENSION_MAPPING      =
318 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
319 # according to the Markdown format, which allows for more readable
320 # documentation. See https://daringfireball.net/projects/markdown/ for details.
321 # The output of markdown processing is further processed by doxygen, so you can
322 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
323 # case of backward compatibilities issues.
324 # The default value is: YES.
326 MARKDOWN_SUPPORT       = YES
328 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
329 # to that level are automatically included in the table of contents, even if
330 # they do not have an id attribute.
331 # Note: This feature currently applies only to Markdown headings.
332 # Minimum value: 0, maximum value: 99, default value: 5.
333 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
335 TOC_INCLUDE_HEADINGS   = 5
337 # When enabled doxygen tries to link words that correspond to documented
338 # classes, or namespaces to their corresponding documentation. Such a link can
339 # be prevented in individual cases by putting a % sign in front of the word or
340 # globally by setting AUTOLINK_SUPPORT to NO.
341 # The default value is: YES.
343 AUTOLINK_SUPPORT       = YES
345 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
346 # to include (a tag file for) the STL sources as input, then you should set this
347 # tag to YES in order to let doxygen match functions declarations and
348 # definitions whose arguments contain STL classes (e.g. func(std::string);
349 # versus func(std::string) {}). This also make the inheritance and collaboration
350 # diagrams that involve STL classes more complete and accurate.
351 # The default value is: NO.
353 BUILTIN_STL_SUPPORT    = YES
355 # If you use Microsoft's C++/CLI language, you should set this option to YES to
356 # enable parsing support.
357 # The default value is: NO.
359 CPP_CLI_SUPPORT        = NO
361 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
362 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
363 # will parse them like normal C++ but will assume all classes use public instead
364 # of private inheritance when no explicit protection keyword is present.
365 # The default value is: NO.
367 SIP_SUPPORT            = NO
369 # For Microsoft's IDL there are propget and propput attributes to indicate
370 # getter and setter methods for a property. Setting this option to YES will make
371 # doxygen to replace the get and set methods by a property in the documentation.
372 # This will only work if the methods are indeed getting or setting a simple
373 # type. If this is not the case, or you want to show the methods anyway, you
374 # should set this option to NO.
375 # The default value is: YES.
377 IDL_PROPERTY_SUPPORT   = YES
379 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
380 # tag is set to YES then doxygen will reuse the documentation of the first
381 # member in the group (if any) for the other members of the group. By default
382 # all members of a group must be documented explicitly.
383 # The default value is: NO.
385 DISTRIBUTE_GROUP_DOC   = NO
387 # If one adds a struct or class to a group and this option is enabled, then also
388 # any nested class or struct is added to the same group. By default this option
389 # is disabled and one has to add nested compounds explicitly via \ingroup.
390 # The default value is: NO.
392 GROUP_NESTED_COMPOUNDS = NO
394 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
395 # (for instance a group of public functions) to be put as a subgroup of that
396 # type (e.g. under the Public Functions section). Set it to NO to prevent
397 # subgrouping. Alternatively, this can be done per class using the
398 # \nosubgrouping command.
399 # The default value is: YES.
401 SUBGROUPING            = YES
403 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
404 # are shown inside the group in which they are included (e.g. using \ingroup)
405 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
406 # and RTF).
408 # Note that this feature does not work in combination with
409 # SEPARATE_MEMBER_PAGES.
410 # The default value is: NO.
412 INLINE_GROUPED_CLASSES = NO
414 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
415 # with only public data fields or simple typedef fields will be shown inline in
416 # the documentation of the scope in which they are defined (i.e. file,
417 # namespace, or group documentation), provided this scope is documented. If set
418 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
419 # Man pages) or section (for LaTeX and RTF).
420 # The default value is: NO.
422 INLINE_SIMPLE_STRUCTS  = NO
424 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
425 # enum is documented as struct, union, or enum with the name of the typedef. So
426 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
427 # with name TypeT. When disabled the typedef will appear as a member of a file,
428 # namespace, or class. And the struct will be named TypeS. This can typically be
429 # useful for C code in case the coding convention dictates that all compound
430 # types are typedef'ed and only the typedef is referenced, never the tag name.
431 # The default value is: NO.
433 TYPEDEF_HIDES_STRUCT   = NO
435 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
436 # cache is used to resolve symbols given their name and scope. Since this can be
437 # an expensive process and often the same symbol appears multiple times in the
438 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
439 # doxygen will become slower. If the cache is too large, memory is wasted. The
440 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
441 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
442 # symbols. At the end of a run doxygen will report the cache usage and suggest
443 # the optimal cache size from a speed point of view.
444 # Minimum value: 0, maximum value: 9, default value: 0.
446 LOOKUP_CACHE_SIZE      = 0
448 #---------------------------------------------------------------------------
449 # Build related configuration options
450 #---------------------------------------------------------------------------
452 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
453 # documentation are documented, even if no documentation was available. Private
454 # class members and static file members will be hidden unless the
455 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
456 # Note: This will also disable the warnings about undocumented members that are
457 # normally produced when WARNINGS is set to YES.
458 # The default value is: NO.
460 EXTRACT_ALL            = YES
462 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
463 # be included in the documentation.
464 # The default value is: NO.
466 EXTRACT_PRIVATE        = YES
468 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
469 # methods of a class will be included in the documentation.
470 # The default value is: NO.
472 EXTRACT_PRIV_VIRTUAL   = NO
474 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
475 # scope will be included in the documentation.
476 # The default value is: NO.
478 EXTRACT_PACKAGE        = NO
480 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
481 # included in the documentation.
482 # The default value is: NO.
484 EXTRACT_STATIC         = YES
486 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
487 # locally in source files will be included in the documentation. If set to NO,
488 # only classes defined in header files are included. Does not have any effect
489 # for Java sources.
490 # The default value is: YES.
492 EXTRACT_LOCAL_CLASSES  = YES
494 # This flag is only useful for Objective-C code. If set to YES, local methods,
495 # which are defined in the implementation section but not in the interface are
496 # included in the documentation. If set to NO, only methods in the interface are
497 # included.
498 # The default value is: NO.
500 EXTRACT_LOCAL_METHODS  = NO
502 # If this flag is set to YES, the members of anonymous namespaces will be
503 # extracted and appear in the documentation as a namespace called
504 # 'anonymous_namespace{file}', where file will be replaced with the base name of
505 # the file that contains the anonymous namespace. By default anonymous namespace
506 # are hidden.
507 # The default value is: NO.
509 EXTRACT_ANON_NSPACES   = YES
511 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
512 # undocumented members inside documented classes or files. If set to NO these
513 # members will be included in the various overviews, but no documentation
514 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
515 # The default value is: NO.
517 HIDE_UNDOC_MEMBERS     = NO
519 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
520 # undocumented classes that are normally visible in the class hierarchy. If set
521 # to NO, these classes will be included in the various overviews. This option
522 # has no effect if EXTRACT_ALL is enabled.
523 # The default value is: NO.
525 HIDE_UNDOC_CLASSES     = NO
527 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
528 # declarations. If set to NO, these declarations will be included in the
529 # documentation.
530 # The default value is: NO.
532 HIDE_FRIEND_COMPOUNDS  = NO
534 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
535 # documentation blocks found inside the body of a function. If set to NO, these
536 # blocks will be appended to the function's detailed documentation block.
537 # The default value is: NO.
539 HIDE_IN_BODY_DOCS      = NO
541 # The INTERNAL_DOCS tag determines if documentation that is typed after a
542 # \internal command is included. If the tag is set to NO then the documentation
543 # will be excluded. Set it to YES to include the internal documentation.
544 # The default value is: NO.
546 INTERNAL_DOCS          = NO
548 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
549 # names in lower-case letters. If set to YES, upper-case letters are also
550 # allowed. This is useful if you have classes or files whose names only differ
551 # in case and if your file system supports case sensitive file names. Windows
552 # (including Cygwin) ands Mac users are advised to set this option to NO.
553 # The default value is: system dependent.
555 CASE_SENSE_NAMES       = NO
557 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
558 # their full class and namespace scopes in the documentation. If set to YES, the
559 # scope will be hidden.
560 # The default value is: NO.
562 HIDE_SCOPE_NAMES       = NO
564 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
565 # append additional text to a page's title, such as Class Reference. If set to
566 # YES the compound reference will be hidden.
567 # The default value is: NO.
569 HIDE_COMPOUND_REFERENCE= NO
571 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
572 # the files that are included by a file in the documentation of that file.
573 # The default value is: YES.
575 SHOW_INCLUDE_FILES     = YES
577 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
578 # grouped member an include statement to the documentation, telling the reader
579 # which file to include in order to use the member.
580 # The default value is: NO.
582 SHOW_GROUPED_MEMB_INC  = NO
584 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
585 # files with double quotes in the documentation rather than with sharp brackets.
586 # The default value is: NO.
588 FORCE_LOCAL_INCLUDES   = NO
590 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
591 # documentation for inline members.
592 # The default value is: YES.
594 INLINE_INFO            = YES
596 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
597 # (detailed) documentation of file and class members alphabetically by member
598 # name. If set to NO, the members will appear in declaration order.
599 # The default value is: YES.
601 SORT_MEMBER_DOCS       = YES
603 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
604 # descriptions of file, namespace and class members alphabetically by member
605 # name. If set to NO, the members will appear in declaration order. Note that
606 # this will also influence the order of the classes in the class list.
607 # The default value is: NO.
609 SORT_BRIEF_DOCS        = NO
611 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
612 # (brief and detailed) documentation of class members so that constructors and
613 # destructors are listed first. If set to NO the constructors will appear in the
614 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
615 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
616 # member documentation.
617 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
618 # detailed member documentation.
619 # The default value is: NO.
621 SORT_MEMBERS_CTORS_1ST = NO
623 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
624 # of group names into alphabetical order. If set to NO the group names will
625 # appear in their defined order.
626 # The default value is: NO.
628 SORT_GROUP_NAMES       = NO
630 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
631 # fully-qualified names, including namespaces. If set to NO, the class list will
632 # be sorted only by class name, not including the namespace part.
633 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
634 # Note: This option applies only to the class list, not to the alphabetical
635 # list.
636 # The default value is: NO.
638 SORT_BY_SCOPE_NAME     = NO
640 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
641 # type resolution of all parameters of a function it will reject a match between
642 # the prototype and the implementation of a member function even if there is
643 # only one candidate or it is obvious which candidate to choose by doing a
644 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
645 # accept a match between prototype and implementation in such cases.
646 # The default value is: NO.
648 STRICT_PROTO_MATCHING  = NO
650 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
651 # list. This list is created by putting \todo commands in the documentation.
652 # The default value is: YES.
654 GENERATE_TODOLIST      = YES
656 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
657 # list. This list is created by putting \test commands in the documentation.
658 # The default value is: YES.
660 GENERATE_TESTLIST      = YES
662 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
663 # list. This list is created by putting \bug commands in the documentation.
664 # The default value is: YES.
666 GENERATE_BUGLIST       = YES
668 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
669 # the deprecated list. This list is created by putting \deprecated commands in
670 # the documentation.
671 # The default value is: YES.
673 GENERATE_DEPRECATEDLIST= YES
675 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
676 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
677 # ... \endcond blocks.
679 ENABLED_SECTIONS       =
681 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
682 # initial value of a variable or macro / define can have for it to appear in the
683 # documentation. If the initializer consists of more lines than specified here
684 # it will be hidden. Use a value of 0 to hide initializers completely. The
685 # appearance of the value of individual variables and macros / defines can be
686 # controlled using \showinitializer or \hideinitializer command in the
687 # documentation regardless of this setting.
688 # Minimum value: 0, maximum value: 10000, default value: 30.
690 MAX_INITIALIZER_LINES  = 30
692 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
693 # the bottom of the documentation of classes and structs. If set to YES, the
694 # list will mention the files that were used to generate the documentation.
695 # The default value is: YES.
697 SHOW_USED_FILES        = YES
699 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
700 # will remove the Files entry from the Quick Index and from the Folder Tree View
701 # (if specified).
702 # The default value is: YES.
704 SHOW_FILES             = YES
706 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
707 # page. This will remove the Namespaces entry from the Quick Index and from the
708 # Folder Tree View (if specified).
709 # The default value is: YES.
711 SHOW_NAMESPACES        = YES
713 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
714 # doxygen should invoke to get the current version for each file (typically from
715 # the version control system). Doxygen will invoke the program by executing (via
716 # popen()) the command command input-file, where command is the value of the
717 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
718 # by doxygen. Whatever the program writes to standard output is used as the file
719 # version. For an example see the documentation.
721 FILE_VERSION_FILTER    =
723 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
724 # by doxygen. The layout file controls the global structure of the generated
725 # output files in an output format independent way. To create the layout file
726 # that represents doxygen's defaults, run doxygen with the -l option. You can
727 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
728 # will be used as the name of the layout file.
730 # Note that if you run doxygen from a directory containing a file called
731 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
732 # tag is left empty.
734 LAYOUT_FILE            =
736 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
737 # the reference definitions. This must be a list of .bib files. The .bib
738 # extension is automatically appended if omitted. This requires the bibtex tool
739 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
740 # For LaTeX the style of the bibliography can be controlled using
741 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
742 # search path. See also \cite for info how to create references.
744 CITE_BIB_FILES         =
746 #---------------------------------------------------------------------------
747 # Configuration options related to warning and progress messages
748 #---------------------------------------------------------------------------
750 # The QUIET tag can be used to turn on/off the messages that are generated to
751 # standard output by doxygen. If QUIET is set to YES this implies that the
752 # messages are off.
753 # The default value is: NO.
755 QUIET                  = NO
757 # The WARNINGS tag can be used to turn on/off the warning messages that are
758 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
759 # this implies that the warnings are on.
761 # Tip: Turn warnings on while writing the documentation.
762 # The default value is: YES.
764 WARNINGS               = YES
766 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
767 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
768 # will automatically be disabled.
769 # The default value is: YES.
771 WARN_IF_UNDOCUMENTED   = YES
773 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
774 # potential errors in the documentation, such as not documenting some parameters
775 # in a documented function, or documenting parameters that don't exist or using
776 # markup commands wrongly.
777 # The default value is: YES.
779 WARN_IF_DOC_ERROR      = YES
781 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
782 # are documented, but have no documentation for their parameters or return
783 # value. If set to NO, doxygen will only warn about wrong or incomplete
784 # parameter documentation, but not about the absence of documentation. If
785 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
786 # The default value is: NO.
788 WARN_NO_PARAMDOC       = NO
790 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
791 # a warning is encountered.
792 # The default value is: NO.
794 WARN_AS_ERROR          = NO
796 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
797 # can produce. The string should contain the $file, $line, and $text tags, which
798 # will be replaced by the file and line number from which the warning originated
799 # and the warning text. Optionally the format may contain $version, which will
800 # be replaced by the version of the file (if it could be obtained via
801 # FILE_VERSION_FILTER)
802 # The default value is: $file:$line: $text.
804 WARN_FORMAT            = "$file:$line: $text"
806 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
807 # messages should be written. If left blank the output is written to standard
808 # error (stderr).
810 WARN_LOGFILE           =
812 #---------------------------------------------------------------------------
813 # Configuration options related to the input files
814 #---------------------------------------------------------------------------
816 # The INPUT tag is used to specify the files and/or directories that contain
817 # documented source files. You may enter file names like myfile.cpp or
818 # directories like /usr/src/myproject. Separate the files or directories with
819 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
820 # Note: If this tag is empty the current directory is searched.
822 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src/ \
823                          @CMAKE_CURRENT_SOURCE_DIR@/docs
825 # This tag can be used to specify the character encoding of the source files
826 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
827 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
828 # documentation (see: https://www.gnu.org/software/libiconv/) for the list of
829 # possible encodings.
830 # The default value is: UTF-8.
832 INPUT_ENCODING         = UTF-8
834 # If the value of the INPUT tag contains directories, you can use the
835 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
836 # *.h) to filter out the source-files in the directories.
838 # Note that for custom extensions or not directly supported extensions you also
839 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
840 # read by doxygen.
842 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
843 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
844 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
845 # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
846 # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
847 # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd,
848 # *.vhdl, *.ucf, *.qsf and *.ice.
850 FILE_PATTERNS          =
852 # The RECURSIVE tag can be used to specify whether or not subdirectories should
853 # be searched for input files as well.
854 # The default value is: NO.
856 RECURSIVE              = YES
858 # The EXCLUDE tag can be used to specify files and/or directories that should be
859 # excluded from the INPUT source files. This way you can easily exclude a
860 # subdirectory from a directory tree whose root is specified with the INPUT tag.
862 # Note that relative paths are relative to the directory from which doxygen is
863 # run.
865 EXCLUDE                =
867 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
868 # directories that are symbolic links (a Unix file system feature) are excluded
869 # from the input.
870 # The default value is: NO.
872 EXCLUDE_SYMLINKS       = NO
874 # If the value of the INPUT tag contains directories, you can use the
875 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
876 # certain files from those directories.
878 # Note that the wildcards are matched against the file with absolute path, so to
879 # exclude all test directories for example use the pattern */test/*
881 EXCLUDE_PATTERNS       =
883 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
884 # (namespaces, classes, functions, etc.) that should be excluded from the
885 # output. The symbol name can be a fully qualified name, a word, or if the
886 # wildcard * is used, a substring. Examples: ANamespace, AClass,
887 # AClass::ANamespace, ANamespace::*Test
889 # Note that the wildcards are matched against the file with absolute path, so to
890 # exclude all test directories use the pattern */test/*
892 EXCLUDE_SYMBOLS        =
894 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
895 # that contain example code fragments that are included (see the \include
896 # command).
898 EXAMPLE_PATH           =
900 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
901 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
902 # *.h) to filter out the source-files in the directories. If left blank all
903 # files are included.
905 EXAMPLE_PATTERNS       =
907 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
908 # searched for input files to be used with the \include or \dontinclude commands
909 # irrespective of the value of the RECURSIVE tag.
910 # The default value is: NO.
912 EXAMPLE_RECURSIVE      = NO
914 # The IMAGE_PATH tag can be used to specify one or more files or directories
915 # that contain images that are to be included in the documentation (see the
916 # \image command).
918 IMAGE_PATH             =
920 # The INPUT_FILTER tag can be used to specify a program that doxygen should
921 # invoke to filter for each input file. Doxygen will invoke the filter program
922 # by executing (via popen()) the command:
924 # <filter> <input-file>
926 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
927 # name of an input file. Doxygen will then use the output that the filter
928 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
929 # will be ignored.
931 # Note that the filter must not add or remove lines; it is applied before the
932 # code is scanned, but not when the output code is generated. If lines are added
933 # or removed, the anchors will not be placed correctly.
935 # Note that for custom extensions or not directly supported extensions you also
936 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
937 # properly processed by doxygen.
939 INPUT_FILTER           =
941 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
942 # basis. Doxygen will compare the file name with each pattern and apply the
943 # filter if there is a match. The filters are a list of the form: pattern=filter
944 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
945 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
946 # patterns match the file name, INPUT_FILTER is applied.
948 # Note that for custom extensions or not directly supported extensions you also
949 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
950 # properly processed by doxygen.
952 FILTER_PATTERNS        =
954 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
955 # INPUT_FILTER) will also be used to filter the input files that are used for
956 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
957 # The default value is: NO.
959 FILTER_SOURCE_FILES    = NO
961 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
962 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
963 # it is also possible to disable source filtering for a specific pattern using
964 # *.ext= (so without naming a filter).
965 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
967 FILTER_SOURCE_PATTERNS =
969 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
970 # is part of the input, its contents will be placed on the main page
971 # (index.html). This can be useful if you have a project on for instance GitHub
972 # and want to reuse the introduction page also for the doxygen output.
974 USE_MDFILE_AS_MAINPAGE =
976 #---------------------------------------------------------------------------
977 # Configuration options related to source browsing
978 #---------------------------------------------------------------------------
980 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
981 # generated. Documented entities will be cross-referenced with these sources.
983 # Note: To get rid of all source code in the generated output, make sure that
984 # also VERBATIM_HEADERS is set to NO.
985 # The default value is: NO.
987 SOURCE_BROWSER         = YES
989 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
990 # classes and enums directly into the documentation.
991 # The default value is: NO.
993 INLINE_SOURCES         = YES
995 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
996 # special comment blocks from generated source code fragments. Normal C, C++ and
997 # Fortran comments will always remain visible.
998 # The default value is: YES.
1000 STRIP_CODE_COMMENTS    = YES
1002 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1003 # entity all documented functions referencing it will be listed.
1004 # The default value is: NO.
1006 REFERENCED_BY_RELATION = YES
1008 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1009 # all documented entities called/used by that function will be listed.
1010 # The default value is: NO.
1012 REFERENCES_RELATION    = YES
1014 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1015 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1016 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1017 # link to the documentation.
1018 # The default value is: YES.
1020 REFERENCES_LINK_SOURCE = YES
1022 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1023 # source code will show a tooltip with additional information such as prototype,
1024 # brief description and links to the definition and documentation. Since this
1025 # will make the HTML file larger and loading of large files a bit slower, you
1026 # can opt to disable this feature.
1027 # The default value is: YES.
1028 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1030 SOURCE_TOOLTIPS        = YES
1032 # If the USE_HTAGS tag is set to YES then the references to source code will
1033 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1034 # source browser. The htags tool is part of GNU's global source tagging system
1035 # (see https://www.gnu.org/software/global/global.html). You will need version
1036 # 4.8.6 or higher.
1038 # To use it do the following:
1039 # - Install the latest version of global
1040 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1041 # - Make sure the INPUT points to the root of the source tree
1042 # - Run doxygen as normal
1044 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1045 # tools must be available from the command line (i.e. in the search path).
1047 # The result: instead of the source browser generated by doxygen, the links to
1048 # source code will now point to the output of htags.
1049 # The default value is: NO.
1050 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1052 USE_HTAGS              = NO
1054 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1055 # verbatim copy of the header file for each class for which an include is
1056 # specified. Set to NO to disable this.
1057 # See also: Section \class.
1058 # The default value is: YES.
1060 VERBATIM_HEADERS       = YES
1062 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1063 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1064 # cost of reduced performance. This can be particularly helpful with template
1065 # rich C++ code for which doxygen's built-in parser lacks the necessary type
1066 # information.
1067 # Note: The availability of this option depends on whether or not doxygen was
1068 # generated with the -Duse_libclang=ON option for CMake.
1069 # The default value is: NO.
1071 CLANG_ASSISTED_PARSING = NO
1073 # If clang assisted parsing is enabled you can provide the compiler with command
1074 # line options that you would normally use when invoking the compiler. Note that
1075 # the include paths will already be set by doxygen for the files and directories
1076 # specified with INPUT and INCLUDE_PATH.
1077 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1079 CLANG_OPTIONS          =
1081 # If clang assisted parsing is enabled you can provide the clang parser with the
1082 # path to the compilation database (see:
1083 # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1084 # were built. This is equivalent to specifying the "-p" option to a clang tool,
1085 # such as clang-check. These options will then be passed to the parser.
1086 # Note: The availability of this option depends on whether or not doxygen was
1087 # generated with the -Duse_libclang=ON option for CMake.
1089 CLANG_DATABASE_PATH    =
1091 #---------------------------------------------------------------------------
1092 # Configuration options related to the alphabetical class index
1093 #---------------------------------------------------------------------------
1095 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1096 # compounds will be generated. Enable this if the project contains a lot of
1097 # classes, structs, unions or interfaces.
1098 # The default value is: YES.
1100 ALPHABETICAL_INDEX     = YES
1102 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1103 # which the alphabetical index list will be split.
1104 # Minimum value: 1, maximum value: 20, default value: 5.
1105 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1107 COLS_IN_ALPHA_INDEX    = 5
1109 # In case all classes in a project start with a common prefix, all classes will
1110 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1111 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1112 # while generating the index headers.
1113 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1115 IGNORE_PREFIX          =
1117 #---------------------------------------------------------------------------
1118 # Configuration options related to the HTML output
1119 #---------------------------------------------------------------------------
1121 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1122 # The default value is: YES.
1124 GENERATE_HTML          = YES
1126 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1127 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1128 # it.
1129 # The default directory is: html.
1130 # This tag requires that the tag GENERATE_HTML is set to YES.
1132 HTML_OUTPUT            = html
1134 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1135 # generated HTML page (for example: .htm, .php, .asp).
1136 # The default value is: .html.
1137 # This tag requires that the tag GENERATE_HTML is set to YES.
1139 HTML_FILE_EXTENSION    = .html
1141 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1142 # each generated HTML page. If the tag is left blank doxygen will generate a
1143 # standard header.
1145 # To get valid HTML the header file that includes any scripts and style sheets
1146 # that doxygen needs, which is dependent on the configuration options used (e.g.
1147 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1148 # default header using
1149 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1150 # YourConfigFile
1151 # and then modify the file new_header.html. See also section "Doxygen usage"
1152 # for information on how to generate the default header that doxygen normally
1153 # uses.
1154 # Note: The header is subject to change so you typically have to regenerate the
1155 # default header when upgrading to a newer version of doxygen. For a description
1156 # of the possible markers and block names see the documentation.
1157 # This tag requires that the tag GENERATE_HTML is set to YES.
1159 HTML_HEADER            =
1161 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1162 # generated HTML page. If the tag is left blank doxygen will generate a standard
1163 # footer. See HTML_HEADER for more information on how to generate a default
1164 # footer and what special commands can be used inside the footer. See also
1165 # section "Doxygen usage" for information on how to generate the default footer
1166 # that doxygen normally uses.
1167 # This tag requires that the tag GENERATE_HTML is set to YES.
1169 HTML_FOOTER            =
1171 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1172 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1173 # the HTML output. If left blank doxygen will generate a default style sheet.
1174 # See also section "Doxygen usage" for information on how to generate the style
1175 # sheet that doxygen normally uses.
1176 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1177 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1178 # obsolete.
1179 # This tag requires that the tag GENERATE_HTML is set to YES.
1181 HTML_STYLESHEET        =
1183 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1184 # cascading style sheets that are included after the standard style sheets
1185 # created by doxygen. Using this option one can overrule certain style aspects.
1186 # This is preferred over using HTML_STYLESHEET since it does not replace the
1187 # standard style sheet and is therefore more robust against future updates.
1188 # Doxygen will copy the style sheet files to the output directory.
1189 # Note: The order of the extra style sheet files is of importance (e.g. the last
1190 # style sheet in the list overrules the setting of the previous ones in the
1191 # list). For an example see the documentation.
1192 # This tag requires that the tag GENERATE_HTML is set to YES.
1194 HTML_EXTRA_STYLESHEET  =
1196 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1197 # other source files which should be copied to the HTML output directory. Note
1198 # that these files will be copied to the base HTML output directory. Use the
1199 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1200 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1201 # files will be copied as-is; there are no commands or markers available.
1202 # This tag requires that the tag GENERATE_HTML is set to YES.
1204 HTML_EXTRA_FILES       =
1206 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1207 # will adjust the colors in the style sheet and background images according to
1208 # this color. Hue is specified as an angle on a colorwheel, see
1209 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1210 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1211 # purple, and 360 is red again.
1212 # Minimum value: 0, maximum value: 359, default value: 220.
1213 # This tag requires that the tag GENERATE_HTML is set to YES.
1215 HTML_COLORSTYLE_HUE    = 220
1217 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1218 # in the HTML output. For a value of 0 the output will use grayscales only. A
1219 # value of 255 will produce the most vivid colors.
1220 # Minimum value: 0, maximum value: 255, default value: 100.
1221 # This tag requires that the tag GENERATE_HTML is set to YES.
1223 HTML_COLORSTYLE_SAT    = 100
1225 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1226 # luminance component of the colors in the HTML output. Values below 100
1227 # gradually make the output lighter, whereas values above 100 make the output
1228 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1229 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1230 # change the gamma.
1231 # Minimum value: 40, maximum value: 240, default value: 80.
1232 # This tag requires that the tag GENERATE_HTML is set to YES.
1234 HTML_COLORSTYLE_GAMMA  = 80
1236 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1237 # page will contain the date and time when the page was generated. Setting this
1238 # to YES can help to show when doxygen was last run and thus if the
1239 # documentation is up to date.
1240 # The default value is: NO.
1241 # This tag requires that the tag GENERATE_HTML is set to YES.
1243 HTML_TIMESTAMP         = YES
1245 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1246 # documentation will contain a main index with vertical navigation menus that
1247 # are dynamically created via JavaScript. If disabled, the navigation index will
1248 # consists of multiple levels of tabs that are statically embedded in every HTML
1249 # page. Disable this option to support browsers that do not have JavaScript,
1250 # like the Qt help browser.
1251 # The default value is: YES.
1252 # This tag requires that the tag GENERATE_HTML is set to YES.
1254 HTML_DYNAMIC_MENUS     = YES
1256 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1257 # documentation will contain sections that can be hidden and shown after the
1258 # page has loaded.
1259 # The default value is: NO.
1260 # This tag requires that the tag GENERATE_HTML is set to YES.
1262 HTML_DYNAMIC_SECTIONS  = NO
1264 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1265 # shown in the various tree structured indices initially; the user can expand
1266 # and collapse entries dynamically later on. Doxygen will expand the tree to
1267 # such a level that at most the specified number of entries are visible (unless
1268 # a fully collapsed tree already exceeds this amount). So setting the number of
1269 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1270 # representing an infinite number of entries and will result in a full expanded
1271 # tree by default.
1272 # Minimum value: 0, maximum value: 9999, default value: 100.
1273 # This tag requires that the tag GENERATE_HTML is set to YES.
1275 HTML_INDEX_NUM_ENTRIES = 100
1277 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1278 # generated that can be used as input for Apple's Xcode 3 integrated development
1279 # environment (see: https://developer.apple.com/xcode/), introduced with OSX
1280 # 10.5 (Leopard). To create a documentation set, doxygen will generate a
1281 # Makefile in the HTML output directory. Running make will produce the docset in
1282 # that directory and running make install will install the docset in
1283 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1284 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1285 # genXcode/_index.html for more information.
1286 # The default value is: NO.
1287 # This tag requires that the tag GENERATE_HTML is set to YES.
1289 GENERATE_DOCSET        = NO
1291 # This tag determines the name of the docset feed. A documentation feed provides
1292 # an umbrella under which multiple documentation sets from a single provider
1293 # (such as a company or product suite) can be grouped.
1294 # The default value is: Doxygen generated docs.
1295 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1297 DOCSET_FEEDNAME        = "Doxygen generated docs"
1299 # This tag specifies a string that should uniquely identify the documentation
1300 # set bundle. This should be a reverse domain-name style string, e.g.
1301 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1302 # The default value is: org.doxygen.Project.
1303 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1305 DOCSET_BUNDLE_ID       = org.doxygen.Project
1307 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1308 # the documentation publisher. This should be a reverse domain-name style
1309 # string, e.g. com.mycompany.MyDocSet.documentation.
1310 # The default value is: org.doxygen.Publisher.
1311 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1313 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1315 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1316 # The default value is: Publisher.
1317 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1319 DOCSET_PUBLISHER_NAME  = Publisher
1321 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1322 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1323 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1324 # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1325 # Windows.
1327 # The HTML Help Workshop contains a compiler that can convert all HTML output
1328 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1329 # files are now used as the Windows 98 help format, and will replace the old
1330 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1331 # HTML files also contain an index, a table of contents, and you can search for
1332 # words in the documentation. The HTML workshop also contains a viewer for
1333 # compressed HTML files.
1334 # The default value is: NO.
1335 # This tag requires that the tag GENERATE_HTML is set to YES.
1337 GENERATE_HTMLHELP      = NO
1339 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1340 # file. You can add a path in front of the file if the result should not be
1341 # written to the html output directory.
1342 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1344 CHM_FILE               =
1346 # The HHC_LOCATION tag can be used to specify the location (absolute path
1347 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1348 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1349 # The file has to be specified with full path.
1350 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1352 HHC_LOCATION           =
1354 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1355 # (YES) or that it should be included in the master .chm file (NO).
1356 # The default value is: NO.
1357 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1359 GENERATE_CHI           = NO
1361 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1362 # and project file content.
1363 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1365 CHM_INDEX_ENCODING     =
1367 # The BINARY_TOC flag controls whether a binary table of contents is generated
1368 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1369 # enables the Previous and Next buttons.
1370 # The default value is: NO.
1371 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1373 BINARY_TOC             = NO
1375 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1376 # the table of contents of the HTML help documentation and to the tree view.
1377 # The default value is: NO.
1378 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1380 TOC_EXPAND             = NO
1382 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1383 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1384 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1385 # (.qch) of the generated HTML documentation.
1386 # The default value is: NO.
1387 # This tag requires that the tag GENERATE_HTML is set to YES.
1389 GENERATE_QHP           = NO
1391 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1392 # the file name of the resulting .qch file. The path specified is relative to
1393 # the HTML output folder.
1394 # This tag requires that the tag GENERATE_QHP is set to YES.
1396 QCH_FILE               =
1398 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1399 # Project output. For more information please see Qt Help Project / Namespace
1400 # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1401 # The default value is: org.doxygen.Project.
1402 # This tag requires that the tag GENERATE_QHP is set to YES.
1404 QHP_NAMESPACE          = org.doxygen.Project
1406 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1407 # Help Project output. For more information please see Qt Help Project / Virtual
1408 # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1409 # folders).
1410 # The default value is: doc.
1411 # This tag requires that the tag GENERATE_QHP is set to YES.
1413 QHP_VIRTUAL_FOLDER     = doc
1415 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1416 # filter to add. For more information please see Qt Help Project / Custom
1417 # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1418 # filters).
1419 # This tag requires that the tag GENERATE_QHP is set to YES.
1421 QHP_CUST_FILTER_NAME   =
1423 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1424 # custom filter to add. For more information please see Qt Help Project / Custom
1425 # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1426 # filters).
1427 # This tag requires that the tag GENERATE_QHP is set to YES.
1429 QHP_CUST_FILTER_ATTRS  =
1431 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1432 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1433 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1434 # This tag requires that the tag GENERATE_QHP is set to YES.
1436 QHP_SECT_FILTER_ATTRS  =
1438 # The QHG_LOCATION tag can be used to specify the location of Qt's
1439 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1440 # generated .qhp file.
1441 # This tag requires that the tag GENERATE_QHP is set to YES.
1443 QHG_LOCATION           =
1445 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1446 # generated, together with the HTML files, they form an Eclipse help plugin. To
1447 # install this plugin and make it available under the help contents menu in
1448 # Eclipse, the contents of the directory containing the HTML and XML files needs
1449 # to be copied into the plugins directory of eclipse. The name of the directory
1450 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1451 # After copying Eclipse needs to be restarted before the help appears.
1452 # The default value is: NO.
1453 # This tag requires that the tag GENERATE_HTML is set to YES.
1455 GENERATE_ECLIPSEHELP   = NO
1457 # A unique identifier for the Eclipse help plugin. When installing the plugin
1458 # the directory name containing the HTML and XML files should also have this
1459 # name. Each documentation set should have its own identifier.
1460 # The default value is: org.doxygen.Project.
1461 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1463 ECLIPSE_DOC_ID         = org.doxygen.Project
1465 # If you want full control over the layout of the generated HTML pages it might
1466 # be necessary to disable the index and replace it with your own. The
1467 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1468 # of each HTML page. A value of NO enables the index and the value YES disables
1469 # it. Since the tabs in the index contain the same information as the navigation
1470 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1471 # The default value is: NO.
1472 # This tag requires that the tag GENERATE_HTML is set to YES.
1474 DISABLE_INDEX          = NO
1476 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1477 # structure should be generated to display hierarchical information. If the tag
1478 # value is set to YES, a side panel will be generated containing a tree-like
1479 # index structure (just like the one that is generated for HTML Help). For this
1480 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1481 # (i.e. any modern browser). Windows users are probably better off using the
1482 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1483 # further fine-tune the look of the index. As an example, the default style
1484 # sheet generated by doxygen has an example that shows how to put an image at
1485 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1486 # the same information as the tab index, you could consider setting
1487 # DISABLE_INDEX to YES when enabling this option.
1488 # The default value is: NO.
1489 # This tag requires that the tag GENERATE_HTML is set to YES.
1491 GENERATE_TREEVIEW      = YES
1493 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1494 # doxygen will group on one line in the generated HTML documentation.
1496 # Note that a value of 0 will completely suppress the enum values from appearing
1497 # in the overview section.
1498 # Minimum value: 0, maximum value: 20, default value: 4.
1499 # This tag requires that the tag GENERATE_HTML is set to YES.
1501 ENUM_VALUES_PER_LINE   = 4
1503 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1504 # to set the initial width (in pixels) of the frame in which the tree is shown.
1505 # Minimum value: 0, maximum value: 1500, default value: 250.
1506 # This tag requires that the tag GENERATE_HTML is set to YES.
1508 TREEVIEW_WIDTH         = 250
1510 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1511 # external symbols imported via tag files in a separate window.
1512 # The default value is: NO.
1513 # This tag requires that the tag GENERATE_HTML is set to YES.
1515 EXT_LINKS_IN_WINDOW    = NO
1517 # Use this tag to change the font size of LaTeX formulas included as images in
1518 # the HTML documentation. When you change the font size after a successful
1519 # doxygen run you need to manually remove any form_*.png images from the HTML
1520 # output directory to force them to be regenerated.
1521 # Minimum value: 8, maximum value: 50, default value: 10.
1522 # This tag requires that the tag GENERATE_HTML is set to YES.
1524 FORMULA_FONTSIZE       = 10
1526 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1527 # generated for formulas are transparent PNGs. Transparent PNGs are not
1528 # supported properly for IE 6.0, but are supported on all modern browsers.
1530 # Note that when changing this option you need to delete any form_*.png files in
1531 # the HTML output directory before the changes have effect.
1532 # The default value is: YES.
1533 # This tag requires that the tag GENERATE_HTML is set to YES.
1535 FORMULA_TRANSPARENT    = YES
1537 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1538 # to create new LaTeX commands to be used in formulas as building blocks. See
1539 # the section "Including formulas" for details.
1541 FORMULA_MACROFILE      =
1543 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1544 # https://www.mathjax.org) which uses client side JavaScript for the rendering
1545 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1546 # installed or if you want to formulas look prettier in the HTML output. When
1547 # enabled you may also need to install MathJax separately and configure the path
1548 # to it using the MATHJAX_RELPATH option.
1549 # The default value is: NO.
1550 # This tag requires that the tag GENERATE_HTML is set to YES.
1552 USE_MATHJAX            = NO
1554 # When MathJax is enabled you can set the default output format to be used for
1555 # the MathJax output. See the MathJax site (see:
1556 # http://docs.mathjax.org/en/latest/output.html) for more details.
1557 # Possible values are: HTML-CSS (which is slower, but has the best
1558 # compatibility), NativeMML (i.e. MathML) and SVG.
1559 # The default value is: HTML-CSS.
1560 # This tag requires that the tag USE_MATHJAX is set to YES.
1562 MATHJAX_FORMAT         = HTML-CSS
1564 # When MathJax is enabled you need to specify the location relative to the HTML
1565 # output directory using the MATHJAX_RELPATH option. The destination directory
1566 # should contain the MathJax.js script. For instance, if the mathjax directory
1567 # is located at the same level as the HTML output directory, then
1568 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1569 # Content Delivery Network so you can quickly see the result without installing
1570 # MathJax. However, it is strongly recommended to install a local copy of
1571 # MathJax from https://www.mathjax.org before deployment.
1572 # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1573 # This tag requires that the tag USE_MATHJAX is set to YES.
1575 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1577 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1578 # extension names that should be enabled during MathJax rendering. For example
1579 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1580 # This tag requires that the tag USE_MATHJAX is set to YES.
1582 MATHJAX_EXTENSIONS     =
1584 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1585 # of code that will be used on startup of the MathJax code. See the MathJax site
1586 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1587 # example see the documentation.
1588 # This tag requires that the tag USE_MATHJAX is set to YES.
1590 MATHJAX_CODEFILE       =
1592 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1593 # the HTML output. The underlying search engine uses javascript and DHTML and
1594 # should work on any modern browser. Note that when using HTML help
1595 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1596 # there is already a search function so this one should typically be disabled.
1597 # For large projects the javascript based search engine can be slow, then
1598 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1599 # search using the keyboard; to jump to the search box use <access key> + S
1600 # (what the <access key> is depends on the OS and browser, but it is typically
1601 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1602 # key> to jump into the search results window, the results can be navigated
1603 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1604 # the search. The filter options can be selected when the cursor is inside the
1605 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1606 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1607 # option.
1608 # The default value is: YES.
1609 # This tag requires that the tag GENERATE_HTML is set to YES.
1611 SEARCHENGINE           = YES
1613 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1614 # implemented using a web server instead of a web client using JavaScript. There
1615 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1616 # setting. When disabled, doxygen will generate a PHP script for searching and
1617 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1618 # and searching needs to be provided by external tools. See the section
1619 # "External Indexing and Searching" for details.
1620 # The default value is: NO.
1621 # This tag requires that the tag SEARCHENGINE is set to YES.
1623 SERVER_BASED_SEARCH    = NO
1625 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1626 # script for searching. Instead the search results are written to an XML file
1627 # which needs to be processed by an external indexer. Doxygen will invoke an
1628 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1629 # search results.
1631 # Doxygen ships with an example indexer (doxyindexer) and search engine
1632 # (doxysearch.cgi) which are based on the open source search engine library
1633 # Xapian (see: https://xapian.org/).
1635 # See the section "External Indexing and Searching" for details.
1636 # The default value is: NO.
1637 # This tag requires that the tag SEARCHENGINE is set to YES.
1639 EXTERNAL_SEARCH        = NO
1641 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1642 # which will return the search results when EXTERNAL_SEARCH is enabled.
1644 # Doxygen ships with an example indexer (doxyindexer) and search engine
1645 # (doxysearch.cgi) which are based on the open source search engine library
1646 # Xapian (see: https://xapian.org/). See the section "External Indexing and
1647 # Searching" for details.
1648 # This tag requires that the tag SEARCHENGINE is set to YES.
1650 SEARCHENGINE_URL       =
1652 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1653 # search data is written to a file for indexing by an external tool. With the
1654 # SEARCHDATA_FILE tag the name of this file can be specified.
1655 # The default file is: searchdata.xml.
1656 # This tag requires that the tag SEARCHENGINE is set to YES.
1658 SEARCHDATA_FILE        = searchdata.xml
1660 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1661 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1662 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1663 # projects and redirect the results back to the right project.
1664 # This tag requires that the tag SEARCHENGINE is set to YES.
1666 EXTERNAL_SEARCH_ID     =
1668 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1669 # projects other than the one defined by this configuration file, but that are
1670 # all added to the same external search index. Each project needs to have a
1671 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1672 # to a relative location where the documentation can be found. The format is:
1673 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1674 # This tag requires that the tag SEARCHENGINE is set to YES.
1676 EXTRA_SEARCH_MAPPINGS  =
1678 #---------------------------------------------------------------------------
1679 # Configuration options related to the LaTeX output
1680 #---------------------------------------------------------------------------
1682 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1683 # The default value is: YES.
1685 GENERATE_LATEX         = NO
1687 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1688 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1689 # it.
1690 # The default directory is: latex.
1691 # This tag requires that the tag GENERATE_LATEX is set to YES.
1693 LATEX_OUTPUT           = latex
1695 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1696 # invoked.
1698 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1699 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1700 # chosen this is overwritten by pdflatex. For specific output languages the
1701 # default can have been set differently, this depends on the implementation of
1702 # the output language.
1703 # This tag requires that the tag GENERATE_LATEX is set to YES.
1705 LATEX_CMD_NAME         = latex
1707 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1708 # index for LaTeX.
1709 # Note: This tag is used in the Makefile / make.bat.
1710 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1711 # (.tex).
1712 # The default file is: makeindex.
1713 # This tag requires that the tag GENERATE_LATEX is set to YES.
1715 MAKEINDEX_CMD_NAME     = makeindex
1717 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1718 # generate index for LaTeX. In case there is no backslash (\) as first character
1719 # it will be automatically added in the LaTeX code.
1720 # Note: This tag is used in the generated output file (.tex).
1721 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1722 # The default value is: makeindex.
1723 # This tag requires that the tag GENERATE_LATEX is set to YES.
1725 LATEX_MAKEINDEX_CMD    = makeindex
1727 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1728 # documents. This may be useful for small projects and may help to save some
1729 # trees in general.
1730 # The default value is: NO.
1731 # This tag requires that the tag GENERATE_LATEX is set to YES.
1733 COMPACT_LATEX          = NO
1735 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1736 # printer.
1737 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1738 # 14 inches) and executive (7.25 x 10.5 inches).
1739 # The default value is: a4.
1740 # This tag requires that the tag GENERATE_LATEX is set to YES.
1742 PAPER_TYPE             = a4
1744 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1745 # that should be included in the LaTeX output. The package can be specified just
1746 # by its name or with the correct syntax as to be used with the LaTeX
1747 # \usepackage command. To get the times font for instance you can specify :
1748 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1749 # To use the option intlimits with the amsmath package you can specify:
1750 # EXTRA_PACKAGES=[intlimits]{amsmath}
1751 # If left blank no extra packages will be included.
1752 # This tag requires that the tag GENERATE_LATEX is set to YES.
1754 EXTRA_PACKAGES         =
1756 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1757 # generated LaTeX document. The header should contain everything until the first
1758 # chapter. If it is left blank doxygen will generate a standard header. See
1759 # section "Doxygen usage" for information on how to let doxygen write the
1760 # default header to a separate file.
1762 # Note: Only use a user-defined header if you know what you are doing! The
1763 # following commands have a special meaning inside the header: $title,
1764 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1765 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1766 # string, for the replacement values of the other commands the user is referred
1767 # to HTML_HEADER.
1768 # This tag requires that the tag GENERATE_LATEX is set to YES.
1770 LATEX_HEADER           =
1772 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1773 # generated LaTeX document. The footer should contain everything after the last
1774 # chapter. If it is left blank doxygen will generate a standard footer. See
1775 # LATEX_HEADER for more information on how to generate a default footer and what
1776 # special commands can be used inside the footer.
1778 # Note: Only use a user-defined footer if you know what you are doing!
1779 # This tag requires that the tag GENERATE_LATEX is set to YES.
1781 LATEX_FOOTER           =
1783 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1784 # LaTeX style sheets that are included after the standard style sheets created
1785 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1786 # will copy the style sheet files to the output directory.
1787 # Note: The order of the extra style sheet files is of importance (e.g. the last
1788 # style sheet in the list overrules the setting of the previous ones in the
1789 # list).
1790 # This tag requires that the tag GENERATE_LATEX is set to YES.
1792 LATEX_EXTRA_STYLESHEET =
1794 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1795 # other source files which should be copied to the LATEX_OUTPUT output
1796 # directory. Note that the files will be copied as-is; there are no commands or
1797 # markers available.
1798 # This tag requires that the tag GENERATE_LATEX is set to YES.
1800 LATEX_EXTRA_FILES      =
1802 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1803 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1804 # contain links (just like the HTML output) instead of page references. This
1805 # makes the output suitable for online browsing using a PDF viewer.
1806 # The default value is: YES.
1807 # This tag requires that the tag GENERATE_LATEX is set to YES.
1809 PDF_HYPERLINKS         = YES
1811 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1812 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1813 # higher quality PDF documentation.
1814 # The default value is: YES.
1815 # This tag requires that the tag GENERATE_LATEX is set to YES.
1817 USE_PDFLATEX           = YES
1819 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1820 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1821 # if errors occur, instead of asking the user for help. This option is also used
1822 # when generating formulas in HTML.
1823 # The default value is: NO.
1824 # This tag requires that the tag GENERATE_LATEX is set to YES.
1826 LATEX_BATCHMODE        = NO
1828 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1829 # index chapters (such as File Index, Compound Index, etc.) in the output.
1830 # The default value is: NO.
1831 # This tag requires that the tag GENERATE_LATEX is set to YES.
1833 LATEX_HIDE_INDICES     = NO
1835 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1836 # code with syntax highlighting in the LaTeX output.
1838 # Note that which sources are shown also depends on other settings such as
1839 # SOURCE_BROWSER.
1840 # The default value is: NO.
1841 # This tag requires that the tag GENERATE_LATEX is set to YES.
1843 LATEX_SOURCE_CODE      = NO
1845 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1846 # bibliography, e.g. plainnat, or ieeetr. See
1847 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1848 # The default value is: plain.
1849 # This tag requires that the tag GENERATE_LATEX is set to YES.
1851 LATEX_BIB_STYLE        = plain
1853 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1854 # page will contain the date and time when the page was generated. Setting this
1855 # to NO can help when comparing the output of multiple runs.
1856 # The default value is: NO.
1857 # This tag requires that the tag GENERATE_LATEX is set to YES.
1859 LATEX_TIMESTAMP        = NO
1861 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1862 # path from which the emoji images will be read. If a relative path is entered,
1863 # it will be relative to the LATEX_OUTPUT directory. If left blank the
1864 # LATEX_OUTPUT directory will be used.
1865 # This tag requires that the tag GENERATE_LATEX is set to YES.
1867 LATEX_EMOJI_DIRECTORY  =
1869 #---------------------------------------------------------------------------
1870 # Configuration options related to the RTF output
1871 #---------------------------------------------------------------------------
1873 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1874 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1875 # readers/editors.
1876 # The default value is: NO.
1878 GENERATE_RTF           = NO
1880 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1881 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1882 # it.
1883 # The default directory is: rtf.
1884 # This tag requires that the tag GENERATE_RTF is set to YES.
1886 RTF_OUTPUT             = rtf
1888 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1889 # documents. This may be useful for small projects and may help to save some
1890 # trees in general.
1891 # The default value is: NO.
1892 # This tag requires that the tag GENERATE_RTF is set to YES.
1894 COMPACT_RTF            = NO
1896 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1897 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1898 # output) instead of page references. This makes the output suitable for online
1899 # browsing using Word or some other Word compatible readers that support those
1900 # fields.
1902 # Note: WordPad (write) and others do not support links.
1903 # The default value is: NO.
1904 # This tag requires that the tag GENERATE_RTF is set to YES.
1906 RTF_HYPERLINKS         = NO
1908 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1909 # configuration file, i.e. a series of assignments. You only have to provide
1910 # replacements, missing definitions are set to their default value.
1912 # See also section "Doxygen usage" for information on how to generate the
1913 # default style sheet that doxygen normally uses.
1914 # This tag requires that the tag GENERATE_RTF is set to YES.
1916 RTF_STYLESHEET_FILE    =
1918 # Set optional variables used in the generation of an RTF document. Syntax is
1919 # similar to doxygen's configuration file. A template extensions file can be
1920 # generated using doxygen -e rtf extensionFile.
1921 # This tag requires that the tag GENERATE_RTF is set to YES.
1923 RTF_EXTENSIONS_FILE    =
1925 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1926 # with syntax highlighting in the RTF output.
1928 # Note that which sources are shown also depends on other settings such as
1929 # SOURCE_BROWSER.
1930 # The default value is: NO.
1931 # This tag requires that the tag GENERATE_RTF is set to YES.
1933 RTF_SOURCE_CODE        = NO
1935 #---------------------------------------------------------------------------
1936 # Configuration options related to the man page output
1937 #---------------------------------------------------------------------------
1939 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1940 # classes and files.
1941 # The default value is: NO.
1943 GENERATE_MAN           = NO
1945 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1946 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1947 # it. A directory man3 will be created inside the directory specified by
1948 # MAN_OUTPUT.
1949 # The default directory is: man.
1950 # This tag requires that the tag GENERATE_MAN is set to YES.
1952 MAN_OUTPUT             = man
1954 # The MAN_EXTENSION tag determines the extension that is added to the generated
1955 # man pages. In case the manual section does not start with a number, the number
1956 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1957 # optional.
1958 # The default value is: .3.
1959 # This tag requires that the tag GENERATE_MAN is set to YES.
1961 MAN_EXTENSION          = .3
1963 # The MAN_SUBDIR tag determines the name of the directory created within
1964 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1965 # MAN_EXTENSION with the initial . removed.
1966 # This tag requires that the tag GENERATE_MAN is set to YES.
1968 MAN_SUBDIR             =
1970 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1971 # will generate one additional man file for each entity documented in the real
1972 # man page(s). These additional files only source the real man page, but without
1973 # them the man command would be unable to find the correct page.
1974 # The default value is: NO.
1975 # This tag requires that the tag GENERATE_MAN is set to YES.
1977 MAN_LINKS              = NO
1979 #---------------------------------------------------------------------------
1980 # Configuration options related to the XML output
1981 #---------------------------------------------------------------------------
1983 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1984 # captures the structure of the code including all documentation.
1985 # The default value is: NO.
1987 GENERATE_XML           = NO
1989 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1990 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1991 # it.
1992 # The default directory is: xml.
1993 # This tag requires that the tag GENERATE_XML is set to YES.
1995 XML_OUTPUT             = xml
1997 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1998 # listings (including syntax highlighting and cross-referencing information) to
1999 # the XML output. Note that enabling this will significantly increase the size
2000 # of the XML output.
2001 # The default value is: YES.
2002 # This tag requires that the tag GENERATE_XML is set to YES.
2004 XML_PROGRAMLISTING     = YES
2006 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2007 # namespace members in file scope as well, matching the HTML output.
2008 # The default value is: NO.
2009 # This tag requires that the tag GENERATE_XML is set to YES.
2011 XML_NS_MEMB_FILE_SCOPE = NO
2013 #---------------------------------------------------------------------------
2014 # Configuration options related to the DOCBOOK output
2015 #---------------------------------------------------------------------------
2017 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2018 # that can be used to generate PDF.
2019 # The default value is: NO.
2021 GENERATE_DOCBOOK       = NO
2023 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2024 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2025 # front of it.
2026 # The default directory is: docbook.
2027 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2029 DOCBOOK_OUTPUT         = docbook
2031 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2032 # program listings (including syntax highlighting and cross-referencing
2033 # information) to the DOCBOOK output. Note that enabling this will significantly
2034 # increase the size of the DOCBOOK output.
2035 # The default value is: NO.
2036 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2038 DOCBOOK_PROGRAMLISTING = NO
2040 #---------------------------------------------------------------------------
2041 # Configuration options for the AutoGen Definitions output
2042 #---------------------------------------------------------------------------
2044 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2045 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2046 # the structure of the code including all documentation. Note that this feature
2047 # is still experimental and incomplete at the moment.
2048 # The default value is: NO.
2050 GENERATE_AUTOGEN_DEF   = NO
2052 #---------------------------------------------------------------------------
2053 # Configuration options related to the Perl module output
2054 #---------------------------------------------------------------------------
2056 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2057 # file that captures the structure of the code including all documentation.
2059 # Note that this feature is still experimental and incomplete at the moment.
2060 # The default value is: NO.
2062 GENERATE_PERLMOD       = NO
2064 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2065 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2066 # output from the Perl module output.
2067 # The default value is: NO.
2068 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2070 PERLMOD_LATEX          = NO
2072 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2073 # formatted so it can be parsed by a human reader. This is useful if you want to
2074 # understand what is going on. On the other hand, if this tag is set to NO, the
2075 # size of the Perl module output will be much smaller and Perl will parse it
2076 # just the same.
2077 # The default value is: YES.
2078 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2080 PERLMOD_PRETTY         = YES
2082 # The names of the make variables in the generated doxyrules.make file are
2083 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2084 # so different doxyrules.make files included by the same Makefile don't
2085 # overwrite each other's variables.
2086 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2088 PERLMOD_MAKEVAR_PREFIX =
2090 #---------------------------------------------------------------------------
2091 # Configuration options related to the preprocessor
2092 #---------------------------------------------------------------------------
2094 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2095 # C-preprocessor directives found in the sources and include files.
2096 # The default value is: YES.
2098 ENABLE_PREPROCESSING   = YES
2100 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2101 # in the source code. If set to NO, only conditional compilation will be
2102 # performed. Macro expansion can be done in a controlled way by setting
2103 # EXPAND_ONLY_PREDEF to YES.
2104 # The default value is: NO.
2105 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2107 MACRO_EXPANSION        = YES
2109 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2110 # the macro expansion is limited to the macros specified with the PREDEFINED and
2111 # EXPAND_AS_DEFINED tags.
2112 # The default value is: NO.
2113 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2115 EXPAND_ONLY_PREDEF     = NO
2117 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2118 # INCLUDE_PATH will be searched if a #include is found.
2119 # The default value is: YES.
2120 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2122 SEARCH_INCLUDES        = YES
2124 # The INCLUDE_PATH tag can be used to specify one or more directories that
2125 # contain include files that are not input files but should be processed by the
2126 # preprocessor.
2127 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2129 INCLUDE_PATH           =
2131 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2132 # patterns (like *.h and *.hpp) to filter out the header-files in the
2133 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2134 # used.
2135 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2137 INCLUDE_FILE_PATTERNS  =
2139 # The PREDEFINED tag can be used to specify one or more macro names that are
2140 # defined before the preprocessor is started (similar to the -D option of e.g.
2141 # gcc). The argument of the tag is a list of macros of the form: name or
2142 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2143 # is assumed. To prevent a macro definition from being undefined via #undef or
2144 # recursively expanded use the := operator instead of the = operator.
2145 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2147 PREDEFINED             =
2149 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2150 # tag can be used to specify a list of macro names that should be expanded. The
2151 # macro definition that is found in the sources will be used. Use the PREDEFINED
2152 # tag if you want to use a different macro definition that overrules the
2153 # definition found in the source code.
2154 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2156 EXPAND_AS_DEFINED      =
2158 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2159 # remove all references to function-like macros that are alone on a line, have
2160 # an all uppercase name, and do not end with a semicolon. Such function macros
2161 # are typically used for boiler-plate code, and will confuse the parser if not
2162 # removed.
2163 # The default value is: YES.
2164 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2166 SKIP_FUNCTION_MACROS   = YES
2168 #---------------------------------------------------------------------------
2169 # Configuration options related to external references
2170 #---------------------------------------------------------------------------
2172 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2173 # file the location of the external documentation should be added. The format of
2174 # a tag file without this location is as follows:
2175 # TAGFILES = file1 file2 ...
2176 # Adding location for the tag files is done as follows:
2177 # TAGFILES = file1=loc1 "file2 = loc2" ...
2178 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2179 # section "Linking to external documentation" for more information about the use
2180 # of tag files.
2181 # Note: Each tag file must have a unique name (where the name does NOT include
2182 # the path). If a tag file is not located in the directory in which doxygen is
2183 # run, you must also specify the path to the tagfile here.
2185 TAGFILES               =
2187 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2188 # tag file that is based on the input files it reads. See section "Linking to
2189 # external documentation" for more information about the usage of tag files.
2191 GENERATE_TAGFILE       =
2193 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2194 # the class index. If set to NO, only the inherited external classes will be
2195 # listed.
2196 # The default value is: NO.
2198 ALLEXTERNALS           = NO
2200 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2201 # in the modules index. If set to NO, only the current project's groups will be
2202 # listed.
2203 # The default value is: YES.
2205 EXTERNAL_GROUPS        = YES
2207 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2208 # the related pages index. If set to NO, only the current project's pages will
2209 # be listed.
2210 # The default value is: YES.
2212 EXTERNAL_PAGES         = YES
2214 #---------------------------------------------------------------------------
2215 # Configuration options related to the dot tool
2216 #---------------------------------------------------------------------------
2218 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2219 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2220 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2221 # disabled, but it is recommended to install and use dot, since it yields more
2222 # powerful graphs.
2223 # The default value is: YES.
2225 CLASS_DIAGRAMS         = YES
2227 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2228 # then run dia to produce the diagram and insert it in the documentation. The
2229 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2230 # If left empty dia is assumed to be found in the default search path.
2232 DIA_PATH               =
2234 # If set to YES the inheritance and collaboration graphs will hide inheritance
2235 # and usage relations if the target is undocumented or is not a class.
2236 # The default value is: YES.
2238 HIDE_UNDOC_RELATIONS   = NO
2240 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2241 # available from the path. This tool is part of Graphviz (see:
2242 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2243 # Bell Labs. The other options in this section have no effect if this option is
2244 # set to NO
2245 # The default value is: YES.
2247 HAVE_DOT               = YES
2249 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2250 # to run in parallel. When set to 0 doxygen will base this on the number of
2251 # processors available in the system. You can set it explicitly to a value
2252 # larger than 0 to get control over the balance between CPU load and processing
2253 # speed.
2254 # Minimum value: 0, maximum value: 32, default value: 0.
2255 # This tag requires that the tag HAVE_DOT is set to YES.
2257 DOT_NUM_THREADS        = 0
2259 # When you want a differently looking font in the dot files that doxygen
2260 # generates you can specify the font name using DOT_FONTNAME. You need to make
2261 # sure dot is able to find the font, which can be done by putting it in a
2262 # standard location or by setting the DOTFONTPATH environment variable or by
2263 # setting DOT_FONTPATH to the directory containing the font.
2264 # The default value is: Helvetica.
2265 # This tag requires that the tag HAVE_DOT is set to YES.
2267 DOT_FONTNAME           = Helvetica
2269 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2270 # dot graphs.
2271 # Minimum value: 4, maximum value: 24, default value: 10.
2272 # This tag requires that the tag HAVE_DOT is set to YES.
2274 DOT_FONTSIZE           = 10
2276 # By default doxygen will tell dot to use the default font as specified with
2277 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2278 # the path where dot can find it using this tag.
2279 # This tag requires that the tag HAVE_DOT is set to YES.
2281 DOT_FONTPATH           =
2283 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2284 # each documented class showing the direct and indirect inheritance relations.
2285 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2286 # The default value is: YES.
2287 # This tag requires that the tag HAVE_DOT is set to YES.
2289 CLASS_GRAPH            = YES
2291 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2292 # graph for each documented class showing the direct and indirect implementation
2293 # dependencies (inheritance, containment, and class references variables) of the
2294 # class with other documented classes.
2295 # The default value is: YES.
2296 # This tag requires that the tag HAVE_DOT is set to YES.
2298 COLLABORATION_GRAPH    = YES
2300 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2301 # groups, showing the direct groups dependencies.
2302 # The default value is: YES.
2303 # This tag requires that the tag HAVE_DOT is set to YES.
2305 GROUP_GRAPHS           = YES
2307 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2308 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2309 # Language.
2310 # The default value is: NO.
2311 # This tag requires that the tag HAVE_DOT is set to YES.
2313 UML_LOOK               = NO
2315 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2316 # class node. If there are many fields or methods and many nodes the graph may
2317 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2318 # number of items for each type to make the size more manageable. Set this to 0
2319 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2320 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2321 # but if the number exceeds 15, the total amount of fields shown is limited to
2322 # 10.
2323 # Minimum value: 0, maximum value: 100, default value: 10.
2324 # This tag requires that the tag HAVE_DOT is set to YES.
2326 UML_LIMIT_NUM_FIELDS   = 10
2328 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2329 # collaboration graphs will show the relations between templates and their
2330 # instances.
2331 # The default value is: NO.
2332 # This tag requires that the tag HAVE_DOT is set to YES.
2334 TEMPLATE_RELATIONS     = NO
2336 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2337 # YES then doxygen will generate a graph for each documented file showing the
2338 # direct and indirect include dependencies of the file with other documented
2339 # files.
2340 # The default value is: YES.
2341 # This tag requires that the tag HAVE_DOT is set to YES.
2343 INCLUDE_GRAPH          = YES
2345 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2346 # set to YES then doxygen will generate a graph for each documented file showing
2347 # the direct and indirect include dependencies of the file with other documented
2348 # files.
2349 # The default value is: YES.
2350 # This tag requires that the tag HAVE_DOT is set to YES.
2352 INCLUDED_BY_GRAPH      = YES
2354 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2355 # dependency graph for every global function or class method.
2357 # Note that enabling this option will significantly increase the time of a run.
2358 # So in most cases it will be better to enable call graphs for selected
2359 # functions only using the \callgraph command. Disabling a call graph can be
2360 # accomplished by means of the command \hidecallgraph.
2361 # The default value is: NO.
2362 # This tag requires that the tag HAVE_DOT is set to YES.
2364 CALL_GRAPH             = YES
2366 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2367 # dependency graph for every global function or class method.
2369 # Note that enabling this option will significantly increase the time of a run.
2370 # So in most cases it will be better to enable caller graphs for selected
2371 # functions only using the \callergraph command. Disabling a caller graph can be
2372 # accomplished by means of the command \hidecallergraph.
2373 # The default value is: NO.
2374 # This tag requires that the tag HAVE_DOT is set to YES.
2376 CALLER_GRAPH           = YES
2378 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2379 # hierarchy of all classes instead of a textual one.
2380 # The default value is: YES.
2381 # This tag requires that the tag HAVE_DOT is set to YES.
2383 GRAPHICAL_HIERARCHY    = YES
2385 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2386 # dependencies a directory has on other directories in a graphical way. The
2387 # dependency relations are determined by the #include relations between the
2388 # files in the directories.
2389 # The default value is: YES.
2390 # This tag requires that the tag HAVE_DOT is set to YES.
2392 DIRECTORY_GRAPH        = YES
2394 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2395 # generated by dot. For an explanation of the image formats see the section
2396 # output formats in the documentation of the dot tool (Graphviz (see:
2397 # http://www.graphviz.org/)).
2398 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2399 # to make the SVG files visible in IE 9+ (other browsers do not have this
2400 # requirement).
2401 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2402 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2403 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2404 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2405 # png:gdiplus:gdiplus.
2406 # The default value is: png.
2407 # This tag requires that the tag HAVE_DOT is set to YES.
2409 DOT_IMAGE_FORMAT       = png
2411 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2412 # enable generation of interactive SVG images that allow zooming and panning.
2414 # Note that this requires a modern browser other than Internet Explorer. Tested
2415 # and working are Firefox, Chrome, Safari, and Opera.
2416 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2417 # the SVG files visible. Older versions of IE do not have SVG support.
2418 # The default value is: NO.
2419 # This tag requires that the tag HAVE_DOT is set to YES.
2421 INTERACTIVE_SVG        = YES
2423 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2424 # found. If left blank, it is assumed the dot tool can be found in the path.
2425 # This tag requires that the tag HAVE_DOT is set to YES.
2427 DOT_PATH               =
2429 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2430 # contain dot files that are included in the documentation (see the \dotfile
2431 # command).
2432 # This tag requires that the tag HAVE_DOT is set to YES.
2434 DOTFILE_DIRS           =
2436 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2437 # contain msc files that are included in the documentation (see the \mscfile
2438 # command).
2440 MSCFILE_DIRS           =
2442 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2443 # contain dia files that are included in the documentation (see the \diafile
2444 # command).
2446 DIAFILE_DIRS           =
2448 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2449 # path where java can find the plantuml.jar file. If left blank, it is assumed
2450 # PlantUML is not used or called during a preprocessing step. Doxygen will
2451 # generate a warning when it encounters a \startuml command in this case and
2452 # will not generate output for the diagram.
2454 PLANTUML_JAR_PATH      =
2456 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2457 # configuration file for plantuml.
2459 PLANTUML_CFG_FILE      =
2461 # When using plantuml, the specified paths are searched for files specified by
2462 # the !include statement in a plantuml block.
2464 PLANTUML_INCLUDE_PATH  =
2466 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2467 # that will be shown in the graph. If the number of nodes in a graph becomes
2468 # larger than this value, doxygen will truncate the graph, which is visualized
2469 # by representing a node as a red box. Note that doxygen if the number of direct
2470 # children of the root node in a graph is already larger than
2471 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2472 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2473 # Minimum value: 0, maximum value: 10000, default value: 50.
2474 # This tag requires that the tag HAVE_DOT is set to YES.
2476 DOT_GRAPH_MAX_NODES    = 50
2478 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2479 # generated by dot. A depth value of 3 means that only nodes reachable from the
2480 # root by following a path via at most 3 edges will be shown. Nodes that lay
2481 # further from the root node will be omitted. Note that setting this option to 1
2482 # or 2 may greatly reduce the computation time needed for large code bases. Also
2483 # note that the size of a graph can be further restricted by
2484 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2485 # Minimum value: 0, maximum value: 1000, default value: 0.
2486 # This tag requires that the tag HAVE_DOT is set to YES.
2488 MAX_DOT_GRAPH_DEPTH    = 0
2490 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2491 # background. This is disabled by default, because dot on Windows does not seem
2492 # to support this out of the box.
2494 # Warning: Depending on the platform used, enabling this option may lead to
2495 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2496 # read).
2497 # The default value is: NO.
2498 # This tag requires that the tag HAVE_DOT is set to YES.
2500 DOT_TRANSPARENT        = NO
2502 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2503 # files in one run (i.e. multiple -o and -T options on the command line). This
2504 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2505 # this, this feature is disabled by default.
2506 # The default value is: NO.
2507 # This tag requires that the tag HAVE_DOT is set to YES.
2509 DOT_MULTI_TARGETS      = NO
2511 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2512 # explaining the meaning of the various boxes and arrows in the dot generated
2513 # graphs.
2514 # The default value is: YES.
2515 # This tag requires that the tag HAVE_DOT is set to YES.
2517 GENERATE_LEGEND        = YES
2519 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2520 # files that are used to generate the various graphs.
2521 # The default value is: YES.
2522 # This tag requires that the tag HAVE_DOT is set to YES.
2524 DOT_CLEANUP            = YES