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