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