CMake: add WITH_LINKER_LLD option for unix platforms
[blender-staging.git] / doc / doxygen / Doxyfile
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           = Blender
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         = "V2.90"
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           = ../../release/freedesktop/icons/48x48/apps/blender.png
55
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
60
61 OUTPUT_DIRECTORY       =
62
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64 # directories (in 2 levels) under the output directory of each output format and
65 # will distribute the generated files over these directories. Enabling this
66 # option can be useful when feeding doxygen a huge amount of source files, where
67 # putting all generated files in the same directory would otherwise causes
68 # performance problems for the file system.
69 # The default value is: NO.
70
71 CREATE_SUBDIRS         = YES
72
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 # characters to appear in the names of generated files. If set to NO, non-ASCII
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76 # U+3044.
77 # The default value is: NO.
78
79 ALLOW_UNICODE_NAMES    = NO
80
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82 # documentation generated by doxygen is written. Doxygen will use this
83 # information to generate all constant output in the proper language.
84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91 # Ukrainian and Vietnamese.
92 # The default value is: English.
93
94 OUTPUT_LANGUAGE        = English
95
96 # 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        = NO
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         = YES
495
496 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
497 # locally in source files will be included in the documentation. If set to NO,
498 # only classes defined in header files are included. Does not have any effect
499 # for Java sources.
500 # The default value is: YES.
501
502 EXTRACT_LOCAL_CLASSES  = YES
503
504 # This flag is only useful for Objective-C code. If set to YES, local methods,
505 # which are defined in the implementation section but not in the interface are
506 # included in the documentation. If set to NO, only methods in the interface are
507 # included.
508 # The default value is: NO.
509
510 EXTRACT_LOCAL_METHODS  = 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          = YES
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       = YES
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   = NO
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                  = doxygen.main.h \
833                          doxygen.source.h \
834                          doxygen.intern.h \
835                          doxygen.extern.h \
836                          ../../source \
837                          ../../intern \
838                          ../../extern/bullet2
839
840 # This tag can be used to specify the character encoding of the source files
841 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
842 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
843 # documentation (see: https://www.gnu.org/software/libiconv/) for the list of
844 # possible encodings.
845 # The default value is: UTF-8.
846
847 INPUT_ENCODING         = UTF-8
848
849 # If the value of the INPUT tag contains directories, you can use the
850 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
851 # *.h) to filter out the source-files in the directories.
852 #
853 # Note that for custom extensions or not directly supported extensions you also
854 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
855 # read by doxygen.
856 #
857 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
858 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
859 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
860 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
861 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
862
863 FILE_PATTERNS          =
864
865 # The RECURSIVE tag can be used to specify whether or not subdirectories should
866 # be searched for input files as well.
867 # The default value is: NO.
868
869 RECURSIVE              = YES
870
871 # The EXCLUDE tag can be used to specify files and/or directories that should be
872 # excluded from the INPUT source files. This way you can easily exclude a
873 # subdirectory from a directory tree whose root is specified with the INPUT tag.
874 #
875 # Note that relative paths are relative to the directory from which doxygen is
876 # run.
877
878 EXCLUDE                = ../../build_files \
879                          ../../release
880
881 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
882 # directories that are symbolic links (a Unix file system feature) are excluded
883 # from the input.
884 # The default value is: NO.
885
886 EXCLUDE_SYMLINKS       = NO
887
888 # If the value of the INPUT tag contains directories, you can use the
889 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
890 # certain files from those directories.
891 #
892 # Note that the wildcards are matched against the file with absolute path, so to
893 # exclude all test directories for example use the pattern */test/*
894
895 EXCLUDE_PATTERNS       = .svn \
896                          .git \
897                          *.py
898
899 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
900 # (namespaces, classes, functions, etc.) that should be excluded from the
901 # output. The symbol name can be a fully qualified name, a word, or if the
902 # wildcard * is used, a substring. Examples: ANamespace, AClass,
903 # AClass::ANamespace, ANamespace::*Test
904 #
905 # Note that the wildcards are matched against the file with absolute path, so to
906 # exclude all test directories use the pattern */test/*
907
908 EXCLUDE_SYMBOLS        =
909
910 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
911 # that contain example code fragments that are included (see the \include
912 # command).
913
914 EXAMPLE_PATH           =
915
916 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
917 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
918 # *.h) to filter out the source-files in the directories. If left blank all
919 # files are included.
920
921 EXAMPLE_PATTERNS       =
922
923 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
924 # searched for input files to be used with the \include or \dontinclude commands
925 # irrespective of the value of the RECURSIVE tag.
926 # The default value is: NO.
927
928 EXAMPLE_RECURSIVE      = NO
929
930 # The IMAGE_PATH tag can be used to specify one or more files or directories
931 # that contain images that are to be included in the documentation (see the
932 # \image command).
933
934 IMAGE_PATH             =
935
936 # The INPUT_FILTER tag can be used to specify a program that doxygen should
937 # invoke to filter for each input file. Doxygen will invoke the filter program
938 # by executing (via popen()) the command:
939 #
940 # <filter> <input-file>
941 #
942 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
943 # name of an input file. Doxygen will then use the output that the filter
944 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
945 # will be ignored.
946 #
947 # Note that the filter must not add or remove lines; it is applied before the
948 # code is scanned, but not when the output code is generated. If lines are added
949 # or removed, the anchors will not be placed correctly.
950 #
951 # Note that for custom extensions or not directly supported extensions you also
952 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
953 # properly processed by doxygen.
954
955 INPUT_FILTER           =
956
957 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
958 # basis. Doxygen will compare the file name with each pattern and apply the
959 # filter if there is a match. The filters are a list of the form: pattern=filter
960 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
961 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
962 # patterns match the file name, INPUT_FILTER is applied.
963 #
964 # Note that for custom extensions or not directly supported extensions you also
965 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
966 # properly processed by doxygen.
967
968 FILTER_PATTERNS        =
969
970 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
971 # INPUT_FILTER) will also be used to filter the input files that are used for
972 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
973 # The default value is: NO.
974
975 FILTER_SOURCE_FILES    = NO
976
977 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
978 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
979 # it is also possible to disable source filtering for a specific pattern using
980 # *.ext= (so without naming a filter).
981 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
982
983 FILTER_SOURCE_PATTERNS =
984
985 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
986 # is part of the input, its contents will be placed on the main page
987 # (index.html). This can be useful if you have a project on for instance GitHub
988 # and want to reuse the introduction page also for the doxygen output.
989
990 USE_MDFILE_AS_MAINPAGE =
991
992 #---------------------------------------------------------------------------
993 # Configuration options related to source browsing
994 #---------------------------------------------------------------------------
995
996 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
997 # generated. Documented entities will be cross-referenced with these sources.
998 #
999 # Note: To get rid of all source code in the generated output, make sure that
1000 # also VERBATIM_HEADERS is set to NO.
1001 # The default value is: NO.
1002
1003 SOURCE_BROWSER         = YES
1004
1005 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1006 # classes and enums directly into the documentation.
1007 # The default value is: NO.
1008
1009 INLINE_SOURCES         = NO
1010
1011 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1012 # special comment blocks from generated source code fragments. Normal C, C++ and
1013 # Fortran comments will always remain visible.
1014 # The default value is: YES.
1015
1016 STRIP_CODE_COMMENTS    = YES
1017
1018 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1019 # entity all documented functions referencing it will be listed.
1020 # The default value is: NO.
1021
1022 REFERENCED_BY_RELATION = YES
1023
1024 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1025 # all documented entities called/used by that function will be listed.
1026 # The default value is: NO.
1027
1028 REFERENCES_RELATION    = YES
1029
1030 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1031 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1032 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1033 # link to the documentation.
1034 # The default value is: YES.
1035
1036 REFERENCES_LINK_SOURCE = YES
1037
1038 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1039 # source code will show a tooltip with additional information such as prototype,
1040 # brief description and links to the definition and documentation. Since this
1041 # will make the HTML file larger and loading of large files a bit slower, you
1042 # can opt to disable this feature.
1043 # The default value is: YES.
1044 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1045
1046 SOURCE_TOOLTIPS        = YES
1047
1048 # If the USE_HTAGS tag is set to YES then the references to source code will
1049 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1050 # source browser. The htags tool is part of GNU's global source tagging system
1051 # (see https://www.gnu.org/software/global/global.html). You will need version
1052 # 4.8.6 or higher.
1053 #
1054 # To use it do the following:
1055 # - Install the latest version of global
1056 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1057 # - Make sure the INPUT points to the root of the source tree
1058 # - Run doxygen as normal
1059 #
1060 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1061 # tools must be available from the command line (i.e. in the search path).
1062 #
1063 # The result: instead of the source browser generated by doxygen, the links to
1064 # source code will now point to the output of htags.
1065 # The default value is: NO.
1066 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1067
1068 USE_HTAGS              = NO
1069
1070 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1071 # verbatim copy of the header file for each class for which an include is
1072 # specified. Set to NO to disable this.
1073 # See also: Section \class.
1074 # The default value is: YES.
1075
1076 VERBATIM_HEADERS       = YES
1077
1078 #---------------------------------------------------------------------------
1079 # Configuration options related to the alphabetical class index
1080 #---------------------------------------------------------------------------
1081
1082 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1083 # compounds will be generated. Enable this if the project contains a lot of
1084 # classes, structs, unions or interfaces.
1085 # The default value is: YES.
1086
1087 ALPHABETICAL_INDEX     = YES
1088
1089 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1090 # which the alphabetical index list will be split.
1091 # Minimum value: 1, maximum value: 20, default value: 5.
1092 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1093
1094 COLS_IN_ALPHA_INDEX    = 5
1095
1096 # In case all classes in a project start with a common prefix, all classes will
1097 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1098 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1099 # while generating the index headers.
1100 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1101
1102 IGNORE_PREFIX          =
1103
1104 #---------------------------------------------------------------------------
1105 # Configuration options related to the HTML output
1106 #---------------------------------------------------------------------------
1107
1108 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1109 # The default value is: YES.
1110
1111 GENERATE_HTML          = YES
1112
1113 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1114 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1115 # it.
1116 # The default directory is: html.
1117 # This tag requires that the tag GENERATE_HTML is set to YES.
1118
1119 HTML_OUTPUT            = html
1120
1121 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1122 # generated HTML page (for example: .htm, .php, .asp).
1123 # The default value is: .html.
1124 # This tag requires that the tag GENERATE_HTML is set to YES.
1125
1126 HTML_FILE_EXTENSION    = .html
1127
1128 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1129 # each generated HTML page. If the tag is left blank doxygen will generate a
1130 # standard header.
1131 #
1132 # To get valid HTML the header file that includes any scripts and style sheets
1133 # that doxygen needs, which is dependent on the configuration options used (e.g.
1134 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1135 # default header using
1136 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1137 # YourConfigFile
1138 # and then modify the file new_header.html. See also section "Doxygen usage"
1139 # for information on how to generate the default header that doxygen normally
1140 # uses.
1141 # Note: The header is subject to change so you typically have to regenerate the
1142 # default header when upgrading to a newer version of doxygen. For a description
1143 # of the possible markers and block names see the documentation.
1144 # This tag requires that the tag GENERATE_HTML is set to YES.
1145
1146 HTML_HEADER            =
1147
1148 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1149 # generated HTML page. If the tag is left blank doxygen will generate a standard
1150 # footer. See HTML_HEADER for more information on how to generate a default
1151 # footer and what special commands can be used inside the footer. See also
1152 # section "Doxygen usage" for information on how to generate the default footer
1153 # that doxygen normally uses.
1154 # This tag requires that the tag GENERATE_HTML is set to YES.
1155
1156 HTML_FOOTER            = footer.html
1157
1158 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1159 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1160 # the HTML output. If left blank doxygen will generate a default style sheet.
1161 # See also section "Doxygen usage" for information on how to generate the style
1162 # sheet that doxygen normally uses.
1163 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1164 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1165 # obsolete.
1166 # This tag requires that the tag GENERATE_HTML is set to YES.
1167
1168 HTML_STYLESHEET        =
1169
1170 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1171 # cascading style sheets that are included after the standard style sheets
1172 # created by doxygen. Using this option one can overrule certain style aspects.
1173 # This is preferred over using HTML_STYLESHEET since it does not replace the
1174 # standard style sheet and is therefore more robust against future updates.
1175 # Doxygen will copy the style sheet files to the output directory.
1176 # Note: The order of the extra style sheet files is of importance (e.g. the last
1177 # style sheet in the list overrules the setting of the previous ones in the
1178 # list). For an example see the documentation.
1179 # This tag requires that the tag GENERATE_HTML is set to YES.
1180
1181 HTML_EXTRA_STYLESHEET  =
1182
1183 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1184 # other source files which should be copied to the HTML output directory. Note
1185 # that these files will be copied to the base HTML output directory. Use the
1186 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1187 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1188 # files will be copied as-is; there are no commands or markers available.
1189 # This tag requires that the tag GENERATE_HTML is set to YES.
1190
1191 HTML_EXTRA_FILES       =
1192
1193 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1194 # will adjust the colors in the style sheet and background images according to
1195 # this color. Hue is specified as an angle on a colorwheel, see
1196 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1197 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1198 # purple, and 360 is red again.
1199 # Minimum value: 0, maximum value: 359, default value: 220.
1200 # This tag requires that the tag GENERATE_HTML is set to YES.
1201
1202 HTML_COLORSTYLE_HUE    = 220
1203
1204 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1205 # in the HTML output. For a value of 0 the output will use grayscales only. A
1206 # value of 255 will produce the most vivid colors.
1207 # Minimum value: 0, maximum value: 255, default value: 100.
1208 # This tag requires that the tag GENERATE_HTML is set to YES.
1209
1210 HTML_COLORSTYLE_SAT    = 100
1211
1212 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1213 # luminance component of the colors in the HTML output. Values below 100
1214 # gradually make the output lighter, whereas values above 100 make the output
1215 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1216 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1217 # change the gamma.
1218 # Minimum value: 40, maximum value: 240, default value: 80.
1219 # This tag requires that the tag GENERATE_HTML is set to YES.
1220
1221 HTML_COLORSTYLE_GAMMA  = 79
1222
1223 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1224 # page will contain the date and time when the page was generated. Setting this
1225 # to YES can help to show when doxygen was last run and thus if the
1226 # documentation is up to date.
1227 # The default value is: NO.
1228 # This tag requires that the tag GENERATE_HTML is set to YES.
1229
1230 HTML_TIMESTAMP         = YES
1231
1232 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1233 # documentation will contain a main index with vertical navigation menus that
1234 # are dynamically created via Javascript. If disabled, the navigation index will
1235 # consists of multiple levels of tabs that are statically embedded in every HTML
1236 # page. Disable this option to support browsers that do not have Javascript,
1237 # like the Qt help browser.
1238 # The default value is: YES.
1239 # This tag requires that the tag GENERATE_HTML is set to YES.
1240
1241 HTML_DYNAMIC_MENUS     = YES
1242
1243 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1244 # documentation will contain sections that can be hidden and shown after the
1245 # page has loaded.
1246 # The default value is: NO.
1247 # This tag requires that the tag GENERATE_HTML is set to YES.
1248
1249 HTML_DYNAMIC_SECTIONS  = NO
1250
1251 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1252 # shown in the various tree structured indices initially; the user can expand
1253 # and collapse entries dynamically later on. Doxygen will expand the tree to
1254 # such a level that at most the specified number of entries are visible (unless
1255 # a fully collapsed tree already exceeds this amount). So setting the number of
1256 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1257 # representing an infinite number of entries and will result in a full expanded
1258 # tree by default.
1259 # Minimum value: 0, maximum value: 9999, default value: 100.
1260 # This tag requires that the tag GENERATE_HTML is set to YES.
1261
1262 HTML_INDEX_NUM_ENTRIES = 100
1263
1264 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1265 # generated that can be used as input for Apple's Xcode 3 integrated development
1266 # environment (see: https://developer.apple.com/xcode/), introduced with OSX
1267 # 10.5 (Leopard). To create a documentation set, doxygen will generate a
1268 # Makefile in the HTML output directory. Running make will produce the docset in
1269 # that directory and running make install will install the docset in
1270 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1271 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1272 # genXcode/_index.html for more information.
1273 # The default value is: NO.
1274 # This tag requires that the tag GENERATE_HTML is set to YES.
1275
1276 GENERATE_DOCSET        = NO
1277
1278 # This tag determines the name of the docset feed. A documentation feed provides
1279 # an umbrella under which multiple documentation sets from a single provider
1280 # (such as a company or product suite) can be grouped.
1281 # The default value is: Doxygen generated docs.
1282 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1283
1284 DOCSET_FEEDNAME        = "Doxygen generated docs"
1285
1286 # This tag specifies a string that should uniquely identify the documentation
1287 # set bundle. This should be a reverse domain-name style string, e.g.
1288 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1289 # The default value is: org.doxygen.Project.
1290 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1291
1292 DOCSET_BUNDLE_ID       = org.doxygen.Project
1293
1294 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1295 # the documentation publisher. This should be a reverse domain-name style
1296 # string, e.g. com.mycompany.MyDocSet.documentation.
1297 # The default value is: org.doxygen.Publisher.
1298 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1299
1300 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1301
1302 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1303 # The default value is: Publisher.
1304 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1305
1306 DOCSET_PUBLISHER_NAME  = Publisher
1307
1308 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1309 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1310 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1311 # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1312 # Windows.
1313 #
1314 # The HTML Help Workshop contains a compiler that can convert all HTML output
1315 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1316 # files are now used as the Windows 98 help format, and will replace the old
1317 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1318 # HTML files also contain an index, a table of contents, and you can search for
1319 # words in the documentation. The HTML workshop also contains a viewer for
1320 # compressed HTML files.
1321 # The default value is: NO.
1322 # This tag requires that the tag GENERATE_HTML is set to YES.
1323
1324 GENERATE_HTMLHELP      = YES
1325
1326 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1327 # file. You can add a path in front of the file if the result should not be
1328 # written to the html output directory.
1329 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1330
1331 CHM_FILE               = blender.chm
1332
1333 # The HHC_LOCATION tag can be used to specify the location (absolute path
1334 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1335 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1336 # The file has to be specified with full path.
1337 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1338
1339 HHC_LOCATION           = "C:/Program Files (x86)/HTML Help Workshop/hhc.exe"
1340
1341 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1342 # (YES) or that it should be included in the master .chm file (NO).
1343 # The default value is: NO.
1344 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1345
1346 GENERATE_CHI           = NO
1347
1348 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1349 # and project file content.
1350 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1351
1352 CHM_INDEX_ENCODING     =
1353
1354 # The BINARY_TOC flag controls whether a binary table of contents is generated
1355 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1356 # enables the Previous and Next buttons.
1357 # The default value is: NO.
1358 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1359
1360 BINARY_TOC             = NO
1361
1362 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1363 # the table of contents of the HTML help documentation and to the tree view.
1364 # The default value is: NO.
1365 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1366
1367 TOC_EXPAND             = NO
1368
1369 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1370 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1371 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1372 # (.qch) of the generated HTML documentation.
1373 # The default value is: NO.
1374 # This tag requires that the tag GENERATE_HTML is set to YES.
1375
1376 GENERATE_QHP           = NO
1377
1378 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1379 # the file name of the resulting .qch file. The path specified is relative to
1380 # the HTML output folder.
1381 # This tag requires that the tag GENERATE_QHP is set to YES.
1382
1383 QCH_FILE               =
1384
1385 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1386 # Project output. For more information please see Qt Help Project / Namespace
1387 # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1388 # The default value is: org.doxygen.Project.
1389 # This tag requires that the tag GENERATE_QHP is set to YES.
1390
1391 QHP_NAMESPACE          = org.doxygen.Project
1392
1393 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1394 # Help Project output. For more information please see Qt Help Project / Virtual
1395 # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1396 # folders).
1397 # The default value is: doc.
1398 # This tag requires that the tag GENERATE_QHP is set to YES.
1399
1400 QHP_VIRTUAL_FOLDER     = doc
1401
1402 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1403 # filter to add. For more information please see Qt Help Project / Custom
1404 # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1405 # filters).
1406 # This tag requires that the tag GENERATE_QHP is set to YES.
1407
1408 QHP_CUST_FILTER_NAME   =
1409
1410 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1411 # custom filter to add. For more information please see Qt Help Project / Custom
1412 # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1413 # filters).
1414 # This tag requires that the tag GENERATE_QHP is set to YES.
1415
1416 QHP_CUST_FILTER_ATTRS  =
1417
1418 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1419 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1420 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1421 # This tag requires that the tag GENERATE_QHP is set to YES.
1422
1423 QHP_SECT_FILTER_ATTRS  =
1424
1425 # The QHG_LOCATION tag can be used to specify the location of Qt's
1426 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1427 # generated .qhp file.
1428 # This tag requires that the tag GENERATE_QHP is set to YES.
1429
1430 QHG_LOCATION           =
1431
1432 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1433 # generated, together with the HTML files, they form an Eclipse help plugin. To
1434 # install this plugin and make it available under the help contents menu in
1435 # Eclipse, the contents of the directory containing the HTML and XML files needs
1436 # to be copied into the plugins directory of eclipse. The name of the directory
1437 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1438 # After copying Eclipse needs to be restarted before the help appears.
1439 # The default value is: NO.
1440 # This tag requires that the tag GENERATE_HTML is set to YES.
1441
1442 GENERATE_ECLIPSEHELP   = NO
1443
1444 # A unique identifier for the Eclipse help plugin. When installing the plugin
1445 # the directory name containing the HTML and XML files should also have this
1446 # name. Each documentation set should have its own identifier.
1447 # The default value is: org.doxygen.Project.
1448 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1449
1450 ECLIPSE_DOC_ID         = org.doxygen.Project
1451
1452 # If you want full control over the layout of the generated HTML pages it might
1453 # be necessary to disable the index and replace it with your own. The
1454 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1455 # of each HTML page. A value of NO enables the index and the value YES disables
1456 # it. Since the tabs in the index contain the same information as the navigation
1457 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1458 # The default value is: NO.
1459 # This tag requires that the tag GENERATE_HTML is set to YES.
1460
1461 DISABLE_INDEX          = NO
1462
1463 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1464 # structure should be generated to display hierarchical information. If the tag
1465 # value is set to YES, a side panel will be generated containing a tree-like
1466 # index structure (just like the one that is generated for HTML Help). For this
1467 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1468 # (i.e. any modern browser). Windows users are probably better off using the
1469 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1470 # further fine-tune the look of the index. As an example, the default style
1471 # sheet generated by doxygen has an example that shows how to put an image at
1472 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1473 # the same information as the tab index, you could consider setting
1474 # DISABLE_INDEX to YES when enabling this option.
1475 # The default value is: NO.
1476 # This tag requires that the tag GENERATE_HTML is set to YES.
1477
1478 GENERATE_TREEVIEW      = NO
1479
1480 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1481 # doxygen will group on one line in the generated HTML documentation.
1482 #
1483 # Note that a value of 0 will completely suppress the enum values from appearing
1484 # in the overview section.
1485 # Minimum value: 0, maximum value: 20, default value: 4.
1486 # This tag requires that the tag GENERATE_HTML is set to YES.
1487
1488 ENUM_VALUES_PER_LINE   = 4
1489
1490 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1491 # to set the initial width (in pixels) of the frame in which the tree is shown.
1492 # Minimum value: 0, maximum value: 1500, default value: 250.
1493 # This tag requires that the tag GENERATE_HTML is set to YES.
1494
1495 TREEVIEW_WIDTH         = 246
1496
1497 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1498 # external symbols imported via tag files in a separate window.
1499 # The default value is: NO.
1500 # This tag requires that the tag GENERATE_HTML is set to YES.
1501
1502 EXT_LINKS_IN_WINDOW    = NO
1503
1504 # Use this tag to change the font size of LaTeX formulas included as images in
1505 # the HTML documentation. When you change the font size after a successful
1506 # doxygen run you need to manually remove any form_*.png images from the HTML
1507 # output directory to force them to be regenerated.
1508 # Minimum value: 8, maximum value: 50, default value: 10.
1509 # This tag requires that the tag GENERATE_HTML is set to YES.
1510
1511 FORMULA_FONTSIZE       = 10
1512
1513 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1514 # generated for formulas are transparent PNGs. Transparent PNGs are not
1515 # supported properly for IE 6.0, but are supported on all modern browsers.
1516 #
1517 # Note that when changing this option you need to delete any form_*.png files in
1518 # the HTML output directory before the changes have effect.
1519 # The default value is: YES.
1520 # This tag requires that the tag GENERATE_HTML is set to YES.
1521
1522 FORMULA_TRANSPARENT    = YES
1523
1524 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1525 # https://www.mathjax.org) which uses client side Javascript for the rendering
1526 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1527 # installed or if you want to formulas look prettier in the HTML output. When
1528 # enabled you may also need to install MathJax separately and configure the path
1529 # to it using the MATHJAX_RELPATH option.
1530 # The default value is: NO.
1531 # This tag requires that the tag GENERATE_HTML is set to YES.
1532
1533 USE_MATHJAX            = NO
1534
1535 # When MathJax is enabled you can set the default output format to be used for
1536 # the MathJax output. See the MathJax site (see:
1537 # http://docs.mathjax.org/en/latest/output.html) for more details.
1538 # Possible values are: HTML-CSS (which is slower, but has the best
1539 # compatibility), NativeMML (i.e. MathML) and SVG.
1540 # The default value is: HTML-CSS.
1541 # This tag requires that the tag USE_MATHJAX is set to YES.
1542
1543 MATHJAX_FORMAT         = HTML-CSS
1544
1545 # When MathJax is enabled you need to specify the location relative to the HTML
1546 # output directory using the MATHJAX_RELPATH option. The destination directory
1547 # should contain the MathJax.js script. For instance, if the mathjax directory
1548 # is located at the same level as the HTML output directory, then
1549 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1550 # Content Delivery Network so you can quickly see the result without installing
1551 # MathJax. However, it is strongly recommended to install a local copy of
1552 # MathJax from https://www.mathjax.org before deployment.
1553 # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1554 # This tag requires that the tag USE_MATHJAX is set to YES.
1555
1556 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1557
1558 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1559 # extension names that should be enabled during MathJax rendering. For example
1560 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1561 # This tag requires that the tag USE_MATHJAX is set to YES.
1562
1563 MATHJAX_EXTENSIONS     =
1564
1565 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1566 # of code that will be used on startup of the MathJax code. See the MathJax site
1567 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1568 # example see the documentation.
1569 # This tag requires that the tag USE_MATHJAX is set to YES.
1570
1571 MATHJAX_CODEFILE       =
1572
1573 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1574 # the HTML output. The underlying search engine uses javascript and DHTML and
1575 # should work on any modern browser. Note that when using HTML help
1576 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1577 # there is already a search function so this one should typically be disabled.
1578 # For large projects the javascript based search engine can be slow, then
1579 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1580 # search using the keyboard; to jump to the search box use <access key> + S
1581 # (what the <access key> is depends on the OS and browser, but it is typically
1582 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1583 # key> to jump into the search results window, the results can be navigated
1584 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1585 # the search. The filter options can be selected when the cursor is inside the
1586 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1587 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1588 # option.
1589 # The default value is: YES.
1590 # This tag requires that the tag GENERATE_HTML is set to YES.
1591
1592 SEARCHENGINE           = NO
1593
1594 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1595 # implemented using a web server instead of a web client using Javascript. There
1596 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1597 # setting. When disabled, doxygen will generate a PHP script for searching and
1598 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1599 # and searching needs to be provided by external tools. See the section
1600 # "External Indexing and Searching" for details.
1601 # The default value is: NO.
1602 # This tag requires that the tag SEARCHENGINE is set to YES.
1603
1604 SERVER_BASED_SEARCH    = NO
1605
1606 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1607 # script for searching. Instead the search results are written to an XML file
1608 # which needs to be processed by an external indexer. Doxygen will invoke an
1609 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1610 # search results.
1611 #
1612 # Doxygen ships with an example indexer (doxyindexer) and search engine
1613 # (doxysearch.cgi) which are based on the open source search engine library
1614 # Xapian (see: https://xapian.org/).
1615 #
1616 # See the section "External Indexing and Searching" for details.
1617 # The default value is: NO.
1618 # This tag requires that the tag SEARCHENGINE is set to YES.
1619
1620 EXTERNAL_SEARCH        = NO
1621
1622 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1623 # which will return the search results when EXTERNAL_SEARCH is enabled.
1624 #
1625 # Doxygen ships with an example indexer (doxyindexer) and search engine
1626 # (doxysearch.cgi) which are based on the open source search engine library
1627 # Xapian (see: https://xapian.org/). See the section "External Indexing and
1628 # Searching" for details.
1629 # This tag requires that the tag SEARCHENGINE is set to YES.
1630
1631 SEARCHENGINE_URL       =
1632
1633 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1634 # search data is written to a file for indexing by an external tool. With the
1635 # SEARCHDATA_FILE tag the name of this file can be specified.
1636 # The default file is: searchdata.xml.
1637 # This tag requires that the tag SEARCHENGINE is set to YES.
1638
1639 SEARCHDATA_FILE        = searchdata.xml
1640
1641 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1642 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1643 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1644 # projects and redirect the results back to the right project.
1645 # This tag requires that the tag SEARCHENGINE is set to YES.
1646
1647 EXTERNAL_SEARCH_ID     =
1648
1649 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1650 # projects other than the one defined by this configuration file, but that are
1651 # all added to the same external search index. Each project needs to have a
1652 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1653 # to a relative location where the documentation can be found. The format is:
1654 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1655 # This tag requires that the tag SEARCHENGINE is set to YES.
1656
1657 EXTRA_SEARCH_MAPPINGS  =
1658
1659 #---------------------------------------------------------------------------
1660 # Configuration options related to the LaTeX output
1661 #---------------------------------------------------------------------------
1662
1663 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1664 # The default value is: YES.
1665
1666 GENERATE_LATEX         = NO
1667
1668 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1669 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1670 # it.
1671 # The default directory is: latex.
1672 # This tag requires that the tag GENERATE_LATEX is set to YES.
1673
1674 LATEX_OUTPUT           = latex
1675
1676 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1677 # invoked.
1678 #
1679 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1680 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1681 # chosen this is overwritten by pdflatex. For specific output languages the
1682 # default can have been set differently, this depends on the implementation of
1683 # the output language.
1684 # This tag requires that the tag GENERATE_LATEX is set to YES.
1685
1686 LATEX_CMD_NAME         = latex
1687
1688 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1689 # index for LaTeX.
1690 # Note: This tag is used in the Makefile / make.bat.
1691 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1692 # (.tex).
1693 # The default file is: makeindex.
1694 # This tag requires that the tag GENERATE_LATEX is set to YES.
1695
1696 MAKEINDEX_CMD_NAME     = makeindex
1697
1698 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1699 # generate index for LaTeX. In case there is no backslash (\) as first character
1700 # it will be automatically added in the LaTeX code.
1701 # Note: This tag is used in the generated output file (.tex).
1702 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1703 # The default value is: makeindex.
1704 # This tag requires that the tag GENERATE_LATEX is set to YES.
1705
1706 LATEX_MAKEINDEX_CMD    = \makeindex
1707
1708 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1709 # documents. This may be useful for small projects and may help to save some
1710 # trees in general.
1711 # The default value is: NO.
1712 # This tag requires that the tag GENERATE_LATEX is set to YES.
1713
1714 COMPACT_LATEX          = NO
1715
1716 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1717 # printer.
1718 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1719 # 14 inches) and executive (7.25 x 10.5 inches).
1720 # The default value is: a4.
1721 # This tag requires that the tag GENERATE_LATEX is set to YES.
1722
1723 PAPER_TYPE             = a4wide
1724
1725 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1726 # that should be included in the LaTeX output. The package can be specified just
1727 # by its name or with the correct syntax as to be used with the LaTeX
1728 # \usepackage command. To get the times font for instance you can specify :
1729 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1730 # To use the option intlimits with the amsmath package you can specify:
1731 # EXTRA_PACKAGES=[intlimits]{amsmath}
1732 # If left blank no extra packages will be included.
1733 # This tag requires that the tag GENERATE_LATEX is set to YES.
1734
1735 EXTRA_PACKAGES         =
1736
1737 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1738 # generated LaTeX document. The header should contain everything until the first
1739 # chapter. If it is left blank doxygen will generate a standard header. See
1740 # section "Doxygen usage" for information on how to let doxygen write the
1741 # default header to a separate file.
1742 #
1743 # Note: Only use a user-defined header if you know what you are doing! The
1744 # following commands have a special meaning inside the header: $title,
1745 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1746 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1747 # string, for the replacement values of the other commands the user is referred
1748 # to HTML_HEADER.
1749 # This tag requires that the tag GENERATE_LATEX is set to YES.
1750
1751 LATEX_HEADER           =
1752
1753 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1754 # generated LaTeX document. The footer should contain everything after the last
1755 # chapter. If it is left blank doxygen will generate a standard footer. See
1756 # LATEX_HEADER for more information on how to generate a default footer and what
1757 # special commands can be used inside the footer.
1758 #
1759 # Note: Only use a user-defined footer if you know what you are doing!
1760 # This tag requires that the tag GENERATE_LATEX is set to YES.
1761
1762 LATEX_FOOTER           =
1763
1764 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1765 # LaTeX style sheets that are included after the standard style sheets created
1766 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1767 # will copy the style sheet files to the output directory.
1768 # Note: The order of the extra style sheet files is of importance (e.g. the last
1769 # style sheet in the list overrules the setting of the previous ones in the
1770 # list).
1771 # This tag requires that the tag GENERATE_LATEX is set to YES.
1772
1773 LATEX_EXTRA_STYLESHEET =
1774
1775 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1776 # other source files which should be copied to the LATEX_OUTPUT output
1777 # directory. Note that the files will be copied as-is; there are no commands or
1778 # markers available.
1779 # This tag requires that the tag GENERATE_LATEX is set to YES.
1780
1781 LATEX_EXTRA_FILES      =
1782
1783 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1784 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1785 # contain links (just like the HTML output) instead of page references. This
1786 # makes the output suitable for online browsing using a PDF viewer.
1787 # The default value is: YES.
1788 # This tag requires that the tag GENERATE_LATEX is set to YES.
1789
1790 PDF_HYPERLINKS         = NO
1791
1792 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1793 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1794 # higher quality PDF documentation.
1795 # The default value is: YES.
1796 # This tag requires that the tag GENERATE_LATEX is set to YES.
1797
1798 USE_PDFLATEX           = NO
1799
1800 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1801 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1802 # if errors occur, instead of asking the user for help. This option is also used
1803 # when generating formulas in HTML.
1804 # The default value is: NO.
1805 # This tag requires that the tag GENERATE_LATEX is set to YES.
1806
1807 LATEX_BATCHMODE        = NO
1808
1809 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1810 # index chapters (such as File Index, Compound Index, etc.) in the output.
1811 # The default value is: NO.
1812 # This tag requires that the tag GENERATE_LATEX is set to YES.
1813
1814 LATEX_HIDE_INDICES     = NO
1815
1816 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1817 # code with syntax highlighting in the LaTeX output.
1818 #
1819 # Note that which sources are shown also depends on other settings such as
1820 # SOURCE_BROWSER.
1821 # The default value is: NO.
1822 # This tag requires that the tag GENERATE_LATEX is set to YES.
1823
1824 LATEX_SOURCE_CODE      = NO
1825
1826 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1827 # bibliography, e.g. plainnat, or ieeetr. See
1828 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1829 # The default value is: plain.
1830 # This tag requires that the tag GENERATE_LATEX is set to YES.
1831
1832 LATEX_BIB_STYLE        = plain
1833
1834 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1835 # page will contain the date and time when the page was generated. Setting this
1836 # to NO can help when comparing the output of multiple runs.
1837 # The default value is: NO.
1838 # This tag requires that the tag GENERATE_LATEX is set to YES.
1839
1840 LATEX_TIMESTAMP        = NO
1841
1842 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1843 # path from which the emoji images will be read. If a relative path is entered,
1844 # it will be relative to the LATEX_OUTPUT directory. If left blank the
1845 # LATEX_OUTPUT directory will be used.
1846 # This tag requires that the tag GENERATE_LATEX is set to YES.
1847
1848 LATEX_EMOJI_DIRECTORY  =
1849
1850 #---------------------------------------------------------------------------
1851 # Configuration options related to the RTF output
1852 #---------------------------------------------------------------------------
1853
1854 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1855 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1856 # readers/editors.
1857 # The default value is: NO.
1858
1859 GENERATE_RTF           = NO
1860
1861 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1862 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1863 # it.
1864 # The default directory is: rtf.
1865 # This tag requires that the tag GENERATE_RTF is set to YES.
1866
1867 RTF_OUTPUT             = rtf
1868
1869 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1870 # documents. This may be useful for small projects and may help to save some
1871 # trees in general.
1872 # The default value is: NO.
1873 # This tag requires that the tag GENERATE_RTF is set to YES.
1874
1875 COMPACT_RTF            = NO
1876
1877 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1878 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1879 # output) instead of page references. This makes the output suitable for online
1880 # browsing using Word or some other Word compatible readers that support those
1881 # fields.
1882 #
1883 # Note: WordPad (write) and others do not support links.
1884 # The default value is: NO.
1885 # This tag requires that the tag GENERATE_RTF is set to YES.
1886
1887 RTF_HYPERLINKS         = NO
1888
1889 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1890 # configuration file, i.e. a series of assignments. You only have to provide
1891 # replacements, missing definitions are set to their default value.
1892 #
1893 # See also section "Doxygen usage" for information on how to generate the
1894 # default style sheet that doxygen normally uses.
1895 # This tag requires that the tag GENERATE_RTF is set to YES.
1896
1897 RTF_STYLESHEET_FILE    =
1898
1899 # Set optional variables used in the generation of an RTF document. Syntax is
1900 # similar to doxygen's configuration file. A template extensions file can be
1901 # generated using doxygen -e rtf extensionFile.
1902 # This tag requires that the tag GENERATE_RTF is set to YES.
1903
1904 RTF_EXTENSIONS_FILE    =
1905
1906 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1907 # with syntax highlighting in the RTF output.
1908 #
1909 # Note that which sources are shown also depends on other settings such as
1910 # SOURCE_BROWSER.
1911 # The default value is: NO.
1912 # This tag requires that the tag GENERATE_RTF is set to YES.
1913
1914 RTF_SOURCE_CODE        = NO
1915
1916 #---------------------------------------------------------------------------
1917 # Configuration options related to the man page output
1918 #---------------------------------------------------------------------------
1919
1920 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1921 # classes and files.
1922 # The default value is: NO.
1923
1924 GENERATE_MAN           = NO
1925
1926 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1927 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1928 # it. A directory man3 will be created inside the directory specified by
1929 # MAN_OUTPUT.
1930 # The default directory is: man.
1931 # This tag requires that the tag GENERATE_MAN is set to YES.
1932
1933 MAN_OUTPUT             = man
1934
1935 # The MAN_EXTENSION tag determines the extension that is added to the generated
1936 # man pages. In case the manual section does not start with a number, the number
1937 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1938 # optional.
1939 # The default value is: .3.
1940 # This tag requires that the tag GENERATE_MAN is set to YES.
1941
1942 MAN_EXTENSION          = .3
1943
1944 # The MAN_SUBDIR tag determines the name of the directory created within
1945 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1946 # MAN_EXTENSION with the initial . removed.
1947 # This tag requires that the tag GENERATE_MAN is set to YES.
1948
1949 MAN_SUBDIR             =
1950
1951 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1952 # will generate one additional man file for each entity documented in the real
1953 # man page(s). These additional files only source the real man page, but without
1954 # them the man command would be unable to find the correct page.
1955 # The default value is: NO.
1956 # This tag requires that the tag GENERATE_MAN is set to YES.
1957
1958 MAN_LINKS              = NO
1959
1960 #---------------------------------------------------------------------------
1961 # Configuration options related to the XML output
1962 #---------------------------------------------------------------------------
1963
1964 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1965 # captures the structure of the code including all documentation.
1966 # The default value is: NO.
1967
1968 GENERATE_XML           = NO
1969
1970 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1971 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1972 # it.
1973 # The default directory is: xml.
1974 # This tag requires that the tag GENERATE_XML is set to YES.
1975
1976 XML_OUTPUT             = xml
1977
1978 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1979 # listings (including syntax highlighting and cross-referencing information) to
1980 # the XML output. Note that enabling this will significantly increase the size
1981 # of the XML output.
1982 # The default value is: YES.
1983 # This tag requires that the tag GENERATE_XML is set to YES.
1984
1985 XML_PROGRAMLISTING     = YES
1986
1987 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
1988 # namespace members in file scope as well, matching the HTML output.
1989 # The default value is: NO.
1990 # This tag requires that the tag GENERATE_XML is set to YES.
1991
1992 XML_NS_MEMB_FILE_SCOPE = NO
1993
1994 #---------------------------------------------------------------------------
1995 # Configuration options related to the DOCBOOK output
1996 #---------------------------------------------------------------------------
1997
1998 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1999 # that can be used to generate PDF.
2000 # The default value is: NO.
2001
2002 GENERATE_DOCBOOK       = NO
2003
2004 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2005 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2006 # front of it.
2007 # The default directory is: docbook.
2008 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2009
2010 DOCBOOK_OUTPUT         = docbook
2011
2012 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2013 # program listings (including syntax highlighting and cross-referencing
2014 # information) to the DOCBOOK output. Note that enabling this will significantly
2015 # increase the size of the DOCBOOK output.
2016 # The default value is: NO.
2017 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2018
2019 DOCBOOK_PROGRAMLISTING = NO
2020
2021 #---------------------------------------------------------------------------
2022 # Configuration options for the AutoGen Definitions output
2023 #---------------------------------------------------------------------------
2024
2025 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2026 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2027 # the structure of the code including all documentation. Note that this feature
2028 # is still experimental and incomplete at the moment.
2029 # The default value is: NO.
2030
2031 GENERATE_AUTOGEN_DEF   = NO
2032
2033 #---------------------------------------------------------------------------
2034 # Configuration options related to the Perl module output
2035 #---------------------------------------------------------------------------
2036
2037 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2038 # file that captures the structure of the code including all documentation.
2039 #
2040 # Note that this feature is still experimental and incomplete at the moment.
2041 # The default value is: NO.
2042
2043 GENERATE_PERLMOD       = NO
2044
2045 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2046 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2047 # output from the Perl module output.
2048 # The default value is: NO.
2049 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2050
2051 PERLMOD_LATEX          = NO
2052
2053 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2054 # formatted so it can be parsed by a human reader. This is useful if you want to
2055 # understand what is going on. On the other hand, if this tag is set to NO, the
2056 # size of the Perl module output will be much smaller and Perl will parse it
2057 # just the same.
2058 # The default value is: YES.
2059 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2060
2061 PERLMOD_PRETTY         = YES
2062
2063 # The names of the make variables in the generated doxyrules.make file are
2064 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2065 # so different doxyrules.make files included by the same Makefile don't
2066 # overwrite each other's variables.
2067 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2068
2069 PERLMOD_MAKEVAR_PREFIX =
2070
2071 #---------------------------------------------------------------------------
2072 # Configuration options related to the preprocessor
2073 #---------------------------------------------------------------------------
2074
2075 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2076 # C-preprocessor directives found in the sources and include files.
2077 # The default value is: YES.
2078
2079 ENABLE_PREPROCESSING   = YES
2080
2081 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2082 # in the source code. If set to NO, only conditional compilation will be
2083 # performed. Macro expansion can be done in a controlled way by setting
2084 # EXPAND_ONLY_PREDEF to YES.
2085 # The default value is: NO.
2086 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2087
2088 MACRO_EXPANSION        = NO
2089
2090 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2091 # the macro expansion is limited to the macros specified with the PREDEFINED and
2092 # EXPAND_AS_DEFINED tags.
2093 # The default value is: NO.
2094 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2095
2096 EXPAND_ONLY_PREDEF     = NO
2097
2098 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2099 # INCLUDE_PATH will be searched if a #include is found.
2100 # The default value is: YES.
2101 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2102
2103 SEARCH_INCLUDES        = YES
2104
2105 # The INCLUDE_PATH tag can be used to specify one or more directories that
2106 # contain include files that are not input files but should be processed by the
2107 # preprocessor.
2108 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2109
2110 INCLUDE_PATH           = ../../source/blender/nodes \
2111                          ../../source/blender/editors/include
2112
2113 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2114 # patterns (like *.h and *.hpp) to filter out the header-files in the
2115 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2116 # used.
2117 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2118
2119 INCLUDE_FILE_PATTERNS  =
2120
2121 # The PREDEFINED tag can be used to specify one or more macro names that are
2122 # defined before the preprocessor is started (similar to the -D option of e.g.
2123 # gcc). The argument of the tag is a list of macros of the form: name or
2124 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2125 # is assumed. To prevent a macro definition from being undefined via #undef or
2126 # recursively expanded use the := operator instead of the = operator.
2127 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2128
2129 PREDEFINED             = BUILD_DATE
2130
2131 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2132 # tag can be used to specify a list of macro names that should be expanded. The
2133 # macro definition that is found in the sources will be used. Use the PREDEFINED
2134 # tag if you want to use a different macro definition that overrules the
2135 # definition found in the source code.
2136 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2137
2138 EXPAND_AS_DEFINED      =
2139
2140 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2141 # remove all references to function-like macros that are alone on a line, have
2142 # an all uppercase name, and do not end with a semicolon. Such function macros
2143 # are typically used for boiler-plate code, and will confuse the parser if not
2144 # removed.
2145 # The default value is: YES.
2146 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2147
2148 SKIP_FUNCTION_MACROS   = YES
2149
2150 #---------------------------------------------------------------------------
2151 # Configuration options related to external references
2152 #---------------------------------------------------------------------------
2153
2154 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2155 # file the location of the external documentation should be added. The format of
2156 # a tag file without this location is as follows:
2157 # TAGFILES = file1 file2 ...
2158 # Adding location for the tag files is done as follows:
2159 # TAGFILES = file1=loc1 "file2 = loc2" ...
2160 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2161 # section "Linking to external documentation" for more information about the use
2162 # of tag files.
2163 # Note: Each tag file must have a unique name (where the name does NOT include
2164 # the path). If a tag file is not located in the directory in which doxygen is
2165 # run, you must also specify the path to the tagfile here.
2166
2167 TAGFILES               =
2168
2169 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2170 # tag file that is based on the input files it reads. See section "Linking to
2171 # external documentation" for more information about the usage of tag files.
2172
2173 GENERATE_TAGFILE       =
2174
2175 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2176 # the class index. If set to NO, only the inherited external classes will be
2177 # listed.
2178 # The default value is: NO.
2179
2180 ALLEXTERNALS           = NO
2181
2182 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2183 # in the modules index. If set to NO, only the current project's groups will be
2184 # listed.
2185 # The default value is: YES.
2186
2187 EXTERNAL_GROUPS        = YES
2188
2189 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2190 # the related pages index. If set to NO, only the current project's pages will
2191 # be listed.
2192 # The default value is: YES.
2193
2194 EXTERNAL_PAGES         = YES
2195
2196 #---------------------------------------------------------------------------
2197 # Configuration options related to the dot tool
2198 #---------------------------------------------------------------------------
2199
2200 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2201 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2202 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2203 # disabled, but it is recommended to install and use dot, since it yields more
2204 # powerful graphs.
2205 # The default value is: YES.
2206
2207 CLASS_DIAGRAMS         = NO
2208
2209 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2210 # then run dia to produce the diagram and insert it in the documentation. The
2211 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2212 # If left empty dia is assumed to be found in the default search path.
2213
2214 DIA_PATH               =
2215
2216 # If set to YES the inheritance and collaboration graphs will hide inheritance
2217 # and usage relations if the target is undocumented or is not a class.
2218 # The default value is: YES.
2219
2220 HIDE_UNDOC_RELATIONS   = YES
2221
2222 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2223 # available from the path. This tool is part of Graphviz (see:
2224 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2225 # Bell Labs. The other options in this section have no effect if this option is
2226 # set to NO
2227 # The default value is: NO.
2228
2229 HAVE_DOT               = NO
2230
2231 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2232 # to run in parallel. When set to 0 doxygen will base this on the number of
2233 # processors available in the system. You can set it explicitly to a value
2234 # larger than 0 to get control over the balance between CPU load and processing
2235 # speed.
2236 # Minimum value: 0, maximum value: 32, default value: 0.
2237 # This tag requires that the tag HAVE_DOT is set to YES.
2238
2239 DOT_NUM_THREADS        = 0
2240
2241 # When you want a differently looking font in the dot files that doxygen
2242 # generates you can specify the font name using DOT_FONTNAME. You need to make
2243 # sure dot is able to find the font, which can be done by putting it in a
2244 # standard location or by setting the DOTFONTPATH environment variable or by
2245 # setting DOT_FONTPATH to the directory containing the font.
2246 # The default value is: Helvetica.
2247 # This tag requires that the tag HAVE_DOT is set to YES.
2248
2249 DOT_FONTNAME           = Helvetica
2250
2251 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2252 # dot graphs.
2253 # Minimum value: 4, maximum value: 24, default value: 10.
2254 # This tag requires that the tag HAVE_DOT is set to YES.
2255
2256 DOT_FONTSIZE           = 10
2257
2258 # By default doxygen will tell dot to use the default font as specified with
2259 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2260 # the path where dot can find it using this tag.
2261 # This tag requires that the tag HAVE_DOT is set to YES.
2262
2263 DOT_FONTPATH           =
2264
2265 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2266 # each documented class showing the direct and indirect inheritance relations.
2267 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2268 # The default value is: YES.
2269 # This tag requires that the tag HAVE_DOT is set to YES.
2270
2271 CLASS_GRAPH            = YES
2272
2273 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2274 # graph for each documented class showing the direct and indirect implementation
2275 # dependencies (inheritance, containment, and class references variables) of the
2276 # class with other documented classes.
2277 # The default value is: YES.
2278 # This tag requires that the tag HAVE_DOT is set to YES.
2279
2280 COLLABORATION_GRAPH    = NO
2281
2282 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2283 # groups, showing the direct groups dependencies.
2284 # The default value is: YES.
2285 # This tag requires that the tag HAVE_DOT is set to YES.
2286
2287 GROUP_GRAPHS           = YES
2288
2289 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2290 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2291 # Language.
2292 # The default value is: NO.
2293 # This tag requires that the tag HAVE_DOT is set to YES.
2294
2295 UML_LOOK               = YES
2296
2297 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2298 # class node. If there are many fields or methods and many nodes the graph may
2299 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2300 # number of items for each type to make the size more manageable. Set this to 0
2301 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2302 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2303 # but if the number exceeds 15, the total amount of fields shown is limited to
2304 # 10.
2305 # Minimum value: 0, maximum value: 100, default value: 10.
2306 # This tag requires that the tag HAVE_DOT is set to YES.
2307
2308 UML_LIMIT_NUM_FIELDS   = 10
2309
2310 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2311 # collaboration graphs will show the relations between templates and their
2312 # instances.
2313 # The default value is: NO.
2314 # This tag requires that the tag HAVE_DOT is set to YES.
2315
2316 TEMPLATE_RELATIONS     = YES
2317
2318 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2319 # YES then doxygen will generate a graph for each documented file showing the
2320 # direct and indirect include dependencies of the file with other documented
2321 # files.
2322 # The default value is: YES.
2323 # This tag requires that the tag HAVE_DOT is set to YES.
2324
2325 INCLUDE_GRAPH          = NO
2326
2327 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2328 # set to YES then doxygen will generate a graph for each documented file showing
2329 # the direct and indirect include dependencies of the file with other documented
2330 # files.
2331 # The default value is: YES.
2332 # This tag requires that the tag HAVE_DOT is set to YES.
2333
2334 INCLUDED_BY_GRAPH      = NO
2335
2336 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2337 # dependency graph for every global function or class method.
2338 #
2339 # Note that enabling this option will significantly increase the time of a run.
2340 # So in most cases it will be better to enable call graphs for selected
2341 # functions only using the \callgraph command. Disabling a call graph can be
2342 # accomplished by means of the command \hidecallgraph.
2343 # The default value is: NO.
2344 # This tag requires that the tag HAVE_DOT is set to YES.
2345
2346 CALL_GRAPH             = NO
2347
2348 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2349 # dependency graph for every global function or class method.
2350 #
2351 # Note that enabling this option will significantly increase the time of a run.
2352 # So in most cases it will be better to enable caller graphs for selected
2353 # functions only using the \callergraph command. Disabling a caller graph can be
2354 # accomplished by means of the command \hidecallergraph.
2355 # The default value is: NO.
2356 # This tag requires that the tag HAVE_DOT is set to YES.
2357
2358 CALLER_GRAPH           = NO
2359
2360 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2361 # hierarchy of all classes instead of a textual one.
2362 # The default value is: YES.
2363 # This tag requires that the tag HAVE_DOT is set to YES.
2364
2365 GRAPHICAL_HIERARCHY    = YES
2366
2367 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2368 # dependencies a directory has on other directories in a graphical way. The
2369 # dependency relations are determined by the #include relations between the
2370 # files in the directories.
2371 # The default value is: YES.
2372 # This tag requires that the tag HAVE_DOT is set to YES.
2373
2374 DIRECTORY_GRAPH        = YES
2375
2376 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2377 # generated by dot. For an explanation of the image formats see the section
2378 # output formats in the documentation of the dot tool (Graphviz (see:
2379 # http://www.graphviz.org/)).
2380 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2381 # to make the SVG files visible in IE 9+ (other browsers do not have this
2382 # requirement).
2383 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2384 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2385 # png:gdiplus:gdiplus.
2386 # The default value is: png.
2387 # This tag requires that the tag HAVE_DOT is set to YES.
2388
2389 DOT_IMAGE_FORMAT       = png
2390
2391 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2392 # enable generation of interactive SVG images that allow zooming and panning.
2393 #
2394 # Note that this requires a modern browser other than Internet Explorer. Tested
2395 # and working are Firefox, Chrome, Safari, and Opera.
2396 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2397 # the SVG files visible. Older versions of IE do not have SVG support.
2398 # The default value is: NO.
2399 # This tag requires that the tag HAVE_DOT is set to YES.
2400
2401 INTERACTIVE_SVG        = NO
2402
2403 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2404 # found. If left blank, it is assumed the dot tool can be found in the path.
2405 # This tag requires that the tag HAVE_DOT is set to YES.
2406
2407 DOT_PATH               =
2408
2409 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2410 # contain dot files that are included in the documentation (see the \dotfile
2411 # command).
2412 # This tag requires that the tag HAVE_DOT is set to YES.
2413
2414 DOTFILE_DIRS           =
2415
2416 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2417 # contain msc files that are included in the documentation (see the \mscfile
2418 # command).
2419
2420 MSCFILE_DIRS           =
2421
2422 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2423 # contain dia files that are included in the documentation (see the \diafile
2424 # command).
2425
2426 DIAFILE_DIRS           =
2427
2428 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2429 # path where java can find the plantuml.jar file. If left blank, it is assumed
2430 # PlantUML is not used or called during a preprocessing step. Doxygen will
2431 # generate a warning when it encounters a \startuml command in this case and
2432 # will not generate output for the diagram.
2433
2434 PLANTUML_JAR_PATH      =
2435
2436 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2437 # configuration file for plantuml.
2438
2439 PLANTUML_CFG_FILE      =
2440
2441 # When using plantuml, the specified paths are searched for files specified by
2442 # the !include statement in a plantuml block.
2443
2444 PLANTUML_INCLUDE_PATH  =
2445
2446 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2447 # that will be shown in the graph. If the number of nodes in a graph becomes
2448 # larger than this value, doxygen will truncate the graph, which is visualized
2449 # by representing a node as a red box. Note that doxygen if the number of direct
2450 # children of the root node in a graph is already larger than
2451 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2452 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2453 # Minimum value: 0, maximum value: 10000, default value: 50.
2454 # This tag requires that the tag HAVE_DOT is set to YES.
2455
2456 DOT_GRAPH_MAX_NODES    = 50
2457
2458 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2459 # generated by dot. A depth value of 3 means that only nodes reachable from the
2460 # root by following a path via at most 3 edges will be shown. Nodes that lay
2461 # further from the root node will be omitted. Note that setting this option to 1
2462 # or 2 may greatly reduce the computation time needed for large code bases. Also
2463 # note that the size of a graph can be further restricted by
2464 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2465 # Minimum value: 0, maximum value: 1000, default value: 0.
2466 # This tag requires that the tag HAVE_DOT is set to YES.
2467
2468 MAX_DOT_GRAPH_DEPTH    = 0
2469
2470 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2471 # background. This is disabled by default, because dot on Windows does not seem
2472 # to support this out of the box.
2473 #
2474 # Warning: Depending on the platform used, enabling this option may lead to
2475 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2476 # read).
2477 # The default value is: NO.
2478 # This tag requires that the tag HAVE_DOT is set to YES.
2479
2480 DOT_TRANSPARENT        = NO
2481
2482 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2483 # files in one run (i.e. multiple -o and -T options on the command line). This
2484 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2485 # this, this feature is disabled by default.
2486 # The default value is: NO.
2487 # This tag requires that the tag HAVE_DOT is set to YES.
2488
2489 DOT_MULTI_TARGETS      = YES
2490
2491 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2492 # explaining the meaning of the various boxes and arrows in the dot generated
2493 # graphs.
2494 # The default value is: YES.
2495 # This tag requires that the tag HAVE_DOT is set to YES.
2496
2497 GENERATE_LEGEND        = YES
2498
2499 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2500 # files that are used to generate the various graphs.
2501 # The default value is: YES.
2502 # This tag requires that the tag HAVE_DOT is set to YES.
2503
2504 DOT_CLEANUP            = YES