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