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