docs/dali_internal.doxy

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