OSDN Git Service

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