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