Debian Codegraph @

third_party/vkmemalloc/src/Doxyfile

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