libfuse: add flags to ->rename()
[fuse.git] / doc / Doxyfile
blob16ce23a132619709107be6c47638f43982d4389a
1 # Doxyfile 1.5.6
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 
18 # that follow. The default is UTF-8 which is also the encoding used for all 
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 
20 # iconv built into libc) for the transcoding. See 
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
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           = fuse
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       = doc
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, Farsi, Finnish, French, German, Greek, 
58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 
59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 
60 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 
61 # and Ukrainian.
63 OUTPUT_LANGUAGE        = English
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
66 # include brief member descriptions after the members that are listed in 
67 # the file and class documentation (similar to JavaDoc). 
68 # Set to NO to disable this.
70 BRIEF_MEMBER_DESC      = YES
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
73 # the brief description of a member or function before the detailed description. 
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
75 # brief descriptions will be completely suppressed.
77 REPEAT_BRIEF           = YES
79 # This tag implements a quasi-intelligent brief description abbreviator 
80 # that is used to form the text in various listings. Each string 
81 # in this list, if found as the leading text of the brief description, will be 
82 # stripped from the text and the result after processing the whole list, is 
83 # used as the annotated text. Otherwise, the brief description is used as-is. 
84 # If left blank, the following values are used ("$name" is automatically 
85 # replaced with the name of the entity): "The $name class" "The $name widget" 
86 # "The $name file" "is" "provides" "specifies" "contains" 
87 # "represents" "a" "an" "the"
89 ABBREVIATE_BRIEF       = "The $name class" \
90                          "The $name widget" \
91                          "The $name file" \
92                          is \
93                          provides \
94                          specifies \
95                          contains \
96                          represents \
97                          a \
98                          an \
99                          the
101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
102 # Doxygen will generate a detailed section even if there is only a brief 
103 # description.
105 ALWAYS_DETAILED_SEC    = NO
107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
108 # inherited members of a class in the documentation of that class as if those 
109 # members were ordinary class members. Constructors, destructors and assignment 
110 # operators of the base classes will not be shown.
112 INLINE_INHERITED_MEMB  = NO
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
115 # path before files name in the file list and in the header files. If set 
116 # to NO the shortest path that makes the file name unique will be used.
118 FULL_PATH_NAMES        = YES
120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
121 # can be used to strip a user-defined part of the path. Stripping is 
122 # only done if one of the specified strings matches the left-hand part of 
123 # the path. The tag can be used to show relative paths in the file list. 
124 # If left blank the directory from which doxygen is run is used as the 
125 # path to strip.
127 STRIP_FROM_PATH        = 
129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
130 # the path mentioned in the documentation of a class, which tells 
131 # the reader which header file to include in order to use a class. 
132 # If left blank only the name of the header file containing the class 
133 # definition is used. Otherwise one should specify the include paths that 
134 # are normally passed to the compiler using the -I flag.
136 STRIP_FROM_INC_PATH    = 
138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
139 # (but less readable) file names. This can be useful is your file systems 
140 # doesn't support long names like on DOS, Mac, or CD-ROM.
142 SHORT_NAMES            = NO
144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
145 # will interpret the first line (until the first dot) of a JavaDoc-style 
146 # comment as the brief description. If set to NO, the JavaDoc 
147 # comments will behave just like regular Qt-style comments 
148 # (thus requiring an explicit @brief command for a brief description.)
150 JAVADOC_AUTOBRIEF      = NO
152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
153 # interpret the first line (until the first dot) of a Qt-style 
154 # comment as the brief description. If set to NO, the comments 
155 # will behave just like regular Qt-style comments (thus requiring 
156 # an explicit \brief command for a brief description.)
158 QT_AUTOBRIEF           = NO
160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
161 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
162 # comments) as a brief description. This used to be the default behaviour. 
163 # The new default is to treat a multi-line C++ comment block as a detailed 
164 # description. Set this tag to YES if you prefer the old behaviour instead.
166 MULTILINE_CPP_IS_BRIEF = NO
168 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 
169 # will output the detailed description near the top, like JavaDoc.
170 # If set to NO, the detailed description appears after the member 
171 # documentation.
173 DETAILS_AT_TOP         = NO
175 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
176 # member inherits the documentation from any documented member that it 
177 # re-implements.
179 INHERIT_DOCS           = YES
181 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
182 # a new page for each member. If set to NO, the documentation of a member will 
183 # be part of the file/class/namespace that contains it.
185 SEPARATE_MEMBER_PAGES  = NO
187 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
188 # Doxygen uses this value to replace tabs by spaces in code fragments.
190 TAB_SIZE               = 8
192 # This tag can be used to specify a number of aliases that acts 
193 # as commands in the documentation. An alias has the form "name=value". 
194 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
195 # put the command \sideeffect (or @sideeffect) in the documentation, which 
196 # will result in a user-defined paragraph with heading "Side Effects:". 
197 # You can put \n's in the value part of an alias to insert newlines.
199 ALIASES                = 
201 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
202 # sources only. Doxygen will then generate output that is more tailored for C. 
203 # For instance, some of the names that are used will be different. The list 
204 # of all members will be omitted, etc.
206 OPTIMIZE_OUTPUT_FOR_C  = YES
208 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
209 # sources only. Doxygen will then generate output that is more tailored for 
210 # Java. For instance, namespaces will be presented as packages, qualified 
211 # scopes will look different, etc.
213 OPTIMIZE_OUTPUT_JAVA   = NO
215 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
216 # sources only. Doxygen will then generate output that is more tailored for 
217 # Fortran.
219 OPTIMIZE_FOR_FORTRAN   = NO
221 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
222 # sources. Doxygen will then generate output that is tailored for 
223 # VHDL.
225 OPTIMIZE_OUTPUT_VHDL   = NO
227 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
228 # to include (a tag file for) the STL sources as input, then you should 
229 # set this tag to YES in order to let doxygen match functions declarations and 
230 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
231 # func(std::string) {}). This also make the inheritance and collaboration 
232 # diagrams that involve STL classes more complete and accurate.
234 BUILTIN_STL_SUPPORT    = NO
236 # If you use Microsoft's C++/CLI language, you should set this option to YES to
237 # enable parsing support.
239 CPP_CLI_SUPPORT        = NO
241 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
242 # Doxygen will parse them like normal C++ but will assume all classes use public 
243 # instead of private inheritance when no explicit protection keyword is present.
245 SIP_SUPPORT            = NO
247 # For Microsoft's IDL there are propget and propput attributes to indicate getter 
248 # and setter methods for a property. Setting this option to YES (the default) 
249 # will make doxygen to replace the get and set methods by a property in the 
250 # documentation. This will only work if the methods are indeed getting or 
251 # setting a simple type. If this is not the case, or you want to show the 
252 # methods anyway, you should set this option to NO.
254 IDL_PROPERTY_SUPPORT   = YES
256 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
257 # tag is set to YES, then doxygen will reuse the documentation of the first 
258 # member in the group (if any) for the other members of the group. By default 
259 # all members of a group must be documented explicitly.
261 DISTRIBUTE_GROUP_DOC   = NO
263 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
264 # the same type (for instance a group of public functions) to be put as a 
265 # subgroup of that type (e.g. under the Public Functions section). Set it to 
266 # NO to prevent subgrouping. Alternatively, this can be done per class using 
267 # the \nosubgrouping command.
269 SUBGROUPING            = YES
271 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
272 # is documented as struct, union, or enum with the name of the typedef. So 
273 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
274 # with name TypeT. When disabled the typedef will appear as a member of a file, 
275 # namespace, or class. And the struct will be named TypeS. This can typically 
276 # be useful for C code in case the coding convention dictates that all compound 
277 # types are typedef'ed and only the typedef is referenced, never the tag name.
279 TYPEDEF_HIDES_STRUCT   = NO
281 #---------------------------------------------------------------------------
282 # Build related configuration options
283 #---------------------------------------------------------------------------
285 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
286 # documentation are documented, even if no documentation was available. 
287 # Private class members and static file members will be hidden unless 
288 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
290 EXTRACT_ALL            = NO
292 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
293 # will be included in the documentation.
295 EXTRACT_PRIVATE        = NO
297 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
298 # will be included in the documentation.
300 EXTRACT_STATIC         = NO
302 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
303 # defined locally in source files will be included in the documentation. 
304 # If set to NO only classes defined in header files are included.
306 EXTRACT_LOCAL_CLASSES  = YES
308 # This flag is only useful for Objective-C code. When set to YES local 
309 # methods, which are defined in the implementation section but not in 
310 # the interface are included in the documentation. 
311 # If set to NO (the default) only methods in the interface are included.
313 EXTRACT_LOCAL_METHODS  = NO
315 # If this flag is set to YES, the members of anonymous namespaces will be 
316 # extracted and appear in the documentation as a namespace called 
317 # 'anonymous_namespace{file}', where file will be replaced with the base 
318 # name of the file that contains the anonymous namespace. By default 
319 # anonymous namespace are hidden.
321 EXTRACT_ANON_NSPACES   = NO
323 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
324 # undocumented members of documented classes, files or namespaces. 
325 # If set to NO (the default) these members will be included in the 
326 # various overviews, but no documentation section is generated. 
327 # This option has no effect if EXTRACT_ALL is enabled.
329 HIDE_UNDOC_MEMBERS     = YES
331 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
332 # undocumented classes that are normally visible in the class hierarchy. 
333 # If set to NO (the default) these classes will be included in the various 
334 # overviews. This option has no effect if EXTRACT_ALL is enabled.
336 HIDE_UNDOC_CLASSES     = YES
338 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
339 # friend (class|struct|union) declarations. 
340 # If set to NO (the default) these declarations will be included in the 
341 # documentation.
343 HIDE_FRIEND_COMPOUNDS  = NO
345 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
346 # documentation blocks found inside the body of a function. 
347 # If set to NO (the default) these blocks will be appended to the 
348 # function's detailed documentation block.
350 HIDE_IN_BODY_DOCS      = NO
352 # The INTERNAL_DOCS tag determines if documentation 
353 # that is typed after a \internal command is included. If the tag is set 
354 # to NO (the default) then the documentation will be excluded. 
355 # Set it to YES to include the internal documentation.
357 INTERNAL_DOCS          = NO
359 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
360 # file names in lower-case letters. If set to YES upper-case letters are also 
361 # allowed. This is useful if you have classes or files whose names only differ 
362 # in case and if your file system supports case sensitive file names. Windows 
363 # and Mac users are advised to set this option to NO.
365 CASE_SENSE_NAMES       = YES
367 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
368 # will show members with their full class and namespace scopes in the 
369 # documentation. If set to YES the scope will be hidden.
371 HIDE_SCOPE_NAMES       = NO
373 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
374 # will put a list of the files that are included by a file in the documentation 
375 # of that file.
377 SHOW_INCLUDE_FILES     = YES
379 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
380 # is inserted in the documentation for inline members.
382 INLINE_INFO            = YES
384 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
385 # will sort the (detailed) documentation of file and class members 
386 # alphabetically by member name. If set to NO the members will appear in 
387 # declaration order.
389 SORT_MEMBER_DOCS       = YES
391 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
392 # brief documentation of file, namespace and class members alphabetically 
393 # by member name. If set to NO (the default) the members will appear in 
394 # declaration order.
396 SORT_BRIEF_DOCS        = NO
398 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
399 # hierarchy of group names into alphabetical order. If set to NO (the default) 
400 # the group names will appear in their defined order.
402 SORT_GROUP_NAMES       = NO
404 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
405 # sorted by fully-qualified names, including namespaces. If set to 
406 # NO (the default), the class list will be sorted only by class name, 
407 # not including the namespace part. 
408 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
409 # Note: This option applies only to the class list, not to the 
410 # alphabetical list.
412 SORT_BY_SCOPE_NAME     = NO
414 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
415 # disable (NO) the todo list. This list is created by putting \todo 
416 # commands in the documentation.
418 GENERATE_TODOLIST      = YES
420 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
421 # disable (NO) the test list. This list is created by putting \test 
422 # commands in the documentation.
424 GENERATE_TESTLIST      = YES
426 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
427 # disable (NO) the bug list. This list is created by putting \bug 
428 # commands in the documentation.
430 GENERATE_BUGLIST       = YES
432 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
433 # disable (NO) the deprecated list. This list is created by putting 
434 # \deprecated commands in the documentation.
436 GENERATE_DEPRECATEDLIST= YES
438 # The ENABLED_SECTIONS tag can be used to enable conditional 
439 # documentation sections, marked by \if sectionname ... \endif.
441 ENABLED_SECTIONS       = 
443 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
444 # the initial value of a variable or define consists of for it to appear in 
445 # the documentation. If the initializer consists of more lines than specified 
446 # here it will be hidden. Use a value of 0 to hide initializers completely. 
447 # The appearance of the initializer of individual variables and defines in the 
448 # documentation can be controlled using \showinitializer or \hideinitializer 
449 # command in the documentation regardless of this setting.
451 MAX_INITIALIZER_LINES  = 30
453 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
454 # at the bottom of the documentation of classes and structs. If set to YES the 
455 # list will mention the files that were used to generate the documentation.
457 SHOW_USED_FILES        = YES
459 # If the sources in your project are distributed over multiple directories 
460 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
461 # in the documentation. The default is NO.
463 SHOW_DIRECTORIES       = NO
465 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
466 # This will remove the Files entry from the Quick Index and from the 
467 # Folder Tree View (if specified). The default is YES.
469 SHOW_FILES             = YES
471 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
472 # Namespaces page.  This will remove the Namespaces entry from the Quick Index
473 # and from the Folder Tree View (if specified). The default is YES.
475 SHOW_NAMESPACES        = YES
477 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
478 # doxygen should invoke to get the current version for each file (typically from 
479 # the version control system). Doxygen will invoke the program by executing (via 
480 # popen()) the command <command> <input-file>, where <command> is the value of 
481 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
482 # provided by doxygen. Whatever the program writes to standard output 
483 # is used as the file version. See the manual for examples.
485 FILE_VERSION_FILTER    = 
487 #---------------------------------------------------------------------------
488 # configuration options related to warning and progress messages
489 #---------------------------------------------------------------------------
491 # The QUIET tag can be used to turn on/off the messages that are generated 
492 # by doxygen. Possible values are YES and NO. If left blank NO is used.
494 QUIET                  = NO
496 # The WARNINGS tag can be used to turn on/off the warning messages that are 
497 # generated by doxygen. Possible values are YES and NO. If left blank 
498 # NO is used.
500 WARNINGS               = YES
502 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
503 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
504 # automatically be disabled.
506 WARN_IF_UNDOCUMENTED   = YES
508 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
509 # potential errors in the documentation, such as not documenting some 
510 # parameters in a documented function, or documenting parameters that 
511 # don't exist or using markup commands wrongly.
513 WARN_IF_DOC_ERROR      = YES
515 # This WARN_NO_PARAMDOC option can be abled to get warnings for 
516 # functions that are documented, but have no documentation for their parameters 
517 # or return value. If set to NO (the default) doxygen will only warn about 
518 # wrong or incomplete parameter documentation, but not about the absence of 
519 # documentation.
521 WARN_NO_PARAMDOC       = NO
523 # The WARN_FORMAT tag determines the format of the warning messages that 
524 # doxygen can produce. The string should contain the $file, $line, and $text 
525 # tags, which will be replaced by the file and line number from which the 
526 # warning originated and the warning text. Optionally the format may contain 
527 # $version, which will be replaced by the version of the file (if it could 
528 # be obtained via FILE_VERSION_FILTER)
530 WARN_FORMAT            = "$file:$line: $text"
532 # The WARN_LOGFILE tag can be used to specify a file to which warning 
533 # and error messages should be written. If left blank the output is written 
534 # to stderr.
536 WARN_LOGFILE           = 
538 #---------------------------------------------------------------------------
539 # configuration options related to the input files
540 #---------------------------------------------------------------------------
542 # The INPUT tag can be used to specify the files and/or directories that contain 
543 # documented source files. You may enter file names like "myfile.cpp" or 
544 # directories like "/usr/src/myproject". Separate the files or directories 
545 # with spaces.
547 INPUT                  = . ../include ../example ../lib
549 # This tag can be used to specify the character encoding of the source files 
550 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
551 # also the default input encoding. Doxygen uses libiconv (or the iconv built 
552 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
553 # the list of possible encodings.
555 INPUT_ENCODING         = UTF-8
557 # If the value of the INPUT tag contains directories, you can use the 
558 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
559 # and *.h) to filter out the source-files in the directories. If left 
560 # blank the following patterns are tested: 
561 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
562 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
564 FILE_PATTERNS          = *.h *.c *.h *.dox
566 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
567 # should be searched for input files as well. Possible values are YES and NO. 
568 # If left blank NO is used.
570 RECURSIVE              = YES
572 # The EXCLUDE tag can be used to specify files and/or directories that should 
573 # excluded from the INPUT source files. This way you can easily exclude a 
574 # subdirectory from a directory tree whose root is specified with the INPUT tag.
576 EXCLUDE                = 
578 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
579 # directories that are symbolic links (a Unix filesystem feature) are excluded 
580 # from the input.
582 EXCLUDE_SYMLINKS       = NO
584 # If the value of the INPUT tag contains directories, you can use the 
585 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
586 # certain files from those directories. Note that the wildcards are matched 
587 # against the file with absolute path, so to exclude all test directories 
588 # for example use the pattern */test/*
590 EXCLUDE_PATTERNS       = 
592 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
593 # (namespaces, classes, functions, etc.) that should be excluded from the 
594 # output. The symbol name can be a fully qualified name, a word, or if the 
595 # wildcard * is used, a substring. Examples: ANamespace, AClass, 
596 # AClass::ANamespace, ANamespace::*Test
598 EXCLUDE_SYMBOLS        = 
600 # The EXAMPLE_PATH tag can be used to specify one or more files or 
601 # directories that contain example code fragments that are included (see 
602 # the \include command).
604 EXAMPLE_PATH           = . ../example/ ../lib
606 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
607 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
608 # and *.h) to filter out the source-files in the directories. If left 
609 # blank all files are included.
611 EXAMPLE_PATTERNS       = *
613 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
614 # searched for input files to be used with the \include or \dontinclude 
615 # commands irrespective of the value of the RECURSIVE tag. 
616 # Possible values are YES and NO. If left blank NO is used.
618 EXAMPLE_RECURSIVE      = NO
620 # The IMAGE_PATH tag can be used to specify one or more files or 
621 # directories that contain image that are included in the documentation (see 
622 # the \image command).
624 IMAGE_PATH             = images/
626 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
627 # invoke to filter for each input file. Doxygen will invoke the filter program 
628 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
629 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
630 # input file. Doxygen will then use the output that the filter program writes 
631 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
632 # ignored.
634 INPUT_FILTER           = 
636 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
637 # basis.  Doxygen will compare the file name with each pattern and apply the 
638 # filter if there is a match.  The filters are a list of the form: 
639 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
640 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
641 # is applied to all files.
643 FILTER_PATTERNS        = 
645 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
646 # INPUT_FILTER) will be used to filter the input files when producing source 
647 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
649 FILTER_SOURCE_FILES    = NO
651 #---------------------------------------------------------------------------
652 # configuration options related to source browsing
653 #---------------------------------------------------------------------------
655 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
656 # be generated. Documented entities will be cross-referenced with these sources. 
657 # Note: To get rid of all source code in the generated output, make sure also 
658 # VERBATIM_HEADERS is set to NO.
660 SOURCE_BROWSER         = NO
662 # Setting the INLINE_SOURCES tag to YES will include the body 
663 # of functions and classes directly in the documentation.
665 INLINE_SOURCES         = NO
667 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
668 # doxygen to hide any special comment blocks from generated source code 
669 # fragments. Normal C and C++ comments will always remain visible.
671 STRIP_CODE_COMMENTS    = YES
673 # If the REFERENCED_BY_RELATION tag is set to YES 
674 # then for each documented function all documented 
675 # functions referencing it will be listed.
677 REFERENCED_BY_RELATION = NO
679 # If the REFERENCES_RELATION tag is set to YES 
680 # then for each documented function all documented entities 
681 # called/used by that function will be listed.
683 REFERENCES_RELATION    = NO
685 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
686 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
687 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
688 # link to the source code.  Otherwise they will link to the documentstion.
690 REFERENCES_LINK_SOURCE = YES
692 # If the USE_HTAGS tag is set to YES then the references to source code 
693 # will point to the HTML generated by the htags(1) tool instead of doxygen 
694 # built-in source browser. The htags tool is part of GNU's global source 
695 # tagging system (see http://www.gnu.org/software/global/global.html). You 
696 # will need version 4.8.6 or higher.
698 USE_HTAGS              = NO
700 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
701 # will generate a verbatim copy of the header file for each class for 
702 # which an include is specified. Set to NO to disable this.
704 VERBATIM_HEADERS       = NO
706 #---------------------------------------------------------------------------
707 # configuration options related to the alphabetical class index
708 #---------------------------------------------------------------------------
710 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
711 # of all compounds will be generated. Enable this if the project 
712 # contains a lot of classes, structs, unions or interfaces.
714 ALPHABETICAL_INDEX     = NO
716 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
717 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
718 # in which this list will be split (can be a number in the range [1..20])
720 COLS_IN_ALPHA_INDEX    = 5
722 # In case all classes in a project start with a common prefix, all 
723 # classes will be put under the same header in the alphabetical index. 
724 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
725 # should be ignored while generating the index headers.
727 IGNORE_PREFIX          = 
729 #---------------------------------------------------------------------------
730 # configuration options related to the HTML output
731 #---------------------------------------------------------------------------
733 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
734 # generate HTML output.
736 GENERATE_HTML          = YES
738 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
739 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
740 # put in front of it. If left blank `html' will be used as the default path.
742 HTML_OUTPUT            = html
744 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
745 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
746 # doxygen will generate files with .html extension.
748 HTML_FILE_EXTENSION    = .html
750 # The HTML_HEADER tag can be used to specify a personal HTML header for 
751 # each generated HTML page. If it is left blank doxygen will generate a 
752 # standard header.
754 HTML_HEADER            = 
756 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
757 # each generated HTML page. If it is left blank doxygen will generate a 
758 # standard footer.
760 HTML_FOOTER            = 
762 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
763 # style sheet that is used by each HTML page. It can be used to 
764 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
765 # will generate a default style sheet. Note that doxygen will try to copy 
766 # the style sheet file to the HTML output directory, so don't put your own 
767 # stylesheet in the HTML output directory as well, or it will be erased!
769 HTML_STYLESHEET        = 
771 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
772 # files or namespaces will be aligned in HTML using tables. If set to 
773 # NO a bullet list will be used.
775 HTML_ALIGN_MEMBERS     = YES
777 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
778 # will be generated that can be used as input for tools like the 
779 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
780 # of the generated HTML documentation.
782 GENERATE_HTMLHELP      = NO
784 # If the GENERATE_DOCSET tag is set to YES, additional index files 
785 # will be generated that can be used as input for Apple's Xcode 3 
786 # integrated development environment, introduced with OSX 10.5 (Leopard). 
787 # To create a documentation set, doxygen will generate a Makefile in the 
788 # HTML output directory. Running make will produce the docset in that 
789 # directory and running "make install" will install the docset in 
790 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
791 # it at startup.
793 GENERATE_DOCSET        = NO
795 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
796 # feed. A documentation feed provides an umbrella under which multiple 
797 # documentation sets from a single provider (such as a company or product suite) 
798 # can be grouped.
800 DOCSET_FEEDNAME        = "Doxygen generated docs"
802 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
803 # should uniquely identify the documentation set bundle. This should be a 
804 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
805 # will append .docset to the name.
807 DOCSET_BUNDLE_ID       = org.doxygen.Project
809 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
810 # documentation will contain sections that can be hidden and shown after the 
811 # page has loaded. For this to work a browser that supports 
812 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
813 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
815 HTML_DYNAMIC_SECTIONS  = NO
817 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
818 # be used to specify the file name of the resulting .chm file. You 
819 # can add a path in front of the file if the result should not be 
820 # written to the html output directory.
822 CHM_FILE               = 
824 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
825 # be used to specify the location (absolute path including file name) of 
826 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
827 # the HTML help compiler on the generated index.hhp.
829 HHC_LOCATION           = 
831 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
832 # controls if a separate .chi index file is generated (YES) or that 
833 # it should be included in the master .chm file (NO).
835 GENERATE_CHI           = NO
837 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
838 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
839 # content.
841 CHM_INDEX_ENCODING     = 
843 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
844 # controls whether a binary table of contents is generated (YES) or a 
845 # normal table of contents (NO) in the .chm file.
847 BINARY_TOC             = NO
849 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
850 # to the contents of the HTML help documentation and to the tree view.
852 TOC_EXPAND             = NO
854 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
855 # top of each HTML page. The value NO (the default) enables the index and 
856 # the value YES disables it.
858 DISABLE_INDEX          = NO
860 # This tag can be used to set the number of enum values (range [1..20]) 
861 # that doxygen will group on one line in the generated HTML documentation.
863 ENUM_VALUES_PER_LINE   = 4
865 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
866 # structure should be generated to display hierarchical information.
867 # If the tag value is set to FRAME, a side panel will be generated
868 # containing a tree-like index structure (just like the one that 
869 # is generated for HTML Help). For this to work a browser that supports 
870 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
871 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
872 # probably better off using the HTML help feature. Other possible values 
873 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
874 # and Class Hiererachy pages using a tree view instead of an ordered list;
875 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
876 # disables this behavior completely. For backwards compatibility with previous
877 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
878 # respectively.
880 GENERATE_TREEVIEW      = NO
882 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
883 # used to set the initial width (in pixels) of the frame in which the tree 
884 # is shown.
886 TREEVIEW_WIDTH         = 250
888 # Use this tag to change the font size of Latex formulas included 
889 # as images in the HTML documentation. The default is 10. Note that 
890 # when you change the font size after a successful doxygen run you need 
891 # to manually remove any form_*.png images from the HTML output directory 
892 # to force them to be regenerated.
894 FORMULA_FONTSIZE       = 10
896 #---------------------------------------------------------------------------
897 # configuration options related to the LaTeX output
898 #---------------------------------------------------------------------------
900 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
901 # generate Latex output.
903 GENERATE_LATEX         = NO
905 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
906 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
907 # put in front of it. If left blank `latex' will be used as the default path.
909 LATEX_OUTPUT           = latex
911 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
912 # invoked. If left blank `latex' will be used as the default command name.
914 LATEX_CMD_NAME         = latex
916 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
917 # generate index for LaTeX. If left blank `makeindex' will be used as the 
918 # default command name.
920 MAKEINDEX_CMD_NAME     = makeindex
922 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
923 # LaTeX documents. This may be useful for small projects and may help to 
924 # save some trees in general.
926 COMPACT_LATEX          = NO
928 # The PAPER_TYPE tag can be used to set the paper type that is used 
929 # by the printer. Possible values are: a4, a4wide, letter, legal and 
930 # executive. If left blank a4wide will be used.
932 PAPER_TYPE             = a4wide
934 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
935 # packages that should be included in the LaTeX output.
937 EXTRA_PACKAGES         = 
939 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
940 # the generated latex document. The header should contain everything until 
941 # the first chapter. If it is left blank doxygen will generate a 
942 # standard header. Notice: only use this tag if you know what you are doing!
944 LATEX_HEADER           = 
946 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
947 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
948 # contain links (just like the HTML output) instead of page references 
949 # This makes the output suitable for online browsing using a pdf viewer.
951 PDF_HYPERLINKS         = NO
953 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
954 # plain latex in the generated Makefile. Set this option to YES to get a 
955 # higher quality PDF documentation.
957 USE_PDFLATEX           = NO
959 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
960 # command to the generated LaTeX files. This will instruct LaTeX to keep 
961 # running if errors occur, instead of asking the user for help. 
962 # This option is also used when generating formulas in HTML.
964 LATEX_BATCHMODE        = NO
966 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
967 # include the index chapters (such as File Index, Compound Index, etc.) 
968 # in the output.
970 LATEX_HIDE_INDICES     = NO
972 #---------------------------------------------------------------------------
973 # configuration options related to the RTF output
974 #---------------------------------------------------------------------------
976 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
977 # The RTF output is optimized for Word 97 and may not look very pretty with 
978 # other RTF readers or editors.
980 GENERATE_RTF           = NO
982 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
983 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
984 # put in front of it. If left blank `rtf' will be used as the default path.
986 RTF_OUTPUT             = rtf
988 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
989 # RTF documents. This may be useful for small projects and may help to 
990 # save some trees in general.
992 COMPACT_RTF            = NO
994 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
995 # will contain hyperlink fields. The RTF file will 
996 # contain links (just like the HTML output) instead of page references. 
997 # This makes the output suitable for online browsing using WORD or other 
998 # programs which support those fields. 
999 # Note: wordpad (write) and others do not support links.
1001 RTF_HYPERLINKS         = NO
1003 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
1004 # config file, i.e. a series of assignments. You only have to provide 
1005 # replacements, missing definitions are set to their default value.
1007 RTF_STYLESHEET_FILE    = 
1009 # Set optional variables used in the generation of an rtf document. 
1010 # Syntax is similar to doxygen's config file.
1012 RTF_EXTENSIONS_FILE    = 
1014 #---------------------------------------------------------------------------
1015 # configuration options related to the man page output
1016 #---------------------------------------------------------------------------
1018 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
1019 # generate man pages
1021 GENERATE_MAN           = NO
1023 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
1024 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1025 # put in front of it. If left blank `man' will be used as the default path.
1027 MAN_OUTPUT             = man
1029 # The MAN_EXTENSION tag determines the extension that is added to 
1030 # the generated man pages (default is the subroutine's section .3)
1032 MAN_EXTENSION          = .3
1034 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
1035 # then it will generate one additional man file for each entity 
1036 # documented in the real man page(s). These additional files 
1037 # only source the real man page, but without them the man command 
1038 # would be unable to find the correct page. The default is NO.
1040 MAN_LINKS              = NO
1042 #---------------------------------------------------------------------------
1043 # configuration options related to the XML output
1044 #---------------------------------------------------------------------------
1046 # If the GENERATE_XML tag is set to YES Doxygen will 
1047 # generate an XML file that captures the structure of 
1048 # the code including all documentation.
1050 GENERATE_XML           = NO
1052 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
1053 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1054 # put in front of it. If left blank `xml' will be used as the default path.
1056 XML_OUTPUT             = xml
1058 # The XML_SCHEMA tag can be used to specify an XML schema, 
1059 # which can be used by a validating XML parser to check the 
1060 # syntax of the XML files.
1062 XML_SCHEMA             = 
1064 # The XML_DTD tag can be used to specify an XML DTD, 
1065 # which can be used by a validating XML parser to check the 
1066 # syntax of the XML files.
1068 XML_DTD                = 
1070 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
1071 # dump the program listings (including syntax highlighting 
1072 # and cross-referencing information) to the XML output. Note that 
1073 # enabling this will significantly increase the size of the XML output.
1075 XML_PROGRAMLISTING     = YES
1077 #---------------------------------------------------------------------------
1078 # configuration options for the AutoGen Definitions output
1079 #---------------------------------------------------------------------------
1081 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
1082 # generate an AutoGen Definitions (see autogen.sf.net) file 
1083 # that captures the structure of the code including all 
1084 # documentation. Note that this feature is still experimental 
1085 # and incomplete at the moment.
1087 GENERATE_AUTOGEN_DEF   = NO
1089 #---------------------------------------------------------------------------
1090 # configuration options related to the Perl module output
1091 #---------------------------------------------------------------------------
1093 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
1094 # generate a Perl module file that captures the structure of 
1095 # the code including all documentation. Note that this 
1096 # feature is still experimental and incomplete at the 
1097 # moment.
1099 GENERATE_PERLMOD       = NO
1101 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
1102 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
1103 # to generate PDF and DVI output from the Perl module output.
1105 PERLMOD_LATEX          = NO
1107 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
1108 # nicely formatted so it can be parsed by a human reader.  This is useful 
1109 # if you want to understand what is going on.  On the other hand, if this 
1110 # tag is set to NO the size of the Perl module output will be much smaller 
1111 # and Perl will parse it just the same.
1113 PERLMOD_PRETTY         = YES
1115 # The names of the make variables in the generated doxyrules.make file 
1116 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1117 # This is useful so different doxyrules.make files included by the same 
1118 # Makefile don't overwrite each other's variables.
1120 PERLMOD_MAKEVAR_PREFIX = 
1122 #---------------------------------------------------------------------------
1123 # Configuration options related to the preprocessor   
1124 #---------------------------------------------------------------------------
1126 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1127 # evaluate all C-preprocessor directives found in the sources and include 
1128 # files.
1130 ENABLE_PREPROCESSING   = YES
1132 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1133 # names in the source code. If set to NO (the default) only conditional 
1134 # compilation will be performed. Macro expansion can be done in a controlled 
1135 # way by setting EXPAND_ONLY_PREDEF to YES.
1137 MACRO_EXPANSION        = NO
1139 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1140 # then the macro expansion is limited to the macros specified with the 
1141 # PREDEFINED and EXPAND_AS_DEFINED tags.
1143 EXPAND_ONLY_PREDEF     = NO
1145 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1146 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1148 SEARCH_INCLUDES        = YES
1150 # The INCLUDE_PATH tag can be used to specify one or more directories that 
1151 # contain include files that are not input files but should be processed by 
1152 # the preprocessor.
1154 INCLUDE_PATH           = 
1156 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1157 # patterns (like *.h and *.hpp) to filter out the header-files in the 
1158 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
1159 # be used.
1161 INCLUDE_FILE_PATTERNS  = 
1163 # The PREDEFINED tag can be used to specify one or more macro names that 
1164 # are defined before the preprocessor is started (similar to the -D option of 
1165 # gcc). The argument of the tag is a list of macros of the form: name 
1166 # or name=definition (no spaces). If the definition and the = are 
1167 # omitted =1 is assumed. To prevent a macro definition from being 
1168 # undefined via #undef or recursively expanded use the := operator 
1169 # instead of the = operator.
1171 PREDEFINED             = 
1173 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1174 # this tag can be used to specify a list of macro names that should be expanded. 
1175 # The macro definition that is found in the sources will be used. 
1176 # Use the PREDEFINED tag if you want to use a different macro definition.
1178 EXPAND_AS_DEFINED      = 
1180 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1181 # doxygen's preprocessor will remove all function-like macros that are alone 
1182 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
1183 # function macros are typically used for boiler-plate code, and will confuse 
1184 # the parser if not removed.
1186 SKIP_FUNCTION_MACROS   = YES
1188 #---------------------------------------------------------------------------
1189 # Configuration::additions related to external references   
1190 #---------------------------------------------------------------------------
1192 # The TAGFILES option can be used to specify one or more tagfiles. 
1193 # Optionally an initial location of the external documentation 
1194 # can be added for each tagfile. The format of a tag file without 
1195 # this location is as follows: 
1196 #   TAGFILES = file1 file2 ... 
1197 # Adding location for the tag files is done as follows: 
1198 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
1199 # where "loc1" and "loc2" can be relative or absolute paths or 
1200 # URLs. If a location is present for each tag, the installdox tool 
1201 # does not have to be run to correct the links.
1202 # Note that each tag file must have a unique name
1203 # (where the name does NOT include the path)
1204 # If a tag file is not located in the directory in which doxygen 
1205 # is run, you must also specify the path to the tagfile here.
1207 TAGFILES               = 
1209 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1210 # a tag file that is based on the input files it reads.
1212 GENERATE_TAGFILE       = 
1214 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1215 # in the class index. If set to NO only the inherited external classes 
1216 # will be listed.
1218 ALLEXTERNALS           = NO
1220 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1221 # in the modules index. If set to NO, only the current project's groups will 
1222 # be listed.
1224 EXTERNAL_GROUPS        = YES
1226 # The PERL_PATH should be the absolute path and name of the perl script 
1227 # interpreter (i.e. the result of `which perl').
1229 PERL_PATH              = /usr/bin/perl
1231 #---------------------------------------------------------------------------
1232 # Configuration options related to the dot tool   
1233 #---------------------------------------------------------------------------
1235 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1236 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1237 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
1238 # this option is superseded by the HAVE_DOT option below. This is only a 
1239 # fallback. It is recommended to install and use dot, since it yields more 
1240 # powerful graphs.
1242 CLASS_DIAGRAMS         = NO
1244 # You can define message sequence charts within doxygen comments using the \msc 
1245 # command. Doxygen will then run the mscgen tool (see 
1246 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
1247 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 
1248 # the mscgen tool resides. If left empty the tool is assumed to be found in the 
1249 # default search path.
1251 MSCGEN_PATH            = 
1253 # If set to YES, the inheritance and collaboration graphs will hide 
1254 # inheritance and usage relations if the target is undocumented 
1255 # or is not a class.
1257 HIDE_UNDOC_RELATIONS   = YES
1259 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1260 # available from the path. This tool is part of Graphviz, a graph visualization 
1261 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1262 # have no effect if this option is set to NO (the default)
1264 HAVE_DOT               = NO
1266 # By default doxygen will write a font called FreeSans.ttf to the output 
1267 # directory and reference it in all dot files that doxygen generates. This 
1268 # font does not include all possible unicode characters however, so when you need 
1269 # these (or just want a differently looking font) you can specify the font name 
1270 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
1271 # which can be done by putting it in a standard location or by setting the 
1272 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
1273 # containing the font.
1275 DOT_FONTNAME           = FreeSans
1277 # By default doxygen will tell dot to use the output directory to look for the 
1278 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 
1279 # different font using DOT_FONTNAME you can set the path where dot 
1280 # can find it using this tag.
1282 DOT_FONTPATH           = 
1284 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1285 # will generate a graph for each documented class showing the direct and 
1286 # indirect inheritance relations. Setting this tag to YES will force the 
1287 # the CLASS_DIAGRAMS tag to NO.
1289 CLASS_GRAPH            = YES
1291 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1292 # will generate a graph for each documented class showing the direct and 
1293 # indirect implementation dependencies (inheritance, containment, and 
1294 # class references variables) of the class with other documented classes.
1296 COLLABORATION_GRAPH    = YES
1298 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1299 # will generate a graph for groups, showing the direct groups dependencies
1301 GROUP_GRAPHS           = YES
1303 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1304 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1305 # Language.
1307 UML_LOOK               = NO
1309 # If set to YES, the inheritance and collaboration graphs will show the 
1310 # relations between templates and their instances.
1312 TEMPLATE_RELATIONS     = NO
1314 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1315 # tags are set to YES then doxygen will generate a graph for each documented 
1316 # file showing the direct and indirect include dependencies of the file with 
1317 # other documented files.
1319 INCLUDE_GRAPH          = YES
1321 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1322 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1323 # documented header file showing the documented files that directly or 
1324 # indirectly include this file.
1326 INCLUDED_BY_GRAPH      = YES
1328 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 
1329 # doxygen will generate a call dependency graph for every global function 
1330 # or class method. Note that enabling this option will significantly increase 
1331 # the time of a run. So in most cases it will be better to enable call graphs 
1332 # for selected functions only using the \callgraph command.
1334 CALL_GRAPH             = NO
1336 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
1337 # doxygen will generate a caller dependency graph for every global function 
1338 # or class method. Note that enabling this option will significantly increase 
1339 # the time of a run. So in most cases it will be better to enable caller 
1340 # graphs for selected functions only using the \callergraph command.
1342 CALLER_GRAPH           = NO
1344 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1345 # will graphical hierarchy of all classes instead of a textual one.
1347 GRAPHICAL_HIERARCHY    = YES
1349 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1350 # then doxygen will show the dependencies a directory has on other directories 
1351 # in a graphical way. The dependency relations are determined by the #include
1352 # relations between the files in the directories.
1354 DIRECTORY_GRAPH        = YES
1356 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1357 # generated by dot. Possible values are png, jpg, or gif
1358 # If left blank png will be used.
1360 DOT_IMAGE_FORMAT       = png
1362 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1363 # found. If left blank, it is assumed the dot tool can be found in the path.
1365 DOT_PATH               = 
1367 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1368 # contain dot files that are included in the documentation (see the 
1369 # \dotfile command).
1371 DOTFILE_DIRS           = 
1373 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1374 # nodes that will be shown in the graph. If the number of nodes in a graph 
1375 # becomes larger than this value, doxygen will truncate the graph, which is 
1376 # visualized by representing a node as a red box. Note that doxygen if the 
1377 # number of direct children of the root node in a graph is already larger than 
1378 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
1379 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1381 DOT_GRAPH_MAX_NODES    = 50
1383 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1384 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
1385 # from the root by following a path via at most 3 edges will be shown. Nodes 
1386 # that lay further from the root node will be omitted. Note that setting this 
1387 # option to 1 or 2 may greatly reduce the computation time needed for large 
1388 # code bases. Also note that the size of a graph can be further restricted by 
1389 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1391 MAX_DOT_GRAPH_DEPTH    = 1000
1393 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1394 # background. This is enabled by default, which results in a transparent 
1395 # background. Warning: Depending on the platform used, enabling this option 
1396 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they 
1397 # become hard to read).
1399 DOT_TRANSPARENT        = NO
1401 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1402 # files in one run (i.e. multiple -o and -T options on the command line). This 
1403 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
1404 # support this, this feature is disabled by default.
1406 DOT_MULTI_TARGETS      = NO
1408 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1409 # generate a legend page explaining the meaning of the various boxes and 
1410 # arrows in the dot generated graphs.
1412 GENERATE_LEGEND        = YES
1414 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1415 # remove the intermediate dot files that are used to generate 
1416 # the various graphs.
1418 DOT_CLEANUP            = YES
1420 #---------------------------------------------------------------------------
1421 # Configuration::additions related to the search engine   
1422 #---------------------------------------------------------------------------
1424 # The SEARCHENGINE tag specifies whether or not a search engine should be 
1425 # used. If set to NO the values of all tags below this one will be ignored.
1427 SEARCHENGINE           = NO