OSDN Git Service

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