Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
integrate the history to the build infrastructure
[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                          @srcdir@/history.doc \
473                          ./index-API.doc \
474                          \
475                          @srcdir@/modules.doc \
476                          @srcdir@/module-xbt.doc \
477                          @srcdir@/module-msg.doc \
478                          @srcdir@/module-gras.doc @srcdir@/module-amok.doc \
479                          @srcdir@/module-sd.doc \
480                          @srcdir@/module-surf.doc \
481                          \
482                          @srcdir@/gtut-main.doc \
483                             @srcdir@/gtut-introduction.doc \
484                             @srcdir@/gtut-tour.doc \
485                                 @srcdir@/gtut-tour-01-bones.doc \
486                                 @srcdir@/gtut-tour-02-simple.doc \
487                                 @srcdir@/gtut-tour-03-args.doc \
488                                 @srcdir@/gtut-tour-04-callback.doc \
489                                 @srcdir@/gtut-tour-05-globals.doc \
490                                 @srcdir@/gtut-tour-06-logs.doc \
491                                 @srcdir@/gtut-tour-07-timers.doc \
492                                 @srcdir@/gtut-tour-08-exceptions.doc \
493                                 @srcdir@/gtut-tour-09-simpledata.doc \
494                                 @srcdir@/gtut-tour-10-rpc.doc \
495                                 @srcdir@/gtut-tour-11-explicitwait.doc \
496                                 @srcdir@/gtut-tour-recap-messages.doc \
497                                 @srcdir@/gtut-tour-12-staticstruct.doc \
498                                 @srcdir@/gtut-tour-13-pointers.doc \
499                                 @srcdir@/gtut-tour-14-dynar.doc \
500                                 @srcdir@/gtut-tour-15-manualdatadef.doc \
501                                 @srcdir@/gtut-tour-16-exchangecb.doc \
502                             @srcdir@/gtut-howto.doc \
503                                 @srcdir@/gtut-howto-design.doc \
504                          \
505                          ./logcategories.doc \
506                          \
507                          @top_srcdir@/include/ \
508                          @top_srcdir@/include/msg \
509                          @top_srcdir@/include/gras \
510                          @top_srcdir@/include/amok \
511                          @top_srcdir@/include/xbt \
512                          @top_srcdir@/include/simdag \
513                          @top_srcdir@/src/include/surf \
514                          @top_srcdir@/src/xbt/ \
515                          @top_srcdir@/src/surf/ \
516                          @top_srcdir@/src/msg/ \
517                          @top_srcdir@/src/gras \
518                          @top_srcdir@/src/gras/DataDesc \
519                          @top_srcdir@/src/gras/Msg \
520                          @top_srcdir@/src/gras/Transport \
521                          @top_srcdir@/src/gras/Virtu \
522                          @top_srcdir@/src/amok \
523                          @top_srcdir@/src/amok/Bandwidth \
524                          @top_srcdir@/src/amok/PeerManagement \
525                          @top_srcdir@/src/simdag
526
527 # This tag can be used to specify the character encoding of the source files that 
528 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
529 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 
530 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
531
532 INPUT_ENCODING         = UTF-8
533
534 # If the value of the INPUT tag contains directories, you can use the 
535 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
536 # and *.h) to filter out the source-files in the directories. If left 
537 # blank the following patterns are tested: 
538 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
539 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
540
541 FILE_PATTERNS          = 
542
543 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
544 # should be searched for input files as well. Possible values are YES and NO. 
545 # If left blank NO is used.
546
547 RECURSIVE              = NO
548
549 # The EXCLUDE tag can be used to specify files and/or directories that should 
550 # excluded from the INPUT source files. This way you can easily exclude a 
551 # subdirectory from a directory tree whose root is specified with the INPUT tag.
552
553 EXCLUDE                = 
554
555 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
556 # directories that are symbolic links (a Unix filesystem feature) are excluded 
557 # from the input.
558
559 EXCLUDE_SYMLINKS       = NO
560
561 # If the value of the INPUT tag contains directories, you can use the 
562 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
563 # certain files from those directories. Note that the wildcards are matched 
564 # against the file with absolute path, so to exclude all test directories 
565 # for example use the pattern */test/*
566
567 EXCLUDE_PATTERNS       = 
568
569 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
570 # (namespaces, classes, functions, etc.) that should be excluded from the output. 
571 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 
572 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
573
574 EXCLUDE_SYMBOLS        = 
575
576 # The EXAMPLE_PATH tag can be used to specify one or more files or 
577 # directories that contain example code fragments that are included (see 
578 # the \include command).
579
580 EXAMPLE_PATH           = ./ \
581                          @top_srcdir@/doc/gtut-files \
582                          @top_srcdir@/src/surf/ \
583                          @top_srcdir@/src/xbt/ \
584                          @top_srcdir@/examples \
585                          @top_srcdir@/testsuite
586
587 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
588 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
589 # and *.h) to filter out the source-files in the directories. If left 
590 # blank all files are included.
591
592 EXAMPLE_PATTERNS       = 
593
594 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
595 # searched for input files to be used with the \include or \dontinclude 
596 # commands irrespective of the value of the RECURSIVE tag. 
597 # Possible values are YES and NO. If left blank NO is used.
598
599 EXAMPLE_RECURSIVE      = YES
600
601 # The IMAGE_PATH tag can be used to specify one or more files or 
602 # directories that contain image that are included in the documentation (see 
603 # the \image command).
604
605 IMAGE_PATH             = @top_srcdir@/doc
606
607 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
608 # invoke to filter for each input file. Doxygen will invoke the filter program 
609 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
610 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
611 # input file. Doxygen will then use the output that the filter program writes 
612 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
613 # ignored.
614
615 INPUT_FILTER           = 
616
617 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
618 # basis.  Doxygen will compare the file name with each pattern and apply the 
619 # filter if there is a match.  The filters are a list of the form: 
620 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
621 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
622 # is applied to all files.
623
624 FILTER_PATTERNS        = 
625
626 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
627 # INPUT_FILTER) will be used to filter the input files when producing source 
628 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
629
630 FILTER_SOURCE_FILES    = NO
631
632 #---------------------------------------------------------------------------
633 # configuration options related to source browsing
634 #---------------------------------------------------------------------------
635
636 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
637 # be generated. Documented entities will be cross-referenced with these sources. 
638 # Note: To get rid of all source code in the generated output, make sure also 
639 # VERBATIM_HEADERS is set to NO.
640
641 SOURCE_BROWSER         = NO
642
643 # Setting the INLINE_SOURCES tag to YES will include the body 
644 # of functions and classes directly in the documentation.
645
646 INLINE_SOURCES         = NO
647
648 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
649 # doxygen to hide any special comment blocks from generated source code 
650 # fragments. Normal C and C++ comments will always remain visible.
651
652 STRIP_CODE_COMMENTS    = YES
653
654 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
655 # then for each documented function all documented 
656 # functions referencing it will be listed.
657
658 REFERENCED_BY_RELATION = NO
659
660 # If the REFERENCES_RELATION tag is set to YES (the default) 
661 # then for each documented function all documented entities 
662 # called/used by that function will be listed.
663
664 REFERENCES_RELATION    = NO
665
666 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
667 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
668 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
669 # link to the source code.  Otherwise they will link to the documentstion.
670
671 REFERENCES_LINK_SOURCE = YES
672
673 # If the USE_HTAGS tag is set to YES then the references to source code 
674 # will point to the HTML generated by the htags(1) tool instead of doxygen 
675 # built-in source browser. The htags tool is part of GNU's global source 
676 # tagging system (see http://www.gnu.org/software/global/global.html). You 
677 # will need version 4.8.6 or higher.
678
679 USE_HTAGS              = NO
680
681 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
682 # will generate a verbatim copy of the header file for each class for 
683 # which an include is specified. Set to NO to disable this.
684
685 VERBATIM_HEADERS       = NO
686
687 #---------------------------------------------------------------------------
688 # configuration options related to the alphabetical class index
689 #---------------------------------------------------------------------------
690
691 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
692 # of all compounds will be generated. Enable this if the project 
693 # contains a lot of classes, structs, unions or interfaces.
694
695 ALPHABETICAL_INDEX     = NO
696
697 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
698 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
699 # in which this list will be split (can be a number in the range [1..20])
700
701 COLS_IN_ALPHA_INDEX    = 5
702
703 # In case all classes in a project start with a common prefix, all 
704 # classes will be put under the same header in the alphabetical index. 
705 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
706 # should be ignored while generating the index headers.
707
708 IGNORE_PREFIX          = 
709
710 #---------------------------------------------------------------------------
711 # configuration options related to the HTML output
712 #---------------------------------------------------------------------------
713
714 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
715 # generate HTML output.
716
717 GENERATE_HTML          = YES
718
719 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
720 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
721 # put in front of it. If left blank `html' will be used as the default path.
722
723 HTML_OUTPUT            = html
724
725 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
726 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
727 # doxygen will generate files with .html extension.
728
729 HTML_FILE_EXTENSION    = .html
730
731 # The HTML_HEADER tag can be used to specify a personal HTML header for 
732 # each generated HTML page. If it is left blank doxygen will generate a 
733 # standard header.
734
735 HTML_HEADER            = 
736
737 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
738 # each generated HTML page. If it is left blank doxygen will generate a 
739 # standard footer.
740
741 HTML_FOOTER            = @srcdir@/footer.html
742
743 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
744 # style sheet that is used by each HTML page. It can be used to 
745 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
746 # will generate a default style sheet. Note that doxygen will try to copy 
747 # the style sheet file to the HTML output directory, so don't put your own 
748 # stylesheet in the HTML output directory as well, or it will be erased!
749
750 HTML_STYLESHEET        = 
751
752 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
753 # files or namespaces will be aligned in HTML using tables. If set to 
754 # NO a bullet list will be used.
755
756 HTML_ALIGN_MEMBERS     = YES
757
758 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
759 # will be generated that can be used as input for tools like the 
760 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
761 # of the generated HTML documentation.
762
763 GENERATE_HTMLHELP      = NO
764
765 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
766 # be used to specify the file name of the resulting .chm file. You 
767 # can add a path in front of the file if the result should not be 
768 # written to the html output directory.
769
770 CHM_FILE               = 
771
772 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
773 # be used to specify the location (absolute path including file name) of 
774 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
775 # the HTML help compiler on the generated index.hhp.
776
777 HHC_LOCATION           = 
778
779 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
780 # controls if a separate .chi index file is generated (YES) or that 
781 # it should be included in the master .chm file (NO).
782
783 GENERATE_CHI           = NO
784
785 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
786 # controls whether a binary table of contents is generated (YES) or a 
787 # normal table of contents (NO) in the .chm file.
788
789 BINARY_TOC             = NO
790
791 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
792 # to the contents of the HTML help documentation and to the tree view.
793
794 TOC_EXPAND             = YES
795
796 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
797 # top of each HTML page. The value NO (the default) enables the index and 
798 # the value YES disables it.
799
800 DISABLE_INDEX          = NO
801
802 # This tag can be used to set the number of enum values (range [1..20]) 
803 # that doxygen will group on one line in the generated HTML documentation.
804
805 ENUM_VALUES_PER_LINE   = 4
806
807 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
808 # generated containing a tree-like index structure (just like the one that 
809 # is generated for HTML Help). For this to work a browser that supports 
810 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
811 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
812 # probably better off using the HTML help feature.
813
814 GENERATE_TREEVIEW      = NO
815
816 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
817 # used to set the initial width (in pixels) of the frame in which the tree 
818 # is shown.
819
820 TREEVIEW_WIDTH         = 250
821
822 #---------------------------------------------------------------------------
823 # configuration options related to the LaTeX output
824 #---------------------------------------------------------------------------
825
826 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
827 # generate Latex output.
828
829 GENERATE_LATEX         = NO
830
831 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
832 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
833 # put in front of it. If left blank `latex' will be used as the default path.
834
835 LATEX_OUTPUT           = latex
836
837 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
838 # invoked. If left blank `latex' will be used as the default command name.
839
840 LATEX_CMD_NAME         = latex
841
842 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
843 # generate index for LaTeX. If left blank `makeindex' will be used as the 
844 # default command name.
845
846 MAKEINDEX_CMD_NAME     = makeindex
847
848 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
849 # LaTeX documents. This may be useful for small projects and may help to 
850 # save some trees in general.
851
852 COMPACT_LATEX          = NO
853
854 # The PAPER_TYPE tag can be used to set the paper type that is used 
855 # by the printer. Possible values are: a4, a4wide, letter, legal and 
856 # executive. If left blank a4wide will be used.
857
858 PAPER_TYPE             = a4wide
859
860 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
861 # packages that should be included in the LaTeX output.
862
863 EXTRA_PACKAGES         = 
864
865 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
866 # the generated latex document. The header should contain everything until 
867 # the first chapter. If it is left blank doxygen will generate a 
868 # standard header. Notice: only use this tag if you know what you are doing!
869
870 LATEX_HEADER           = 
871
872 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
873 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
874 # contain links (just like the HTML output) instead of page references 
875 # This makes the output suitable for online browsing using a pdf viewer.
876
877 PDF_HYPERLINKS         = NO
878
879 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
880 # plain latex in the generated Makefile. Set this option to YES to get a 
881 # higher quality PDF documentation.
882
883 USE_PDFLATEX           = NO
884
885 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
886 # command to the generated LaTeX files. This will instruct LaTeX to keep 
887 # running if errors occur, instead of asking the user for help. 
888 # This option is also used when generating formulas in HTML.
889
890 LATEX_BATCHMODE        = NO
891
892 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
893 # include the index chapters (such as File Index, Compound Index, etc.) 
894 # in the output.
895
896 LATEX_HIDE_INDICES     = NO
897
898 #---------------------------------------------------------------------------
899 # configuration options related to the RTF output
900 #---------------------------------------------------------------------------
901
902 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
903 # The RTF output is optimized for Word 97 and may not look very pretty with 
904 # other RTF readers or editors.
905
906 GENERATE_RTF           = NO
907
908 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
909 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
910 # put in front of it. If left blank `rtf' will be used as the default path.
911
912 RTF_OUTPUT             = rtf
913
914 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
915 # RTF documents. This may be useful for small projects and may help to 
916 # save some trees in general.
917
918 COMPACT_RTF            = NO
919
920 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
921 # will contain hyperlink fields. The RTF file will 
922 # contain links (just like the HTML output) instead of page references. 
923 # This makes the output suitable for online browsing using WORD or other 
924 # programs which support those fields. 
925 # Note: wordpad (write) and others do not support links.
926
927 RTF_HYPERLINKS         = NO
928
929 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
930 # config file, i.e. a series of assignments. You only have to provide 
931 # replacements, missing definitions are set to their default value.
932
933 RTF_STYLESHEET_FILE    = 
934
935 # Set optional variables used in the generation of an rtf document. 
936 # Syntax is similar to doxygen's config file.
937
938 RTF_EXTENSIONS_FILE    = 
939
940 #---------------------------------------------------------------------------
941 # configuration options related to the man page output
942 #---------------------------------------------------------------------------
943
944 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
945 # generate man pages
946
947 GENERATE_MAN           = NO
948
949 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
950 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
951 # put in front of it. If left blank `man' will be used as the default path.
952
953 MAN_OUTPUT             = man
954
955 # The MAN_EXTENSION tag determines the extension that is added to 
956 # the generated man pages (default is the subroutine's section .3)
957
958 MAN_EXTENSION          = .3
959
960 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
961 # then it will generate one additional man file for each entity 
962 # documented in the real man page(s). These additional files 
963 # only source the real man page, but without them the man command 
964 # would be unable to find the correct page. The default is NO.
965
966 MAN_LINKS              = NO
967
968 #---------------------------------------------------------------------------
969 # configuration options related to the XML output
970 #---------------------------------------------------------------------------
971
972 # If the GENERATE_XML tag is set to YES Doxygen will 
973 # generate an XML file that captures the structure of 
974 # the code including all documentation.
975
976 GENERATE_XML           = NO
977
978 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
979 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
980 # put in front of it. If left blank `xml' will be used as the default path.
981
982 XML_OUTPUT             = xml
983
984 # The XML_SCHEMA tag can be used to specify an XML schema, 
985 # which can be used by a validating XML parser to check the 
986 # syntax of the XML files.
987
988 XML_SCHEMA             = 
989
990 # The XML_DTD tag can be used to specify an XML DTD, 
991 # which can be used by a validating XML parser to check the 
992 # syntax of the XML files.
993
994 XML_DTD                = 
995
996 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
997 # dump the program listings (including syntax highlighting 
998 # and cross-referencing information) to the XML output. Note that 
999 # enabling this will significantly increase the size of the XML output.
1000
1001 XML_PROGRAMLISTING     = YES
1002
1003 #---------------------------------------------------------------------------
1004 # configuration options for the AutoGen Definitions output
1005 #---------------------------------------------------------------------------
1006
1007 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
1008 # generate an AutoGen Definitions (see autogen.sf.net) file 
1009 # that captures the structure of the code including all 
1010 # documentation. Note that this feature is still experimental 
1011 # and incomplete at the moment.
1012
1013 GENERATE_AUTOGEN_DEF   = NO
1014
1015 #---------------------------------------------------------------------------
1016 # configuration options related to the Perl module output
1017 #---------------------------------------------------------------------------
1018
1019 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
1020 # generate a Perl module file that captures the structure of 
1021 # the code including all documentation. Note that this 
1022 # feature is still experimental and incomplete at the 
1023 # moment.
1024
1025 GENERATE_PERLMOD       = NO
1026
1027 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
1028 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
1029 # to generate PDF and DVI output from the Perl module output.
1030
1031 PERLMOD_LATEX          = NO
1032
1033 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
1034 # nicely formatted so it can be parsed by a human reader.  This is useful 
1035 # if you want to understand what is going on.  On the other hand, if this 
1036 # tag is set to NO the size of the Perl module output will be much smaller 
1037 # and Perl will parse it just the same.
1038
1039 PERLMOD_PRETTY         = YES
1040
1041 # The names of the make variables in the generated doxyrules.make file 
1042 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1043 # This is useful so different doxyrules.make files included by the same 
1044 # Makefile don't overwrite each other's variables.
1045
1046 PERLMOD_MAKEVAR_PREFIX = 
1047
1048 #---------------------------------------------------------------------------
1049 # Configuration options related to the preprocessor   
1050 #---------------------------------------------------------------------------
1051
1052 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1053 # evaluate all C-preprocessor directives found in the sources and include 
1054 # files.
1055
1056 ENABLE_PREPROCESSING   = YES
1057
1058 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1059 # names in the source code. If set to NO (the default) only conditional 
1060 # compilation will be performed. Macro expansion can be done in a controlled 
1061 # way by setting EXPAND_ONLY_PREDEF to YES.
1062
1063 MACRO_EXPANSION        = YES
1064
1065 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1066 # then the macro expansion is limited to the macros specified with the 
1067 # PREDEFINED and EXPAND_AS_DEFINED tags.
1068
1069 EXPAND_ONLY_PREDEF     = YES
1070
1071 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1072 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1073
1074 SEARCH_INCLUDES        = YES
1075
1076 # The INCLUDE_PATH tag can be used to specify one or more directories that 
1077 # contain include files that are not input files but should be processed by 
1078 # the preprocessor.
1079
1080 INCLUDE_PATH           = 
1081
1082 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1083 # patterns (like *.h and *.hpp) to filter out the header-files in the 
1084 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
1085 # be used.
1086
1087 INCLUDE_FILE_PATTERNS  = 
1088
1089 # The PREDEFINED tag can be used to specify one or more macro names that 
1090 # are defined before the preprocessor is started (similar to the -D option of 
1091 # gcc). The argument of the tag is a list of macros of the form: name 
1092 # or name=definition (no spaces). If the definition and the = are 
1093 # omitted =1 is assumed. To prevent a macro definition from being 
1094 # undefined via #undef or recursively expanded use the := operator 
1095 # instead of the = operator.
1096
1097 PREDEFINED             = DOXYGEN \
1098                          DOXYGEN_SKIP_IT \
1099                          XBT_PUBLIC=
1100
1101 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1102 # this tag can be used to specify a list of macro names that should be expanded. 
1103 # The macro definition that is found in the sources will be used. 
1104 # Use the PREDEFINED tag if you want to use a different macro definition.
1105
1106 EXPAND_AS_DEFINED      = 
1107
1108 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1109 # doxygen's preprocessor will remove all function-like macros that are alone 
1110 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
1111 # function macros are typically used for boiler-plate code, and will confuse 
1112 # the parser if not removed.
1113
1114 SKIP_FUNCTION_MACROS   = YES
1115
1116 #---------------------------------------------------------------------------
1117 # Configuration::additions related to external references   
1118 #---------------------------------------------------------------------------
1119
1120 # The TAGFILES option can be used to specify one or more tagfiles. 
1121 # Optionally an initial location of the external documentation 
1122 # can be added for each tagfile. The format of a tag file without 
1123 # this location is as follows: 
1124 #   TAGFILES = file1 file2 ... 
1125 # Adding location for the tag files is done as follows: 
1126 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
1127 # where "loc1" and "loc2" can be relative or absolute paths or 
1128 # URLs. If a location is present for each tag, the installdox tool 
1129 # does not have to be run to correct the links.
1130 # Note that each tag file must have a unique name
1131 # (where the name does NOT include the path)
1132 # If a tag file is not located in the directory in which doxygen 
1133 # is run, you must also specify the path to the tagfile here.
1134
1135 TAGFILES               = 
1136
1137 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1138 # a tag file that is based on the input files it reads.
1139
1140 GENERATE_TAGFILE       = simgrid.tag
1141
1142 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1143 # in the class index. If set to NO only the inherited external classes 
1144 # will be listed.
1145
1146 ALLEXTERNALS           = NO
1147
1148 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1149 # in the modules index. If set to NO, only the current project's groups will 
1150 # be listed.
1151
1152 EXTERNAL_GROUPS        = NO
1153
1154 # The PERL_PATH should be the absolute path and name of the perl script 
1155 # interpreter (i.e. the result of `which perl').
1156
1157 PERL_PATH              = /usr/bin/perl
1158
1159 #---------------------------------------------------------------------------
1160 # Configuration options related to the dot tool   
1161 #---------------------------------------------------------------------------
1162
1163 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1164 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1165 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
1166 # this option is superseded by the HAVE_DOT option below. This is only a 
1167 # fallback. It is recommended to install and use dot, since it yields more 
1168 # powerful graphs.
1169
1170 CLASS_DIAGRAMS         = YES
1171
1172 # You can define message sequence charts within doxygen comments using the \msc 
1173 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 
1174 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 
1175 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to 
1176 # be found in the default search path.
1177
1178 MSCGEN_PATH            = 
1179
1180 # If set to YES, the inheritance and collaboration graphs will hide 
1181 # inheritance and usage relations if the target is undocumented 
1182 # or is not a class.
1183
1184 HIDE_UNDOC_RELATIONS   = YES
1185
1186 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1187 # available from the path. This tool is part of Graphviz, a graph visualization 
1188 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1189 # have no effect if this option is set to NO (the default)
1190
1191 HAVE_DOT               = NO
1192
1193 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1194 # will generate a graph for each documented class showing the direct and 
1195 # indirect inheritance relations. Setting this tag to YES will force the 
1196 # the CLASS_DIAGRAMS tag to NO.
1197
1198 CLASS_GRAPH            = YES
1199
1200 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1201 # will generate a graph for each documented class showing the direct and 
1202 # indirect implementation dependencies (inheritance, containment, and 
1203 # class references variables) of the class with other documented classes.
1204
1205 COLLABORATION_GRAPH    = YES
1206
1207 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1208 # will generate a graph for groups, showing the direct groups dependencies
1209
1210 GROUP_GRAPHS           = YES
1211
1212 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1213 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1214 # Language.
1215
1216 UML_LOOK               = NO
1217
1218 # If set to YES, the inheritance and collaboration graphs will show the 
1219 # relations between templates and their instances.
1220
1221 TEMPLATE_RELATIONS     = YES
1222
1223 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1224 # tags are set to YES then doxygen will generate a graph for each documented 
1225 # file showing the direct and indirect include dependencies of the file with 
1226 # other documented files.
1227
1228 INCLUDE_GRAPH          = YES
1229
1230 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1231 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1232 # documented header file showing the documented files that directly or 
1233 # indirectly include this file.
1234
1235 INCLUDED_BY_GRAPH      = YES
1236
1237 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1238 # generate a call dependency graph for every global function or class method. 
1239 # Note that enabling this option will significantly increase the time of a run. 
1240 # So in most cases it will be better to enable call graphs for selected 
1241 # functions only using the \callgraph command.
1242
1243 CALL_GRAPH             = NO
1244
1245 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1246 # generate a caller dependency graph for every global function or class method. 
1247 # Note that enabling this option will significantly increase the time of a run. 
1248 # So in most cases it will be better to enable caller graphs for selected 
1249 # functions only using the \callergraph command.
1250
1251 CALLER_GRAPH           = NO
1252
1253 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1254 # will graphical hierarchy of all classes instead of a textual one.
1255
1256 GRAPHICAL_HIERARCHY    = YES
1257
1258 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1259 # then doxygen will show the dependencies a directory has on other directories 
1260 # in a graphical way. The dependency relations are determined by the #include
1261 # relations between the files in the directories.
1262
1263 DIRECTORY_GRAPH        = YES
1264
1265 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1266 # generated by dot. Possible values are png, jpg, or gif
1267 # If left blank png will be used.
1268
1269 DOT_IMAGE_FORMAT       = png
1270
1271 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1272 # found. If left blank, it is assumed the dot tool can be found in the path.
1273
1274 DOT_PATH               = 
1275
1276 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1277 # contain dot files that are included in the documentation (see the 
1278 # \dotfile command).
1279
1280 DOTFILE_DIRS           = 
1281
1282 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1283 # nodes that will be shown in the graph. If the number of nodes in a graph 
1284 # becomes larger than this value, doxygen will truncate the graph, which is 
1285 # visualized by representing a node as a red box. Note that doxygen will always 
1286 # show the root nodes and its direct children regardless of this setting.
1287
1288 DOT_GRAPH_MAX_NODES    = 50
1289
1290 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1291 # background. This is disabled by default, which results in a white background. 
1292 # Warning: Depending on the platform used, enabling this option may lead to 
1293 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
1294 # read).
1295
1296 DOT_TRANSPARENT        = NO
1297
1298 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1299 # files in one run (i.e. multiple -o and -T options on the command line). This 
1300 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
1301 # support this, this feature is disabled by default.
1302
1303 DOT_MULTI_TARGETS      = NO
1304
1305 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1306 # generate a legend page explaining the meaning of the various boxes and 
1307 # arrows in the dot generated graphs.
1308
1309 GENERATE_LEGEND        = YES
1310
1311 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1312 # remove the intermediate dot files that are used to generate 
1313 # the various graphs.
1314
1315 DOT_CLEANUP            = YES
1316
1317 #---------------------------------------------------------------------------
1318 # Configuration::additions related to the search engine   
1319 #---------------------------------------------------------------------------
1320
1321 # The SEARCHENGINE tag specifies whether or not a search engine should be 
1322 # used. If set to NO the values of all tags below this one will be ignored.
1323
1324 SEARCHENGINE           = NO