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