Logo AND Algorithmique Numérique Distribuée

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