GraphMultiEpgSetup.py: Remove unused Directories.* import
[openblackhole/openblackhole-enigma2.git] / doxy.conf
1 # Doxyfile 1.7.5
2
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project.
5 #
6 # All text after a hash (#) is considered a comment and will be ignored.
7 # The format is:
8 #       TAG = value [value, ...]
9 # For lists items can also be appended using:
10 #       TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ").
12
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING      = UTF-8
24
25 # The PROJECT_NAME tag is a single word (or sequence of words) that should
26 # identify the project. Note that if you do not use Doxywizard you need
27 # to put quotes around the project name if it contains spaces.
28
29 PROJECT_NAME           = Enigma2
30
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
32 # This could be handy for archiving the generated documentation or
33 # if some version control system is used.
34
35 PROJECT_NUMBER         =
36
37 # Using the PROJECT_BRIEF tag one can provide an optional one line description
38 # for a project that appears at the top of each page and should give viewer
39 # a quick idea about the purpose of the project. Keep the description short.
40
41 PROJECT_BRIEF          =
42
43 # With the PROJECT_LOGO tag one can specify an logo or icon that is
44 # included in the documentation. The maximum height of the logo should not
45 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
46 # Doxygen will copy the logo to the output directory.
47
48 PROJECT_LOGO           = data/skin_default/icons/plilogo-fs8.png
49
50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51 # base path where the generated documentation will be put.
52 # If a relative path is entered, it will be relative to the location
53 # where doxygen was started. If left blank the current directory will be used.
54
55 OUTPUT_DIRECTORY       = doxy
56
57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58 # 4096 sub-directories (in 2 levels) under the output directory of each output
59 # format and will distribute the generated files over these directories.
60 # Enabling this option can be useful when feeding doxygen a huge amount of
61 # source files, where putting all generated files in the same directory would
62 # otherwise cause performance problems for the file system.
63
64 CREATE_SUBDIRS         = NO
65
66 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
67 # documentation generated by doxygen is written. Doxygen will use this
68 # information to generate all constant output in the proper language.
69 # The default language is English, other supported languages are:
70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76
77 OUTPUT_LANGUAGE        = English
78
79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80 # include brief member descriptions after the members that are listed in
81 # the file and class documentation (similar to JavaDoc).
82 # Set to NO to disable this.
83
84 BRIEF_MEMBER_DESC      = YES
85
86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87 # the brief description of a member or function before the detailed description.
88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89 # brief descriptions will be completely suppressed.
90
91 REPEAT_BRIEF           = YES
92
93 # This tag implements a quasi-intelligent brief description abbreviator
94 # that is used to form the text in various listings. Each string
95 # in this list, if found as the leading text of the brief description, will be
96 # stripped from the text and the result after processing the whole list, is
97 # used as the annotated text. Otherwise, the brief description is used as-is.
98 # If left blank, the following values are used ("$name" is automatically
99 # replaced with the name of the entity): "The $name class" "The $name widget"
100 # "The $name file" "is" "provides" "specifies" "contains"
101 # "represents" "a" "an" "the"
102
103 ABBREVIATE_BRIEF       =
104
105 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106 # Doxygen will generate a detailed section even if there is only a brief
107 # description.
108
109 ALWAYS_DETAILED_SEC    = NO
110
111 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112 # inherited members of a class in the documentation of that class as if those
113 # members were ordinary class members. Constructors, destructors and assignment
114 # operators of the base classes will not be shown.
115
116 INLINE_INHERITED_MEMB  = NO
117
118 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119 # path before files name in the file list and in the header files. If set
120 # to NO the shortest path that makes the file name unique will be used.
121
122 FULL_PATH_NAMES        = YES
123
124 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125 # can be used to strip a user-defined part of the path. Stripping is
126 # only done if one of the specified strings matches the left-hand part of
127 # the path. The tag can be used to show relative paths in the file list.
128 # If left blank the directory from which doxygen is run is used as the
129 # path to strip.
130
131 STRIP_FROM_PATH        =
132
133 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
134 # the path mentioned in the documentation of a class, which tells
135 # the reader which header file to include in order to use a class.
136 # If left blank only the name of the header file containing the class
137 # definition is used. Otherwise one should specify the include paths that
138 # are normally passed to the compiler using the -I flag.
139
140 STRIP_FROM_INC_PATH    =
141
142 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
143 # (but less readable) file names. This can be useful if your file system
144 # doesn't support long names like on DOS, Mac, or CD-ROM.
145
146 SHORT_NAMES            = NO
147
148 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
149 # will interpret the first line (until the first dot) of a JavaDoc-style
150 # comment as the brief description. If set to NO, the JavaDoc
151 # comments will behave just like regular Qt-style comments
152 # (thus requiring an explicit @brief command for a brief description.)
153
154 JAVADOC_AUTOBRIEF      = NO
155
156 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
157 # interpret the first line (until the first dot) of a Qt-style
158 # comment as the brief description. If set to NO, the comments
159 # will behave just like regular Qt-style comments (thus requiring
160 # an explicit \brief command for a brief description.)
161
162 QT_AUTOBRIEF           = NO
163
164 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
165 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
166 # comments) as a brief description. This used to be the default behaviour.
167 # The new default is to treat a multi-line C++ comment block as a detailed
168 # description. Set this tag to YES if you prefer the old behaviour instead.
169
170 MULTILINE_CPP_IS_BRIEF = NO
171
172 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
173 # member inherits the documentation from any documented member that it
174 # re-implements.
175
176 INHERIT_DOCS           = YES
177
178 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
179 # a new page for each member. If set to NO, the documentation of a member will
180 # be part of the file/class/namespace that contains it.
181
182 SEPARATE_MEMBER_PAGES  = NO
183
184 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
185 # Doxygen uses this value to replace tabs by spaces in code fragments.
186
187 TAB_SIZE               = 8
188
189 # This tag can be used to specify a number of aliases that acts
190 # as commands in the documentation. An alias has the form "name=value".
191 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
192 # put the command \sideeffect (or @sideeffect) in the documentation, which
193 # will result in a user-defined paragraph with heading "Side Effects:".
194 # You can put \n's in the value part of an alias to insert newlines.
195
196 ALIASES                =
197
198 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
199 # sources only. Doxygen will then generate output that is more tailored for C.
200 # For instance, some of the names that are used will be different. The list
201 # of all members will be omitted, etc.
202
203 OPTIMIZE_OUTPUT_FOR_C  = NO
204
205 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
206 # sources only. Doxygen will then generate output that is more tailored for
207 # Java. For instance, namespaces will be presented as packages, qualified
208 # scopes will look different, etc.
209
210 OPTIMIZE_OUTPUT_JAVA   = NO
211
212 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
213 # sources only. Doxygen will then generate output that is more tailored for
214 # Fortran.
215
216 OPTIMIZE_FOR_FORTRAN   = NO
217
218 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
219 # sources. Doxygen will then generate output that is tailored for
220 # VHDL.
221
222 OPTIMIZE_OUTPUT_VHDL   = NO
223
224 # Doxygen selects the parser to use depending on the extension of the files it
225 # parses. With this tag you can assign which parser to use for a given extension.
226 # Doxygen has a built-in mapping, but you can override or extend it using this
227 # tag. The format is ext=language, where ext is a file extension, and language
228 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
229 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
230 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
231 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
232 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
233
234 EXTENSION_MAPPING      =
235
236 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
237 # to include (a tag file for) the STL sources as input, then you should
238 # set this tag to YES in order to let doxygen match functions declarations and
239 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
240 # func(std::string) {}). This also makes the inheritance and collaboration
241 # diagrams that involve STL classes more complete and accurate.
242
243 BUILTIN_STL_SUPPORT    = NO
244
245 # If you use Microsoft's C++/CLI language, you should set this option to YES to
246 # enable parsing support.
247
248 CPP_CLI_SUPPORT        = NO
249
250 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
251 # Doxygen will parse them like normal C++ but will assume all classes use public
252 # instead of private inheritance when no explicit protection keyword is present.
253
254 SIP_SUPPORT            = NO
255
256 # For Microsoft's IDL there are propget and propput attributes to indicate getter
257 # and setter methods for a property. Setting this option to YES (the default)
258 # will make doxygen replace the get and set methods by a property in the
259 # documentation. This will only work if the methods are indeed getting or
260 # setting a simple type. If this is not the case, or you want to show the
261 # methods anyway, you should set this option to NO.
262
263 IDL_PROPERTY_SUPPORT   = NO
264
265 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
266 # tag is set to YES, then doxygen will reuse the documentation of the first
267 # member in the group (if any) for the other members of the group. By default
268 # all members of a group must be documented explicitly.
269
270 DISTRIBUTE_GROUP_DOC   = NO
271
272 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
273 # the same type (for instance a group of public functions) to be put as a
274 # subgroup of that type (e.g. under the Public Functions section). Set it to
275 # NO to prevent subgrouping. Alternatively, this can be done per class using
276 # the \nosubgrouping command.
277
278 SUBGROUPING            = YES
279
280 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
281 # unions are shown inside the group in which they are included (e.g. using
282 # @ingroup) instead of on a separate page (for HTML and Man pages) or
283 # section (for LaTeX and RTF).
284
285 INLINE_GROUPED_CLASSES = NO
286
287 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
288 # unions with only public data fields will be shown inline in the documentation
289 # of the scope in which they are defined (i.e. file, namespace, or group
290 # documentation), provided this scope is documented. If set to NO (the default),
291 # structs, classes, and unions are shown on a separate page (for HTML and Man
292 # pages) or section (for LaTeX and RTF).
293
294 INLINE_SIMPLE_STRUCTS  = NO
295
296 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
297 # is documented as struct, union, or enum with the name of the typedef. So
298 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
299 # with name TypeT. When disabled the typedef will appear as a member of a file,
300 # namespace, or class. And the struct will be named TypeS. This can typically
301 # be useful for C code in case the coding convention dictates that all compound
302 # types are typedef'ed and only the typedef is referenced, never the tag name.
303
304 TYPEDEF_HIDES_STRUCT   = NO
305
306 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
307 # determine which symbols to keep in memory and which to flush to disk.
308 # When the cache is full, less often used symbols will be written to disk.
309 # For small to medium size projects (<1000 input files) the default value is
310 # probably good enough. For larger projects a too small cache size can cause
311 # doxygen to be busy swapping symbols to and from disk most of the time
312 # causing a significant performance penalty.
313 # If the system has enough physical memory increasing the cache will improve the
314 # performance by keeping more symbols in memory. Note that the value works on
315 # a logarithmic scale so increasing the size by one will roughly double the
316 # memory usage. The cache size is given by this formula:
317 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
318 # corresponding to a cache size of 2^16 = 65536 symbols
319
320 SYMBOL_CACHE_SIZE      = 0
321
322 #---------------------------------------------------------------------------
323 # Build related configuration options
324 #---------------------------------------------------------------------------
325
326 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
327 # documentation are documented, even if no documentation was available.
328 # Private class members and static file members will be hidden unless
329 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
330
331 EXTRACT_ALL            = NO
332
333 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
334 # will be included in the documentation.
335
336 EXTRACT_PRIVATE        = NO
337
338 # If the EXTRACT_STATIC tag is set to YES all static members of a file
339 # will be included in the documentation.
340
341 EXTRACT_STATIC         = YES
342
343 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
344 # defined locally in source files will be included in the documentation.
345 # If set to NO only classes defined in header files are included.
346
347 EXTRACT_LOCAL_CLASSES  = YES
348
349 # This flag is only useful for Objective-C code. When set to YES local
350 # methods, which are defined in the implementation section but not in
351 # the interface are included in the documentation.
352 # If set to NO (the default) only methods in the interface are included.
353
354 EXTRACT_LOCAL_METHODS  = NO
355
356 # If this flag is set to YES, the members of anonymous namespaces will be
357 # extracted and appear in the documentation as a namespace called
358 # 'anonymous_namespace{file}', where file will be replaced with the base
359 # name of the file that contains the anonymous namespace. By default
360 # anonymous namespaces are hidden.
361
362 EXTRACT_ANON_NSPACES   = NO
363
364 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
365 # undocumented members of documented classes, files or namespaces.
366 # If set to NO (the default) these members will be included in the
367 # various overviews, but no documentation section is generated.
368 # This option has no effect if EXTRACT_ALL is enabled.
369
370 HIDE_UNDOC_MEMBERS     = NO
371
372 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
373 # undocumented classes that are normally visible in the class hierarchy.
374 # If set to NO (the default) these classes will be included in the various
375 # overviews. This option has no effect if EXTRACT_ALL is enabled.
376
377 HIDE_UNDOC_CLASSES     = NO
378
379 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
380 # friend (class|struct|union) declarations.
381 # If set to NO (the default) these declarations will be included in the
382 # documentation.
383
384 HIDE_FRIEND_COMPOUNDS  = NO
385
386 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
387 # documentation blocks found inside the body of a function.
388 # If set to NO (the default) these blocks will be appended to the
389 # function's detailed documentation block.
390
391 HIDE_IN_BODY_DOCS      = NO
392
393 # The INTERNAL_DOCS tag determines if documentation
394 # that is typed after a \internal command is included. If the tag is set
395 # to NO (the default) then the documentation will be excluded.
396 # Set it to YES to include the internal documentation.
397
398 INTERNAL_DOCS          = NO
399
400 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
401 # file names in lower-case letters. If set to YES upper-case letters are also
402 # allowed. This is useful if you have classes or files whose names only differ
403 # in case and if your file system supports case sensitive file names. Windows
404 # and Mac users are advised to set this option to NO.
405
406 CASE_SENSE_NAMES       = YES
407
408 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
409 # will show members with their full class and namespace scopes in the
410 # documentation. If set to YES the scope will be hidden.
411
412 HIDE_SCOPE_NAMES       = NO
413
414 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
415 # will put a list of the files that are included by a file in the documentation
416 # of that file.
417
418 SHOW_INCLUDE_FILES     = YES
419
420 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
421 # will list include files with double quotes in the documentation
422 # rather than with sharp brackets.
423
424 FORCE_LOCAL_INCLUDES   = NO
425
426 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
427 # is inserted in the documentation for inline members.
428
429 INLINE_INFO            = YES
430
431 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
432 # will sort the (detailed) documentation of file and class members
433 # alphabetically by member name. If set to NO the members will appear in
434 # declaration order.
435
436 SORT_MEMBER_DOCS       = YES
437
438 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
439 # brief documentation of file, namespace and class members alphabetically
440 # by member name. If set to NO (the default) the members will appear in
441 # declaration order.
442
443 SORT_BRIEF_DOCS        = NO
444
445 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
446 # will sort the (brief and detailed) documentation of class members so that
447 # constructors and destructors are listed first. If set to NO (the default)
448 # the constructors will appear in the respective orders defined by
449 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
450 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
451 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
452
453 SORT_MEMBERS_CTORS_1ST = NO
454
455 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
456 # hierarchy of group names into alphabetical order. If set to NO (the default)
457 # the group names will appear in their defined order.
458
459 SORT_GROUP_NAMES       = NO
460
461 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
462 # sorted by fully-qualified names, including namespaces. If set to
463 # NO (the default), the class list will be sorted only by class name,
464 # not including the namespace part.
465 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
466 # Note: This option applies only to the class list, not to the
467 # alphabetical list.
468
469 SORT_BY_SCOPE_NAME     = NO
470
471 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
472 # do proper type resolution of all parameters of a function it will reject a
473 # match between the prototype and the implementation of a member function even
474 # if there is only one candidate or it is obvious which candidate to choose
475 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
476 # will still accept a match between prototype and implementation in such cases.
477
478 STRICT_PROTO_MATCHING  = NO
479
480 # The GENERATE_TODOLIST tag can be used to enable (YES) or
481 # disable (NO) the todo list. This list is created by putting \todo
482 # commands in the documentation.
483
484 GENERATE_TODOLIST      = YES
485
486 # The GENERATE_TESTLIST tag can be used to enable (YES) or
487 # disable (NO) the test list. This list is created by putting \test
488 # commands in the documentation.
489
490 GENERATE_TESTLIST      = YES
491
492 # The GENERATE_BUGLIST tag can be used to enable (YES) or
493 # disable (NO) the bug list. This list is created by putting \bug
494 # commands in the documentation.
495
496 GENERATE_BUGLIST       = YES
497
498 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
499 # disable (NO) the deprecated list. This list is created by putting
500 # \deprecated commands in the documentation.
501
502 GENERATE_DEPRECATEDLIST= YES
503
504 # The ENABLED_SECTIONS tag can be used to enable conditional
505 # documentation sections, marked by \if sectionname ... \endif.
506
507 ENABLED_SECTIONS       =
508
509 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
510 # the initial value of a variable or macro consists of for it to appear in
511 # the documentation. If the initializer consists of more lines than specified
512 # here it will be hidden. Use a value of 0 to hide initializers completely.
513 # The appearance of the initializer of individual variables and macros in the
514 # documentation can be controlled using \showinitializer or \hideinitializer
515 # command in the documentation regardless of this setting.
516
517 MAX_INITIALIZER_LINES  = 30
518
519 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
520 # at the bottom of the documentation of classes and structs. If set to YES the
521 # list will mention the files that were used to generate the documentation.
522
523 SHOW_USED_FILES        = YES
524
525 # If the sources in your project are distributed over multiple directories
526 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
527 # in the documentation. The default is NO.
528
529 SHOW_DIRECTORIES       = YES
530
531 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
532 # This will remove the Files entry from the Quick Index and from the
533 # Folder Tree View (if specified). The default is YES.
534
535 SHOW_FILES             = YES
536
537 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
538 # Namespaces page.
539 # This will remove the Namespaces entry from the Quick Index
540 # and from the Folder Tree View (if specified). The default is YES.
541
542 SHOW_NAMESPACES        = YES
543
544 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
545 # doxygen should invoke to get the current version for each file (typically from
546 # the version control system). Doxygen will invoke the program by executing (via
547 # popen()) the command <command> <input-file>, where <command> is the value of
548 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
549 # provided by doxygen. Whatever the program writes to standard output
550 # is used as the file version. See the manual for examples.
551
552 FILE_VERSION_FILTER    =
553
554 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
555 # by doxygen. The layout file controls the global structure of the generated
556 # output files in an output format independent way. The create the layout file
557 # that represents doxygen's defaults, run doxygen with the -l option.
558 # You can optionally specify a file name after the option, if omitted
559 # DoxygenLayout.xml will be used as the name of the layout file.
560
561 LAYOUT_FILE            =
562
563 # The CITE_BIB_FILES tag can be used to specify one or more bib files
564 # containing the references data. This must be a list of .bib files. The
565 # .bib extension is automatically appended if omitted. Using this command
566 # requires the bibtex tool to be installed. See also
567 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
568 # of the bibliography can be controlled using LATEX_BIB_STYLE.
569
570 CITE_BIB_FILES         =
571
572 #---------------------------------------------------------------------------
573 # configuration options related to warning and progress messages
574 #---------------------------------------------------------------------------
575
576 # The QUIET tag can be used to turn on/off the messages that are generated
577 # by doxygen. Possible values are YES and NO. If left blank NO is used.
578
579 QUIET                  = NO
580
581 # The WARNINGS tag can be used to turn on/off the warning messages that are
582 # generated by doxygen. Possible values are YES and NO. If left blank
583 # NO is used.
584
585 WARNINGS               = YES
586
587 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
588 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
589 # automatically be disabled.
590
591 WARN_IF_UNDOCUMENTED   = YES
592
593 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
594 # potential errors in the documentation, such as not documenting some
595 # parameters in a documented function, or documenting parameters that
596 # don't exist or using markup commands wrongly.
597
598 WARN_IF_DOC_ERROR      = YES
599
600 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
601 # functions that are documented, but have no documentation for their parameters
602 # or return value. If set to NO (the default) doxygen will only warn about
603 # wrong or incomplete parameter documentation, but not about the absence of
604 # documentation.
605
606 WARN_NO_PARAMDOC       = NO
607
608 # The WARN_FORMAT tag determines the format of the warning messages that
609 # doxygen can produce. The string should contain the $file, $line, and $text
610 # tags, which will be replaced by the file and line number from which the
611 # warning originated and the warning text. Optionally the format may contain
612 # $version, which will be replaced by the version of the file (if it could
613 # be obtained via FILE_VERSION_FILTER)
614
615 WARN_FORMAT            = "$file:$line: $text"
616
617 # The WARN_LOGFILE tag can be used to specify a file to which warning
618 # and error messages should be written. If left blank the output is written
619 # to stderr.
620
621 WARN_LOGFILE           =
622
623 #---------------------------------------------------------------------------
624 # configuration options related to the input files
625 #---------------------------------------------------------------------------
626
627 # The INPUT tag can be used to specify the files and/or directories that contain
628 # documented source files. You may enter file names like "myfile.cpp" or
629 # directories like "/usr/src/myproject". Separate the files or directories
630 # with spaces.
631
632 INPUT                  = data main lib tools include
633
634 # This tag can be used to specify the character encoding of the source files
635 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
636 # also the default input encoding. Doxygen uses libiconv (or the iconv built
637 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
638 # the list of possible encodings.
639
640 INPUT_ENCODING         = UTF-8
641
642 # If the value of the INPUT tag contains directories, you can use the
643 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
644 # and *.h) to filter out the source-files in the directories. If left
645 # blank the following patterns are tested:
646 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
647 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
648 # *.f90 *.f *.for *.vhd *.vhdl
649
650 FILE_PATTERNS          =
651
652 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
653 # should be searched for input files as well. Possible values are YES and NO.
654 # If left blank NO is used.
655
656 RECURSIVE              = YES
657
658 # The EXCLUDE tag can be used to specify files and/or directories that should
659 # excluded from the INPUT source files. This way you can easily exclude a
660 # subdirectory from a directory tree whose root is specified with the INPUT tag.
661 # Note that relative paths are relative to directory from which doxygen is run.
662
663 EXCLUDE                =
664
665 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
666 # directories that are symbolic links (a Unix file system feature) are excluded
667 # from the input.
668
669 EXCLUDE_SYMLINKS       = NO
670
671 # If the value of the INPUT tag contains directories, you can use the
672 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
673 # certain files from those directories. Note that the wildcards are matched
674 # against the file with absolute path, so to exclude all test directories
675 # for example use the pattern */test/*
676
677 EXCLUDE_PATTERNS       =
678
679 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
680 # (namespaces, classes, functions, etc.) that should be excluded from the
681 # output. The symbol name can be a fully qualified name, a word, or if the
682 # wildcard * is used, a substring. Examples: ANamespace, AClass,
683 # AClass::ANamespace, ANamespace::*Test
684
685 EXCLUDE_SYMBOLS        =
686
687 # The EXAMPLE_PATH tag can be used to specify one or more files or
688 # directories that contain example code fragments that are included (see
689 # the \include command).
690
691 EXAMPLE_PATH           =
692
693 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
694 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
695 # and *.h) to filter out the source-files in the directories. If left
696 # blank all files are included.
697
698 EXAMPLE_PATTERNS       =
699
700 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
701 # searched for input files to be used with the \include or \dontinclude
702 # commands irrespective of the value of the RECURSIVE tag.
703 # Possible values are YES and NO. If left blank NO is used.
704
705 EXAMPLE_RECURSIVE      = NO
706
707 # The IMAGE_PATH tag can be used to specify one or more files or
708 # directories that contain image that are included in the documentation (see
709 # the \image command).
710
711 IMAGE_PATH             =
712
713 # The INPUT_FILTER tag can be used to specify a program that doxygen should
714 # invoke to filter for each input file. Doxygen will invoke the filter program
715 # by executing (via popen()) the command <filter> <input-file>, where <filter>
716 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
717 # input file. Doxygen will then use the output that the filter program writes
718 # to standard output.
719 # If FILTER_PATTERNS is specified, this tag will be
720 # ignored.
721
722 INPUT_FILTER           =
723
724 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
725 # basis.
726 # Doxygen will compare the file name with each pattern and apply the
727 # filter if there is a match.
728 # The filters are a list of the form:
729 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
730 # info on how filters are used. If FILTER_PATTERNS is empty or if
731 # non of the patterns match the file name, INPUT_FILTER is applied.
732
733 FILTER_PATTERNS        =
734
735 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
736 # INPUT_FILTER) will be used to filter the input files when producing source
737 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
738
739 FILTER_SOURCE_FILES    = NO
740
741 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
742 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
743 # and it is also possible to disable source filtering for a specific pattern
744 # using *.ext= (so without naming a filter). This option only has effect when
745 # FILTER_SOURCE_FILES is enabled.
746
747 FILTER_SOURCE_PATTERNS =
748
749 #---------------------------------------------------------------------------
750 # configuration options related to source browsing
751 #---------------------------------------------------------------------------
752
753 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
754 # be generated. Documented entities will be cross-referenced with these sources.
755 # Note: To get rid of all source code in the generated output, make sure also
756 # VERBATIM_HEADERS is set to NO.
757
758 SOURCE_BROWSER         = NO
759
760 # Setting the INLINE_SOURCES tag to YES will include the body
761 # of functions and classes directly in the documentation.
762
763 INLINE_SOURCES         = NO
764
765 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
766 # doxygen to hide any special comment blocks from generated source code
767 # fragments. Normal C and C++ comments will always remain visible.
768
769 STRIP_CODE_COMMENTS    = YES
770
771 # If the REFERENCED_BY_RELATION tag is set to YES
772 # then for each documented function all documented
773 # functions referencing it will be listed.
774
775 REFERENCED_BY_RELATION = NO
776
777 # If the REFERENCES_RELATION tag is set to YES
778 # then for each documented function all documented entities
779 # called/used by that function will be listed.
780
781 REFERENCES_RELATION    = NO
782
783 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
784 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
785 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
786 # link to the source code.
787 # Otherwise they will link to the documentation.
788
789 REFERENCES_LINK_SOURCE = YES
790
791 # If the USE_HTAGS tag is set to YES then the references to source code
792 # will point to the HTML generated by the htags(1) tool instead of doxygen
793 # built-in source browser. The htags tool is part of GNU's global source
794 # tagging system (see http://www.gnu.org/software/global/global.html). You
795 # will need version 4.8.6 or higher.
796
797 USE_HTAGS              = NO
798
799 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
800 # will generate a verbatim copy of the header file for each class for
801 # which an include is specified. Set to NO to disable this.
802
803 VERBATIM_HEADERS       = YES
804
805 #---------------------------------------------------------------------------
806 # configuration options related to the alphabetical class index
807 #---------------------------------------------------------------------------
808
809 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
810 # of all compounds will be generated. Enable this if the project
811 # contains a lot of classes, structs, unions or interfaces.
812
813 ALPHABETICAL_INDEX     = YES
814
815 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
816 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
817 # in which this list will be split (can be a number in the range [1..20])
818
819 COLS_IN_ALPHA_INDEX    = 5
820
821 # In case all classes in a project start with a common prefix, all
822 # classes will be put under the same header in the alphabetical index.
823 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
824 # should be ignored while generating the index headers.
825
826 IGNORE_PREFIX          =
827
828 #---------------------------------------------------------------------------
829 # configuration options related to the HTML output
830 #---------------------------------------------------------------------------
831
832 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
833 # generate HTML output.
834
835 GENERATE_HTML          = YES
836
837 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
838 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
839 # put in front of it. If left blank `html' will be used as the default path.
840
841 HTML_OUTPUT            = html
842
843 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
844 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
845 # doxygen will generate files with .html extension.
846
847 HTML_FILE_EXTENSION    = .html
848
849 # The HTML_HEADER tag can be used to specify a personal HTML header for
850 # each generated HTML page. If it is left blank doxygen will generate a
851 # standard header. Note that when using a custom header you are responsible
852 #  for the proper inclusion of any scripts and style sheets that doxygen
853 # needs, which is dependent on the configuration options used.
854 # It is adviced to generate a default header using "doxygen -w html
855 # header.html footer.html stylesheet.css YourConfigFile" and then modify
856 # that header. Note that the header is subject to change so you typically
857 # have to redo this when upgrading to a newer version of doxygen or when
858 # changing the value of configuration settings such as GENERATE_TREEVIEW!
859
860 HTML_HEADER            =
861
862 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
863 # each generated HTML page. If it is left blank doxygen will generate a
864 # standard footer.
865
866 HTML_FOOTER            =
867
868 # If the HTML_TIMESTAMP tag is set to YES then the generated HTML documentation will contain the timesstamp.
869
870 HTML_TIMESTAMP         = NO
871
872 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
873 # style sheet that is used by each HTML page. It can be used to
874 # fine-tune the look of the HTML output. If the tag is left blank doxygen
875 # will generate a default style sheet. Note that doxygen will try to copy
876 # the style sheet file to the HTML output directory, so don't put your own
877 # stylesheet in the HTML output directory as well, or it will be erased!
878
879 HTML_STYLESHEET        =
880
881 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
882 # other source files which should be copied to the HTML output directory. Note
883 # that these files will be copied to the base HTML output directory. Use the
884 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
885 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
886 # the files will be copied as-is; there are no commands or markers available.
887
888 HTML_EXTRA_FILES       =
889
890 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
891 # Doxygen will adjust the colors in the stylesheet and background images
892 # according to this color. Hue is specified as an angle on a colorwheel,
893 # see http://en.wikipedia.org/wiki/Hue for more information.
894 # For instance the value 0 represents red, 60 is yellow, 120 is green,
895 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
896 # The allowed range is 0 to 359.
897
898 HTML_COLORSTYLE_HUE    = 220
899
900 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
901 # the colors in the HTML output. For a value of 0 the output will use
902 # grayscales only. A value of 255 will produce the most vivid colors.
903
904 HTML_COLORSTYLE_SAT    = 100
905
906 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
907 # the luminance component of the colors in the HTML output. Values below
908 # 100 gradually make the output lighter, whereas values above 100 make
909 # the output darker. The value divided by 100 is the actual gamma applied,
910 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
911 # and 100 does not change the gamma.
912
913 HTML_COLORSTYLE_GAMMA  = 80
914
915 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
916 # page will contain the date and time when the page was generated. Setting
917 # this to NO can help when comparing the output of multiple runs.
918
919 HTML_TIMESTAMP         = YES
920
921 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
922 # files or namespaces will be aligned in HTML using tables. If set to
923 # NO a bullet list will be used.
924
925 HTML_ALIGN_MEMBERS     = YES
926
927 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
928 # documentation will contain sections that can be hidden and shown after the
929 # page has loaded. For this to work a browser that supports
930 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
931 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
932
933 HTML_DYNAMIC_SECTIONS  = NO
934
935 # If the GENERATE_DOCSET tag is set to YES, additional index files
936 # will be generated that can be used as input for Apple's Xcode 3
937 # integrated development environment, introduced with OSX 10.5 (Leopard).
938 # To create a documentation set, doxygen will generate a Makefile in the
939 # HTML output directory. Running make will produce the docset in that
940 # directory and running "make install" will install the docset in
941 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
942 # it at startup.
943 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
944 # for more information.
945
946 GENERATE_DOCSET        = NO
947
948 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
949 # feed. A documentation feed provides an umbrella under which multiple
950 # documentation sets from a single provider (such as a company or product suite)
951 # can be grouped.
952
953 DOCSET_FEEDNAME        = "Doxygen generated docs"
954
955 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
956 # should uniquely identify the documentation set bundle. This should be a
957 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
958 # will append .docset to the name.
959
960 DOCSET_BUNDLE_ID       = org.doxygen.Project
961
962 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
963 # the documentation publisher. This should be a reverse domain-name style
964 # string, e.g. com.mycompany.MyDocSet.documentation.
965
966 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
967
968 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
969
970 DOCSET_PUBLISHER_NAME  = Publisher
971
972 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
973 # will be generated that can be used as input for tools like the
974 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
975 # of the generated HTML documentation.
976
977 GENERATE_HTMLHELP      = NO
978
979 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
980 # be used to specify the file name of the resulting .chm file. You
981 # can add a path in front of the file if the result should not be
982 # written to the html output directory.
983
984 CHM_FILE               =
985
986 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
987 # be used to specify the location (absolute path including file name) of
988 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
989 # the HTML help compiler on the generated index.hhp.
990
991 HHC_LOCATION           =
992
993 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
994 # controls if a separate .chi index file is generated (YES) or that
995 # it should be included in the master .chm file (NO).
996
997 GENERATE_CHI           = NO
998
999 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1000 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1001 # content.
1002
1003 CHM_INDEX_ENCODING     =
1004
1005 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1006 # controls whether a binary table of contents is generated (YES) or a
1007 # normal table of contents (NO) in the .chm file.
1008
1009 BINARY_TOC             = NO
1010
1011 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1012 # to the contents of the HTML help documentation and to the tree view.
1013
1014 TOC_EXPAND             = NO
1015
1016 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1017 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1018 # that can be used as input for Qt's qhelpgenerator to generate a
1019 # Qt Compressed Help (.qch) of the generated HTML documentation.
1020
1021 GENERATE_QHP           = NO
1022
1023 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1024 # be used to specify the file name of the resulting .qch file.
1025 # The path specified is relative to the HTML output folder.
1026
1027 QCH_FILE               =
1028
1029 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1030 # Qt Help Project output. For more information please see
1031 # http://doc.trolltech.com/qthelpproject.html#namespace
1032
1033 QHP_NAMESPACE          = org.doxygen.Project
1034
1035 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1036 # Qt Help Project output. For more information please see
1037 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1038
1039 QHP_VIRTUAL_FOLDER     = doc
1040
1041 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1042 # add. For more information please see
1043 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1044
1045 QHP_CUST_FILTER_NAME   =
1046
1047 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1048 # custom filter to add. For more information please see
1049 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1050 # Qt Help Project / Custom Filters</a>.
1051
1052 QHP_CUST_FILTER_ATTRS  =
1053
1054 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1055 # project's
1056 # filter section matches.
1057 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1058 # Qt Help Project / Filter Attributes</a>.
1059
1060 QHP_SECT_FILTER_ATTRS  =
1061
1062 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1063 # be used to specify the location of Qt's qhelpgenerator.
1064 # If non-empty doxygen will try to run qhelpgenerator on the generated
1065 # .qhp file.
1066
1067 QHG_LOCATION           =
1068
1069 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1070 #  will be generated, which together with the HTML files, form an Eclipse help
1071 # plugin. To install this plugin and make it available under the help contents
1072 # menu in Eclipse, the contents of the directory containing the HTML and XML
1073 # files needs to be copied into the plugins directory of eclipse. The name of
1074 # the directory within the plugins directory should be the same as
1075 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1076 # the help appears.
1077
1078 GENERATE_ECLIPSEHELP   = NO
1079
1080 # A unique identifier for the eclipse help plugin. When installing the plugin
1081 # the directory name containing the HTML and XML files should also have
1082 # this name.
1083
1084 ECLIPSE_DOC_ID         = org.doxygen.Project
1085
1086 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1087 # top of each HTML page. The value NO (the default) enables the index and
1088 # the value YES disables it.
1089
1090 DISABLE_INDEX          = NO
1091
1092 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1093 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1094 # documentation. Note that a value of 0 will completely suppress the enum
1095 # values from appearing in the overview section.
1096
1097 ENUM_VALUES_PER_LINE   = 4
1098
1099 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1100 # structure should be generated to display hierarchical information.
1101 # If the tag value is set to YES, a side panel will be generated
1102 # containing a tree-like index structure (just like the one that
1103 # is generated for HTML Help). For this to work a browser that supports
1104 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1105 # Windows users are probably better off using the HTML help feature.
1106
1107 GENERATE_TREEVIEW      = NO
1108
1109 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1110 # and Class Hierarchy pages using a tree view instead of an ordered list.
1111
1112 USE_INLINE_TREES       = NO
1113
1114 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1115 # used to set the initial width (in pixels) of the frame in which the tree
1116 # is shown.
1117
1118 TREEVIEW_WIDTH         = 250
1119
1120 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1121 # links to external symbols imported via tag files in a separate window.
1122
1123 EXT_LINKS_IN_WINDOW    = NO
1124
1125 # Use this tag to change the font size of Latex formulas included
1126 # as images in the HTML documentation. The default is 10. Note that
1127 # when you change the font size after a successful doxygen run you need
1128 # to manually remove any form_*.png images from the HTML output directory
1129 # to force them to be regenerated.
1130
1131 FORMULA_FONTSIZE       = 10
1132
1133 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1134 # generated for formulas are transparent PNGs. Transparent PNGs are
1135 # not supported properly for IE 6.0, but are supported on all modern browsers.
1136 # Note that when changing this option you need to delete any form_*.png files
1137 # in the HTML output before the changes have effect.
1138
1139 FORMULA_TRANSPARENT    = YES
1140
1141 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1142 # (see http://www.mathjax.org) which uses client side Javascript for the
1143 # rendering instead of using prerendered bitmaps. Use this if you do not
1144 # have LaTeX installed or if you want to formulas look prettier in the HTML
1145 # output. When enabled you also need to install MathJax separately and
1146 # configure the path to it using the MATHJAX_RELPATH option.
1147
1148 USE_MATHJAX            = NO
1149
1150 # When MathJax is enabled you need to specify the location relative to the
1151 # HTML output directory using the MATHJAX_RELPATH option. The destination
1152 # directory should contain the MathJax.js script. For instance, if the mathjax
1153 # directory is located at the same level as the HTML output directory, then
1154 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1155 # mathjax.org site, so you can quickly see the result without installing
1156 # MathJax, but it is strongly recommended to install a local copy of MathJax
1157 # before deployment.
1158
1159 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1160
1161 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1162 # names that should be enabled during MathJax rendering.
1163
1164 MATHJAX_EXTENSIONS     =
1165
1166 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1167 # for the HTML output. The underlying search engine uses javascript
1168 # and DHTML and should work on any modern browser. Note that when using
1169 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1170 # (GENERATE_DOCSET) there is already a search function so this one should
1171 # typically be disabled. For large projects the javascript based search engine
1172 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1173
1174 SEARCHENGINE           = YES
1175
1176 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1177 # implemented using a PHP enabled web server instead of at the web client
1178 # using Javascript. Doxygen will generate the search PHP script and index
1179 # file to put on the web server. The advantage of the server
1180 # based approach is that it scales better to large projects and allows
1181 # full text search. The disadvantages are that it is more difficult to setup
1182 # and does not have live searching capabilities.
1183
1184 SERVER_BASED_SEARCH    = NO
1185
1186 #---------------------------------------------------------------------------
1187 # configuration options related to the LaTeX output
1188 #---------------------------------------------------------------------------
1189
1190 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1191 # generate Latex output.
1192
1193 GENERATE_LATEX         = YES
1194
1195 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1196 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1197 # put in front of it. If left blank `latex' will be used as the default path.
1198
1199 LATEX_OUTPUT           = latex
1200
1201 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1202 # invoked. If left blank `latex' will be used as the default command name.
1203 # Note that when enabling USE_PDFLATEX this option is only used for
1204 # generating bitmaps for formulas in the HTML output, but not in the
1205 # Makefile that is written to the output directory.
1206
1207 LATEX_CMD_NAME         = latex
1208
1209 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1210 # generate index for LaTeX. If left blank `makeindex' will be used as the
1211 # default command name.
1212
1213 MAKEINDEX_CMD_NAME     = makeindex
1214
1215 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1216 # LaTeX documents. This may be useful for small projects and may help to
1217 # save some trees in general.
1218
1219 COMPACT_LATEX          = NO
1220
1221 # The PAPER_TYPE tag can be used to set the paper type that is used
1222 # by the printer. Possible values are: a4, letter, legal and
1223 # executive. If left blank a4wide will be used.
1224
1225 PAPER_TYPE             = a4
1226
1227 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1228 # packages that should be included in the LaTeX output.
1229
1230 EXTRA_PACKAGES         =
1231
1232 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1233 # the generated latex document. The header should contain everything until
1234 # the first chapter. If it is left blank doxygen will generate a
1235 # standard header. Notice: only use this tag if you know what you are doing!
1236
1237 LATEX_HEADER           =
1238
1239 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1240 # the generated latex document. The footer should contain everything after
1241 # the last chapter. If it is left blank doxygen will generate a
1242 # standard footer. Notice: only use this tag if you know what you are doing!
1243
1244 LATEX_FOOTER           =
1245
1246 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1247 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1248 # contain links (just like the HTML output) instead of page references
1249 # This makes the output suitable for online browsing using a pdf viewer.
1250
1251 PDF_HYPERLINKS         = YES
1252
1253 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1254 # plain latex in the generated Makefile. Set this option to YES to get a
1255 # higher quality PDF documentation.
1256
1257 USE_PDFLATEX           = YES
1258
1259 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1260 # command to the generated LaTeX files. This will instruct LaTeX to keep
1261 # running if errors occur, instead of asking the user for help.
1262 # This option is also used when generating formulas in HTML.
1263
1264 LATEX_BATCHMODE        = NO
1265
1266 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1267 # include the index chapters (such as File Index, Compound Index, etc.)
1268 # in the output.
1269
1270 LATEX_HIDE_INDICES     = NO
1271
1272 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1273 # source code with syntax highlighting in the LaTeX output.
1274 # Note that which sources are shown also depends on other settings
1275 # such as SOURCE_BROWSER.
1276
1277 LATEX_SOURCE_CODE      = NO
1278
1279 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1280 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1281 # http://en.wikipedia.org/wiki/BibTeX for more info.
1282
1283 LATEX_BIB_STYLE        = plain
1284
1285 #---------------------------------------------------------------------------
1286 # configuration options related to the RTF output
1287 #---------------------------------------------------------------------------
1288
1289 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1290 # The RTF output is optimized for Word 97 and may not look very pretty with
1291 # other RTF readers or editors.
1292
1293 GENERATE_RTF           = NO
1294
1295 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1296 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1297 # put in front of it. If left blank `rtf' will be used as the default path.
1298
1299 RTF_OUTPUT             = rtf
1300
1301 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1302 # RTF documents. This may be useful for small projects and may help to
1303 # save some trees in general.
1304
1305 COMPACT_RTF            = NO
1306
1307 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1308 # will contain hyperlink fields. The RTF file will
1309 # contain links (just like the HTML output) instead of page references.
1310 # This makes the output suitable for online browsing using WORD or other
1311 # programs which support those fields.
1312 # Note: wordpad (write) and others do not support links.
1313
1314 RTF_HYPERLINKS         = NO
1315
1316 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1317 # config file, i.e. a series of assignments. You only have to provide
1318 # replacements, missing definitions are set to their default value.
1319
1320 RTF_STYLESHEET_FILE    =
1321
1322 # Set optional variables used in the generation of an rtf document.
1323 # Syntax is similar to doxygen's config file.
1324
1325 RTF_EXTENSIONS_FILE    =
1326
1327 #---------------------------------------------------------------------------
1328 # configuration options related to the man page output
1329 #---------------------------------------------------------------------------
1330
1331 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1332 # generate man pages
1333
1334 GENERATE_MAN           = NO
1335
1336 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1337 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1338 # put in front of it. If left blank `man' will be used as the default path.
1339
1340 MAN_OUTPUT             = man
1341
1342 # The MAN_EXTENSION tag determines the extension that is added to
1343 # the generated man pages (default is the subroutine's section .3)
1344
1345 MAN_EXTENSION          = .3
1346
1347 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1348 # then it will generate one additional man file for each entity
1349 # documented in the real man page(s). These additional files
1350 # only source the real man page, but without them the man command
1351 # would be unable to find the correct page. The default is NO.
1352
1353 MAN_LINKS              = NO
1354
1355 #---------------------------------------------------------------------------
1356 # configuration options related to the XML output
1357 #---------------------------------------------------------------------------
1358
1359 # If the GENERATE_XML tag is set to YES Doxygen will
1360 # generate an XML file that captures the structure of
1361 # the code including all documentation.
1362
1363 GENERATE_XML           = NO
1364
1365 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1366 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1367 # put in front of it. If left blank `xml' will be used as the default path.
1368
1369 XML_OUTPUT             = xml
1370
1371 # The XML_SCHEMA tag can be used to specify an XML schema,
1372 # which can be used by a validating XML parser to check the
1373 # syntax of the XML files.
1374
1375 XML_SCHEMA             =
1376
1377 # The XML_DTD tag can be used to specify an XML DTD,
1378 # which can be used by a validating XML parser to check the
1379 # syntax of the XML files.
1380
1381 XML_DTD                =
1382
1383 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1384 # dump the program listings (including syntax highlighting
1385 # and cross-referencing information) to the XML output. Note that
1386 # enabling this will significantly increase the size of the XML output.
1387
1388 XML_PROGRAMLISTING     = YES
1389
1390 #---------------------------------------------------------------------------
1391 # configuration options for the AutoGen Definitions output
1392 #---------------------------------------------------------------------------
1393
1394 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1395 # generate an AutoGen Definitions (see autogen.sf.net) file
1396 # that captures the structure of the code including all
1397 # documentation. Note that this feature is still experimental
1398 # and incomplete at the moment.
1399
1400 GENERATE_AUTOGEN_DEF   = NO
1401
1402 #---------------------------------------------------------------------------
1403 # configuration options related to the Perl module output
1404 #---------------------------------------------------------------------------
1405
1406 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1407 # generate a Perl module file that captures the structure of
1408 # the code including all documentation. Note that this
1409 # feature is still experimental and incomplete at the
1410 # moment.
1411
1412 GENERATE_PERLMOD       = NO
1413
1414 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1415 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1416 # to generate PDF and DVI output from the Perl module output.
1417
1418 PERLMOD_LATEX          = NO
1419
1420 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1421 # nicely formatted so it can be parsed by a human reader.
1422 # This is useful
1423 # if you want to understand what is going on.
1424 # On the other hand, if this
1425 # tag is set to NO the size of the Perl module output will be much smaller
1426 # and Perl will parse it just the same.
1427
1428 PERLMOD_PRETTY         = YES
1429
1430 # The names of the make variables in the generated doxyrules.make file
1431 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1432 # This is useful so different doxyrules.make files included by the same
1433 # Makefile don't overwrite each other's variables.
1434
1435 PERLMOD_MAKEVAR_PREFIX =
1436
1437 #---------------------------------------------------------------------------
1438 # Configuration options related to the preprocessor
1439 #---------------------------------------------------------------------------
1440
1441 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1442 # evaluate all C-preprocessor directives found in the sources and include
1443 # files.
1444
1445 ENABLE_PREPROCESSING   = YES
1446
1447 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1448 # names in the source code. If set to NO (the default) only conditional
1449 # compilation will be performed. Macro expansion can be done in a controlled
1450 # way by setting EXPAND_ONLY_PREDEF to YES.
1451
1452 MACRO_EXPANSION        = NO
1453
1454 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1455 # then the macro expansion is limited to the macros specified with the
1456 # PREDEFINED and EXPAND_AS_DEFINED tags.
1457
1458 EXPAND_ONLY_PREDEF     = NO
1459
1460 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1461 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1462
1463 SEARCH_INCLUDES        = YES
1464
1465 # The INCLUDE_PATH tag can be used to specify one or more directories that
1466 # contain include files that are not input files but should be processed by
1467 # the preprocessor.
1468
1469 INCLUDE_PATH           =
1470
1471 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1472 # patterns (like *.h and *.hpp) to filter out the header-files in the
1473 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1474 # be used.
1475
1476 INCLUDE_FILE_PATTERNS  =
1477
1478 # The PREDEFINED tag can be used to specify one or more macro names that
1479 # are defined before the preprocessor is started (similar to the -D option of
1480 # gcc). The argument of the tag is a list of macros of the form: name
1481 # or name=definition (no spaces). If the definition and the = are
1482 # omitted =1 is assumed. To prevent a macro definition from being
1483 # undefined via #undef or recursively expanded use the := operator
1484 # instead of the = operator.
1485
1486 PREDEFINED             =
1487
1488 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1489 # this tag can be used to specify a list of macro names that should be expanded.
1490 # The macro definition that is found in the sources will be used.
1491 # Use the PREDEFINED tag if you want to use a different macro definition that
1492 # overrules the definition found in the source code.
1493
1494 EXPAND_AS_DEFINED      =
1495
1496 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1497 # doxygen's preprocessor will remove all references to function-like macros
1498 # that are alone on a line, have an all uppercase name, and do not end with a
1499 # semicolon, because these will confuse the parser if not removed.
1500
1501 SKIP_FUNCTION_MACROS   = YES
1502
1503 #---------------------------------------------------------------------------
1504 # Configuration::additions related to external references
1505 #---------------------------------------------------------------------------
1506
1507 # The TAGFILES option can be used to specify one or more tagfiles.
1508 # Optionally an initial location of the external documentation
1509 # can be added for each tagfile. The format of a tag file without
1510 # this location is as follows:
1511 #
1512 # TAGFILES = file1 file2 ...
1513 # Adding location for the tag files is done as follows:
1514 #
1515 # TAGFILES = file1=loc1 "file2 = loc2" ...
1516 # where "loc1" and "loc2" can be relative or absolute paths or
1517 # URLs. If a location is present for each tag, the installdox tool
1518 # does not have to be run to correct the links.
1519 # Note that each tag file must have a unique name
1520 # (where the name does NOT include the path)
1521 # If a tag file is not located in the directory in which doxygen
1522 # is run, you must also specify the path to the tagfile here.
1523
1524 TAGFILES               =
1525
1526 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1527 # a tag file that is based on the input files it reads.
1528
1529 GENERATE_TAGFILE       =
1530
1531 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1532 # in the class index. If set to NO only the inherited external classes
1533 # will be listed.
1534
1535 ALLEXTERNALS           = NO
1536
1537 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1538 # in the modules index. If set to NO, only the current project's groups will
1539 # be listed.
1540
1541 EXTERNAL_GROUPS        = YES
1542
1543 # The PERL_PATH should be the absolute path and name of the perl script
1544 # interpreter (i.e. the result of `which perl').
1545
1546 PERL_PATH              = /usr/bin/perl
1547
1548 #---------------------------------------------------------------------------
1549 # Configuration options related to the dot tool
1550 #---------------------------------------------------------------------------
1551
1552 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1553 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1554 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1555 # this option also works with HAVE_DOT disabled, but it is recommended to
1556 # install and use dot, since it yields more powerful graphs.
1557
1558 CLASS_DIAGRAMS         = YES
1559
1560 # You can define message sequence charts within doxygen comments using the \msc
1561 # command. Doxygen will then run the mscgen tool (see
1562 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1563 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1564 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1565 # default search path.
1566
1567 MSCGEN_PATH            =
1568
1569 # If set to YES, the inheritance and collaboration graphs will hide
1570 # inheritance and usage relations if the target is undocumented
1571 # or is not a class.
1572
1573 HIDE_UNDOC_RELATIONS   = YES
1574
1575 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1576 # available from the path. This tool is part of Graphviz, a graph visualization
1577 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1578 # have no effect if this option is set to NO (the default)
1579
1580 HAVE_DOT               = YES
1581
1582 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1583 # allowed to run in parallel. When set to 0 (the default) doxygen will
1584 # base this on the number of processors available in the system. You can set it
1585 # explicitly to a value larger than 0 to get control over the balance
1586 # between CPU load and processing speed.
1587
1588 DOT_NUM_THREADS        = 0
1589
1590 # By default doxygen will use the Helvetica font for all dot files that
1591 # doxygen generates. When you want a differently looking font you can specify
1592 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1593 # the font, which can be done by putting it in a standard location or by setting
1594 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1595 # directory containing the font.
1596
1597 DOT_FONTNAME           = Helvetica
1598
1599 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1600 # The default size is 10pt.
1601
1602 DOT_FONTSIZE           = 10
1603
1604 # By default doxygen will tell dot to use the Helvetica font.
1605 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1606 # set the path where dot can find it.
1607
1608 DOT_FONTPATH           =
1609
1610 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1611 # will generate a graph for each documented class showing the direct and
1612 # indirect inheritance relations. Setting this tag to YES will force the
1613 # the CLASS_DIAGRAMS tag to NO.
1614
1615 CLASS_GRAPH            = YES
1616
1617 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1618 # will generate a graph for each documented class showing the direct and
1619 # indirect implementation dependencies (inheritance, containment, and
1620 # class references variables) of the class with other documented classes.
1621
1622 COLLABORATION_GRAPH    = YES
1623
1624 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1625 # will generate a graph for groups, showing the direct groups dependencies
1626
1627 GROUP_GRAPHS           = YES
1628
1629 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1630 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1631 # Language.
1632
1633 UML_LOOK               = NO
1634
1635 # If set to YES, the inheritance and collaboration graphs will show the
1636 # relations between templates and their instances.
1637
1638 TEMPLATE_RELATIONS     = NO
1639
1640 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1641 # tags are set to YES then doxygen will generate a graph for each documented
1642 # file showing the direct and indirect include dependencies of the file with
1643 # other documented files.
1644
1645 INCLUDE_GRAPH          = YES
1646
1647 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1648 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1649 # documented header file showing the documented files that directly or
1650 # indirectly include this file.
1651
1652 INCLUDED_BY_GRAPH      = YES
1653
1654 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1655 # doxygen will generate a call dependency graph for every global function
1656 # or class method. Note that enabling this option will significantly increase
1657 # the time of a run. So in most cases it will be better to enable call graphs
1658 # for selected functions only using the \callgraph command.
1659
1660 CALL_GRAPH             = YES
1661
1662 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1663 # doxygen will generate a caller dependency graph for every global function
1664 # or class method. Note that enabling this option will significantly increase
1665 # the time of a run. So in most cases it will be better to enable caller
1666 # graphs for selected functions only using the \callergraph command.
1667
1668 CALLER_GRAPH           = YES
1669
1670 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1671 # will generate a graphical hierarchy of all classes instead of a textual one.
1672
1673 GRAPHICAL_HIERARCHY    = YES
1674
1675 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1676 # then doxygen will show the dependencies a directory has on other directories
1677 # in a graphical way. The dependency relations are determined by the #include
1678 # relations between the files in the directories.
1679
1680 DIRECTORY_GRAPH        = YES
1681
1682 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1683 # generated by dot. Possible values are svg, png, jpg, or gif.
1684 # If left blank png will be used. If you choose svg you need to set
1685 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1686 # visible in IE 9+ (other browsers do not have this requirement).
1687
1688 DOT_IMAGE_FORMAT       = png
1689
1690 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1691 # enable generation of interactive SVG images that allow zooming and panning.
1692 # Note that this requires a modern browser other than Internet Explorer.
1693 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1694 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1695 # visible. Older versions of IE do not have SVG support.
1696
1697 INTERACTIVE_SVG        = NO
1698
1699 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1700 # found. If left blank, it is assumed the dot tool can be found in the path.
1701
1702 DOT_PATH               =
1703
1704 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1705 # contain dot files that are included in the documentation (see the
1706 # \dotfile command).
1707
1708 DOTFILE_DIRS           =
1709
1710 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1711 # contain msc files that are included in the documentation (see the
1712 # \mscfile command).
1713
1714 MSCFILE_DIRS           =
1715
1716 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1717 # nodes that will be shown in the graph. If the number of nodes in a graph
1718 # becomes larger than this value, doxygen will truncate the graph, which is
1719 # visualized by representing a node as a red box. Note that doxygen if the
1720 # number of direct children of the root node in a graph is already larger than
1721 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1722 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1723
1724 DOT_GRAPH_MAX_NODES    = 50
1725
1726 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1727 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1728 # from the root by following a path via at most 3 edges will be shown. Nodes
1729 # that lay further from the root node will be omitted. Note that setting this
1730 # option to 1 or 2 may greatly reduce the computation time needed for large
1731 # code bases. Also note that the size of a graph can be further restricted by
1732 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1733
1734 MAX_DOT_GRAPH_DEPTH    = 0
1735
1736 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1737 # background. This is disabled by default, because dot on Windows does not
1738 # seem to support this out of the box. Warning: Depending on the platform used,
1739 # enabling this option may lead to badly anti-aliased labels on the edges of
1740 # a graph (i.e. they become hard to read).
1741
1742 DOT_TRANSPARENT        = NO
1743
1744 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1745 # files in one run (i.e. multiple -o and -T options on the command line). This
1746 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1747 # support this, this feature is disabled by default.
1748
1749 DOT_MULTI_TARGETS      = NO
1750
1751 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1752 # generate a legend page explaining the meaning of the various boxes and
1753 # arrows in the dot generated graphs.
1754
1755 GENERATE_LEGEND        = YES
1756
1757 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1758 # remove the intermediate dot files that are used to generate
1759 # the various graphs.
1760
1761 DOT_CLEANUP            = YES