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