chiark / gitweb /
plugins/tracklength-gstreamer.c: Rewrite to use `GstDiscoverer'.
[disorder] / Doxyfile
1 # Doxyfile 1.5.1
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 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
18 # by quotes) that should identify the project.
19
20 PROJECT_NAME           = DisOrder
21
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
23 # This could be handy for archiving the generated documentation or 
24 # if some version control system is used.
25
26 PROJECT_NUMBER         = 
27
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
29 # base path where the generated documentation will be put. 
30 # If a relative path is entered, it will be relative to the location 
31 # where doxygen was started. If left blank the current directory will be used.
32
33 OUTPUT_DIRECTORY       = doc/guts
34
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
36 # 4096 sub-directories (in 2 levels) under the output directory of each output 
37 # format and will distribute the generated files over these directories. 
38 # Enabling this option can be useful when feeding doxygen a huge amount of 
39 # source files, where putting all generated files in the same directory would 
40 # otherwise cause performance problems for the file system.
41
42 CREATE_SUBDIRS         = NO
43
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
45 # documentation generated by doxygen is written. Doxygen will use this 
46 # information to generate all constant output in the proper language. 
47 # The default language is English, other supported languages are: 
48 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
49 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
50 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 
51 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
52 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
53
54 OUTPUT_LANGUAGE        = English
55
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
57 # include brief member descriptions after the members that are listed in 
58 # the file and class documentation (similar to JavaDoc). 
59 # Set to NO to disable this.
60
61 BRIEF_MEMBER_DESC      = YES
62
63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
64 # the brief description of a member or function before the detailed description. 
65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
66 # brief descriptions will be completely suppressed.
67
68 REPEAT_BRIEF           = YES
69
70 # This tag implements a quasi-intelligent brief description abbreviator 
71 # that is used to form the text in various listings. Each string 
72 # in this list, if found as the leading text of the brief description, will be 
73 # stripped from the text and the result after processing the whole list, is 
74 # used as the annotated text. Otherwise, the brief description is used as-is. 
75 # If left blank, the following values are used ("$name" is automatically 
76 # replaced with the name of the entity): "The $name class" "The $name widget" 
77 # "The $name file" "is" "provides" "specifies" "contains" 
78 # "represents" "a" "an" "the"
79
80 ABBREVIATE_BRIEF       = 
81
82 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
83 # Doxygen will generate a detailed section even if there is only a brief 
84 # description.
85
86 ALWAYS_DETAILED_SEC    = NO
87
88 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
89 # inherited members of a class in the documentation of that class as if those 
90 # members were ordinary class members. Constructors, destructors and assignment 
91 # operators of the base classes will not be shown.
92
93 INLINE_INHERITED_MEMB  = NO
94
95 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
96 # path before files name in the file list and in the header files. If set 
97 # to NO the shortest path that makes the file name unique will be used.
98
99 FULL_PATH_NAMES        = NO
100
101 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
102 # can be used to strip a user-defined part of the path. Stripping is 
103 # only done if one of the specified strings matches the left-hand part of 
104 # the path. The tag can be used to show relative paths in the file list. 
105 # If left blank the directory from which doxygen is run is used as the 
106 # path to strip.
107
108 STRIP_FROM_PATH        = 
109
110 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
111 # the path mentioned in the documentation of a class, which tells 
112 # the reader which header file to include in order to use a class. 
113 # If left blank only the name of the header file containing the class 
114 # definition is used. Otherwise one should specify the include paths that 
115 # are normally passed to the compiler using the -I flag.
116
117 STRIP_FROM_INC_PATH    = 
118
119 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
120 # (but less readable) file names. This can be useful is your file systems 
121 # doesn't support long names like on DOS, Mac, or CD-ROM.
122
123 SHORT_NAMES            = NO
124
125 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
126 # will interpret the first line (until the first dot) of a JavaDoc-style 
127 # comment as the brief description. If set to NO, the JavaDoc 
128 # comments will behave just like the Qt-style comments (thus requiring an 
129 # explicit @brief command for a brief description.
130
131 JAVADOC_AUTOBRIEF      = NO
132
133 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
134 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
135 # comments) as a brief description. This used to be the default behaviour. 
136 # The new default is to treat a multi-line C++ comment block as a detailed 
137 # description. Set this tag to YES if you prefer the old behaviour instead.
138
139 MULTILINE_CPP_IS_BRIEF = NO
140
141 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
142 # member inherits the documentation from any documented member that it 
143 # re-implements.
144
145 INHERIT_DOCS           = YES
146
147 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
148 # a new page for each member. If set to NO, the documentation of a member will 
149 # be part of the file/class/namespace that contains it.
150
151 SEPARATE_MEMBER_PAGES  = NO
152
153 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
154 # Doxygen uses this value to replace tabs by spaces in code fragments.
155
156 TAB_SIZE               = 8
157
158 # This tag can be used to specify a number of aliases that acts 
159 # as commands in the documentation. An alias has the form "name=value". 
160 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
161 # put the command \sideeffect (or @sideeffect) in the documentation, which 
162 # will result in a user-defined paragraph with heading "Side Effects:". 
163 # You can put \n's in the value part of an alias to insert newlines.
164
165 ALIASES                = 
166
167 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
168 # sources only. Doxygen will then generate output that is more tailored for C. 
169 # For instance, some of the names that are used will be different. The list 
170 # of all members will be omitted, etc.
171
172 OPTIMIZE_OUTPUT_FOR_C  = YES
173
174 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
175 # sources only. Doxygen will then generate output that is more tailored for Java. 
176 # For instance, namespaces will be presented as packages, qualified scopes 
177 # will look different, etc.
178
179 OPTIMIZE_OUTPUT_JAVA   = NO
180
181 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
182 # include (a tag file for) the STL sources as input, then you should 
183 # set this tag to YES in order to let doxygen match functions declarations and 
184 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
185 # func(std::string) {}). This also make the inheritance and collaboration 
186 # diagrams that involve STL classes more complete and accurate.
187
188 BUILTIN_STL_SUPPORT    = NO
189
190 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
191 # tag is set to YES, then doxygen will reuse the documentation of the first 
192 # member in the group (if any) for the other members of the group. By default 
193 # all members of a group must be documented explicitly.
194
195 DISTRIBUTE_GROUP_DOC   = NO
196
197 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
198 # the same type (for instance a group of public functions) to be put as a 
199 # subgroup of that type (e.g. under the Public Functions section). Set it to 
200 # NO to prevent subgrouping. Alternatively, this can be done per class using 
201 # the \nosubgrouping command.
202
203 SUBGROUPING            = YES
204
205 #---------------------------------------------------------------------------
206 # Build related configuration options
207 #---------------------------------------------------------------------------
208
209 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
210 # documentation are documented, even if no documentation was available. 
211 # Private class members and static file members will be hidden unless 
212 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
213
214 EXTRACT_ALL            = YES
215
216 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
217 # will be included in the documentation.
218
219 EXTRACT_PRIVATE        = YES
220
221 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
222 # will be included in the documentation.
223
224 EXTRACT_STATIC         = YES
225
226 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
227 # defined locally in source files will be included in the documentation. 
228 # If set to NO only classes defined in header files are included.
229
230 EXTRACT_LOCAL_CLASSES  = YES
231
232 # This flag is only useful for Objective-C code. When set to YES local 
233 # methods, which are defined in the implementation section but not in 
234 # the interface are included in the documentation. 
235 # If set to NO (the default) only methods in the interface are included.
236
237 EXTRACT_LOCAL_METHODS  = YES
238
239 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
240 # undocumented members of documented classes, files or namespaces. 
241 # If set to NO (the default) these members will be included in the 
242 # various overviews, but no documentation section is generated. 
243 # This option has no effect if EXTRACT_ALL is enabled.
244
245 HIDE_UNDOC_MEMBERS     = NO
246
247 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
248 # undocumented classes that are normally visible in the class hierarchy. 
249 # If set to NO (the default) these classes will be included in the various 
250 # overviews. This option has no effect if EXTRACT_ALL is enabled.
251
252 HIDE_UNDOC_CLASSES     = NO
253
254 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
255 # friend (class|struct|union) declarations. 
256 # If set to NO (the default) these declarations will be included in the 
257 # documentation.
258
259 HIDE_FRIEND_COMPOUNDS  = NO
260
261 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
262 # documentation blocks found inside the body of a function. 
263 # If set to NO (the default) these blocks will be appended to the 
264 # function's detailed documentation block.
265
266 HIDE_IN_BODY_DOCS      = NO
267
268 # The INTERNAL_DOCS tag determines if documentation 
269 # that is typed after a \internal command is included. If the tag is set 
270 # to NO (the default) then the documentation will be excluded. 
271 # Set it to YES to include the internal documentation.
272
273 INTERNAL_DOCS          = YES
274
275 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
276 # file names in lower-case letters. If set to YES upper-case letters are also 
277 # allowed. This is useful if you have classes or files whose names only differ 
278 # in case and if your file system supports case sensitive file names. Windows 
279 # and Mac users are advised to set this option to NO.
280
281 CASE_SENSE_NAMES       = NO
282
283 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
284 # will show members with their full class and namespace scopes in the 
285 # documentation. If set to YES the scope will be hidden.
286
287 HIDE_SCOPE_NAMES       = YES
288
289 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
290 # will put a list of the files that are included by a file in the documentation 
291 # of that file.
292
293 SHOW_INCLUDE_FILES     = NO
294
295 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
296 # is inserted in the documentation for inline members.
297
298 INLINE_INFO            = YES
299
300 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
301 # will sort the (detailed) documentation of file and class members 
302 # alphabetically by member name. If set to NO the members will appear in 
303 # declaration order.
304
305 SORT_MEMBER_DOCS       = NO
306
307 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
308 # brief documentation of file, namespace and class members alphabetically 
309 # by member name. If set to NO (the default) the members will appear in 
310 # declaration order.
311
312 SORT_BRIEF_DOCS        = YES
313
314 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
315 # sorted by fully-qualified names, including namespaces. If set to 
316 # NO (the default), the class list will be sorted only by class name, 
317 # not including the namespace part. 
318 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
319 # Note: This option applies only to the class list, not to the 
320 # alphabetical list.
321
322 SORT_BY_SCOPE_NAME     = NO
323
324 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
325 # disable (NO) the todo list. This list is created by putting \todo 
326 # commands in the documentation.
327
328 GENERATE_TODOLIST      = YES
329
330 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
331 # disable (NO) the test list. This list is created by putting \test 
332 # commands in the documentation.
333
334 GENERATE_TESTLIST      = YES
335
336 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
337 # disable (NO) the bug list. This list is created by putting \bug 
338 # commands in the documentation.
339
340 GENERATE_BUGLIST       = YES
341
342 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
343 # disable (NO) the deprecated list. This list is created by putting 
344 # \deprecated commands in the documentation.
345
346 GENERATE_DEPRECATEDLIST= YES
347
348 # The ENABLED_SECTIONS tag can be used to enable conditional 
349 # documentation sections, marked by \if sectionname ... \endif.
350
351 ENABLED_SECTIONS       = 
352
353 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
354 # the initial value of a variable or define consists of for it to appear in 
355 # the documentation. If the initializer consists of more lines than specified 
356 # here it will be hidden. Use a value of 0 to hide initializers completely. 
357 # The appearance of the initializer of individual variables and defines in the 
358 # documentation can be controlled using \showinitializer or \hideinitializer 
359 # command in the documentation regardless of this setting.
360
361 MAX_INITIALIZER_LINES  = 30
362
363 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
364 # at the bottom of the documentation of classes and structs. If set to YES the 
365 # list will mention the files that were used to generate the documentation.
366
367 SHOW_USED_FILES        = NO
368
369 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
370 # doxygen should invoke to get the current version for each file (typically from the 
371 # version control system). Doxygen will invoke the program by executing (via 
372 # popen()) the command <command> <input-file>, where <command> is the value of 
373 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
374 # provided by doxygen. Whatever the program writes to standard output 
375 # is used as the file version. See the manual for examples.
376
377 FILE_VERSION_FILTER    = 
378
379 #---------------------------------------------------------------------------
380 # configuration options related to warning and progress messages
381 #---------------------------------------------------------------------------
382
383 # The QUIET tag can be used to turn on/off the messages that are generated 
384 # by doxygen. Possible values are YES and NO. If left blank NO is used.
385
386 QUIET                  = YES
387
388 # The WARNINGS tag can be used to turn on/off the warning messages that are 
389 # generated by doxygen. Possible values are YES and NO. If left blank 
390 # NO is used.
391
392 WARNINGS               = YES
393
394 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
395 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
396 # automatically be disabled.
397
398 WARN_IF_UNDOCUMENTED   = YES
399
400 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
401 # potential errors in the documentation, such as not documenting some 
402 # parameters in a documented function, or documenting parameters that 
403 # don't exist or using markup commands wrongly.
404
405 WARN_IF_DOC_ERROR      = YES
406
407 # This WARN_NO_PARAMDOC option can be abled to get warnings for 
408 # functions that are documented, but have no documentation for their parameters 
409 # or return value. If set to NO (the default) doxygen will only warn about 
410 # wrong or incomplete parameter documentation, but not about the absence of 
411 # documentation.
412
413 WARN_NO_PARAMDOC       = NO
414
415 # The WARN_FORMAT tag determines the format of the warning messages that 
416 # doxygen can produce. The string should contain the $file, $line, and $text 
417 # tags, which will be replaced by the file and line number from which the 
418 # warning originated and the warning text. Optionally the format may contain 
419 # $version, which will be replaced by the version of the file (if it could 
420 # be obtained via FILE_VERSION_FILTER)
421
422 WARN_FORMAT            = "$file:$line: $text"
423
424 # The WARN_LOGFILE tag can be used to specify a file to which warning 
425 # and error messages should be written. If left blank the output is written 
426 # to stderr.
427
428 WARN_LOGFILE           = 
429
430 #---------------------------------------------------------------------------
431 # configuration options related to the input files
432 #---------------------------------------------------------------------------
433
434 # The INPUT tag can be used to specify the files and/or directories that contain 
435 # documented source files. You may enter file names like "myfile.cpp" or 
436 # directories like "/usr/src/myproject". Separate the files or directories 
437 # with spaces.
438
439 INPUT                  = .
440
441 # If the value of the INPUT tag contains directories, you can use the 
442 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
443 # and *.h) to filter out the source-files in the directories. If left 
444 # blank the following patterns are tested: 
445 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
446 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
447
448 FILE_PATTERNS          = 
449
450 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
451 # should be searched for input files as well. Possible values are YES and NO. 
452 # If left blank NO is used.
453
454 RECURSIVE              = YES
455
456 # The EXCLUDE tag can be used to specify files and/or directories that should 
457 # excluded from the INPUT source files. This way you can easily exclude a 
458 # subdirectory from a directory tree whose root is specified with the INPUT tag.
459
460 EXCLUDE                = disobedience/images.h
461
462 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
463 # directories that are symbolic links (a Unix filesystem feature) are excluded 
464 # from the input.
465
466 EXCLUDE_SYMLINKS       = YES
467
468 # If the value of the INPUT tag contains directories, you can use the 
469 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
470 # certain files from those directories. Note that the wildcards are matched 
471 # against the file with absolute path, so to exclude all test directories 
472 # for example use the pattern */test/*
473
474 EXCLUDE_PATTERNS       = 
475
476 # The EXAMPLE_PATH tag can be used to specify one or more files or 
477 # directories that contain example code fragments that are included (see 
478 # the \include command).
479
480 EXAMPLE_PATH           = 
481
482 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
483 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
484 # and *.h) to filter out the source-files in the directories. If left 
485 # blank all files are included.
486
487 EXAMPLE_PATTERNS       = 
488
489 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
490 # searched for input files to be used with the \include or \dontinclude 
491 # commands irrespective of the value of the RECURSIVE tag. 
492 # Possible values are YES and NO. If left blank NO is used.
493
494 EXAMPLE_RECURSIVE      = NO
495
496 # The IMAGE_PATH tag can be used to specify one or more files or 
497 # directories that contain image that are included in the documentation (see 
498 # the \image command).
499
500 IMAGE_PATH             = 
501
502 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
503 # invoke to filter for each input file. Doxygen will invoke the filter program 
504 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
505 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
506 # input file. Doxygen will then use the output that the filter program writes 
507 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
508 # ignored.
509
510 INPUT_FILTER           = 
511
512 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
513 # basis.  Doxygen will compare the file name with each pattern and apply the 
514 # filter if there is a match.  The filters are a list of the form: 
515 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
516 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
517 # is applied to all files.
518
519 FILTER_PATTERNS        = 
520
521 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
522 # INPUT_FILTER) will be used to filter the input files when producing source 
523 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
524
525 FILTER_SOURCE_FILES    = NO
526
527 #---------------------------------------------------------------------------
528 # configuration options related to source browsing
529 #---------------------------------------------------------------------------
530
531 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
532 # be generated. Documented entities will be cross-referenced with these sources. 
533 # Note: To get rid of all source code in the generated output, make sure also 
534 # VERBATIM_HEADERS is set to NO.
535
536 SOURCE_BROWSER         = NO
537
538 # Setting the INLINE_SOURCES tag to YES will include the body 
539 # of functions and classes directly in the documentation.
540
541 INLINE_SOURCES         = NO
542
543 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
544 # doxygen to hide any special comment blocks from generated source code 
545 # fragments. Normal C and C++ comments will always remain visible.
546
547 STRIP_CODE_COMMENTS    = NO
548
549 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
550 # then for each documented function all documented 
551 # functions referencing it will be listed.
552
553 REFERENCED_BY_RELATION = NO
554
555 # If the REFERENCES_RELATION tag is set to YES (the default) 
556 # then for each documented function all documented entities 
557 # called/used by that function will be listed.
558
559 REFERENCES_RELATION    = NO
560
561 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
562 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
563 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
564 # link to the source code.  Otherwise they will link to the documentstion.
565
566 REFERENCES_LINK_SOURCE = YES
567
568 # If the USE_HTAGS tag is set to YES then the references to source code 
569 # will point to the HTML generated by the htags(1) tool instead of doxygen 
570 # built-in source browser. The htags tool is part of GNU's global source 
571 # tagging system (see http://www.gnu.org/software/global/global.html). You 
572 # will need version 4.8.6 or higher.
573
574 USE_HTAGS              = NO
575
576 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
577 # will generate a verbatim copy of the header file for each class for 
578 # which an include is specified. Set to NO to disable this.
579
580 VERBATIM_HEADERS       = YES
581
582 #---------------------------------------------------------------------------
583 # configuration options related to the alphabetical class index
584 #---------------------------------------------------------------------------
585
586 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
587 # of all compounds will be generated. Enable this if the project 
588 # contains a lot of classes, structs, unions or interfaces.
589
590 ALPHABETICAL_INDEX     = NO
591
592 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
593 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
594 # in which this list will be split (can be a number in the range [1..20])
595
596 COLS_IN_ALPHA_INDEX    = 5
597
598 # In case all classes in a project start with a common prefix, all 
599 # classes will be put under the same header in the alphabetical index. 
600 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
601 # should be ignored while generating the index headers.
602
603 IGNORE_PREFIX          = 
604
605 #---------------------------------------------------------------------------
606 # configuration options related to the HTML output
607 #---------------------------------------------------------------------------
608
609 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
610 # generate HTML output.
611
612 GENERATE_HTML          = YES
613
614 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
615 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
616 # put in front of it. If left blank `html' will be used as the default path.
617
618 HTML_OUTPUT            = html
619
620 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
621 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
622 # doxygen will generate files with .html extension.
623
624 HTML_FILE_EXTENSION    = .html
625
626 # The HTML_HEADER tag can be used to specify a personal HTML header for 
627 # each generated HTML page. If it is left blank doxygen will generate a 
628 # standard header.
629
630 HTML_HEADER            = 
631
632 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
633 # each generated HTML page. If it is left blank doxygen will generate a 
634 # standard footer.
635
636 HTML_FOOTER            = 
637
638 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
639 # style sheet that is used by each HTML page. It can be used to 
640 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
641 # will generate a default style sheet. Note that doxygen will try to copy 
642 # the style sheet file to the HTML output directory, so don't put your own 
643 # stylesheet in the HTML output directory as well, or it will be erased!
644
645 HTML_STYLESHEET        = 
646
647 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
648 # will be generated that can be used as input for tools like the 
649 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
650 # of the generated HTML documentation.
651
652 GENERATE_HTMLHELP      = NO
653
654 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
655 # be used to specify the file name of the resulting .chm file. You 
656 # can add a path in front of the file if the result should not be 
657 # written to the html output directory.
658
659 CHM_FILE               = 
660
661 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
662 # be used to specify the location (absolute path including file name) of 
663 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
664 # the HTML help compiler on the generated index.hhp.
665
666 HHC_LOCATION           = 
667
668 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
669 # controls if a separate .chi index file is generated (YES) or that 
670 # it should be included in the master .chm file (NO).
671
672 GENERATE_CHI           = NO
673
674 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
675 # controls whether a binary table of contents is generated (YES) or a 
676 # normal table of contents (NO) in the .chm file.
677
678 BINARY_TOC             = NO
679
680 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
681 # to the contents of the HTML help documentation and to the tree view.
682
683 TOC_EXPAND             = NO
684
685 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
686 # top of each HTML page. The value NO (the default) enables the index and 
687 # the value YES disables it.
688
689 DISABLE_INDEX          = NO
690
691 # This tag can be used to set the number of enum values (range [1..20]) 
692 # that doxygen will group on one line in the generated HTML documentation.
693
694 ENUM_VALUES_PER_LINE   = 4
695
696 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
697 # generated containing a tree-like index structure (just like the one that 
698 # is generated for HTML Help). For this to work a browser that supports 
699 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
700 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
701 # probably better off using the HTML help feature.
702
703 GENERATE_TREEVIEW      = NO
704
705 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
706 # used to set the initial width (in pixels) of the frame in which the tree 
707 # is shown.
708
709 TREEVIEW_WIDTH         = 250
710
711 #---------------------------------------------------------------------------
712 # configuration options related to the LaTeX output
713 #---------------------------------------------------------------------------
714
715 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
716 # generate Latex output.
717
718 GENERATE_LATEX         = NO
719
720 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
721 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
722 # put in front of it. If left blank `latex' will be used as the default path.
723
724 LATEX_OUTPUT           = latex
725
726 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
727 # invoked. If left blank `latex' will be used as the default command name.
728
729 LATEX_CMD_NAME         = latex
730
731 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
732 # generate index for LaTeX. If left blank `makeindex' will be used as the 
733 # default command name.
734
735 MAKEINDEX_CMD_NAME     = makeindex
736
737 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
738 # LaTeX documents. This may be useful for small projects and may help to 
739 # save some trees in general.
740
741 COMPACT_LATEX          = NO
742
743 # The PAPER_TYPE tag can be used to set the paper type that is used 
744 # by the printer. Possible values are: a4, a4wide, letter, legal and 
745 # executive. If left blank a4wide will be used.
746
747 PAPER_TYPE             = a4wide
748
749 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
750 # packages that should be included in the LaTeX output.
751
752 EXTRA_PACKAGES         = 
753
754 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
755 # the generated latex document. The header should contain everything until 
756 # the first chapter. If it is left blank doxygen will generate a 
757 # standard header. Notice: only use this tag if you know what you are doing!
758
759 LATEX_HEADER           = 
760
761 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
762 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
763 # contain links (just like the HTML output) instead of page references 
764 # This makes the output suitable for online browsing using a pdf viewer.
765
766 PDF_HYPERLINKS         = NO
767
768 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
769 # plain latex in the generated Makefile. Set this option to YES to get a 
770 # higher quality PDF documentation.
771
772 USE_PDFLATEX           = NO
773
774 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
775 # command to the generated LaTeX files. This will instruct LaTeX to keep 
776 # running if errors occur, instead of asking the user for help. 
777 # This option is also used when generating formulas in HTML.
778
779 LATEX_BATCHMODE        = NO
780
781 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
782 # include the index chapters (such as File Index, Compound Index, etc.) 
783 # in the output.
784
785 LATEX_HIDE_INDICES     = NO
786
787 #---------------------------------------------------------------------------
788 # configuration options related to the RTF output
789 #---------------------------------------------------------------------------
790
791 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
792 # The RTF output is optimized for Word 97 and may not look very pretty with 
793 # other RTF readers or editors.
794
795 GENERATE_RTF           = NO
796
797 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
798 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
799 # put in front of it. If left blank `rtf' will be used as the default path.
800
801 RTF_OUTPUT             = rtf
802
803 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
804 # RTF documents. This may be useful for small projects and may help to 
805 # save some trees in general.
806
807 COMPACT_RTF            = NO
808
809 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
810 # will contain hyperlink fields. The RTF file will 
811 # contain links (just like the HTML output) instead of page references. 
812 # This makes the output suitable for online browsing using WORD or other 
813 # programs which support those fields. 
814 # Note: wordpad (write) and others do not support links.
815
816 RTF_HYPERLINKS         = NO
817
818 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
819 # config file, i.e. a series of assignments. You only have to provide 
820 # replacements, missing definitions are set to their default value.
821
822 RTF_STYLESHEET_FILE    = 
823
824 # Set optional variables used in the generation of an rtf document. 
825 # Syntax is similar to doxygen's config file.
826
827 RTF_EXTENSIONS_FILE    = 
828
829 #---------------------------------------------------------------------------
830 # configuration options related to the man page output
831 #---------------------------------------------------------------------------
832
833 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
834 # generate man pages
835
836 GENERATE_MAN           = NO
837
838 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
839 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
840 # put in front of it. If left blank `man' will be used as the default path.
841
842 MAN_OUTPUT             = man
843
844 # The MAN_EXTENSION tag determines the extension that is added to 
845 # the generated man pages (default is the subroutine's section .3)
846
847 MAN_EXTENSION          = .3
848
849 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
850 # then it will generate one additional man file for each entity 
851 # documented in the real man page(s). These additional files 
852 # only source the real man page, but without them the man command 
853 # would be unable to find the correct page. The default is NO.
854
855 MAN_LINKS              = NO
856
857 #---------------------------------------------------------------------------
858 # configuration options related to the XML output
859 #---------------------------------------------------------------------------
860
861 # If the GENERATE_XML tag is set to YES Doxygen will 
862 # generate an XML file that captures the structure of 
863 # the code including all documentation.
864
865 GENERATE_XML           = NO
866
867 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
868 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
869 # put in front of it. If left blank `xml' will be used as the default path.
870
871 XML_OUTPUT             = xml
872
873 # The XML_SCHEMA tag can be used to specify an XML schema, 
874 # which can be used by a validating XML parser to check the 
875 # syntax of the XML files.
876
877 XML_SCHEMA             = 
878
879 # The XML_DTD tag can be used to specify an XML DTD, 
880 # which can be used by a validating XML parser to check the 
881 # syntax of the XML files.
882
883 XML_DTD                = 
884
885 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
886 # dump the program listings (including syntax highlighting 
887 # and cross-referencing information) to the XML output. Note that 
888 # enabling this will significantly increase the size of the XML output.
889
890 XML_PROGRAMLISTING     = YES
891
892 #---------------------------------------------------------------------------
893 # configuration options for the AutoGen Definitions output
894 #---------------------------------------------------------------------------
895
896 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
897 # generate an AutoGen Definitions (see autogen.sf.net) file 
898 # that captures the structure of the code including all 
899 # documentation. Note that this feature is still experimental 
900 # and incomplete at the moment.
901
902 GENERATE_AUTOGEN_DEF   = NO
903
904 #---------------------------------------------------------------------------
905 # configuration options related to the Perl module output
906 #---------------------------------------------------------------------------
907
908 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
909 # generate a Perl module file that captures the structure of 
910 # the code including all documentation. Note that this 
911 # feature is still experimental and incomplete at the 
912 # moment.
913
914 GENERATE_PERLMOD       = NO
915
916 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
917 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
918 # to generate PDF and DVI output from the Perl module output.
919
920 PERLMOD_LATEX          = NO
921
922 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
923 # nicely formatted so it can be parsed by a human reader.  This is useful 
924 # if you want to understand what is going on.  On the other hand, if this 
925 # tag is set to NO the size of the Perl module output will be much smaller 
926 # and Perl will parse it just the same.
927
928 PERLMOD_PRETTY         = YES
929
930 # The names of the make variables in the generated doxyrules.make file 
931 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
932 # This is useful so different doxyrules.make files included by the same 
933 # Makefile don't overwrite each other's variables.
934
935 PERLMOD_MAKEVAR_PREFIX = 
936
937 #---------------------------------------------------------------------------
938 # Configuration options related to the preprocessor   
939 #---------------------------------------------------------------------------
940
941 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
942 # evaluate all C-preprocessor directives found in the sources and include 
943 # files.
944
945 ENABLE_PREPROCESSING   = YES
946
947 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
948 # names in the source code. If set to NO (the default) only conditional 
949 # compilation will be performed. Macro expansion can be done in a controlled 
950 # way by setting EXPAND_ONLY_PREDEF to YES.
951
952 MACRO_EXPANSION        = YES
953
954 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
955 # then the macro expansion is limited to the macros specified with the 
956 # PREDEFINED and EXPAND_AS_DEFINED tags.
957
958 EXPAND_ONLY_PREDEF     = NO
959
960 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
961 # in the INCLUDE_PATH (see below) will be search if a #include is found.
962
963 SEARCH_INCLUDES        = YES
964
965 # The INCLUDE_PATH tag can be used to specify one or more directories that 
966 # contain include files that are not input files but should be processed by 
967 # the preprocessor.
968
969 INCLUDE_PATH           = 
970
971 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
972 # patterns (like *.h and *.hpp) to filter out the header-files in the 
973 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
974 # be used.
975
976 INCLUDE_FILE_PATTERNS  = 
977
978 # The PREDEFINED tag can be used to specify one or more macro names that 
979 # are defined before the preprocessor is started (similar to the -D option of 
980 # gcc). The argument of the tag is a list of macros of the form: name 
981 # or name=definition (no spaces). If the definition and the = are 
982 # omitted =1 is assumed. To prevent a macro definition from being 
983 # undefined via #undef or recursively expanded use the := operator 
984 # instead of the = operator.
985
986 PREDEFINED             = 
987
988 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
989 # this tag can be used to specify a list of macro names that should be expanded. 
990 # The macro definition that is found in the sources will be used. 
991 # Use the PREDEFINED tag if you want to use a different macro definition.
992
993 EXPAND_AS_DEFINED      = 
994
995 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
996 # doxygen's preprocessor will remove all function-like macros that are alone 
997 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
998 # function macros are typically used for boiler-plate code, and will confuse 
999 # the parser if not removed.
1000
1001 SKIP_FUNCTION_MACROS   = YES
1002
1003 #---------------------------------------------------------------------------
1004 # Configuration::additions related to external references   
1005 #---------------------------------------------------------------------------
1006
1007 # The TAGFILES option can be used to specify one or more tagfiles. 
1008 # Optionally an initial location of the external documentation 
1009 # can be added for each tagfile. The format of a tag file without 
1010 # this location is as follows: 
1011 #   TAGFILES = file1 file2 ... 
1012 # Adding location for the tag files is done as follows: 
1013 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
1014 # where "loc1" and "loc2" can be relative or absolute paths or 
1015 # URLs. If a location is present for each tag, the installdox tool 
1016 # does not have to be run to correct the links.
1017 # Note that each tag file must have a unique name
1018 # (where the name does NOT include the path)
1019 # If a tag file is not located in the directory in which doxygen 
1020 # is run, you must also specify the path to the tagfile here.
1021
1022 TAGFILES               = 
1023
1024 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1025 # a tag file that is based on the input files it reads.
1026
1027 GENERATE_TAGFILE       = 
1028
1029 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1030 # in the class index. If set to NO only the inherited external classes 
1031 # will be listed.
1032
1033 ALLEXTERNALS           = NO
1034
1035 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1036 # in the modules index. If set to NO, only the current project's groups will 
1037 # be listed.
1038
1039 EXTERNAL_GROUPS        = YES
1040
1041 # The PERL_PATH should be the absolute path and name of the perl script 
1042 # interpreter (i.e. the result of `which perl').
1043
1044 PERL_PATH              = /usr/bin/perl
1045
1046 #---------------------------------------------------------------------------
1047 # Configuration options related to the dot tool   
1048 #---------------------------------------------------------------------------
1049
1050 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1051 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1052 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
1053 # this option is superseded by the HAVE_DOT option below. This is only a 
1054 # fallback. It is recommended to install and use dot, since it yields more 
1055 # powerful graphs.
1056
1057 CLASS_DIAGRAMS         = YES
1058
1059 # If set to YES, the inheritance and collaboration graphs will hide 
1060 # inheritance and usage relations if the target is undocumented 
1061 # or is not a class.
1062
1063 HIDE_UNDOC_RELATIONS   = YES
1064
1065 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1066 # available from the path. This tool is part of Graphviz, a graph visualization 
1067 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1068 # have no effect if this option is set to NO (the default)
1069
1070 HAVE_DOT               = NO
1071
1072 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1073 # will generate a graph for each documented class showing the direct and 
1074 # indirect inheritance relations. Setting this tag to YES will force the 
1075 # the CLASS_DIAGRAMS tag to NO.
1076
1077 CLASS_GRAPH            = YES
1078
1079 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1080 # will generate a graph for each documented class showing the direct and 
1081 # indirect implementation dependencies (inheritance, containment, and 
1082 # class references variables) of the class with other documented classes.
1083
1084 COLLABORATION_GRAPH    = YES
1085
1086 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1087 # will generate a graph for groups, showing the direct groups dependencies
1088
1089 GROUP_GRAPHS           = YES
1090
1091 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1092 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1093 # Language.
1094
1095 UML_LOOK               = NO
1096
1097 # If set to YES, the inheritance and collaboration graphs will show the 
1098 # relations between templates and their instances.
1099
1100 TEMPLATE_RELATIONS     = NO
1101
1102 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1103 # tags are set to YES then doxygen will generate a graph for each documented 
1104 # file showing the direct and indirect include dependencies of the file with 
1105 # other documented files.
1106
1107 INCLUDE_GRAPH          = YES
1108
1109 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1110 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1111 # documented header file showing the documented files that directly or 
1112 # indirectly include this file.
1113
1114 INCLUDED_BY_GRAPH      = YES
1115
1116 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1117 # generate a call dependency graph for every global function or class method. 
1118 # Note that enabling this option will significantly increase the time of a run. 
1119 # So in most cases it will be better to enable call graphs for selected 
1120 # functions only using the \callgraph command.
1121
1122 CALL_GRAPH             = NO
1123
1124 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1125 # generate a caller dependency graph for every global function or class method. 
1126 # Note that enabling this option will significantly increase the time of a run. 
1127 # So in most cases it will be better to enable caller graphs for selected 
1128 # functions only using the \callergraph command.
1129
1130 CALLER_GRAPH           = NO
1131
1132 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1133 # will graphical hierarchy of all classes instead of a textual one.
1134
1135 GRAPHICAL_HIERARCHY    = YES
1136
1137 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1138 # then doxygen will show the dependencies a directory has on other directories 
1139 # in a graphical way. The dependency relations are determined by the #include
1140 # relations between the files in the directories.
1141
1142 DIRECTORY_GRAPH        = YES
1143
1144 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1145 # generated by dot. Possible values are png, jpg, or gif
1146 # If left blank png will be used.
1147
1148 DOT_IMAGE_FORMAT       = png
1149
1150 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1151 # found. If left blank, it is assumed the dot tool can be found in the path.
1152
1153 DOT_PATH               = 
1154
1155 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1156 # contain dot files that are included in the documentation (see the 
1157 # \dotfile command).
1158
1159 DOTFILE_DIRS           = 
1160
1161 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1162 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
1163 # from the root by following a path via at most 3 edges will be shown. Nodes 
1164 # that lay further from the root node will be omitted. Note that setting this 
1165 # option to 1 or 2 may greatly reduce the computation time needed for large 
1166 # code bases. Also note that a graph may be further truncated if the graph's 
1167 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
1168 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
1169 # the graph is not depth-constrained.
1170
1171 MAX_DOT_GRAPH_DEPTH    = 0
1172
1173 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1174 # background. This is disabled by default, which results in a white background. 
1175 # Warning: Depending on the platform used, enabling this option may lead to 
1176 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
1177 # read).
1178
1179 DOT_TRANSPARENT        = NO
1180
1181 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1182 # files in one run (i.e. multiple -o and -T options on the command line). This 
1183 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
1184 # support this, this feature is disabled by default.
1185
1186 DOT_MULTI_TARGETS      = NO
1187
1188 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1189 # generate a legend page explaining the meaning of the various boxes and 
1190 # arrows in the dot generated graphs.
1191
1192 GENERATE_LEGEND        = YES
1193
1194 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1195 # remove the intermediate dot files that are used to generate 
1196 # the various graphs.
1197
1198 DOT_CLEANUP            = YES
1199
1200 #---------------------------------------------------------------------------
1201 # Configuration::additions related to the search engine   
1202 #---------------------------------------------------------------------------
1203
1204 # The SEARCHENGINE tag specifies whether or not a search engine should be 
1205 # used. If set to NO the values of all tags below this one will be ignored.
1206
1207 SEARCHENGINE           = NO