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