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