Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Action replayer: don't hardcode the usage of raw contextes
[simgrid.git] / doc / Doxyfile.in
1
2 #               @WARNING@
3
4 # Doxyfile 1.7.4
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
21 # that follow. The default is UTF-8 which is also the encoding used for all
22 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
23 # iconv built into libc) for the transcoding. See
24 # http://www.gnu.org/software/libiconv for the list of 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 # Using the PROJECT_BRIEF tag one can provide an optional one line description
40 # for a project that appears at the top of each page and should give viewer
41 # a quick idea about the purpose of the project. Keep the description short.
42
43 PROJECT_BRIEF          =
44
45 # With the PROJECT_LOGO tag one can specify an logo or icon that is
46 # included in the documentation. The maximum height of the logo should not
47 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
48 # Doxygen will copy the logo to the output directory.
49
50 PROJECT_LOGO           =
51
52 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
53 # base path where the generated documentation will be put.
54 # If a relative path is entered, it will be relative to the location
55 # where doxygen was started. If left blank the current directory will be used.
56
57 OUTPUT_DIRECTORY       = ./
58
59 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
60 # 4096 sub-directories (in 2 levels) under the output directory of each output
61 # format and will distribute the generated files over these directories.
62 # Enabling this option can be useful when feeding doxygen a huge amount of
63 # source files, where putting all generated files in the same directory would
64 # otherwise cause performance problems for the file system.
65
66 CREATE_SUBDIRS         = NO
67
68 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
69 # documentation generated by doxygen is written. Doxygen will use this
70 # information to generate all constant output in the proper language.
71 # The default language is English, other supported languages are:
72 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
73 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
74 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
75 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
76 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
77 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
78
79 OUTPUT_LANGUAGE        = English
80
81 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
82 # include brief member descriptions after the members that are listed in
83 # the file and class documentation (similar to JavaDoc).
84 # Set to NO to disable this.
85
86 BRIEF_MEMBER_DESC      = YES
87
88 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
89 # the brief description of a member or function before the detailed description.
90 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
91 # brief descriptions will be completely suppressed.
92
93 REPEAT_BRIEF           = YES
94
95 # This tag implements a quasi-intelligent brief description abbreviator
96 # that is used to form the text in various listings. Each string
97 # in this list, if found as the leading text of the brief description, will be
98 # stripped from the text and the result after processing the whole list, is
99 # used as the annotated text. Otherwise, the brief description is used as-is.
100 # If left blank, the following values are used ("$name" is automatically
101 # replaced with the name of the entity): "The $name class" "The $name widget"
102 # "The $name file" "is" "provides" "specifies" "contains"
103 # "represents" "a" "an" "the"
104
105 ABBREVIATE_BRIEF       =
106
107 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
108 # Doxygen will generate a detailed section even if there is only a brief
109 # description.
110
111 ALWAYS_DETAILED_SEC    = NO
112
113 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
114 # inherited members of a class in the documentation of that class as if those
115 # members were ordinary class members. Constructors, destructors and assignment
116 # operators of the base classes will not be shown.
117
118 INLINE_INHERITED_MEMB  = YES
119
120 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
121 # path before files name in the file list and in the header files. If set
122 # to NO the shortest path that makes the file name unique will be used.
123
124 FULL_PATH_NAMES        = YES
125
126 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
127 # can be used to strip a user-defined part of the path. Stripping is
128 # only done if one of the specified strings matches the left-hand part of
129 # the path. The tag can be used to show relative paths in the file list.
130 # If left blank the directory from which doxygen is run is used as the
131 # path to strip.
132
133 STRIP_FROM_PATH        = @srcdir@
134
135 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
136 # the path mentioned in the documentation of a class, which tells
137 # the reader which header file to include in order to use a class.
138 # If left blank only the name of the header file containing the class
139 # definition is used. Otherwise one should specify the include paths that
140 # are normally passed to the compiler using the -I flag.
141
142 STRIP_FROM_INC_PATH    =
143
144 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145 # (but less readable) file names. This can be useful if your file system
146 # doesn't support long names like on DOS, Mac, or CD-ROM.
147
148 SHORT_NAMES            = NO
149
150 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
151 # will interpret the first line (until the first dot) of a JavaDoc-style
152 # comment as the brief description. If set to NO, the JavaDoc
153 # comments will behave just like regular Qt-style comments
154 # (thus requiring an explicit @brief command for a brief description.)
155
156 JAVADOC_AUTOBRIEF      = NO
157
158 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
159 # interpret the first line (until the first dot) of a Qt-style
160 # comment as the brief description. If set to NO, the comments
161 # will behave just like regular Qt-style comments (thus requiring
162 # an explicit \brief command for a brief description.)
163
164 QT_AUTOBRIEF           = NO
165
166 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
167 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
168 # comments) as a brief description. This used to be the default behaviour.
169 # The new default is to treat a multi-line C++ comment block as a detailed
170 # description. Set this tag to YES if you prefer the old behaviour instead.
171
172 MULTILINE_CPP_IS_BRIEF = NO
173
174 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
175 # member inherits the documentation from any documented member that it
176 # re-implements.
177
178 INHERIT_DOCS           = YES
179
180 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
181 # a new page for each member. If set to NO, the documentation of a member will
182 # be part of the file/class/namespace that contains it.
183
184 SEPARATE_MEMBER_PAGES  = NO
185
186 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
187 # Doxygen uses this value to replace tabs by spaces in code fragments.
188
189 TAB_SIZE               = 8
190
191 # This tag can be used to specify a number of aliases that acts
192 # as commands in the documentation. An alias has the form "name=value".
193 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
194 # put the command \sideeffect (or @sideeffect) in the documentation, which
195 # will result in a user-defined paragraph with heading "Side Effects:".
196 # You can put \n's in the value part of an alias to insert newlines.
197
198 ALIASES                =
199
200 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
201 # sources only. Doxygen will then generate output that is more tailored for C.
202 # For instance, some of the names that are used will be different. The list
203 # of all members will be omitted, etc.
204
205 OPTIMIZE_OUTPUT_FOR_C  = YES
206
207 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
208 # sources only. Doxygen will then generate output that is more tailored for
209 # Java. For instance, namespaces will be presented as packages, qualified
210 # scopes will look different, etc.
211
212 OPTIMIZE_OUTPUT_JAVA   = NO
213
214 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
215 # sources only. Doxygen will then generate output that is more tailored for
216 # Fortran.
217
218 OPTIMIZE_FOR_FORTRAN   = NO
219
220 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
221 # sources. Doxygen will then generate output that is tailored for
222 # VHDL.
223
224 OPTIMIZE_OUTPUT_VHDL   = NO
225
226 # Doxygen selects the parser to use depending on the extension of the files it
227 # parses. With this tag you can assign which parser to use for a given extension.
228 # Doxygen has a built-in mapping, but you can override or extend it using this
229 # tag. The format is ext=language, where ext is a file extension, and language
230 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
231 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
232 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
233 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
234 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
235
236 EXTENSION_MAPPING      =
237
238 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
239 # to include (a tag file for) the STL sources as input, then you should
240 # set this tag to YES in order to let doxygen match functions declarations and
241 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
242 # func(std::string) {}). This also makes the inheritance and collaboration
243 # diagrams that involve STL classes more complete and accurate.
244
245 BUILTIN_STL_SUPPORT    = NO
246
247 # If you use Microsoft's C++/CLI language, you should set this option to YES to
248 # enable parsing support.
249
250 CPP_CLI_SUPPORT        = NO
251
252 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
253 # Doxygen will parse them like normal C++ but will assume all classes use public
254 # instead of private inheritance when no explicit protection keyword is present.
255
256 SIP_SUPPORT            = NO
257
258 # For Microsoft's IDL there are propget and propput attributes to indicate getter
259 # and setter methods for a property. Setting this option to YES (the default)
260 # will make doxygen replace the get and set methods by a property in the
261 # documentation. This will only work if the methods are indeed getting or
262 # setting a simple type. If this is not the case, or you want to show the
263 # methods anyway, you should set this option to NO.
264
265 IDL_PROPERTY_SUPPORT   = YES
266
267 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
268 # tag is set to YES, then doxygen will reuse the documentation of the first
269 # member in the group (if any) for the other members of the group. By default
270 # all members of a group must be documented explicitly.
271
272 DISTRIBUTE_GROUP_DOC   = NO
273
274 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
275 # the same type (for instance a group of public functions) to be put as a
276 # subgroup of that type (e.g. under the Public Functions section). Set it to
277 # NO to prevent subgrouping. Alternatively, this can be done per class using
278 # the \nosubgrouping command.
279
280 SUBGROUPING            = YES
281
282 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
283 # unions are shown inside the group in which they are included (e.g. using
284 # @ingroup) instead of on a separate page (for HTML and Man pages) or
285 # section (for LaTeX and RTF).
286
287 INLINE_GROUPED_CLASSES = NO
288
289 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
290 # is documented as struct, union, or enum with the name of the typedef. So
291 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
292 # with name TypeT. When disabled the typedef will appear as a member of a file,
293 # namespace, or class. And the struct will be named TypeS. This can typically
294 # be useful for C code in case the coding convention dictates that all compound
295 # types are typedef'ed and only the typedef is referenced, never the tag name.
296
297 TYPEDEF_HIDES_STRUCT   = NO
298
299 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
300 # determine which symbols to keep in memory and which to flush to disk.
301 # When the cache is full, less often used symbols will be written to disk.
302 # For small to medium size projects (<1000 input files) the default value is
303 # probably good enough. For larger projects a too small cache size can cause
304 # doxygen to be busy swapping symbols to and from disk most of the time
305 # causing a significant performance penalty.
306 # If the system has enough physical memory increasing the cache will improve the
307 # performance by keeping more symbols in memory. Note that the value works on
308 # a logarithmic scale so increasing the size by one will roughly double the
309 # memory usage. The cache size is given by this formula:
310 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
311 # corresponding to a cache size of 2^16 = 65536 symbols
312
313 SYMBOL_CACHE_SIZE      = 0
314
315 #---------------------------------------------------------------------------
316 # Build related configuration options
317 #---------------------------------------------------------------------------
318
319 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
320 # documentation are documented, even if no documentation was available.
321 # Private class members and static file members will be hidden unless
322 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
323
324 EXTRACT_ALL            = NO
325
326 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
327 # will be included in the documentation.
328
329 EXTRACT_PRIVATE        = NO
330
331 # If the EXTRACT_STATIC tag is set to YES all static members of a file
332 # will be included in the documentation.
333
334 EXTRACT_STATIC         = YES
335
336 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
337 # defined locally in source files will be included in the documentation.
338 # If set to NO only classes defined in header files are included.
339
340 EXTRACT_LOCAL_CLASSES  = YES
341
342 # This flag is only useful for Objective-C code. When set to YES local
343 # methods, which are defined in the implementation section but not in
344 # the interface are included in the documentation.
345 # If set to NO (the default) only methods in the interface are included.
346
347 EXTRACT_LOCAL_METHODS  = NO
348
349 # If this flag is set to YES, the members of anonymous namespaces will be
350 # extracted and appear in the documentation as a namespace called
351 # 'anonymous_namespace{file}', where file will be replaced with the base
352 # name of the file that contains the anonymous namespace. By default
353 # anonymous namespaces are hidden.
354
355 EXTRACT_ANON_NSPACES   = NO
356
357 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
358 # undocumented members of documented classes, files or namespaces.
359 # If set to NO (the default) these members will be included in the
360 # various overviews, but no documentation section is generated.
361 # This option has no effect if EXTRACT_ALL is enabled.
362
363 HIDE_UNDOC_MEMBERS     = YES
364
365 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
366 # undocumented classes that are normally visible in the class hierarchy.
367 # If set to NO (the default) these classes will be included in the various
368 # overviews. This option has no effect if EXTRACT_ALL is enabled.
369
370 HIDE_UNDOC_CLASSES     = YES
371
372 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
373 # friend (class|struct|union) declarations.
374 # If set to NO (the default) these declarations will be included in the
375 # documentation.
376
377 HIDE_FRIEND_COMPOUNDS  = NO
378
379 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
380 # documentation blocks found inside the body of a function.
381 # If set to NO (the default) these blocks will be appended to the
382 # function's detailed documentation block.
383
384 HIDE_IN_BODY_DOCS      = NO
385
386 # The INTERNAL_DOCS tag determines if documentation
387 # that is typed after a \internal command is included. If the tag is set
388 # to NO (the default) then the documentation will be excluded.
389 # Set it to YES to include the internal documentation.
390
391 INTERNAL_DOCS          = NO
392
393 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
394 # file names in lower-case letters. If set to YES upper-case letters are also
395 # allowed. This is useful if you have classes or files whose names only differ
396 # in case and if your file system supports case sensitive file names. Windows
397 # and Mac users are advised to set this option to NO.
398
399 CASE_SENSE_NAMES       = YES
400
401 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
402 # will show members with their full class and namespace scopes in the
403 # documentation. If set to YES the scope will be hidden.
404
405 HIDE_SCOPE_NAMES       = NO
406
407 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
408 # will put a list of the files that are included by a file in the documentation
409 # of that file.
410
411 SHOW_INCLUDE_FILES     = YES
412
413 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
414 # will list include files with double quotes in the documentation
415 # rather than with sharp brackets.
416
417 FORCE_LOCAL_INCLUDES   = NO
418
419 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
420 # is inserted in the documentation for inline members.
421
422 INLINE_INFO            = YES
423
424 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
425 # will sort the (detailed) documentation of file and class members
426 # alphabetically by member name. If set to NO the members will appear in
427 # declaration order.
428
429 SORT_MEMBER_DOCS       = NO
430
431 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
432 # brief documentation of file, namespace and class members alphabetically
433 # by member name. If set to NO (the default) the members will appear in
434 # declaration order.
435
436 SORT_BRIEF_DOCS        = NO
437
438 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
439 # will sort the (brief and detailed) documentation of class members so that
440 # constructors and destructors are listed first. If set to NO (the default)
441 # the constructors will appear in the respective orders defined by
442 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
443 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
444 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
445
446 SORT_MEMBERS_CTORS_1ST = NO
447
448 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
449 # hierarchy of group names into alphabetical order. If set to NO (the default)
450 # the group names will appear in their defined order.
451
452 SORT_GROUP_NAMES       = NO
453
454 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
455 # sorted by fully-qualified names, including namespaces. If set to
456 # NO (the default), the class list will be sorted only by class name,
457 # not including the namespace part.
458 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
459 # Note: This option applies only to the class list, not to the
460 # alphabetical list.
461
462 SORT_BY_SCOPE_NAME     = NO
463
464 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
465 # do proper type resolution of all parameters of a function it will reject a
466 # match between the prototype and the implementation of a member function even
467 # if there is only one candidate or it is obvious which candidate to choose
468 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
469 # will still accept a match between prototype and implementation in such cases.
470
471 STRICT_PROTO_MATCHING  = NO
472
473 # The GENERATE_TODOLIST tag can be used to enable (YES) or
474 # disable (NO) the todo list. This list is created by putting \todo
475 # commands in the documentation.
476
477 GENERATE_TODOLIST      = YES
478
479 # The GENERATE_TESTLIST tag can be used to enable (YES) or
480 # disable (NO) the test list. This list is created by putting \test
481 # commands in the documentation.
482
483 GENERATE_TESTLIST      = YES
484
485 # The GENERATE_BUGLIST tag can be used to enable (YES) or
486 # disable (NO) the bug list. This list is created by putting \bug
487 # commands in the documentation.
488
489 GENERATE_BUGLIST       = YES
490
491 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
492 # disable (NO) the deprecated list. This list is created by putting
493 # \deprecated commands in the documentation.
494
495 GENERATE_DEPRECATEDLIST= YES
496
497 # The ENABLED_SECTIONS tag can be used to enable conditional
498 # documentation sections, marked by \if sectionname ... \endif.
499
500 ENABLED_SECTIONS       =
501
502 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
503 # the initial value of a variable or macro consists of for it to appear in
504 # the documentation. If the initializer consists of more lines than specified
505 # here it will be hidden. Use a value of 0 to hide initializers completely.
506 # The appearance of the initializer of individual variables and macros in the
507 # documentation can be controlled using \showinitializer or \hideinitializer
508 # command in the documentation regardless of this setting.
509
510 MAX_INITIALIZER_LINES  = 30
511
512 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
513 # at the bottom of the documentation of classes and structs. If set to YES the
514 # list will mention the files that were used to generate the documentation.
515
516 SHOW_USED_FILES        = YES
517
518 # If the sources in your project are distributed over multiple directories
519 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
520 # in the documentation. The default is NO.
521
522 SHOW_DIRECTORIES       = NO
523
524 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
525 # This will remove the Files entry from the Quick Index and from the
526 # Folder Tree View (if specified). The default is YES.
527
528 SHOW_FILES             = YES
529
530 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
531 # Namespaces page.
532 # This will remove the Namespaces entry from the Quick Index
533 # and from the Folder Tree View (if specified). The default is YES.
534
535 SHOW_NAMESPACES        = YES
536
537 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
538 # doxygen should invoke to get the current version for each file (typically from
539 # the version control system). Doxygen will invoke the program by executing (via
540 # popen()) the command <command> <input-file>, where <command> is the value of
541 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
542 # provided by doxygen. Whatever the program writes to standard output
543 # is used as the file version. See the manual for examples.
544
545 FILE_VERSION_FILTER    =
546
547 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
548 # by doxygen. The layout file controls the global structure of the generated
549 # output files in an output format independent way. The create the layout file
550 # that represents doxygen's defaults, run doxygen with the -l option.
551 # You can optionally specify a file name after the option, if omitted
552 # DoxygenLayout.xml will be used as the name of the layout file.
553
554 LAYOUT_FILE            =
555
556 #---------------------------------------------------------------------------
557 # configuration options related to warning and progress messages
558 #---------------------------------------------------------------------------
559
560 # The QUIET tag can be used to turn on/off the messages that are generated
561 # by doxygen. Possible values are YES and NO. If left blank NO is used.
562
563 QUIET                  = YES
564
565 # The WARNINGS tag can be used to turn on/off the warning messages that are
566 # generated by doxygen. Possible values are YES and NO. If left blank
567 # NO is used.
568
569 WARNINGS               = YES
570
571 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
572 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
573 # automatically be disabled.
574
575 WARN_IF_UNDOCUMENTED   = YES
576
577 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
578 # potential errors in the documentation, such as not documenting some
579 # parameters in a documented function, or documenting parameters that
580 # don't exist or using markup commands wrongly.
581
582 WARN_IF_DOC_ERROR      = YES
583
584 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
585 # functions that are documented, but have no documentation for their parameters
586 # or return value. If set to NO (the default) doxygen will only warn about
587 # wrong or incomplete parameter documentation, but not about the absence of
588 # documentation.
589
590 WARN_NO_PARAMDOC       = NO
591
592 # The WARN_FORMAT tag determines the format of the warning messages that
593 # doxygen can produce. The string should contain the $file, $line, and $text
594 # tags, which will be replaced by the file and line number from which the
595 # warning originated and the warning text. Optionally the format may contain
596 # $version, which will be replaced by the version of the file (if it could
597 # be obtained via FILE_VERSION_FILTER)
598
599 WARN_FORMAT            = "$file:$line: $text"
600
601 # The WARN_LOGFILE tag can be used to specify a file to which warning
602 # and error messages should be written. If left blank the output is written
603 # to stderr.
604
605 WARN_LOGFILE           =
606
607 #---------------------------------------------------------------------------
608 # configuration options related to the input files
609 #---------------------------------------------------------------------------
610
611 # The INPUT tag can be used to specify the files and/or directories that contain
612 # documented source files. You may enter file names like "myfile.cpp" or
613 # directories like "/usr/src/myproject". Separate the files or directories
614 # with spaces.
615
616 INPUT                  = index.doc \
617                          FAQ.doc \
618                          contrib.doc \
619                          publis.doc \
620                          people.doc \
621                          history.doc \
622                          ./index-API.doc \
623                          modules.doc \
624                          module-xbt.doc \
625                          module-msg.doc \
626                          module-gras.doc \
627                          module-amok.doc \
628                          module-sd.doc \
629                          module-surf.doc \
630                          gtut-main.doc \
631                          gtut-introduction.doc \
632                          gtut-tour.doc \
633                          gtut-tour-00-install.doc \
634                          gtut-tour-01-bones.doc \
635                          gtut-tour-02-simple.doc \
636                          gtut-tour-03-args.doc \
637                          gtut-tour-04-callback.doc \
638                          gtut-tour-05-globals.doc \
639                          gtut-tour-06-logs.doc \
640                          gtut-tour-07-timers.doc \
641                          gtut-tour-08-exceptions.doc \
642                          gtut-tour-09-simpledata.doc \
643                          gtut-tour-10-rpc.doc \
644                          gtut-tour-11-explicitwait.doc \
645                          gtut-tour-recap-messages.doc \
646                          gtut-tour-12-staticstruct.doc \
647                          gtut-tour-13-pointers.doc \
648                          gtut-tour-14-dynar.doc \
649                          gtut-tour-15-manualdatadef.doc \
650                          gtut-tour-16-exchangecb.doc \
651                          gtut-howto.doc \
652                          gtut-howto-design.doc \
653                          @top_srcdir@/include/ \
654                          @top_srcdir@/include/msg \
655                          @top_srcdir@/include/gras \
656                          @top_srcdir@/include/amok \
657                          @top_srcdir@/include/xbt \
658                          @top_srcdir@/include/simdag \
659                          @top_srcdir@/src/include/surf \
660                          @top_srcdir@/src/xbt/ \
661                          @top_srcdir@/src/surf/ \
662                          @top_srcdir@/src/msg/ \
663                          @top_srcdir@/src/gras \
664                          @top_srcdir@/src/gras/DataDesc \
665                          @top_srcdir@/src/gras/Msg \
666                          @top_srcdir@/src/gras/Transport \
667                          @top_srcdir@/src/gras/Virtu \
668                          @top_srcdir@/src/amok \
669                          @top_srcdir@/src/amok/Bandwidth \
670                          @top_srcdir@/src/amok/PeerManagement \
671                          @top_srcdir@/src/simdag
672
673 # This tag can be used to specify the character encoding of the source files
674 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
675 # also the default input encoding. Doxygen uses libiconv (or the iconv built
676 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
677 # the list of possible encodings.
678
679 INPUT_ENCODING         = UTF-8
680
681 # If the value of the INPUT tag contains directories, you can use the
682 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
683 # and *.h) to filter out the source-files in the directories. If left
684 # blank the following patterns are tested:
685 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
686 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
687 # *.f90 *.f *.for *.vhd *.vhdl
688
689 FILE_PATTERNS          =
690
691 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
692 # should be searched for input files as well. Possible values are YES and NO.
693 # If left blank NO is used.
694
695 RECURSIVE              = NO
696
697 # The EXCLUDE tag can be used to specify files and/or directories that should
698 # excluded from the INPUT source files. This way you can easily exclude a
699 # subdirectory from a directory tree whose root is specified with the INPUT tag.
700
701 EXCLUDE                =
702
703 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
704 # directories that are symbolic links (a Unix file system feature) are excluded
705 # from the input.
706
707 EXCLUDE_SYMLINKS       = NO
708
709 # If the value of the INPUT tag contains directories, you can use the
710 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
711 # certain files from those directories. Note that the wildcards are matched
712 # against the file with absolute path, so to exclude all test directories
713 # for example use the pattern */test/*
714
715 EXCLUDE_PATTERNS       =
716
717 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
718 # (namespaces, classes, functions, etc.) that should be excluded from the
719 # output. The symbol name can be a fully qualified name, a word, or if the
720 # wildcard * is used, a substring. Examples: ANamespace, AClass,
721 # AClass::ANamespace, ANamespace::*Test
722
723 EXCLUDE_SYMBOLS        =
724
725 # The EXAMPLE_PATH tag can be used to specify one or more files or
726 # directories that contain example code fragments that are included (see
727 # the \include command).
728
729 EXAMPLE_PATH           = ./ \
730                          @top_srcdir@/doc/gtut-files \
731                          @top_srcdir@/src/surf/ \
732                          @top_srcdir@/src/xbt/ \
733                          @top_srcdir@/examples \
734                          @top_srcdir@/testsuite
735
736 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
737 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
738 # and *.h) to filter out the source-files in the directories. If left
739 # blank all files are included.
740
741 EXAMPLE_PATTERNS       =
742
743 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
744 # searched for input files to be used with the \include or \dontinclude
745 # commands irrespective of the value of the RECURSIVE tag.
746 # Possible values are YES and NO. If left blank NO is used.
747
748 EXAMPLE_RECURSIVE      = YES
749
750 # The IMAGE_PATH tag can be used to specify one or more files or
751 # directories that contain image that are included in the documentation (see
752 # the \image command).
753
754 IMAGE_PATH             = @top_srcdir@/doc
755
756 # The INPUT_FILTER tag can be used to specify a program that doxygen should
757 # invoke to filter for each input file. Doxygen will invoke the filter program
758 # by executing (via popen()) the command <filter> <input-file>, where <filter>
759 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
760 # input file. Doxygen will then use the output that the filter program writes
761 # to standard output.
762 # If FILTER_PATTERNS is specified, this tag will be
763 # ignored.
764
765 INPUT_FILTER           =
766
767 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
768 # basis.
769 # Doxygen will compare the file name with each pattern and apply the
770 # filter if there is a match.
771 # The filters are a list of the form:
772 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
773 # info on how filters are used. If FILTER_PATTERNS is empty or if
774 # non of the patterns match the file name, INPUT_FILTER is applied.
775
776 FILTER_PATTERNS        =
777
778 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
779 # INPUT_FILTER) will be used to filter the input files when producing source
780 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
781
782 FILTER_SOURCE_FILES    = NO
783
784 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
785 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
786 # and it is also possible to disable source filtering for a specific pattern
787 # using *.ext= (so without naming a filter). This option only has effect when
788 # FILTER_SOURCE_FILES is enabled.
789
790 FILTER_SOURCE_PATTERNS =
791
792 #---------------------------------------------------------------------------
793 # configuration options related to source browsing
794 #---------------------------------------------------------------------------
795
796 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
797 # be generated. Documented entities will be cross-referenced with these sources.
798 # Note: To get rid of all source code in the generated output, make sure also
799 # VERBATIM_HEADERS is set to NO.
800
801 SOURCE_BROWSER         = NO
802
803 # Setting the INLINE_SOURCES tag to YES will include the body
804 # of functions and classes directly in the documentation.
805
806 INLINE_SOURCES         = NO
807
808 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
809 # doxygen to hide any special comment blocks from generated source code
810 # fragments. Normal C and C++ comments will always remain visible.
811
812 STRIP_CODE_COMMENTS    = YES
813
814 # If the REFERENCED_BY_RELATION tag is set to YES
815 # then for each documented function all documented
816 # functions referencing it will be listed.
817
818 REFERENCED_BY_RELATION = NO
819
820 # If the REFERENCES_RELATION tag is set to YES
821 # then for each documented function all documented entities
822 # called/used by that function will be listed.
823
824 REFERENCES_RELATION    = NO
825
826 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
827 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
828 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
829 # link to the source code.
830 # Otherwise they will link to the documentation.
831
832 REFERENCES_LINK_SOURCE = YES
833
834 # If the USE_HTAGS tag is set to YES then the references to source code
835 # will point to the HTML generated by the htags(1) tool instead of doxygen
836 # built-in source browser. The htags tool is part of GNU's global source
837 # tagging system (see http://www.gnu.org/software/global/global.html). You
838 # will need version 4.8.6 or higher.
839
840 USE_HTAGS              = NO
841
842 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
843 # will generate a verbatim copy of the header file for each class for
844 # which an include is specified. Set to NO to disable this.
845
846 VERBATIM_HEADERS       = NO
847
848 #---------------------------------------------------------------------------
849 # configuration options related to the alphabetical class index
850 #---------------------------------------------------------------------------
851
852 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
853 # of all compounds will be generated. Enable this if the project
854 # contains a lot of classes, structs, unions or interfaces.
855
856 ALPHABETICAL_INDEX     = NO
857
858 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
859 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
860 # in which this list will be split (can be a number in the range [1..20])
861
862 COLS_IN_ALPHA_INDEX    = 5
863
864 # In case all classes in a project start with a common prefix, all
865 # classes will be put under the same header in the alphabetical index.
866 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
867 # should be ignored while generating the index headers.
868
869 IGNORE_PREFIX          =
870
871 #---------------------------------------------------------------------------
872 # configuration options related to the HTML output
873 #---------------------------------------------------------------------------
874
875 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
876 # generate HTML output.
877
878 GENERATE_HTML          = YES
879
880 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
881 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
882 # put in front of it. If left blank `html' will be used as the default path.
883
884 HTML_OUTPUT            = html
885
886 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
887 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
888 # doxygen will generate files with .html extension.
889
890 HTML_FILE_EXTENSION    = .html
891
892 # The HTML_HEADER tag can be used to specify a personal HTML header for
893 # each generated HTML page. If it is left blank doxygen will generate a
894 # standard header. Note that when using a custom header you are responsible
895 # for the proper inclusion of any scripts and style sheets that doxygen
896 # needs, which is dependent on the configuration options used.
897 # It is adviced to generate a default header using "doxygen -w html
898 # header.html footer.html stylesheet.css YourConfigFile" and then modify
899 # that header. Note that the header is subject to change so you typically
900 # have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!
901
902 HTML_HEADER            =
903
904 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
905 # each generated HTML page. If it is left blank doxygen will generate a
906 # standard footer.
907
908 HTML_FOOTER            = footer.html
909
910 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
911 # style sheet that is used by each HTML page. It can be used to
912 # fine-tune the look of the HTML output. If the tag is left blank doxygen
913 # will generate a default style sheet. Note that doxygen will try to copy
914 # the style sheet file to the HTML output directory, so don't put your own
915 # stylesheet in the HTML output directory as well, or it will be erased!
916
917 HTML_STYLESHEET        =
918
919 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
920 # other source files which should be copied to the HTML output directory. Note
921 # that these files will be copied to the base HTML output directory. Use the
922 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
923 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
924 # the files will be copied as-is; there are no commands or markers available.
925
926 HTML_EXTRA_FILES       =
927
928 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
929 # Doxygen will adjust the colors in the stylesheet and background images
930 # according to this color. Hue is specified as an angle on a colorwheel,
931 # see http://en.wikipedia.org/wiki/Hue for more information.
932 # For instance the value 0 represents red, 60 is yellow, 120 is green,
933 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
934 # The allowed range is 0 to 359.
935
936 HTML_COLORSTYLE_HUE    = 220
937
938 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
939 # the colors in the HTML output. For a value of 0 the output will use
940 # grayscales only. A value of 255 will produce the most vivid colors.
941
942 HTML_COLORSTYLE_SAT    = 100
943
944 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
945 # the luminance component of the colors in the HTML output. Values below
946 # 100 gradually make the output lighter, whereas values above 100 make
947 # the output darker. The value divided by 100 is the actual gamma applied,
948 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
949 # and 100 does not change the gamma.
950
951 HTML_COLORSTYLE_GAMMA  = 80
952
953 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
954 # page will contain the date and time when the page was generated. Setting
955 # this to NO can help when comparing the output of multiple runs.
956
957 HTML_TIMESTAMP         = YES
958
959 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
960 # files or namespaces will be aligned in HTML using tables. If set to
961 # NO a bullet list will be used.
962
963 HTML_ALIGN_MEMBERS     = YES
964
965 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
966 # documentation will contain sections that can be hidden and shown after the
967 # page has loaded. For this to work a browser that supports
968 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
969 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
970
971 HTML_DYNAMIC_SECTIONS  = NO
972
973 # If the GENERATE_DOCSET tag is set to YES, additional index files
974 # will be generated that can be used as input for Apple's Xcode 3
975 # integrated development environment, introduced with OSX 10.5 (Leopard).
976 # To create a documentation set, doxygen will generate a Makefile in the
977 # HTML output directory. Running make will produce the docset in that
978 # directory and running "make install" will install the docset in
979 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
980 # it at startup.
981 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
982 # for more information.
983
984 GENERATE_DOCSET        = NO
985
986 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
987 # feed. A documentation feed provides an umbrella under which multiple
988 # documentation sets from a single provider (such as a company or product suite)
989 # can be grouped.
990
991 DOCSET_FEEDNAME        = "Doxygen generated docs"
992
993 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
994 # should uniquely identify the documentation set bundle. This should be a
995 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
996 # will append .docset to the name.
997
998 DOCSET_BUNDLE_ID       = org.doxygen.Project
999
1000 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1001 # the documentation publisher. This should be a reverse domain-name style
1002 # string, e.g. com.mycompany.MyDocSet.documentation.
1003
1004 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1005
1006 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1007
1008 DOCSET_PUBLISHER_NAME  = Publisher
1009
1010 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1011 # will be generated that can be used as input for tools like the
1012 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1013 # of the generated HTML documentation.
1014
1015 GENERATE_HTMLHELP      = NO
1016
1017 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1018 # be used to specify the file name of the resulting .chm file. You
1019 # can add a path in front of the file if the result should not be
1020 # written to the html output directory.
1021
1022 CHM_FILE               =
1023
1024 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1025 # be used to specify the location (absolute path including file name) of
1026 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1027 # the HTML help compiler on the generated index.hhp.
1028
1029 HHC_LOCATION           =
1030
1031 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1032 # controls if a separate .chi index file is generated (YES) or that
1033 # it should be included in the master .chm file (NO).
1034
1035 GENERATE_CHI           = NO
1036
1037 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1038 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1039 # content.
1040
1041 CHM_INDEX_ENCODING     =
1042
1043 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1044 # controls whether a binary table of contents is generated (YES) or a
1045 # normal table of contents (NO) in the .chm file.
1046
1047 BINARY_TOC             = NO
1048
1049 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1050 # to the contents of the HTML help documentation and to the tree view.
1051
1052 TOC_EXPAND             = YES
1053
1054 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1055 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1056 # that can be used as input for Qt's qhelpgenerator to generate a
1057 # Qt Compressed Help (.qch) of the generated HTML documentation.
1058
1059 GENERATE_QHP           = NO
1060
1061 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1062 # be used to specify the file name of the resulting .qch file.
1063 # The path specified is relative to the HTML output folder.
1064
1065 QCH_FILE               =
1066
1067 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1068 # Qt Help Project output. For more information please see
1069 # http://doc.trolltech.com/qthelpproject.html#namespace
1070
1071 QHP_NAMESPACE          = org.doxygen.Project
1072
1073 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1074 # Qt Help Project output. For more information please see
1075 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1076
1077 QHP_VIRTUAL_FOLDER     = doc
1078
1079 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1080 # add. For more information please see
1081 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1082
1083 QHP_CUST_FILTER_NAME   =
1084
1085 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1086 # custom filter to add. For more information please see
1087 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1088 # Qt Help Project / Custom Filters</a>.
1089
1090 QHP_CUST_FILTER_ATTRS  =
1091
1092 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1093 # project's
1094 # filter section matches.
1095 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1096 # Qt Help Project / Filter Attributes</a>.
1097
1098 QHP_SECT_FILTER_ATTRS  =
1099
1100 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1101 # be used to specify the location of Qt's qhelpgenerator.
1102 # If non-empty doxygen will try to run qhelpgenerator on the generated
1103 # .qhp file.
1104
1105 QHG_LOCATION           =
1106
1107 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1108 #  will be generated, which together with the HTML files, form an Eclipse help
1109 # plugin. To install this plugin and make it available under the help contents
1110 # menu in Eclipse, the contents of the directory containing the HTML and XML
1111 # files needs to be copied into the plugins directory of eclipse. The name of
1112 # the directory within the plugins directory should be the same as
1113 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1114 # the help appears.
1115
1116 GENERATE_ECLIPSEHELP   = NO
1117
1118 # A unique identifier for the eclipse help plugin. When installing the plugin
1119 # the directory name containing the HTML and XML files should also have
1120 # this name.
1121
1122 ECLIPSE_DOC_ID         = org.doxygen.Project
1123
1124 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1125 # top of each HTML page. The value NO (the default) enables the index and
1126 # the value YES disables it.
1127
1128 DISABLE_INDEX          = NO
1129
1130 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1131 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1132 # documentation. Note that a value of 0 will completely suppress the enum
1133 # values from appearing in the overview section.
1134
1135 ENUM_VALUES_PER_LINE   = 4
1136
1137 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1138 # structure should be generated to display hierarchical information.
1139 # If the tag value is set to YES, a side panel will be generated
1140 # containing a tree-like index structure (just like the one that
1141 # is generated for HTML Help). For this to work a browser that supports
1142 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1143 # Windows users are probably better off using the HTML help feature.
1144
1145 GENERATE_TREEVIEW      = NO
1146
1147 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1148 # and Class Hierarchy pages using a tree view instead of an ordered list.
1149
1150 USE_INLINE_TREES       = NO
1151
1152 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1153 # used to set the initial width (in pixels) of the frame in which the tree
1154 # is shown.
1155
1156 TREEVIEW_WIDTH         = 250
1157
1158 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1159 # links to external symbols imported via tag files in a separate window.
1160
1161 EXT_LINKS_IN_WINDOW    = NO
1162
1163 # Use this tag to change the font size of Latex formulas included
1164 # as images in the HTML documentation. The default is 10. Note that
1165 # when you change the font size after a successful doxygen run you need
1166 # to manually remove any form_*.png images from the HTML output directory
1167 # to force them to be regenerated.
1168
1169 FORMULA_FONTSIZE       = 10
1170
1171 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1172 # generated for formulas are transparent PNGs. Transparent PNGs are
1173 # not supported properly for IE 6.0, but are supported on all modern browsers.
1174 # Note that when changing this option you need to delete any form_*.png files
1175 # in the HTML output before the changes have effect.
1176
1177 FORMULA_TRANSPARENT    = YES
1178
1179 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1180 # (see http://www.mathjax.org) which uses client side Javascript for the
1181 # rendering instead of using prerendered bitmaps. Use this if you do not
1182 # have LaTeX installed or if you want to formulas look prettier in the HTML
1183 # output. When enabled you also need to install MathJax separately and
1184 # configure the path to it using the MATHJAX_RELPATH option.
1185
1186 USE_MATHJAX            = NO
1187
1188 # When MathJax is enabled you need to specify the location relative to the
1189 # HTML output directory using the MATHJAX_RELPATH option. The destination
1190 # directory should contain the MathJax.js script. For instance, if the mathjax
1191 # directory is located at the same level as the HTML output directory, then
1192 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1193 # mathjax.org site, so you can quickly see the result without installing
1194 # MathJax, but it is strongly recommended to install a local copy of MathJax
1195 # before deployment.
1196
1197 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1198
1199 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1200 # for the HTML output. The underlying search engine uses javascript
1201 # and DHTML and should work on any modern browser. Note that when using
1202 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1203 # (GENERATE_DOCSET) there is already a search function so this one should
1204 # typically be disabled. For large projects the javascript based search engine
1205 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1206
1207 SEARCHENGINE           = NO
1208
1209 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1210 # implemented using a PHP enabled web server instead of at the web client
1211 # using Javascript. Doxygen will generate the search PHP script and index
1212 # file to put on the web server. The advantage of the server
1213 # based approach is that it scales better to large projects and allows
1214 # full text search. The disadvantages are that it is more difficult to setup
1215 # and does not have live searching capabilities.
1216
1217 SERVER_BASED_SEARCH    = NO
1218
1219 #---------------------------------------------------------------------------
1220 # configuration options related to the LaTeX output
1221 #---------------------------------------------------------------------------
1222
1223 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1224 # generate Latex output.
1225
1226 GENERATE_LATEX         = NO
1227
1228 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1229 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1230 # put in front of it. If left blank `latex' will be used as the default path.
1231
1232 LATEX_OUTPUT           = latex
1233
1234 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1235 # invoked. If left blank `latex' will be used as the default command name.
1236 # Note that when enabling USE_PDFLATEX this option is only used for
1237 # generating bitmaps for formulas in the HTML output, but not in the
1238 # Makefile that is written to the output directory.
1239
1240 LATEX_CMD_NAME         = latex
1241
1242 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1243 # generate index for LaTeX. If left blank `makeindex' will be used as the
1244 # default command name.
1245
1246 MAKEINDEX_CMD_NAME     = makeindex
1247
1248 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1249 # LaTeX documents. This may be useful for small projects and may help to
1250 # save some trees in general.
1251
1252 COMPACT_LATEX          = NO
1253
1254 # The PAPER_TYPE tag can be used to set the paper type that is used
1255 # by the printer. Possible values are: a4, letter, legal and
1256 # executive. If left blank a4wide will be used.
1257
1258 PAPER_TYPE             = a4wide
1259
1260 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1261 # packages that should be included in the LaTeX output.
1262
1263 EXTRA_PACKAGES         =
1264
1265 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1266 # the generated latex document. The header should contain everything until
1267 # the first chapter. If it is left blank doxygen will generate a
1268 # standard header. Notice: only use this tag if you know what you are doing!
1269
1270 LATEX_HEADER           =
1271
1272 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1273 # the generated latex document. The footer should contain everything after
1274 # the last chapter. If it is left blank doxygen will generate a
1275 # standard footer. Notice: only use this tag if you know what you are doing!
1276
1277 LATEX_FOOTER           =
1278
1279 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1280 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1281 # contain links (just like the HTML output) instead of page references
1282 # This makes the output suitable for online browsing using a pdf viewer.
1283
1284 PDF_HYPERLINKS         = NO
1285
1286 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1287 # plain latex in the generated Makefile. Set this option to YES to get a
1288 # higher quality PDF documentation.
1289
1290 USE_PDFLATEX           = NO
1291
1292 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1293 # command to the generated LaTeX files. This will instruct LaTeX to keep
1294 # running if errors occur, instead of asking the user for help.
1295 # This option is also used when generating formulas in HTML.
1296
1297 LATEX_BATCHMODE        = NO
1298
1299 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1300 # include the index chapters (such as File Index, Compound Index, etc.)
1301 # in the output.
1302
1303 LATEX_HIDE_INDICES     = NO
1304
1305 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1306 # source code with syntax highlighting in the LaTeX output.
1307 # Note that which sources are shown also depends on other settings
1308 # such as SOURCE_BROWSER.
1309
1310 LATEX_SOURCE_CODE      = NO
1311
1312 #---------------------------------------------------------------------------
1313 # configuration options related to the RTF output
1314 #---------------------------------------------------------------------------
1315
1316 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1317 # The RTF output is optimized for Word 97 and may not look very pretty with
1318 # other RTF readers or editors.
1319
1320 GENERATE_RTF           = NO
1321
1322 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1323 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1324 # put in front of it. If left blank `rtf' will be used as the default path.
1325
1326 RTF_OUTPUT             = rtf
1327
1328 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1329 # RTF documents. This may be useful for small projects and may help to
1330 # save some trees in general.
1331
1332 COMPACT_RTF            = NO
1333
1334 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1335 # will contain hyperlink fields. The RTF file will
1336 # contain links (just like the HTML output) instead of page references.
1337 # This makes the output suitable for online browsing using WORD or other
1338 # programs which support those fields.
1339 # Note: wordpad (write) and others do not support links.
1340
1341 RTF_HYPERLINKS         = NO
1342
1343 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1344 # config file, i.e. a series of assignments. You only have to provide
1345 # replacements, missing definitions are set to their default value.
1346
1347 RTF_STYLESHEET_FILE    =
1348
1349 # Set optional variables used in the generation of an rtf document.
1350 # Syntax is similar to doxygen's config file.
1351
1352 RTF_EXTENSIONS_FILE    =
1353
1354 #---------------------------------------------------------------------------
1355 # configuration options related to the man page output
1356 #---------------------------------------------------------------------------
1357
1358 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1359 # generate man pages
1360
1361 GENERATE_MAN           = NO
1362
1363 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1364 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1365 # put in front of it. If left blank `man' will be used as the default path.
1366
1367 MAN_OUTPUT             = man
1368
1369 # The MAN_EXTENSION tag determines the extension that is added to
1370 # the generated man pages (default is the subroutine's section .3)
1371
1372 MAN_EXTENSION          = .3
1373
1374 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1375 # then it will generate one additional man file for each entity
1376 # documented in the real man page(s). These additional files
1377 # only source the real man page, but without them the man command
1378 # would be unable to find the correct page. The default is NO.
1379
1380 MAN_LINKS              = NO
1381
1382 #---------------------------------------------------------------------------
1383 # configuration options related to the XML output
1384 #---------------------------------------------------------------------------
1385
1386 # If the GENERATE_XML tag is set to YES Doxygen will
1387 # generate an XML file that captures the structure of
1388 # the code including all documentation.
1389
1390 GENERATE_XML           = NO
1391
1392 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1393 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1394 # put in front of it. If left blank `xml' will be used as the default path.
1395
1396 XML_OUTPUT             = xml
1397
1398 # The XML_SCHEMA tag can be used to specify an XML schema,
1399 # which can be used by a validating XML parser to check the
1400 # syntax of the XML files.
1401
1402 XML_SCHEMA             =
1403
1404 # The XML_DTD tag can be used to specify an XML DTD,
1405 # which can be used by a validating XML parser to check the
1406 # syntax of the XML files.
1407
1408 XML_DTD                =
1409
1410 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1411 # dump the program listings (including syntax highlighting
1412 # and cross-referencing information) to the XML output. Note that
1413 # enabling this will significantly increase the size of the XML output.
1414
1415 XML_PROGRAMLISTING     = YES
1416
1417 #---------------------------------------------------------------------------
1418 # configuration options for the AutoGen Definitions output
1419 #---------------------------------------------------------------------------
1420
1421 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1422 # generate an AutoGen Definitions (see autogen.sf.net) file
1423 # that captures the structure of the code including all
1424 # documentation. Note that this feature is still experimental
1425 # and incomplete at the moment.
1426
1427 GENERATE_AUTOGEN_DEF   = NO
1428
1429 #---------------------------------------------------------------------------
1430 # configuration options related to the Perl module output
1431 #---------------------------------------------------------------------------
1432
1433 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1434 # generate a Perl module file that captures the structure of
1435 # the code including all documentation. Note that this
1436 # feature is still experimental and incomplete at the
1437 # moment.
1438
1439 GENERATE_PERLMOD       = NO
1440
1441 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1442 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1443 # to generate PDF and DVI output from the Perl module output.
1444
1445 PERLMOD_LATEX          = NO
1446
1447 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1448 # nicely formatted so it can be parsed by a human reader.
1449 # This is useful
1450 # if you want to understand what is going on.
1451 # On the other hand, if this
1452 # tag is set to NO the size of the Perl module output will be much smaller
1453 # and Perl will parse it just the same.
1454
1455 PERLMOD_PRETTY         = YES
1456
1457 # The names of the make variables in the generated doxyrules.make file
1458 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1459 # This is useful so different doxyrules.make files included by the same
1460 # Makefile don't overwrite each other's variables.
1461
1462 PERLMOD_MAKEVAR_PREFIX =
1463
1464 #---------------------------------------------------------------------------
1465 # Configuration options related to the preprocessor
1466 #---------------------------------------------------------------------------
1467
1468 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1469 # evaluate all C-preprocessor directives found in the sources and include
1470 # files.
1471
1472 ENABLE_PREPROCESSING   = YES
1473
1474 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1475 # names in the source code. If set to NO (the default) only conditional
1476 # compilation will be performed. Macro expansion can be done in a controlled
1477 # way by setting EXPAND_ONLY_PREDEF to YES.
1478
1479 MACRO_EXPANSION        = YES
1480
1481 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1482 # then the macro expansion is limited to the macros specified with the
1483 # PREDEFINED and EXPAND_AS_DEFINED tags.
1484
1485 EXPAND_ONLY_PREDEF     = YES
1486
1487 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1488 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1489
1490 SEARCH_INCLUDES        = YES
1491
1492 # The INCLUDE_PATH tag can be used to specify one or more directories that
1493 # contain include files that are not input files but should be processed by
1494 # the preprocessor.
1495
1496 INCLUDE_PATH           =
1497
1498 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1499 # patterns (like *.h and *.hpp) to filter out the header-files in the
1500 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1501 # be used.
1502
1503 INCLUDE_FILE_PATTERNS  =
1504
1505 # The PREDEFINED tag can be used to specify one or more macro names that
1506 # are defined before the preprocessor is started (similar to the -D option of
1507 # gcc). The argument of the tag is a list of macros of the form: name
1508 # or name=definition (no spaces). If the definition and the = are
1509 # omitted =1 is assumed. To prevent a macro definition from being
1510 # undefined via #undef or recursively expanded use the := operator
1511 # instead of the = operator.
1512
1513 PREDEFINED             = DOXYGEN \
1514                          DOXYGEN_SKIP_IT \
1515                          XBT_PUBLIC=
1516
1517 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1518 # this tag can be used to specify a list of macro names that should be expanded.
1519 # The macro definition that is found in the sources will be used.
1520 # Use the PREDEFINED tag if you want to use a different macro definition that
1521 # overrules the definition found in the source code.
1522
1523 EXPAND_AS_DEFINED      =
1524
1525 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1526 # doxygen's preprocessor will remove all references to function-like macros
1527 # that are alone on a line, have an all uppercase name, and do not end with a
1528 # semicolon, because these will confuse the parser if not removed.
1529
1530 SKIP_FUNCTION_MACROS   = YES
1531
1532 #---------------------------------------------------------------------------
1533 # Configuration::additions related to external references
1534 #---------------------------------------------------------------------------
1535
1536 # The TAGFILES option can be used to specify one or more tagfiles.
1537 # Optionally an initial location of the external documentation
1538 # can be added for each tagfile. The format of a tag file without
1539 # this location is as follows:
1540 #
1541 # TAGFILES = file1 file2 ...
1542 # Adding location for the tag files is done as follows:
1543 #
1544 # TAGFILES = file1=loc1 "file2 = loc2" ...
1545 # where "loc1" and "loc2" can be relative or absolute paths or
1546 # URLs. If a location is present for each tag, the installdox tool
1547 # does not have to be run to correct the links.
1548 # Note that each tag file must have a unique name
1549 # (where the name does NOT include the path)
1550 # If a tag file is not located in the directory in which doxygen
1551 # is run, you must also specify the path to the tagfile here.
1552
1553 TAGFILES               =
1554
1555 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1556 # a tag file that is based on the input files it reads.
1557
1558 GENERATE_TAGFILE       = simgrid.tag
1559
1560 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1561 # in the class index. If set to NO only the inherited external classes
1562 # will be listed.
1563
1564 ALLEXTERNALS           = NO
1565
1566 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1567 # in the modules index. If set to NO, only the current project's groups will
1568 # be listed.
1569
1570 EXTERNAL_GROUPS        = NO
1571
1572 # The PERL_PATH should be the absolute path and name of the perl script
1573 # interpreter (i.e. the result of `which perl').
1574
1575 PERL_PATH              = /usr/bin/perl
1576
1577 #---------------------------------------------------------------------------
1578 # Configuration options related to the dot tool
1579 #---------------------------------------------------------------------------
1580
1581 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1582 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1583 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1584 # this option also works with HAVE_DOT disabled, but it is recommended to
1585 # install and use dot, since it yields more powerful graphs.
1586
1587 CLASS_DIAGRAMS         = YES
1588
1589 # You can define message sequence charts within doxygen comments using the \msc
1590 # command. Doxygen will then run the mscgen tool (see
1591 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1592 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1593 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1594 # default search path.
1595
1596 MSCGEN_PATH            =
1597
1598 # If set to YES, the inheritance and collaboration graphs will hide
1599 # inheritance and usage relations if the target is undocumented
1600 # or is not a class.
1601
1602 HIDE_UNDOC_RELATIONS   = YES
1603
1604 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1605 # available from the path. This tool is part of Graphviz, a graph visualization
1606 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1607 # have no effect if this option is set to NO (the default)
1608
1609 HAVE_DOT               = NO
1610
1611 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1612 # allowed to run in parallel. When set to 0 (the default) doxygen will
1613 # base this on the number of processors available in the system. You can set it
1614 # explicitly to a value larger than 0 to get control over the balance
1615 # between CPU load and processing speed.
1616
1617 DOT_NUM_THREADS        = 0
1618
1619 # By default doxygen will write a font called Helvetica to the output
1620 # directory and reference it in all dot files that doxygen generates.
1621 # When you want a differently looking font you can specify the font name
1622 # using DOT_FONTNAME. You need to make sure dot is able to find the font,
1623 # which can be done by putting it in a standard location or by setting the
1624 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1625 # containing the font.
1626
1627 DOT_FONTNAME           = Helvetica
1628
1629 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1630 # The default size is 10pt.
1631
1632 DOT_FONTSIZE           = 10
1633
1634 # By default doxygen will tell dot to use the output directory to look for the
1635 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1636 # different font using DOT_FONTNAME you can set the path where dot
1637 # can find it using this tag.
1638
1639 DOT_FONTPATH           =
1640
1641 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1642 # will generate a graph for each documented class showing the direct and
1643 # indirect inheritance relations. Setting this tag to YES will force the
1644 # the CLASS_DIAGRAMS tag to NO.
1645
1646 CLASS_GRAPH            = YES
1647
1648 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1649 # will generate a graph for each documented class showing the direct and
1650 # indirect implementation dependencies (inheritance, containment, and
1651 # class references variables) of the class with other documented classes.
1652
1653 COLLABORATION_GRAPH    = YES
1654
1655 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1656 # will generate a graph for groups, showing the direct groups dependencies
1657
1658 GROUP_GRAPHS           = YES
1659
1660 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1661 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1662 # Language.
1663
1664 UML_LOOK               = NO
1665
1666 # If set to YES, the inheritance and collaboration graphs will show the
1667 # relations between templates and their instances.
1668
1669 TEMPLATE_RELATIONS     = YES
1670
1671 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1672 # tags are set to YES then doxygen will generate a graph for each documented
1673 # file showing the direct and indirect include dependencies of the file with
1674 # other documented files.
1675
1676 INCLUDE_GRAPH          = YES
1677
1678 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1679 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1680 # documented header file showing the documented files that directly or
1681 # indirectly include this file.
1682
1683 INCLUDED_BY_GRAPH      = YES
1684
1685 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1686 # doxygen will generate a call dependency graph for every global function
1687 # or class method. Note that enabling this option will significantly increase
1688 # the time of a run. So in most cases it will be better to enable call graphs
1689 # for selected functions only using the \callgraph command.
1690
1691 CALL_GRAPH             = NO
1692
1693 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1694 # doxygen will generate a caller dependency graph for every global function
1695 # or class method. Note that enabling this option will significantly increase
1696 # the time of a run. So in most cases it will be better to enable caller
1697 # graphs for selected functions only using the \callergraph command.
1698
1699 CALLER_GRAPH           = NO
1700
1701 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1702 # will generate a graphical hierarchy of all classes instead of a textual one.
1703
1704 GRAPHICAL_HIERARCHY    = YES
1705
1706 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1707 # then doxygen will show the dependencies a directory has on other directories
1708 # in a graphical way. The dependency relations are determined by the #include
1709 # relations between the files in the directories.
1710
1711 DIRECTORY_GRAPH        = YES
1712
1713 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1714 # generated by dot. Possible values are svg, png, jpg, or gif.
1715 # If left blank png will be used.
1716
1717 DOT_IMAGE_FORMAT       = png
1718
1719 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1720 # found. If left blank, it is assumed the dot tool can be found in the path.
1721
1722 DOT_PATH               =
1723
1724 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1725 # contain dot files that are included in the documentation (see the
1726 # \dotfile command).
1727
1728 DOTFILE_DIRS           =
1729
1730 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1731 # contain msc files that are included in the documentation (see the
1732 # \mscfile command).
1733
1734 MSCFILE_DIRS           =
1735
1736 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1737 # nodes that will be shown in the graph. If the number of nodes in a graph
1738 # becomes larger than this value, doxygen will truncate the graph, which is
1739 # visualized by representing a node as a red box. Note that doxygen if the
1740 # number of direct children of the root node in a graph is already larger than
1741 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1742 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1743
1744 DOT_GRAPH_MAX_NODES    = 50
1745
1746 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1747 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1748 # from the root by following a path via at most 3 edges will be shown. Nodes
1749 # that lay further from the root node will be omitted. Note that setting this
1750 # option to 1 or 2 may greatly reduce the computation time needed for large
1751 # code bases. Also note that the size of a graph can be further restricted by
1752 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1753
1754 MAX_DOT_GRAPH_DEPTH    = 0
1755
1756 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1757 # background. This is disabled by default, because dot on Windows does not
1758 # seem to support this out of the box. Warning: Depending on the platform used,
1759 # enabling this option may lead to badly anti-aliased labels on the edges of
1760 # a graph (i.e. they become hard to read).
1761
1762 DOT_TRANSPARENT        = NO
1763
1764 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1765 # files in one run (i.e. multiple -o and -T options on the command line). This
1766 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1767 # support this, this feature is disabled by default.
1768
1769 DOT_MULTI_TARGETS      = NO
1770
1771 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1772 # generate a legend page explaining the meaning of the various boxes and
1773 # arrows in the dot generated graphs.
1774
1775 GENERATE_LEGEND        = YES
1776
1777 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1778 # remove the intermediate dot files that are used to generate
1779 # the various graphs.
1780
1781 DOT_CLEANUP            = YES