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