build/slp/docs/dali.doxy.in

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