Kernel/Doxyfile.api

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