Update MAT-THD submodule
[processor-sdk/performance-audio-sr.git] / psdk_cust / libarch_k2g_1_0_1_0 / docs / doxygen / doxycfg.txt
1 # Doxyfile 1.8.9.1
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 (\" \").
16 #---------------------------------------------------------------------------
17 # Project related configuration options
18 #---------------------------------------------------------------------------
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.
27 DOXYFILE_ENCODING      = UTF-8
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.
35 PROJECT_NAME           = "LibArch "
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.
41 PROJECT_NUMBER         =
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.
47 PROJECT_BRIEF          = "Library architecture and framework"
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50 # in the documentation. The maximum height of the logo should not exceed 55
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52 # the logo to the output directory.
54 PROJECT_LOGO           =
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.
61 OUTPUT_DIRECTORY       = ./docs/doxygen
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.
71 CREATE_SUBDIRS         = YES
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 # characters to appear in the names of generated files. If set to NO, non-ASCII
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76 # U+3044.
77 # The default value is: NO.
79 ALLOW_UNICODE_NAMES    = NO
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82 # documentation generated by doxygen is written. Doxygen will use this
83 # information to generate all constant output in the proper language.
84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91 # Ukrainian and Vietnamese.
92 # The default value is: English.
94 OUTPUT_LANGUAGE        = English
96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97 # descriptions after the members that are listed in the file and class
98 # documentation (similar to Javadoc). Set to NO to disable this.
99 # The default value is: YES.
101 BRIEF_MEMBER_DESC      = YES
103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104 # description of a member or function before the detailed description
106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107 # brief descriptions will be completely suppressed.
108 # The default value is: YES.
110 REPEAT_BRIEF           = YES
112 # This tag implements a quasi-intelligent brief description abbreviator that is
113 # used to form the text in various listings. Each string in this list, if found
114 # as the leading text of the brief description, will be stripped from the text
115 # and the result, after processing the whole list, is used as the annotated
116 # text. Otherwise, the brief description is used as-is. If left blank, the
117 # following values are used ($name is automatically replaced with the name of
118 # the entity):The $name class, The $name widget, The $name file, is, provides,
119 # specifies, contains, represents, a, an and the.
121 ABBREVIATE_BRIEF       =
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.
128 ALWAYS_DETAILED_SEC    = NO
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.
136 INLINE_INHERITED_MEMB  = NO
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.
143 FULL_PATH_NAMES        = YES
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.
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.
155 STRIP_FROM_PATH        =
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.
164 STRIP_FROM_INC_PATH    =
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.
171 SHORT_NAMES            = NO
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.
180 JAVADOC_AUTOBRIEF      = NO
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.
188 QT_AUTOBRIEF           = NO
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.
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.
200 MULTILINE_CPP_IS_BRIEF = NO
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.
206 INHERIT_DOCS           = YES
208 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209 # page for each member. If set to NO, the documentation of a member will be part
210 # of the file/class/namespace that contains it.
211 # The default value is: NO.
213 SEPARATE_MEMBER_PAGES  = NO
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.
219 TAB_SIZE               = 8
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.
231 ALIASES                =
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.
237 TCL_SUBST              =
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.
245 OPTIMIZE_OUTPUT_FOR_C  = YES
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.
253 OPTIMIZE_OUTPUT_JAVA   = NO
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.
259 OPTIMIZE_FOR_FORTRAN   = NO
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.
265 OPTIMIZE_OUTPUT_VHDL   = NO
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 (fixed format Fortran:
273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274 # Fortran. In the later case the parser tries to guess whether the code is fixed
275 # or free formatted code, this is the default for Fortran type files), VHDL. For
276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
279 # Note: For files without extension you can use no_extension as a placeholder.
281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282 # the files are not read by doxygen.
284 EXTENSION_MAPPING      =
286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287 # according to the Markdown format, which allows for more readable
288 # documentation. See http://daringfireball.net/projects/markdown/ for details.
289 # The output of markdown processing is further processed by doxygen, so you can
290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291 # case of backward compatibilities issues.
292 # The default value is: YES.
294 MARKDOWN_SUPPORT       = YES
296 # When enabled doxygen tries to link words that correspond to documented
297 # classes, or namespaces to their corresponding documentation. Such a link can
298 # be prevented in individual cases by putting a % sign in front of the word or
299 # globally by setting AUTOLINK_SUPPORT to NO.
300 # The default value is: YES.
302 AUTOLINK_SUPPORT       = YES
304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305 # to include (a tag file for) the STL sources as input, then you should set this
306 # tag to YES in order to let doxygen match functions declarations and
307 # definitions whose arguments contain STL classes (e.g. func(std::string);
308 # versus func(std::string) {}). This also make the inheritance and collaboration
309 # diagrams that involve STL classes more complete and accurate.
310 # The default value is: NO.
312 BUILTIN_STL_SUPPORT    = NO
314 # If you use Microsoft's C++/CLI language, you should set this option to YES to
315 # enable parsing support.
316 # The default value is: NO.
318 CPP_CLI_SUPPORT        = NO
320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322 # will parse them like normal C++ but will assume all classes use public instead
323 # of private inheritance when no explicit protection keyword is present.
324 # The default value is: NO.
326 SIP_SUPPORT            = NO
328 # For Microsoft's IDL there are propget and propput attributes to indicate
329 # getter and setter methods for a property. Setting this option to YES will make
330 # doxygen to replace the get and set methods by a property in the documentation.
331 # This will only work if the methods are indeed getting or setting a simple
332 # type. If this is not the case, or you want to show the methods anyway, you
333 # should set this option to NO.
334 # The default value is: YES.
336 IDL_PROPERTY_SUPPORT   = YES
338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339 # tag is set to YES then doxygen will reuse the documentation of the first
340 # member in the group (if any) for the other members of the group. By default
341 # all members of a group must be documented explicitly.
342 # The default value is: NO.
344 DISTRIBUTE_GROUP_DOC   = NO
346 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
347 # (for instance a group of public functions) to be put as a subgroup of that
348 # type (e.g. under the Public Functions section). Set it to NO to prevent
349 # subgrouping. Alternatively, this can be done per class using the
350 # \nosubgrouping command.
351 # The default value is: YES.
353 SUBGROUPING            = YES
355 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
356 # are shown inside the group in which they are included (e.g. using \ingroup)
357 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
358 # and RTF).
360 # Note that this feature does not work in combination with
361 # SEPARATE_MEMBER_PAGES.
362 # The default value is: NO.
364 INLINE_GROUPED_CLASSES = NO
366 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
367 # with only public data fields or simple typedef fields will be shown inline in
368 # the documentation of the scope in which they are defined (i.e. file,
369 # namespace, or group documentation), provided this scope is documented. If set
370 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
371 # Man pages) or section (for LaTeX and RTF).
372 # The default value is: NO.
374 INLINE_SIMPLE_STRUCTS  = NO
376 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
377 # enum is documented as struct, union, or enum with the name of the typedef. So
378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379 # with name TypeT. When disabled the typedef will appear as a member of a file,
380 # namespace, or class. And the struct will be named TypeS. This can typically be
381 # useful for C code in case the coding convention dictates that all compound
382 # types are typedef'ed and only the typedef is referenced, never the tag name.
383 # The default value is: NO.
385 TYPEDEF_HIDES_STRUCT   = NO
387 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
388 # cache is used to resolve symbols given their name and scope. Since this can be
389 # an expensive process and often the same symbol appears multiple times in the
390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
391 # doxygen will become slower. If the cache is too large, memory is wasted. The
392 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394 # symbols. At the end of a run doxygen will report the cache usage and suggest
395 # the optimal cache size from a speed point of view.
396 # Minimum value: 0, maximum value: 9, default value: 0.
398 LOOKUP_CACHE_SIZE      = 0
400 #---------------------------------------------------------------------------
401 # Build related configuration options
402 #---------------------------------------------------------------------------
404 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
405 # documentation are documented, even if no documentation was available. Private
406 # class members and static file members will be hidden unless the
407 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
408 # Note: This will also disable the warnings about undocumented members that are
409 # normally produced when WARNINGS is set to YES.
410 # The default value is: NO.
412 EXTRACT_ALL            = YES
414 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
415 # be included in the documentation.
416 # The default value is: NO.
418 EXTRACT_PRIVATE        = NO
420 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
421 # scope will be included in the documentation.
422 # The default value is: NO.
424 EXTRACT_PACKAGE        = NO
426 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
427 # included in the documentation.
428 # The default value is: NO.
430 EXTRACT_STATIC         = YES
432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
433 # locally in source files will be included in the documentation. If set to NO,
434 # only classes defined in header files are included. Does not have any effect
435 # for Java sources.
436 # The default value is: YES.
438 EXTRACT_LOCAL_CLASSES  = YES
440 # This flag is only useful for Objective-C code. If set to YES, local methods,
441 # which are defined in the implementation section but not in the interface are
442 # included in the documentation. If set to NO, only methods in the interface are
443 # included.
444 # The default value is: NO.
446 EXTRACT_LOCAL_METHODS  = NO
448 # If this flag is set to YES, the members of anonymous namespaces will be
449 # extracted and appear in the documentation as a namespace called
450 # 'anonymous_namespace{file}', where file will be replaced with the base name of
451 # the file that contains the anonymous namespace. By default anonymous namespace
452 # are hidden.
453 # The default value is: NO.
455 EXTRACT_ANON_NSPACES   = NO
457 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
458 # undocumented members inside documented classes or files. If set to NO these
459 # members will be included in the various overviews, but no documentation
460 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
461 # The default value is: NO.
463 HIDE_UNDOC_MEMBERS     = NO
465 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
466 # undocumented classes that are normally visible in the class hierarchy. If set
467 # to NO, these classes will be included in the various overviews. This option
468 # has no effect if EXTRACT_ALL is enabled.
469 # The default value is: NO.
471 HIDE_UNDOC_CLASSES     = NO
473 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
474 # (class|struct|union) declarations. If set to NO, these declarations will be
475 # included in the documentation.
476 # The default value is: NO.
478 HIDE_FRIEND_COMPOUNDS  = NO
480 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
481 # documentation blocks found inside the body of a function. If set to NO, these
482 # blocks will be appended to the function's detailed documentation block.
483 # The default value is: NO.
485 HIDE_IN_BODY_DOCS      = NO
487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
488 # \internal command is included. If the tag is set to NO then the documentation
489 # will be excluded. Set it to YES to include the internal documentation.
490 # The default value is: NO.
492 INTERNAL_DOCS          = NO
494 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
495 # names in lower-case letters. If set to YES, upper-case letters are also
496 # allowed. This is useful if you have classes or files whose names only differ
497 # in case and if your file system supports case sensitive file names. Windows
498 # and Mac users are advised to set this option to NO.
499 # The default value is: system dependent.
501 CASE_SENSE_NAMES       = YES
503 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
504 # their full class and namespace scopes in the documentation. If set to YES, the
505 # scope will be hidden.
506 # The default value is: NO.
508 HIDE_SCOPE_NAMES       = NO
510 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
511 # append additional text to a page's title, such as Class Reference. If set to
512 # YES the compound reference will be hidden.
513 # The default value is: NO.
515 HIDE_COMPOUND_REFERENCE= NO
517 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
518 # the files that are included by a file in the documentation of that file.
519 # The default value is: YES.
521 SHOW_INCLUDE_FILES     = YES
523 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
524 # grouped member an include statement to the documentation, telling the reader
525 # which file to include in order to use the member.
526 # The default value is: NO.
528 SHOW_GROUPED_MEMB_INC  = NO
530 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
531 # files with double quotes in the documentation rather than with sharp brackets.
532 # The default value is: NO.
534 FORCE_LOCAL_INCLUDES   = NO
536 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
537 # documentation for inline members.
538 # The default value is: YES.
540 INLINE_INFO            = YES
542 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
543 # (detailed) documentation of file and class members alphabetically by member
544 # name. If set to NO, the members will appear in declaration order.
545 # The default value is: YES.
547 SORT_MEMBER_DOCS       = YES
549 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
550 # descriptions of file, namespace and class members alphabetically by member
551 # name. If set to NO, the members will appear in declaration order. Note that
552 # this will also influence the order of the classes in the class list.
553 # The default value is: NO.
555 SORT_BRIEF_DOCS        = NO
557 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
558 # (brief and detailed) documentation of class members so that constructors and
559 # destructors are listed first. If set to NO the constructors will appear in the
560 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
561 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
562 # member documentation.
563 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
564 # detailed member documentation.
565 # The default value is: NO.
567 SORT_MEMBERS_CTORS_1ST = NO
569 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
570 # of group names into alphabetical order. If set to NO the group names will
571 # appear in their defined order.
572 # The default value is: NO.
574 SORT_GROUP_NAMES       = NO
576 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
577 # fully-qualified names, including namespaces. If set to NO, the class list will
578 # be sorted only by class name, not including the namespace part.
579 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
580 # Note: This option applies only to the class list, not to the alphabetical
581 # list.
582 # The default value is: NO.
584 SORT_BY_SCOPE_NAME     = NO
586 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
587 # type resolution of all parameters of a function it will reject a match between
588 # the prototype and the implementation of a member function even if there is
589 # only one candidate or it is obvious which candidate to choose by doing a
590 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
591 # accept a match between prototype and implementation in such cases.
592 # The default value is: NO.
594 STRICT_PROTO_MATCHING  = NO
596 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
597 # list. This list is created by putting \todo commands in the documentation.
598 # The default value is: YES.
600 GENERATE_TODOLIST      = YES
602 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
603 # list. This list is created by putting \test commands in the documentation.
604 # The default value is: YES.
606 GENERATE_TESTLIST      = YES
608 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
609 # list. This list is created by putting \bug commands in the documentation.
610 # The default value is: YES.
612 GENERATE_BUGLIST       = YES
614 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
615 # the deprecated list. This list is created by putting \deprecated commands in
616 # the documentation.
617 # The default value is: YES.
619 GENERATE_DEPRECATEDLIST= YES
621 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
622 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
623 # ... \endcond blocks.
625 ENABLED_SECTIONS       =
627 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
628 # initial value of a variable or macro / define can have for it to appear in the
629 # documentation. If the initializer consists of more lines than specified here
630 # it will be hidden. Use a value of 0 to hide initializers completely. The
631 # appearance of the value of individual variables and macros / defines can be
632 # controlled using \showinitializer or \hideinitializer command in the
633 # documentation regardless of this setting.
634 # Minimum value: 0, maximum value: 10000, default value: 30.
636 MAX_INITIALIZER_LINES  = 30
638 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
639 # the bottom of the documentation of classes and structs. If set to YES, the
640 # list will mention the files that were used to generate the documentation.
641 # The default value is: YES.
643 SHOW_USED_FILES        = YES
645 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
646 # will remove the Files entry from the Quick Index and from the Folder Tree View
647 # (if specified).
648 # The default value is: YES.
650 SHOW_FILES             = YES
652 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
653 # page. This will remove the Namespaces entry from the Quick Index and from the
654 # Folder Tree View (if specified).
655 # The default value is: YES.
657 SHOW_NAMESPACES        = YES
659 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
660 # doxygen should invoke to get the current version for each file (typically from
661 # the version control system). Doxygen will invoke the program by executing (via
662 # popen()) the command command input-file, where command is the value of the
663 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
664 # by doxygen. Whatever the program writes to standard output is used as the file
665 # version. For an example see the documentation.
667 FILE_VERSION_FILTER    =
669 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
670 # by doxygen. The layout file controls the global structure of the generated
671 # output files in an output format independent way. To create the layout file
672 # that represents doxygen's defaults, run doxygen with the -l option. You can
673 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
674 # will be used as the name of the layout file.
676 # Note that if you run doxygen from a directory containing a file called
677 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
678 # tag is left empty.
680 LAYOUT_FILE            =
682 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
683 # the reference definitions. This must be a list of .bib files. The .bib
684 # extension is automatically appended if omitted. This requires the bibtex tool
685 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
686 # For LaTeX the style of the bibliography can be controlled using
687 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
688 # search path. See also \cite for info how to create references.
690 CITE_BIB_FILES         =
692 #---------------------------------------------------------------------------
693 # Configuration options related to warning and progress messages
694 #---------------------------------------------------------------------------
696 # The QUIET tag can be used to turn on/off the messages that are generated to
697 # standard output by doxygen. If QUIET is set to YES this implies that the
698 # messages are off.
699 # The default value is: NO.
701 QUIET                  = NO
703 # The WARNINGS tag can be used to turn on/off the warning messages that are
704 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
705 # this implies that the warnings are on.
707 # Tip: Turn warnings on while writing the documentation.
708 # The default value is: YES.
710 WARNINGS               = YES
712 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
713 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
714 # will automatically be disabled.
715 # The default value is: YES.
717 WARN_IF_UNDOCUMENTED   = YES
719 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
720 # potential errors in the documentation, such as not documenting some parameters
721 # in a documented function, or documenting parameters that don't exist or using
722 # markup commands wrongly.
723 # The default value is: YES.
725 WARN_IF_DOC_ERROR      = YES
727 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
728 # are documented, but have no documentation for their parameters or return
729 # value. If set to NO, doxygen will only warn about wrong or incomplete
730 # parameter documentation, but not about the absence of documentation.
731 # The default value is: NO.
733 WARN_NO_PARAMDOC       = NO
735 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
736 # can produce. The string should contain the $file, $line, and $text tags, which
737 # will be replaced by the file and line number from which the warning originated
738 # and the warning text. Optionally the format may contain $version, which will
739 # be replaced by the version of the file (if it could be obtained via
740 # FILE_VERSION_FILTER)
741 # The default value is: $file:$line: $text.
743 WARN_FORMAT            = "$file:$line: $text"
745 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
746 # messages should be written. If left blank the output is written to standard
747 # error (stderr).
749 WARN_LOGFILE           =
751 #---------------------------------------------------------------------------
752 # Configuration options related to the input files
753 #---------------------------------------------------------------------------
755 # The INPUT tag is used to specify the files and/or directories that contain
756 # documented source files. You may enter file names like myfile.cpp or
757 # directories like /usr/src/myproject. Separate the files or directories with
758 # spaces.
759 # Note: If this tag is empty the current directory is searched.
761 INPUT                  = ./src \
762                          ./docs/doxygen
764 # This tag can be used to specify the character encoding of the source files
765 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
766 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
767 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
768 # possible encodings.
769 # The default value is: UTF-8.
771 INPUT_ENCODING         = UTF-8
773 # If the value of the INPUT tag contains directories, you can use the
774 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
775 # *.h) to filter out the source-files in the directories. If left blank the
776 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
777 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
778 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
779 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
780 # *.qsf, *.as and *.js.
782 FILE_PATTERNS          = *.c \
783                          *.h \
784                          *.dox
786 # The RECURSIVE tag can be used to specify whether or not subdirectories should
787 # be searched for input files as well.
788 # The default value is: NO.
790 RECURSIVE              = NO
792 # The EXCLUDE tag can be used to specify files and/or directories that should be
793 # excluded from the INPUT source files. This way you can easily exclude a
794 # subdirectory from a directory tree whose root is specified with the INPUT tag.
796 # Note that relative paths are relative to the directory from which doxygen is
797 # run.
799 EXCLUDE                =
801 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
802 # directories that are symbolic links (a Unix file system feature) are excluded
803 # from the input.
804 # The default value is: NO.
806 EXCLUDE_SYMLINKS       = NO
808 # If the value of the INPUT tag contains directories, you can use the
809 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
810 # certain files from those directories.
812 # Note that the wildcards are matched against the file with absolute path, so to
813 # exclude all test directories for example use the pattern */test/*
815 EXCLUDE_PATTERNS       =
817 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
818 # (namespaces, classes, functions, etc.) that should be excluded from the
819 # output. The symbol name can be a fully qualified name, a word, or if the
820 # wildcard * is used, a substring. Examples: ANamespace, AClass,
821 # AClass::ANamespace, ANamespace::*Test
823 # Note that the wildcards are matched against the file with absolute path, so to
824 # exclude all test directories use the pattern */test/*
826 EXCLUDE_SYMBOLS        =
828 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
829 # that contain example code fragments that are included (see the \include
830 # command).
832 EXAMPLE_PATH           =
834 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
835 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
836 # *.h) to filter out the source-files in the directories. If left blank all
837 # files are included.
839 EXAMPLE_PATTERNS       =
841 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
842 # searched for input files to be used with the \include or \dontinclude commands
843 # irrespective of the value of the RECURSIVE tag.
844 # The default value is: NO.
846 EXAMPLE_RECURSIVE      = NO
848 # The IMAGE_PATH tag can be used to specify one or more files or directories
849 # that contain images that are to be included in the documentation (see the
850 # \image command).
852 IMAGE_PATH             = ./docs/doxygen/images
854 # The INPUT_FILTER tag can be used to specify a program that doxygen should
855 # invoke to filter for each input file. Doxygen will invoke the filter program
856 # by executing (via popen()) the command:
858 # <filter> <input-file>
860 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
861 # name of an input file. Doxygen will then use the output that the filter
862 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
863 # will be ignored.
865 # Note that the filter must not add or remove lines; it is applied before the
866 # code is scanned, but not when the output code is generated. If lines are added
867 # or removed, the anchors will not be placed correctly.
869 INPUT_FILTER           =
871 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
872 # basis. Doxygen will compare the file name with each pattern and apply the
873 # filter if there is a match. The filters are a list of the form: pattern=filter
874 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
875 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
876 # patterns match the file name, INPUT_FILTER is applied.
878 FILTER_PATTERNS        =
880 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
881 # INPUT_FILTER) will also be used to filter the input files that are used for
882 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
883 # The default value is: NO.
885 FILTER_SOURCE_FILES    = NO
887 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
888 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
889 # it is also possible to disable source filtering for a specific pattern using
890 # *.ext= (so without naming a filter).
891 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
893 FILTER_SOURCE_PATTERNS =
895 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
896 # is part of the input, its contents will be placed on the main page
897 # (index.html). This can be useful if you have a project on for instance GitHub
898 # and want to reuse the introduction page also for the doxygen output.
900 USE_MDFILE_AS_MAINPAGE =
902 #---------------------------------------------------------------------------
903 # Configuration options related to source browsing
904 #---------------------------------------------------------------------------
906 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
907 # generated. Documented entities will be cross-referenced with these sources.
909 # Note: To get rid of all source code in the generated output, make sure that
910 # also VERBATIM_HEADERS is set to NO.
911 # The default value is: NO.
913 SOURCE_BROWSER         = NO
915 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
916 # classes and enums directly into the documentation.
917 # The default value is: NO.
919 INLINE_SOURCES         = NO
921 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
922 # special comment blocks from generated source code fragments. Normal C, C++ and
923 # Fortran comments will always remain visible.
924 # The default value is: YES.
926 STRIP_CODE_COMMENTS    = YES
928 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
929 # function all documented functions referencing it will be listed.
930 # The default value is: NO.
932 REFERENCED_BY_RELATION = NO
934 # If the REFERENCES_RELATION tag is set to YES then for each documented function
935 # all documented entities called/used by that function will be listed.
936 # The default value is: NO.
938 REFERENCES_RELATION    = NO
940 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
941 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
942 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
943 # link to the documentation.
944 # The default value is: YES.
946 REFERENCES_LINK_SOURCE = YES
948 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
949 # source code will show a tooltip with additional information such as prototype,
950 # brief description and links to the definition and documentation. Since this
951 # will make the HTML file larger and loading of large files a bit slower, you
952 # can opt to disable this feature.
953 # The default value is: YES.
954 # This tag requires that the tag SOURCE_BROWSER is set to YES.
956 SOURCE_TOOLTIPS        = YES
958 # If the USE_HTAGS tag is set to YES then the references to source code will
959 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
960 # source browser. The htags tool is part of GNU's global source tagging system
961 # (see http://www.gnu.org/software/global/global.html). You will need version
962 # 4.8.6 or higher.
964 # To use it do the following:
965 # - Install the latest version of global
966 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
967 # - Make sure the INPUT points to the root of the source tree
968 # - Run doxygen as normal
970 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
971 # tools must be available from the command line (i.e. in the search path).
973 # The result: instead of the source browser generated by doxygen, the links to
974 # source code will now point to the output of htags.
975 # The default value is: NO.
976 # This tag requires that the tag SOURCE_BROWSER is set to YES.
978 USE_HTAGS              = NO
980 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
981 # verbatim copy of the header file for each class for which an include is
982 # specified. Set to NO to disable this.
983 # See also: Section \class.
984 # The default value is: YES.
986 VERBATIM_HEADERS       = YES
988 #---------------------------------------------------------------------------
989 # Configuration options related to the alphabetical class index
990 #---------------------------------------------------------------------------
992 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
993 # compounds will be generated. Enable this if the project contains a lot of
994 # classes, structs, unions or interfaces.
995 # The default value is: YES.
997 ALPHABETICAL_INDEX     = YES
999 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1000 # which the alphabetical index list will be split.
1001 # Minimum value: 1, maximum value: 20, default value: 5.
1002 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1004 COLS_IN_ALPHA_INDEX    = 5
1006 # In case all classes in a project start with a common prefix, all classes will
1007 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1008 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1009 # while generating the index headers.
1010 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1012 IGNORE_PREFIX          =
1014 #---------------------------------------------------------------------------
1015 # Configuration options related to the HTML output
1016 #---------------------------------------------------------------------------
1018 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1019 # The default value is: YES.
1021 GENERATE_HTML          = YES
1023 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1024 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1025 # it.
1026 # The default directory is: html.
1027 # This tag requires that the tag GENERATE_HTML is set to YES.
1029 HTML_OUTPUT            = html
1031 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1032 # generated HTML page (for example: .htm, .php, .asp).
1033 # The default value is: .html.
1034 # This tag requires that the tag GENERATE_HTML is set to YES.
1036 HTML_FILE_EXTENSION    = .html
1038 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1039 # each generated HTML page. If the tag is left blank doxygen will generate a
1040 # standard header.
1042 # To get valid HTML the header file that includes any scripts and style sheets
1043 # that doxygen needs, which is dependent on the configuration options used (e.g.
1044 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1045 # default header using
1046 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1047 # YourConfigFile
1048 # and then modify the file new_header.html. See also section "Doxygen usage"
1049 # for information on how to generate the default header that doxygen normally
1050 # uses.
1051 # Note: The header is subject to change so you typically have to regenerate the
1052 # default header when upgrading to a newer version of doxygen. For a description
1053 # of the possible markers and block names see the documentation.
1054 # This tag requires that the tag GENERATE_HTML is set to YES.
1056 HTML_HEADER            =
1058 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1059 # generated HTML page. If the tag is left blank doxygen will generate a standard
1060 # footer. See HTML_HEADER for more information on how to generate a default
1061 # footer and what special commands can be used inside the footer. See also
1062 # section "Doxygen usage" for information on how to generate the default footer
1063 # that doxygen normally uses.
1064 # This tag requires that the tag GENERATE_HTML is set to YES.
1066 HTML_FOOTER            =
1068 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1069 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1070 # the HTML output. If left blank doxygen will generate a default style sheet.
1071 # See also section "Doxygen usage" for information on how to generate the style
1072 # sheet that doxygen normally uses.
1073 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1074 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1075 # obsolete.
1076 # This tag requires that the tag GENERATE_HTML is set to YES.
1078 HTML_STYLESHEET        =
1080 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1081 # cascading style sheets that are included after the standard style sheets
1082 # created by doxygen. Using this option one can overrule certain style aspects.
1083 # This is preferred over using HTML_STYLESHEET since it does not replace the
1084 # standard style sheet and is therefore more robust against future updates.
1085 # Doxygen will copy the style sheet files to the output directory.
1086 # Note: The order of the extra style sheet files is of importance (e.g. the last
1087 # style sheet in the list overrules the setting of the previous ones in the
1088 # list). For an example see the documentation.
1089 # This tag requires that the tag GENERATE_HTML is set to YES.
1091 HTML_EXTRA_STYLESHEET  =
1093 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1094 # other source files which should be copied to the HTML output directory. Note
1095 # that these files will be copied to the base HTML output directory. Use the
1096 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1097 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1098 # files will be copied as-is; there are no commands or markers available.
1099 # This tag requires that the tag GENERATE_HTML is set to YES.
1101 HTML_EXTRA_FILES       =
1103 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1104 # will adjust the colors in the style sheet and background images according to
1105 # this color. Hue is specified as an angle on a colorwheel, see
1106 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1107 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1108 # purple, and 360 is red again.
1109 # Minimum value: 0, maximum value: 359, default value: 220.
1110 # This tag requires that the tag GENERATE_HTML is set to YES.
1112 HTML_COLORSTYLE_HUE    = 220
1114 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1115 # in the HTML output. For a value of 0 the output will use grayscales only. A
1116 # value of 255 will produce the most vivid colors.
1117 # Minimum value: 0, maximum value: 255, default value: 100.
1118 # This tag requires that the tag GENERATE_HTML is set to YES.
1120 HTML_COLORSTYLE_SAT    = 100
1122 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1123 # luminance component of the colors in the HTML output. Values below 100
1124 # gradually make the output lighter, whereas values above 100 make the output
1125 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1126 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1127 # change the gamma.
1128 # Minimum value: 40, maximum value: 240, default value: 80.
1129 # This tag requires that the tag GENERATE_HTML is set to YES.
1131 HTML_COLORSTYLE_GAMMA  = 80
1133 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1134 # page will contain the date and time when the page was generated. Setting this
1135 # to NO can help when comparing the output of multiple runs.
1136 # The default value is: YES.
1137 # This tag requires that the tag GENERATE_HTML is set to YES.
1139 HTML_TIMESTAMP         = YES
1141 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1142 # documentation will contain sections that can be hidden and shown after the
1143 # page has loaded.
1144 # The default value is: NO.
1145 # This tag requires that the tag GENERATE_HTML is set to YES.
1147 HTML_DYNAMIC_SECTIONS  = NO
1149 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1150 # shown in the various tree structured indices initially; the user can expand
1151 # and collapse entries dynamically later on. Doxygen will expand the tree to
1152 # such a level that at most the specified number of entries are visible (unless
1153 # a fully collapsed tree already exceeds this amount). So setting the number of
1154 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1155 # representing an infinite number of entries and will result in a full expanded
1156 # tree by default.
1157 # Minimum value: 0, maximum value: 9999, default value: 100.
1158 # This tag requires that the tag GENERATE_HTML is set to YES.
1160 HTML_INDEX_NUM_ENTRIES = 100
1162 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1163 # generated that can be used as input for Apple's Xcode 3 integrated development
1164 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1165 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1166 # Makefile in the HTML output directory. Running make will produce the docset in
1167 # that directory and running make install will install the docset in
1168 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1169 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1170 # for more information.
1171 # The default value is: NO.
1172 # This tag requires that the tag GENERATE_HTML is set to YES.
1174 GENERATE_DOCSET        = NO
1176 # This tag determines the name of the docset feed. A documentation feed provides
1177 # an umbrella under which multiple documentation sets from a single provider
1178 # (such as a company or product suite) can be grouped.
1179 # The default value is: Doxygen generated docs.
1180 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1182 DOCSET_FEEDNAME        = "Doxygen generated docs"
1184 # This tag specifies a string that should uniquely identify the documentation
1185 # set bundle. This should be a reverse domain-name style string, e.g.
1186 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1187 # The default value is: org.doxygen.Project.
1188 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1190 DOCSET_BUNDLE_ID       = org.doxygen.Project
1192 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1193 # the documentation publisher. This should be a reverse domain-name style
1194 # string, e.g. com.mycompany.MyDocSet.documentation.
1195 # The default value is: org.doxygen.Publisher.
1196 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1198 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1200 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1201 # The default value is: Publisher.
1202 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1204 DOCSET_PUBLISHER_NAME  = Publisher
1206 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1207 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1208 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1209 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1210 # Windows.
1212 # The HTML Help Workshop contains a compiler that can convert all HTML output
1213 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1214 # files are now used as the Windows 98 help format, and will replace the old
1215 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1216 # HTML files also contain an index, a table of contents, and you can search for
1217 # words in the documentation. The HTML workshop also contains a viewer for
1218 # compressed HTML files.
1219 # The default value is: NO.
1220 # This tag requires that the tag GENERATE_HTML is set to YES.
1222 GENERATE_HTMLHELP      = NO
1224 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1225 # file. You can add a path in front of the file if the result should not be
1226 # written to the html output directory.
1227 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1229 CHM_FILE               =
1231 # The HHC_LOCATION tag can be used to specify the location (absolute path
1232 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1233 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1234 # The file has to be specified with full path.
1235 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1237 HHC_LOCATION           =
1239 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1240 # (YES) or that it should be included in the master .chm file (NO).
1241 # The default value is: NO.
1242 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1244 GENERATE_CHI           = NO
1246 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1247 # and project file content.
1248 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1250 CHM_INDEX_ENCODING     =
1252 # The BINARY_TOC flag controls whether a binary table of contents is generated
1253 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1254 # enables the Previous and Next buttons.
1255 # The default value is: NO.
1256 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1258 BINARY_TOC             = NO
1260 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1261 # the table of contents of the HTML help documentation and to the tree view.
1262 # The default value is: NO.
1263 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1265 TOC_EXPAND             = NO
1267 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1268 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1269 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1270 # (.qch) of the generated HTML documentation.
1271 # The default value is: NO.
1272 # This tag requires that the tag GENERATE_HTML is set to YES.
1274 GENERATE_QHP           = NO
1276 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1277 # the file name of the resulting .qch file. The path specified is relative to
1278 # the HTML output folder.
1279 # This tag requires that the tag GENERATE_QHP is set to YES.
1281 QCH_FILE               =
1283 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1284 # Project output. For more information please see Qt Help Project / Namespace
1285 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1286 # The default value is: org.doxygen.Project.
1287 # This tag requires that the tag GENERATE_QHP is set to YES.
1289 QHP_NAMESPACE          = org.doxygen.Project
1291 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1292 # Help Project output. For more information please see Qt Help Project / Virtual
1293 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1294 # folders).
1295 # The default value is: doc.
1296 # This tag requires that the tag GENERATE_QHP is set to YES.
1298 QHP_VIRTUAL_FOLDER     = doc
1300 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1301 # filter to add. For more information please see Qt Help Project / Custom
1302 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1303 # filters).
1304 # This tag requires that the tag GENERATE_QHP is set to YES.
1306 QHP_CUST_FILTER_NAME   =
1308 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1309 # custom filter to add. For more information please see Qt Help Project / Custom
1310 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1311 # filters).
1312 # This tag requires that the tag GENERATE_QHP is set to YES.
1314 QHP_CUST_FILTER_ATTRS  =
1316 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1317 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1318 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1319 # This tag requires that the tag GENERATE_QHP is set to YES.
1321 QHP_SECT_FILTER_ATTRS  =
1323 # The QHG_LOCATION tag can be used to specify the location of Qt's
1324 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1325 # generated .qhp file.
1326 # This tag requires that the tag GENERATE_QHP is set to YES.
1328 QHG_LOCATION           =
1330 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1331 # generated, together with the HTML files, they form an Eclipse help plugin. To
1332 # install this plugin and make it available under the help contents menu in
1333 # Eclipse, the contents of the directory containing the HTML and XML files needs
1334 # to be copied into the plugins directory of eclipse. The name of the directory
1335 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1336 # After copying Eclipse needs to be restarted before the help appears.
1337 # The default value is: NO.
1338 # This tag requires that the tag GENERATE_HTML is set to YES.
1340 GENERATE_ECLIPSEHELP   = NO
1342 # A unique identifier for the Eclipse help plugin. When installing the plugin
1343 # the directory name containing the HTML and XML files should also have this
1344 # name. Each documentation set should have its own identifier.
1345 # The default value is: org.doxygen.Project.
1346 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1348 ECLIPSE_DOC_ID         = org.doxygen.Project
1350 # If you want full control over the layout of the generated HTML pages it might
1351 # be necessary to disable the index and replace it with your own. The
1352 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1353 # of each HTML page. A value of NO enables the index and the value YES disables
1354 # it. Since the tabs in the index contain the same information as the navigation
1355 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1356 # The default value is: NO.
1357 # This tag requires that the tag GENERATE_HTML is set to YES.
1359 DISABLE_INDEX          = NO
1361 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1362 # structure should be generated to display hierarchical information. If the tag
1363 # value is set to YES, a side panel will be generated containing a tree-like
1364 # index structure (just like the one that is generated for HTML Help). For this
1365 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1366 # (i.e. any modern browser). Windows users are probably better off using the
1367 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1368 # further fine-tune the look of the index. As an example, the default style
1369 # sheet generated by doxygen has an example that shows how to put an image at
1370 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1371 # the same information as the tab index, you could consider setting
1372 # DISABLE_INDEX to YES when enabling this option.
1373 # The default value is: NO.
1374 # This tag requires that the tag GENERATE_HTML is set to YES.
1376 GENERATE_TREEVIEW      = NO
1378 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1379 # doxygen will group on one line in the generated HTML documentation.
1381 # Note that a value of 0 will completely suppress the enum values from appearing
1382 # in the overview section.
1383 # Minimum value: 0, maximum value: 20, default value: 4.
1384 # This tag requires that the tag GENERATE_HTML is set to YES.
1386 ENUM_VALUES_PER_LINE   = 4
1388 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1389 # to set the initial width (in pixels) of the frame in which the tree is shown.
1390 # Minimum value: 0, maximum value: 1500, default value: 250.
1391 # This tag requires that the tag GENERATE_HTML is set to YES.
1393 TREEVIEW_WIDTH         = 250
1395 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1396 # external symbols imported via tag files in a separate window.
1397 # The default value is: NO.
1398 # This tag requires that the tag GENERATE_HTML is set to YES.
1400 EXT_LINKS_IN_WINDOW    = NO
1402 # Use this tag to change the font size of LaTeX formulas included as images in
1403 # the HTML documentation. When you change the font size after a successful
1404 # doxygen run you need to manually remove any form_*.png images from the HTML
1405 # output directory to force them to be regenerated.
1406 # Minimum value: 8, maximum value: 50, default value: 10.
1407 # This tag requires that the tag GENERATE_HTML is set to YES.
1409 FORMULA_FONTSIZE       = 10
1411 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1412 # generated for formulas are transparent PNGs. Transparent PNGs are not
1413 # supported properly for IE 6.0, but are supported on all modern browsers.
1415 # Note that when changing this option you need to delete any form_*.png files in
1416 # the HTML output directory before the changes have effect.
1417 # The default value is: YES.
1418 # This tag requires that the tag GENERATE_HTML is set to YES.
1420 FORMULA_TRANSPARENT    = YES
1422 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1423 # http://www.mathjax.org) which uses client side Javascript for the rendering
1424 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1425 # installed or if you want to formulas look prettier in the HTML output. When
1426 # enabled you may also need to install MathJax separately and configure the path
1427 # to it using the MATHJAX_RELPATH option.
1428 # The default value is: NO.
1429 # This tag requires that the tag GENERATE_HTML is set to YES.
1431 USE_MATHJAX            = NO
1433 # When MathJax is enabled you can set the default output format to be used for
1434 # the MathJax output. See the MathJax site (see:
1435 # http://docs.mathjax.org/en/latest/output.html) for more details.
1436 # Possible values are: HTML-CSS (which is slower, but has the best
1437 # compatibility), NativeMML (i.e. MathML) and SVG.
1438 # The default value is: HTML-CSS.
1439 # This tag requires that the tag USE_MATHJAX is set to YES.
1441 MATHJAX_FORMAT         = HTML-CSS
1443 # When MathJax is enabled you need to specify the location relative to the HTML
1444 # output directory using the MATHJAX_RELPATH option. The destination directory
1445 # should contain the MathJax.js script. For instance, if the mathjax directory
1446 # is located at the same level as the HTML output directory, then
1447 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1448 # Content Delivery Network so you can quickly see the result without installing
1449 # MathJax. However, it is strongly recommended to install a local copy of
1450 # MathJax from http://www.mathjax.org before deployment.
1451 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1452 # This tag requires that the tag USE_MATHJAX is set to YES.
1454 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1456 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1457 # extension names that should be enabled during MathJax rendering. For example
1458 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1459 # This tag requires that the tag USE_MATHJAX is set to YES.
1461 MATHJAX_EXTENSIONS     =
1463 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1464 # of code that will be used on startup of the MathJax code. See the MathJax site
1465 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1466 # example see the documentation.
1467 # This tag requires that the tag USE_MATHJAX is set to YES.
1469 MATHJAX_CODEFILE       =
1471 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1472 # the HTML output. The underlying search engine uses javascript and DHTML and
1473 # should work on any modern browser. Note that when using HTML help
1474 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1475 # there is already a search function so this one should typically be disabled.
1476 # For large projects the javascript based search engine can be slow, then
1477 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1478 # search using the keyboard; to jump to the search box use <access key> + S
1479 # (what the <access key> is depends on the OS and browser, but it is typically
1480 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1481 # key> to jump into the search results window, the results can be navigated
1482 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1483 # the search. The filter options can be selected when the cursor is inside the
1484 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1485 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1486 # option.
1487 # The default value is: YES.
1488 # This tag requires that the tag GENERATE_HTML is set to YES.
1490 SEARCHENGINE           = YES
1492 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1493 # implemented using a web server instead of a web client using Javascript. There
1494 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1495 # setting. When disabled, doxygen will generate a PHP script for searching and
1496 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1497 # and searching needs to be provided by external tools. See the section
1498 # "External Indexing and Searching" for details.
1499 # The default value is: NO.
1500 # This tag requires that the tag SEARCHENGINE is set to YES.
1502 SERVER_BASED_SEARCH    = NO
1504 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1505 # script for searching. Instead the search results are written to an XML file
1506 # which needs to be processed by an external indexer. Doxygen will invoke an
1507 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1508 # search results.
1510 # Doxygen ships with an example indexer (doxyindexer) and search engine
1511 # (doxysearch.cgi) which are based on the open source search engine library
1512 # Xapian (see: http://xapian.org/).
1514 # See the section "External Indexing and Searching" for details.
1515 # The default value is: NO.
1516 # This tag requires that the tag SEARCHENGINE is set to YES.
1518 EXTERNAL_SEARCH        = NO
1520 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1521 # which will return the search results when EXTERNAL_SEARCH is enabled.
1523 # Doxygen ships with an example indexer (doxyindexer) and search engine
1524 # (doxysearch.cgi) which are based on the open source search engine library
1525 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1526 # Searching" for details.
1527 # This tag requires that the tag SEARCHENGINE is set to YES.
1529 SEARCHENGINE_URL       =
1531 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1532 # search data is written to a file for indexing by an external tool. With the
1533 # SEARCHDATA_FILE tag the name of this file can be specified.
1534 # The default file is: searchdata.xml.
1535 # This tag requires that the tag SEARCHENGINE is set to YES.
1537 SEARCHDATA_FILE        = searchdata.xml
1539 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1540 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1541 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1542 # projects and redirect the results back to the right project.
1543 # This tag requires that the tag SEARCHENGINE is set to YES.
1545 EXTERNAL_SEARCH_ID     =
1547 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1548 # projects other than the one defined by this configuration file, but that are
1549 # all added to the same external search index. Each project needs to have a
1550 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1551 # to a relative location where the documentation can be found. The format is:
1552 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1553 # This tag requires that the tag SEARCHENGINE is set to YES.
1555 EXTRA_SEARCH_MAPPINGS  =
1557 #---------------------------------------------------------------------------
1558 # Configuration options related to the LaTeX output
1559 #---------------------------------------------------------------------------
1561 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1562 # The default value is: YES.
1564 GENERATE_LATEX         = YES
1566 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1567 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1568 # it.
1569 # The default directory is: latex.
1570 # This tag requires that the tag GENERATE_LATEX is set to YES.
1572 LATEX_OUTPUT           = latex
1574 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1575 # invoked.
1577 # Note that when enabling USE_PDFLATEX this option is only used for generating
1578 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1579 # written to the output directory.
1580 # The default file is: latex.
1581 # This tag requires that the tag GENERATE_LATEX is set to YES.
1583 LATEX_CMD_NAME         = latex
1585 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1586 # index for LaTeX.
1587 # The default file is: makeindex.
1588 # This tag requires that the tag GENERATE_LATEX is set to YES.
1590 MAKEINDEX_CMD_NAME     = makeindex
1592 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1593 # documents. This may be useful for small projects and may help to save some
1594 # trees in general.
1595 # The default value is: NO.
1596 # This tag requires that the tag GENERATE_LATEX is set to YES.
1598 COMPACT_LATEX          = NO
1600 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1601 # printer.
1602 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1603 # 14 inches) and executive (7.25 x 10.5 inches).
1604 # The default value is: a4.
1605 # This tag requires that the tag GENERATE_LATEX is set to YES.
1607 PAPER_TYPE             = a4
1609 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1610 # that should be included in the LaTeX output. To get the times font for
1611 # instance you can specify
1612 # EXTRA_PACKAGES=times
1613 # If left blank no extra packages will be included.
1614 # This tag requires that the tag GENERATE_LATEX is set to YES.
1616 EXTRA_PACKAGES         =
1618 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1619 # generated LaTeX document. The header should contain everything until the first
1620 # chapter. If it is left blank doxygen will generate a standard header. See
1621 # section "Doxygen usage" for information on how to let doxygen write the
1622 # default header to a separate file.
1624 # Note: Only use a user-defined header if you know what you are doing! The
1625 # following commands have a special meaning inside the header: $title,
1626 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1627 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1628 # string, for the replacement values of the other commands the user is referred
1629 # to HTML_HEADER.
1630 # This tag requires that the tag GENERATE_LATEX is set to YES.
1632 LATEX_HEADER           =
1634 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1635 # generated LaTeX document. The footer should contain everything after the last
1636 # chapter. If it is left blank doxygen will generate a standard footer. See
1637 # LATEX_HEADER for more information on how to generate a default footer and what
1638 # special commands can be used inside the footer.
1640 # Note: Only use a user-defined footer if you know what you are doing!
1641 # This tag requires that the tag GENERATE_LATEX is set to YES.
1643 LATEX_FOOTER           =
1645 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1646 # LaTeX style sheets that are included after the standard style sheets created
1647 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1648 # will copy the style sheet files to the output directory.
1649 # Note: The order of the extra style sheet files is of importance (e.g. the last
1650 # style sheet in the list overrules the setting of the previous ones in the
1651 # list).
1652 # This tag requires that the tag GENERATE_LATEX is set to YES.
1654 LATEX_EXTRA_STYLESHEET =
1656 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1657 # other source files which should be copied to the LATEX_OUTPUT output
1658 # directory. Note that the files will be copied as-is; there are no commands or
1659 # markers available.
1660 # This tag requires that the tag GENERATE_LATEX is set to YES.
1662 LATEX_EXTRA_FILES      =
1664 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1665 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1666 # contain links (just like the HTML output) instead of page references. This
1667 # makes the output suitable for online browsing using a PDF viewer.
1668 # The default value is: YES.
1669 # This tag requires that the tag GENERATE_LATEX is set to YES.
1671 PDF_HYPERLINKS         = YES
1673 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1674 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1675 # higher quality PDF documentation.
1676 # The default value is: YES.
1677 # This tag requires that the tag GENERATE_LATEX is set to YES.
1679 USE_PDFLATEX           = YES
1681 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1682 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1683 # if errors occur, instead of asking the user for help. This option is also used
1684 # when generating formulas in HTML.
1685 # The default value is: NO.
1686 # This tag requires that the tag GENERATE_LATEX is set to YES.
1688 LATEX_BATCHMODE        = NO
1690 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1691 # index chapters (such as File Index, Compound Index, etc.) in the output.
1692 # The default value is: NO.
1693 # This tag requires that the tag GENERATE_LATEX is set to YES.
1695 LATEX_HIDE_INDICES     = NO
1697 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1698 # code with syntax highlighting in the LaTeX output.
1700 # Note that which sources are shown also depends on other settings such as
1701 # SOURCE_BROWSER.
1702 # The default value is: NO.
1703 # This tag requires that the tag GENERATE_LATEX is set to YES.
1705 LATEX_SOURCE_CODE      = NO
1707 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1708 # bibliography, e.g. plainnat, or ieeetr. See
1709 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1710 # The default value is: plain.
1711 # This tag requires that the tag GENERATE_LATEX is set to YES.
1713 LATEX_BIB_STYLE        = plain
1715 #---------------------------------------------------------------------------
1716 # Configuration options related to the RTF output
1717 #---------------------------------------------------------------------------
1719 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1720 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1721 # readers/editors.
1722 # The default value is: NO.
1724 GENERATE_RTF           = NO
1726 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1727 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1728 # it.
1729 # The default directory is: rtf.
1730 # This tag requires that the tag GENERATE_RTF is set to YES.
1732 RTF_OUTPUT             = rtf
1734 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1735 # documents. This may be useful for small projects and may help to save some
1736 # trees in general.
1737 # The default value is: NO.
1738 # This tag requires that the tag GENERATE_RTF is set to YES.
1740 COMPACT_RTF            = NO
1742 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1743 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1744 # output) instead of page references. This makes the output suitable for online
1745 # browsing using Word or some other Word compatible readers that support those
1746 # fields.
1748 # Note: WordPad (write) and others do not support links.
1749 # The default value is: NO.
1750 # This tag requires that the tag GENERATE_RTF is set to YES.
1752 RTF_HYPERLINKS         = NO
1754 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1755 # file, i.e. a series of assignments. You only have to provide replacements,
1756 # missing definitions are set to their default value.
1758 # See also section "Doxygen usage" for information on how to generate the
1759 # default style sheet that doxygen normally uses.
1760 # This tag requires that the tag GENERATE_RTF is set to YES.
1762 RTF_STYLESHEET_FILE    =
1764 # Set optional variables used in the generation of an RTF document. Syntax is
1765 # similar to doxygen's config file. A template extensions file can be generated
1766 # using doxygen -e rtf extensionFile.
1767 # This tag requires that the tag GENERATE_RTF is set to YES.
1769 RTF_EXTENSIONS_FILE    =
1771 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1772 # with syntax highlighting in the RTF output.
1774 # Note that which sources are shown also depends on other settings such as
1775 # SOURCE_BROWSER.
1776 # The default value is: NO.
1777 # This tag requires that the tag GENERATE_RTF is set to YES.
1779 RTF_SOURCE_CODE        = NO
1781 #---------------------------------------------------------------------------
1782 # Configuration options related to the man page output
1783 #---------------------------------------------------------------------------
1785 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1786 # classes and files.
1787 # The default value is: NO.
1789 GENERATE_MAN           = NO
1791 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1792 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1793 # it. A directory man3 will be created inside the directory specified by
1794 # MAN_OUTPUT.
1795 # The default directory is: man.
1796 # This tag requires that the tag GENERATE_MAN is set to YES.
1798 MAN_OUTPUT             = man
1800 # The MAN_EXTENSION tag determines the extension that is added to the generated
1801 # man pages. In case the manual section does not start with a number, the number
1802 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1803 # optional.
1804 # The default value is: .3.
1805 # This tag requires that the tag GENERATE_MAN is set to YES.
1807 MAN_EXTENSION          = .3
1809 # The MAN_SUBDIR tag determines the name of the directory created within
1810 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1811 # MAN_EXTENSION with the initial . removed.
1812 # This tag requires that the tag GENERATE_MAN is set to YES.
1814 MAN_SUBDIR             =
1816 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1817 # will generate one additional man file for each entity documented in the real
1818 # man page(s). These additional files only source the real man page, but without
1819 # them the man command would be unable to find the correct page.
1820 # The default value is: NO.
1821 # This tag requires that the tag GENERATE_MAN is set to YES.
1823 MAN_LINKS              = NO
1825 #---------------------------------------------------------------------------
1826 # Configuration options related to the XML output
1827 #---------------------------------------------------------------------------
1829 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1830 # captures the structure of the code including all documentation.
1831 # The default value is: NO.
1833 GENERATE_XML           = NO
1835 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1836 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1837 # it.
1838 # The default directory is: xml.
1839 # This tag requires that the tag GENERATE_XML is set to YES.
1841 XML_OUTPUT             = xml
1843 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1844 # listings (including syntax highlighting and cross-referencing information) to
1845 # the XML output. Note that enabling this will significantly increase the size
1846 # of the XML output.
1847 # The default value is: YES.
1848 # This tag requires that the tag GENERATE_XML is set to YES.
1850 XML_PROGRAMLISTING     = YES
1852 #---------------------------------------------------------------------------
1853 # Configuration options related to the DOCBOOK output
1854 #---------------------------------------------------------------------------
1856 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1857 # that can be used to generate PDF.
1858 # The default value is: NO.
1860 GENERATE_DOCBOOK       = NO
1862 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1863 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1864 # front of it.
1865 # The default directory is: docbook.
1866 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1868 DOCBOOK_OUTPUT         = docbook
1870 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1871 # program listings (including syntax highlighting and cross-referencing
1872 # information) to the DOCBOOK output. Note that enabling this will significantly
1873 # increase the size of the DOCBOOK output.
1874 # The default value is: NO.
1875 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1877 DOCBOOK_PROGRAMLISTING = NO
1879 #---------------------------------------------------------------------------
1880 # Configuration options for the AutoGen Definitions output
1881 #---------------------------------------------------------------------------
1883 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1884 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1885 # structure of the code including all documentation. Note that this feature is
1886 # still experimental and incomplete at the moment.
1887 # The default value is: NO.
1889 GENERATE_AUTOGEN_DEF   = NO
1891 #---------------------------------------------------------------------------
1892 # Configuration options related to the Perl module output
1893 #---------------------------------------------------------------------------
1895 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1896 # file that captures the structure of the code including all documentation.
1898 # Note that this feature is still experimental and incomplete at the moment.
1899 # The default value is: NO.
1901 GENERATE_PERLMOD       = NO
1903 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1904 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1905 # output from the Perl module output.
1906 # The default value is: NO.
1907 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1909 PERLMOD_LATEX          = NO
1911 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1912 # formatted so it can be parsed by a human reader. This is useful if you want to
1913 # understand what is going on. On the other hand, if this tag is set to NO, the
1914 # size of the Perl module output will be much smaller and Perl will parse it
1915 # just the same.
1916 # The default value is: YES.
1917 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1919 PERLMOD_PRETTY         = YES
1921 # The names of the make variables in the generated doxyrules.make file are
1922 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1923 # so different doxyrules.make files included by the same Makefile don't
1924 # overwrite each other's variables.
1925 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1927 PERLMOD_MAKEVAR_PREFIX =
1929 #---------------------------------------------------------------------------
1930 # Configuration options related to the preprocessor
1931 #---------------------------------------------------------------------------
1933 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1934 # C-preprocessor directives found in the sources and include files.
1935 # The default value is: YES.
1937 ENABLE_PREPROCESSING   = YES
1939 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1940 # in the source code. If set to NO, only conditional compilation will be
1941 # performed. Macro expansion can be done in a controlled way by setting
1942 # EXPAND_ONLY_PREDEF to YES.
1943 # The default value is: NO.
1944 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1946 MACRO_EXPANSION        = NO
1948 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1949 # the macro expansion is limited to the macros specified with the PREDEFINED and
1950 # EXPAND_AS_DEFINED tags.
1951 # The default value is: NO.
1952 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1954 EXPAND_ONLY_PREDEF     = NO
1956 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
1957 # INCLUDE_PATH will be searched if a #include is found.
1958 # The default value is: YES.
1959 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1961 SEARCH_INCLUDES        = YES
1963 # The INCLUDE_PATH tag can be used to specify one or more directories that
1964 # contain include files that are not input files but should be processed by the
1965 # preprocessor.
1966 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1968 INCLUDE_PATH           =
1970 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1971 # patterns (like *.h and *.hpp) to filter out the header-files in the
1972 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1973 # used.
1974 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1976 INCLUDE_FILE_PATTERNS  =
1978 # The PREDEFINED tag can be used to specify one or more macro names that are
1979 # defined before the preprocessor is started (similar to the -D option of e.g.
1980 # gcc). The argument of the tag is a list of macros of the form: name or
1981 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1982 # is assumed. To prevent a macro definition from being undefined via #undef or
1983 # recursively expanded use the := operator instead of the = operator.
1984 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1986 PREDEFINED             =
1988 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1989 # tag can be used to specify a list of macro names that should be expanded. The
1990 # macro definition that is found in the sources will be used. Use the PREDEFINED
1991 # tag if you want to use a different macro definition that overrules the
1992 # definition found in the source code.
1993 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1995 EXPAND_AS_DEFINED      =
1997 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1998 # remove all references to function-like macros that are alone on a line, have
1999 # an all uppercase name, and do not end with a semicolon. Such function macros
2000 # are typically used for boiler-plate code, and will confuse the parser if not
2001 # removed.
2002 # The default value is: YES.
2003 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2005 SKIP_FUNCTION_MACROS   = YES
2007 #---------------------------------------------------------------------------
2008 # Configuration options related to external references
2009 #---------------------------------------------------------------------------
2011 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2012 # file the location of the external documentation should be added. The format of
2013 # a tag file without this location is as follows:
2014 # TAGFILES = file1 file2 ...
2015 # Adding location for the tag files is done as follows:
2016 # TAGFILES = file1=loc1 "file2 = loc2" ...
2017 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2018 # section "Linking to external documentation" for more information about the use
2019 # of tag files.
2020 # Note: Each tag file must have a unique name (where the name does NOT include
2021 # the path). If a tag file is not located in the directory in which doxygen is
2022 # run, you must also specify the path to the tagfile here.
2024 TAGFILES               =
2026 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2027 # tag file that is based on the input files it reads. See section "Linking to
2028 # external documentation" for more information about the usage of tag files.
2030 GENERATE_TAGFILE       =
2032 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2033 # the class index. If set to NO, only the inherited external classes will be
2034 # listed.
2035 # The default value is: NO.
2037 ALLEXTERNALS           = NO
2039 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2040 # in the modules index. If set to NO, only the current project's groups will be
2041 # listed.
2042 # The default value is: YES.
2044 EXTERNAL_GROUPS        = YES
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.
2051 EXTERNAL_PAGES         = YES
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.
2057 PERL_PATH              = /usr/bin/perl
2059 #---------------------------------------------------------------------------
2060 # Configuration options related to the dot tool
2061 #---------------------------------------------------------------------------
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.
2070 CLASS_DIAGRAMS         = YES
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.
2079 MSCGEN_PATH            =
2081 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2082 # then run dia to produce the diagram and insert it in the documentation. The
2083 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2084 # If left empty dia is assumed to be found in the default search path.
2086 DIA_PATH               =
2088 # If set to YES the inheritance and collaboration graphs will hide inheritance
2089 # and usage relations if the target is undocumented or is not a class.
2090 # The default value is: YES.
2092 HIDE_UNDOC_RELATIONS   = YES
2094 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2095 # available from the path. This tool is part of Graphviz (see:
2096 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2097 # Bell Labs. The other options in this section have no effect if this option is
2098 # set to NO
2099 # The default value is: NO.
2101 HAVE_DOT               = NO
2103 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2104 # to run in parallel. When set to 0 doxygen will base this on the number of
2105 # processors available in the system. You can set it explicitly to a value
2106 # larger than 0 to get control over the balance between CPU load and processing
2107 # speed.
2108 # Minimum value: 0, maximum value: 32, default value: 0.
2109 # This tag requires that the tag HAVE_DOT is set to YES.
2111 DOT_NUM_THREADS        = 0
2113 # When you want a differently looking font in the dot files that doxygen
2114 # generates you can specify the font name using DOT_FONTNAME. You need to make
2115 # sure dot is able to find the font, which can be done by putting it in a
2116 # standard location or by setting the DOTFONTPATH environment variable or by
2117 # setting DOT_FONTPATH to the directory containing the font.
2118 # The default value is: Helvetica.
2119 # This tag requires that the tag HAVE_DOT is set to YES.
2121 DOT_FONTNAME           = Helvetica
2123 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2124 # dot graphs.
2125 # Minimum value: 4, maximum value: 24, default value: 10.
2126 # This tag requires that the tag HAVE_DOT is set to YES.
2128 DOT_FONTSIZE           = 10
2130 # By default doxygen will tell dot to use the default font as specified with
2131 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2132 # the path where dot can find it using this tag.
2133 # This tag requires that the tag HAVE_DOT is set to YES.
2135 DOT_FONTPATH           =
2137 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2138 # each documented class showing the direct and indirect inheritance relations.
2139 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2140 # The default value is: YES.
2141 # This tag requires that the tag HAVE_DOT is set to YES.
2143 CLASS_GRAPH            = YES
2145 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2146 # graph for each documented class showing the direct and indirect implementation
2147 # dependencies (inheritance, containment, and class references variables) of the
2148 # class with other documented classes.
2149 # The default value is: YES.
2150 # This tag requires that the tag HAVE_DOT is set to YES.
2152 COLLABORATION_GRAPH    = YES
2154 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2155 # groups, showing the direct groups dependencies.
2156 # The default value is: YES.
2157 # This tag requires that the tag HAVE_DOT is set to YES.
2159 GROUP_GRAPHS           = YES
2161 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2162 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2163 # Language.
2164 # The default value is: NO.
2165 # This tag requires that the tag HAVE_DOT is set to YES.
2167 UML_LOOK               = NO
2169 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2170 # class node. If there are many fields or methods and many nodes the graph may
2171 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2172 # number of items for each type to make the size more manageable. Set this to 0
2173 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2174 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2175 # but if the number exceeds 15, the total amount of fields shown is limited to
2176 # 10.
2177 # Minimum value: 0, maximum value: 100, default value: 10.
2178 # This tag requires that the tag HAVE_DOT is set to YES.
2180 UML_LIMIT_NUM_FIELDS   = 10
2182 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2183 # collaboration graphs will show the relations between templates and their
2184 # instances.
2185 # The default value is: NO.
2186 # This tag requires that the tag HAVE_DOT is set to YES.
2188 TEMPLATE_RELATIONS     = NO
2190 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2191 # YES then doxygen will generate a graph for each documented file showing the
2192 # direct and indirect include dependencies of the file with other documented
2193 # files.
2194 # The default value is: YES.
2195 # This tag requires that the tag HAVE_DOT is set to YES.
2197 INCLUDE_GRAPH          = YES
2199 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2200 # set to YES then doxygen will generate a graph for each documented file showing
2201 # the direct and indirect include dependencies of the file with other documented
2202 # files.
2203 # The default value is: YES.
2204 # This tag requires that the tag HAVE_DOT is set to YES.
2206 INCLUDED_BY_GRAPH      = YES
2208 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2209 # dependency graph for every global function or class method.
2211 # Note that enabling this option will significantly increase the time of a run.
2212 # So in most cases it will be better to enable call graphs for selected
2213 # functions only using the \callgraph command.
2214 # The default value is: NO.
2215 # This tag requires that the tag HAVE_DOT is set to YES.
2217 CALL_GRAPH             = NO
2219 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2220 # dependency graph for every global function or class method.
2222 # Note that enabling this option will significantly increase the time of a run.
2223 # So in most cases it will be better to enable caller graphs for selected
2224 # functions only using the \callergraph command.
2225 # The default value is: NO.
2226 # This tag requires that the tag HAVE_DOT is set to YES.
2228 CALLER_GRAPH           = NO
2230 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2231 # hierarchy of all classes instead of a textual one.
2232 # The default value is: YES.
2233 # This tag requires that the tag HAVE_DOT is set to YES.
2235 GRAPHICAL_HIERARCHY    = YES
2237 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2238 # dependencies a directory has on other directories in a graphical way. The
2239 # dependency relations are determined by the #include relations between the
2240 # files in the directories.
2241 # The default value is: YES.
2242 # This tag requires that the tag HAVE_DOT is set to YES.
2244 DIRECTORY_GRAPH        = YES
2246 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2247 # generated by dot.
2248 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2249 # to make the SVG files visible in IE 9+ (other browsers do not have this
2250 # requirement).
2251 # Possible values are: png, jpg, gif and svg.
2252 # The default value is: png.
2253 # This tag requires that the tag HAVE_DOT is set to YES.
2255 DOT_IMAGE_FORMAT       = png
2257 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2258 # enable generation of interactive SVG images that allow zooming and panning.
2260 # Note that this requires a modern browser other than Internet Explorer. Tested
2261 # and working are Firefox, Chrome, Safari, and Opera.
2262 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2263 # the SVG files visible. Older versions of IE do not have SVG support.
2264 # The default value is: NO.
2265 # This tag requires that the tag HAVE_DOT is set to YES.
2267 INTERACTIVE_SVG        = NO
2269 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2270 # found. If left blank, it is assumed the dot tool can be found in the path.
2271 # This tag requires that the tag HAVE_DOT is set to YES.
2273 DOT_PATH               =
2275 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2276 # contain dot files that are included in the documentation (see the \dotfile
2277 # command).
2278 # This tag requires that the tag HAVE_DOT is set to YES.
2280 DOTFILE_DIRS           =
2282 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2283 # contain msc files that are included in the documentation (see the \mscfile
2284 # command).
2286 MSCFILE_DIRS           =
2288 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2289 # contain dia files that are included in the documentation (see the \diafile
2290 # command).
2292 DIAFILE_DIRS           =
2294 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2295 # path where java can find the plantuml.jar file. If left blank, it is assumed
2296 # PlantUML is not used or called during a preprocessing step. Doxygen will
2297 # generate a warning when it encounters a \startuml command in this case and
2298 # will not generate output for the diagram.
2300 PLANTUML_JAR_PATH      =
2302 # When using plantuml, the specified paths are searched for files specified by
2303 # the !include statement in a plantuml block.
2305 PLANTUML_INCLUDE_PATH  =
2307 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2308 # that will be shown in the graph. If the number of nodes in a graph becomes
2309 # larger than this value, doxygen will truncate the graph, which is visualized
2310 # by representing a node as a red box. Note that doxygen if the number of direct
2311 # children of the root node in a graph is already larger than
2312 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2313 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2314 # Minimum value: 0, maximum value: 10000, default value: 50.
2315 # This tag requires that the tag HAVE_DOT is set to YES.
2317 DOT_GRAPH_MAX_NODES    = 50
2319 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2320 # generated by dot. A depth value of 3 means that only nodes reachable from the
2321 # root by following a path via at most 3 edges will be shown. Nodes that lay
2322 # further from the root node will be omitted. Note that setting this option to 1
2323 # or 2 may greatly reduce the computation time needed for large code bases. Also
2324 # note that the size of a graph can be further restricted by
2325 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2326 # Minimum value: 0, maximum value: 1000, default value: 0.
2327 # This tag requires that the tag HAVE_DOT is set to YES.
2329 MAX_DOT_GRAPH_DEPTH    = 0
2331 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2332 # background. This is disabled by default, because dot on Windows does not seem
2333 # to support this out of the box.
2335 # Warning: Depending on the platform used, enabling this option may lead to
2336 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2337 # read).
2338 # The default value is: NO.
2339 # This tag requires that the tag HAVE_DOT is set to YES.
2341 DOT_TRANSPARENT        = NO
2343 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2344 # files in one run (i.e. multiple -o and -T options on the command line). This
2345 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2346 # this, this feature is disabled by default.
2347 # The default value is: NO.
2348 # This tag requires that the tag HAVE_DOT is set to YES.
2350 DOT_MULTI_TARGETS      = YES
2352 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2353 # explaining the meaning of the various boxes and arrows in the dot generated
2354 # graphs.
2355 # The default value is: YES.
2356 # This tag requires that the tag HAVE_DOT is set to YES.
2358 GENERATE_LEGEND        = YES
2360 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2361 # files that are used to generate the various graphs.
2362 # The default value is: YES.
2363 # This tag requires that the tag HAVE_DOT is set to YES.
2365 DOT_CLEANUP            = YES