OSDN Git Service

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