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