Logo AND Algorithmique Numérique Distribuée

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