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