doc/Doxyfile.in

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