resource/docs/c-doc/Doxyfile

   1 # Doxyfile 1.8.2
   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 sequence of words) that should
  26 # identify the project. Note that if you do not use Doxywizard you need
  27 # to put quotes around the project name if it contains spaces.
  28
  29 PROJECT_NAME           = "IoTivity C SDK"
  30
  31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  32 # This could be handy for archiving the generated documentation or
  33 # if some version control system is used.
  34
  35 PROJECT_NUMBER         =
  36
  37 # Using the PROJECT_BRIEF tag one can provide an optional one line description
  38 # for a project that appears at the top of each page and should give viewer
  39 # a quick idea about the purpose of the project. Keep the description short.
  40
  41 PROJECT_BRIEF          =
  42
  43 # With the PROJECT_LOGO tag one can specify an logo or icon that is
  44 # included in the documentation. The maximum height of the logo should not
  45 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
  46 # Doxygen will copy the logo to the output directory.
  47
  48 PROJECT_LOGO           =
  49
  50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  51 # base path where the generated documentation will be put.
  52 # If a relative path is entered, it will be relative to the location
  53 # where doxygen was started. If left blank the current directory will be used.
  54
  55 OUTPUT_DIRECTORY       = docs
  56
  57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
  58 # 4096 sub-directories (in 2 levels) under the output directory of each output
  59 # format and will distribute the generated files over these directories.
  60 # Enabling this option can be useful when feeding doxygen a huge amount of
  61 # source files, where putting all generated files in the same directory would
  62 # otherwise cause performance problems for the file system.
  63
  64 CREATE_SUBDIRS         = NO
  65
  66 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  67 # documentation generated by doxygen is written. Doxygen will use this
  68 # information to generate all constant output in the proper language.
  69 # The default language is English, other supported languages are:
  70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
  71 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
  72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
  73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
  74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
  75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
  76
  77 OUTPUT_LANGUAGE        = English
  78
  79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  80 # include brief member descriptions after the members that are listed in
  81 # the file and class documentation (similar to JavaDoc).
  82 # Set to NO to disable this.
  83
  84 BRIEF_MEMBER_DESC      = YES
  85
  86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  87 # the brief description of a member or function before the detailed description.
  88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  89 # brief descriptions will be completely suppressed.
  90
  91 REPEAT_BRIEF           = YES
  92
  93 # This tag implements a quasi-intelligent brief description abbreviator
  94 # that is used to form the text in various listings. Each string
  95 # in this list, if found as the leading text of the brief description, will be
  96 # stripped from the text and the result after processing the whole list, is
  97 # used as the annotated text. Otherwise, the brief description is used as-is.
  98 # If left blank, the following values are used ("$name" is automatically
  99 # replaced with the name of the entity): "The $name class" "The $name widget"
 100 # "The $name file" "is" "provides" "specifies" "contains"
 101 # "represents" "a" "an" "the"
 102
 103 ABBREVIATE_BRIEF       = "The $name class" \
 104                          "The $name widget" \
 105                          "The $name file" \
 106                          is \
 107                          provides \
 108                          specifies \
 109                          contains \
 110                          represents \
 111                          a \
 112                          an \
 113                          the
 114
 115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
 116 # Doxygen will generate a detailed section even if there is only a brief
 117 # description.
 118
 119 ALWAYS_DETAILED_SEC    = NO
 120
 121 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
 122 # inherited members of a class in the documentation of that class as if those
 123 # members were ordinary class members. Constructors, destructors and assignment
 124 # operators of the base classes will not be shown.
 125
 126 INLINE_INHERITED_MEMB  = NO
 127
 128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
 129 # path before files name in the file list and in the header files. If set
 130 # to NO the shortest path that makes the file name unique will be used.
 131
 132 FULL_PATH_NAMES        = NO
 133
 134 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
 135 # can be used to strip a user-defined part of the path. Stripping is
 136 # only done if one of the specified strings matches the left-hand part of
 137 # the path. The tag can be used to show relative paths in the file list.
 138 # If left blank the directory from which doxygen is run is used as the
 139 # path to strip. Note that you specify absolute paths here, but also
 140 # relative paths, which will be relative from the directory where doxygen is
 141 # started.
 142
 143 STRIP_FROM_PATH        =
 144
 145 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
 146 # the path mentioned in the documentation of a class, which tells
 147 # the reader which header file to include in order to use a class.
 148 # If left blank only the name of the header file containing the class
 149 # definition is used. Otherwise one should specify the include paths that
 150 # are normally passed to the compiler using the -I flag.
 151
 152 STRIP_FROM_INC_PATH    =
 153
 154 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
 155 # (but less readable) file names. This can be useful if your file system
 156 # doesn't support long names like on DOS, Mac, or CD-ROM.
 157
 158 SHORT_NAMES            = NO
 159
 160 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
 161 # will interpret the first line (until the first dot) of a JavaDoc-style
 162 # comment as the brief description. If set to NO, the JavaDoc
 163 # comments will behave just like regular Qt-style comments
 164 # (thus requiring an explicit @brief command for a brief description.)
 165
 166 JAVADOC_AUTOBRIEF      = YES
 167
 168 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
 169 # interpret the first line (until the first dot) of a Qt-style
 170 # comment as the brief description. If set to NO, the comments
 171 # will behave just like regular Qt-style comments (thus requiring
 172 # an explicit \brief command for a brief description.)
 173
 174 QT_AUTOBRIEF           = NO
 175
 176 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
 177 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
 178 # comments) as a brief description. This used to be the default behaviour.
 179 # The new default is to treat a multi-line C++ comment block as a detailed
 180 # description. Set this tag to YES if you prefer the old behaviour instead.
 181
 182 MULTILINE_CPP_IS_BRIEF = NO
 183
 184 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
 185 # member inherits the documentation from any documented member that it
 186 # re-implements.
 187
 188 INHERIT_DOCS           = YES
 189
 190 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
 191 # a new page for each member. If set to NO, the documentation of a member will
 192 # be part of the file/class/namespace that contains it.
 193
 194 SEPARATE_MEMBER_PAGES  = NO
 195
 196 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
 197 # Doxygen uses this value to replace tabs by spaces in code fragments.
 198
 199 TAB_SIZE               = 8
 200
 201 # This tag can be used to specify a number of aliases that acts
 202 # as commands in the documentation. An alias has the form "name=value".
 203 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
 204 # put the command \sideeffect (or @sideeffect) in the documentation, which
 205 # will result in a user-defined paragraph with heading "Side Effects:".
 206 # You can put \n's in the value part of an alias to insert newlines.
 207
 208 ALIASES                =
 209
 210 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 211 # A mapping has the form "name=value". For example adding
 212 # "class=itcl::class" will allow you to use the command class in the
 213 # itcl::class meaning.
 214
 215 TCL_SUBST              =
 216
 217 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
 218 # sources only. Doxygen will then generate output that is more tailored for C.
 219 # For instance, some of the names that are used will be different. The list
 220 # of all members will be omitted, etc.
 221
 222 OPTIMIZE_OUTPUT_FOR_C  = NO
 223
 224 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
 225 # sources only. Doxygen will then generate output that is more tailored for
 226 # Java. For instance, namespaces will be presented as packages, qualified
 227 # scopes will look different, etc.
 228
 229 OPTIMIZE_OUTPUT_JAVA   = NO
 230
 231 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
 232 # sources only. Doxygen will then generate output that is more tailored for
 233 # Fortran.
 234
 235 OPTIMIZE_FOR_FORTRAN   = NO
 236
 237 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
 238 # sources. Doxygen will then generate output that is tailored for
 239 # VHDL.
 240
 241 OPTIMIZE_OUTPUT_VHDL   = NO
 242
 243 # Doxygen selects the parser to use depending on the extension of the files it
 244 # parses. With this tag you can assign which parser to use for a given
 245 # extension. Doxygen has a built-in mapping, but you can override or extend it
 246 # using this tag. The format is ext=language, where ext is a file extension,
 247 # and language is one of the parsers supported by doxygen: IDL, Java,
 248 # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
 249 # C++. For instance to make doxygen treat .inc files as Fortran files (default
 250 # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
 251 # that for custom extensions you also need to set FILE_PATTERNS otherwise the
 252 # files are not read by doxygen.
 253
 254 EXTENSION_MAPPING      =
 255
 256 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
 257 # comments according to the Markdown format, which allows for more readable
 258 # documentation. See http://daringfireball.net/projects/markdown/ for details.
 259 # The output of markdown processing is further processed by doxygen, so you
 260 # can mix doxygen, HTML, and XML commands with Markdown formatting.
 261 # Disable only in case of backward compatibilities issues.
 262
 263 MARKDOWN_SUPPORT       = YES
 264
 265 # When enabled doxygen tries to link words that correspond to documented classes,
 266 # or namespaces to their corresponding documentation. Such a link can be
 267 # prevented in individual cases by by putting a % sign in front of the word or
 268 # globally by setting AUTOLINK_SUPPORT to NO.
 269
 270 AUTOLINK_SUPPORT       = YES
 271
 272 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
 273 # to include (a tag file for) the STL sources as input, then you should
 274 # set this tag to YES in order to let doxygen match functions declarations and
 275 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
 276 # func(std::string) {}). This also makes the inheritance and collaboration
 277 # diagrams that involve STL classes more complete and accurate.
 278
 279 BUILTIN_STL_SUPPORT    = NO
 280
 281 # If you use Microsoft's C++/CLI language, you should set this option to YES to
 282 # enable parsing support.
 283
 284 CPP_CLI_SUPPORT        = NO
 285
 286 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
 287 # Doxygen will parse them like normal C++ but will assume all classes use public
 288 # instead of private inheritance when no explicit protection keyword is present.
 289
 290 SIP_SUPPORT            = NO
 291
 292 # For Microsoft's IDL there are propget and propput attributes to indicate
 293 # getter and setter methods for a property. Setting this option to YES (the
 294 # default) will make doxygen replace the get and set methods by a property in
 295 # the documentation. This will only work if the methods are indeed getting or
 296 # setting a simple type. If this is not the case, or you want to show the
 297 # methods anyway, you should set this option to NO.
 298
 299 IDL_PROPERTY_SUPPORT   = YES
 300
 301 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
 302 # tag is set to YES, then doxygen will reuse the documentation of the first
 303 # member in the group (if any) for the other members of the group. By default
 304 # all members of a group must be documented explicitly.
 305
 306 DISTRIBUTE_GROUP_DOC   = NO
 307
 308 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
 309 # the same type (for instance a group of public functions) to be put as a
 310 # subgroup of that type (e.g. under the Public Functions section). Set it to
 311 # NO to prevent subgrouping. Alternatively, this can be done per class using
 312 # the \nosubgrouping command.
 313
 314 SUBGROUPING            = YES
 315
 316 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
 317 # unions are shown inside the group in which they are included (e.g. using
 318 # @ingroup) instead of on a separate page (for HTML and Man pages) or
 319 # section (for LaTeX and RTF).
 320
 321 INLINE_GROUPED_CLASSES = NO
 322
 323 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
 324 # unions with only public data fields will be shown inline in the documentation
 325 # of the scope in which they are defined (i.e. file, namespace, or group
 326 # documentation), provided this scope is documented. If set to NO (the default),
 327 # structs, classes, and unions are shown on a separate page (for HTML and Man
 328 # pages) or section (for LaTeX and RTF).
 329
 330 INLINE_SIMPLE_STRUCTS  = NO
 331
 332 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
 333 # is documented as struct, union, or enum with the name of the typedef. So
 334 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
 335 # with name TypeT. When disabled the typedef will appear as a member of a file,
 336 # namespace, or class. And the struct will be named TypeS. This can typically
 337 # be useful for C code in case the coding convention dictates that all compound
 338 # types are typedef'ed and only the typedef is referenced, never the tag name.
 339
 340 TYPEDEF_HIDES_STRUCT   = NO
 341
 342 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
 343 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
 344 # their name and scope. Since this can be an expensive process and often the
 345 # same symbol appear multiple times in the code, doxygen keeps a cache of
 346 # pre-resolved symbols. If the cache is too small doxygen will become slower.
 347 # If the cache is too large, memory is wasted. The cache size is given by this
 348 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
 349 # corresponding to a cache size of 2^16 = 65536 symbols.
 350
 351 LOOKUP_CACHE_SIZE      = 0
 352
 353 #---------------------------------------------------------------------------
 354 # Build related configuration options
 355 #---------------------------------------------------------------------------
 356
 357 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
 358 # documentation are documented, even if no documentation was available.
 359 # Private class members and static file members will be hidden unless
 360 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
 361
 362 EXTRACT_ALL            = YES
 363
 364 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
 365 # will be included in the documentation.
 366
 367 EXTRACT_PRIVATE        = NO
 368
 369 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
 370 # scope will be included in the documentation.
 371
 372 EXTRACT_PACKAGE        = NO
 373
 374 # If the EXTRACT_STATIC tag is set to YES all static members of a file
 375 # will be included in the documentation.
 376
 377 EXTRACT_STATIC         = NO
 378
 379 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
 380 # defined locally in source files will be included in the documentation.
 381 # If set to NO only classes defined in header files are included.
 382
 383 EXTRACT_LOCAL_CLASSES  = YES
 384
 385 # This flag is only useful for Objective-C code. When set to YES local
 386 # methods, which are defined in the implementation section but not in
 387 # the interface are included in the documentation.
 388 # If set to NO (the default) only methods in the interface are included.
 389
 390 EXTRACT_LOCAL_METHODS  = NO
 391
 392 # If this flag is set to YES, the members of anonymous namespaces will be
 393 # extracted and appear in the documentation as a namespace called
 394 # 'anonymous_namespace{file}', where file will be replaced with the base
 395 # name of the file that contains the anonymous namespace. By default
 396 # anonymous namespaces are hidden.
 397
 398 EXTRACT_ANON_NSPACES   = NO
 399
 400 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
 401 # undocumented members of documented classes, files or namespaces.
 402 # If set to NO (the default) these members will be included in the
 403 # various overviews, but no documentation section is generated.
 404 # This option has no effect if EXTRACT_ALL is enabled.
 405
 406 HIDE_UNDOC_MEMBERS     = NO
 407
 408 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
 409 # undocumented classes that are normally visible in the class hierarchy.
 410 # If set to NO (the default) these classes will be included in the various
 411 # overviews. This option has no effect if EXTRACT_ALL is enabled.
 412
 413 HIDE_UNDOC_CLASSES     = NO
 414
 415 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
 416 # friend (class|struct|union) declarations.
 417 # If set to NO (the default) these declarations will be included in the
 418 # documentation.
 419
 420 HIDE_FRIEND_COMPOUNDS  = NO
 421
 422 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
 423 # documentation blocks found inside the body of a function.
 424 # If set to NO (the default) these blocks will be appended to the
 425 # function's detailed documentation block.
 426
 427 HIDE_IN_BODY_DOCS      = NO
 428
 429 # The INTERNAL_DOCS tag determines if documentation
 430 # that is typed after a \internal command is included. If the tag is set
 431 # to NO (the default) then the documentation will be excluded.
 432 # Set it to YES to include the internal documentation.
 433
 434 INTERNAL_DOCS          = NO
 435
 436 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
 437 # file names in lower-case letters. If set to YES upper-case letters are also
 438 # allowed. This is useful if you have classes or files whose names only differ
 439 # in case and if your file system supports case sensitive file names. Windows
 440 # and Mac users are advised to set this option to NO.
 441
 442 CASE_SENSE_NAMES       = NO
 443
 444 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
 445 # will show members with their full class and namespace scopes in the
 446 # documentation. If set to YES the scope will be hidden.
 447
 448 HIDE_SCOPE_NAMES       = NO
 449
 450 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
 451 # will put a list of the files that are included by a file in the documentation
 452 # of that file.
 453
 454 SHOW_INCLUDE_FILES     = NO
 455
 456 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
 457 # will list include files with double quotes in the documentation
 458 # rather than with sharp brackets.
 459
 460 FORCE_LOCAL_INCLUDES   = NO
 461
 462 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
 463 # is inserted in the documentation for inline members.
 464
 465 INLINE_INFO            = YES
 466
 467 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
 468 # will sort the (detailed) documentation of file and class members
 469 # alphabetically by member name. If set to NO the members will appear in
 470 # declaration order.
 471
 472 SORT_MEMBER_DOCS       = YES
 473
 474 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
 475 # brief documentation of file, namespace and class members alphabetically
 476 # by member name. If set to NO (the default) the members will appear in
 477 # declaration order.
 478
 479 SORT_BRIEF_DOCS        = NO
 480
 481 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
 482 # will sort the (brief and detailed) documentation of class members so that
 483 # constructors and destructors are listed first. If set to NO (the default)
 484 # the constructors will appear in the respective orders defined by
 485 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
 486 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
 487 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
 488
 489 SORT_MEMBERS_CTORS_1ST = NO
 490
 491 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
 492 # hierarchy of group names into alphabetical order. If set to NO (the default)
 493 # the group names will appear in their defined order.
 494
 495 SORT_GROUP_NAMES       = NO
 496
 497 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
 498 # sorted by fully-qualified names, including namespaces. If set to
 499 # NO (the default), the class list will be sorted only by class name,
 500 # not including the namespace part.
 501 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
 502 # Note: This option applies only to the class list, not to the
 503 # alphabetical list.
 504
 505 SORT_BY_SCOPE_NAME     = NO
 506
 507 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
 508 # do proper type resolution of all parameters of a function it will reject a
 509 # match between the prototype and the implementation of a member function even
 510 # if there is only one candidate or it is obvious which candidate to choose
 511 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
 512 # will still accept a match between prototype and implementation in such cases.
 513
 514 STRICT_PROTO_MATCHING  = NO
 515
 516 # The GENERATE_TODOLIST tag can be used to enable (YES) or
 517 # disable (NO) the todo list. This list is created by putting \todo
 518 # commands in the documentation.
 519
 520 GENERATE_TODOLIST      = YES
 521
 522 # The GENERATE_TESTLIST tag can be used to enable (YES) or
 523 # disable (NO) the test list. This list is created by putting \test
 524 # commands in the documentation.
 525
 526 GENERATE_TESTLIST      = YES
 527
 528 # The GENERATE_BUGLIST tag can be used to enable (YES) or
 529 # disable (NO) the bug list. This list is created by putting \bug
 530 # commands in the documentation.
 531
 532 GENERATE_BUGLIST       = YES
 533
 534 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
 535 # disable (NO) the deprecated list. This list is created by putting
 536 # \deprecated commands in the documentation.
 537
 538 GENERATE_DEPRECATEDLIST= YES
 539
 540 # The ENABLED_SECTIONS tag can be used to enable conditional
 541 # documentation sections, marked by \if sectionname ... \endif.
 542
 543 ENABLED_SECTIONS       =
 544
 545 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
 546 # the initial value of a variable or macro consists of for it to appear in
 547 # the documentation. If the initializer consists of more lines than specified
 548 # here it will be hidden. Use a value of 0 to hide initializers completely.
 549 # The appearance of the initializer of individual variables and macros in the
 550 # documentation can be controlled using \showinitializer or \hideinitializer
 551 # command in the documentation regardless of this setting.
 552
 553 MAX_INITIALIZER_LINES  = 125
 554
 555 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
 556 # at the bottom of the documentation of classes and structs. If set to YES the
 557 # list will mention the files that were used to generate the documentation.
 558
 559 SHOW_USED_FILES        = YES
 560
 561 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
 562 # This will remove the Files entry from the Quick Index and from the
 563 # Folder Tree View (if specified). The default is YES.
 564
 565 SHOW_FILES             = YES
 566
 567 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
 568 # Namespaces page.  This will remove the Namespaces entry from the Quick Index
 569 # and from the Folder Tree View (if specified). The default is YES.
 570
 571 SHOW_NAMESPACES        = YES
 572
 573 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
 574 # doxygen should invoke to get the current version for each file (typically from
 575 # the version control system). Doxygen will invoke the program by executing (via
 576 # popen()) the command <command> <input-file>, where <command> is the value of
 577 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
 578 # provided by doxygen. Whatever the program writes to standard output
 579 # is used as the file version. See the manual for examples.
 580
 581 FILE_VERSION_FILTER    =
 582
 583 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
 584 # by doxygen. The layout file controls the global structure of the generated
 585 # output files in an output format independent way. To create the layout file
 586 # that represents doxygen's defaults, run doxygen with the -l option.
 587 # You can optionally specify a file name after the option, if omitted
 588 # DoxygenLayout.xml will be used as the name of the layout file.
 589
 590 LAYOUT_FILE            = doxygenLayout.xml
 591
 592 # The CITE_BIB_FILES tag can be used to specify one or more bib files
 593 # containing the references data. This must be a list of .bib files. The
 594 # .bib extension is automatically appended if omitted. Using this command
 595 # requires the bibtex tool to be installed. See also
 596 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
 597 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
 598 # feature you need bibtex and perl available in the search path.
 599
 600 CITE_BIB_FILES         =
 601
 602 #---------------------------------------------------------------------------
 603 # configuration options related to warning and progress messages
 604 #---------------------------------------------------------------------------
 605
 606 # The QUIET tag can be used to turn on/off the messages that are generated
 607 # by doxygen. Possible values are YES and NO. If left blank NO is used.
 608
 609 QUIET                  = NO
 610
 611 # The WARNINGS tag can be used to turn on/off the warning messages that are
 612 # generated by doxygen. Possible values are YES and NO. If left blank
 613 # NO is used.
 614
 615 WARNINGS               = YES
 616
 617 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
 618 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
 619 # automatically be disabled.
 620
 621 WARN_IF_UNDOCUMENTED   = YES
 622
 623 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
 624 # potential errors in the documentation, such as not documenting some
 625 # parameters in a documented function, or documenting parameters that
 626 # don't exist or using markup commands wrongly.
 627
 628 WARN_IF_DOC_ERROR      = YES
 629
 630 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
 631 # functions that are documented, but have no documentation for their parameters
 632 # or return value. If set to NO (the default) doxygen will only warn about
 633 # wrong or incomplete parameter documentation, but not about the absence of
 634 # documentation.
 635
 636 WARN_NO_PARAMDOC       = NO
 637
 638 # The WARN_FORMAT tag determines the format of the warning messages that
 639 # doxygen can produce. The string should contain the $file, $line, and $text
 640 # tags, which will be replaced by the file and line number from which the
 641 # warning originated and the warning text. Optionally the format may contain
 642 # $version, which will be replaced by the version of the file (if it could
 643 # be obtained via FILE_VERSION_FILTER)
 644
 645 WARN_FORMAT            = "$file:$line: $text"
 646
 647 # The WARN_LOGFILE tag can be used to specify a file to which warning
 648 # and error messages should be written. If left blank the output is written
 649 # to stderr.
 650
 651 WARN_LOGFILE           = ./doxygen.log
 652
 653 #---------------------------------------------------------------------------
 654 # configuration options related to the input files
 655 #---------------------------------------------------------------------------
 656
 657 # The INPUT tag can be used to specify the files and/or directories that contain
 658 # documented source files. You may enter file names like "myfile.cpp" or
 659 # directories like "/usr/src/myproject". Separate the files or directories
 660 # with spaces.
 661
 662 INPUT                  = . \
 663              ../../csdk/security/provisioning/include/ocprovisioningmanager.h \
 664              ../../csdk/security/provisioning/include/pmtypes.h \
 665              ../../csdk/security/provisioning/include/pmutility.h \
 666              ../../csdk/stack/include/ocstack.h \
 667              ../../csdk/stack/include/octypes.h \
 668              ../../csdk/stack/include/ocpayload.h \
 669              ../../csdk/stack/include/ocpresence.h \
 670              ../../csdk/stack/include/payload_logging.h \
 671              ../../csdk/stack/include/ocstackconfig.h \
 672              ../../csdk/stack/include/internal/occlientcb.h \
 673              ../../csdk/stack/include/internal/occollection.h \
 674              ../../csdk/stack/include/internal/ocobserve.h \
 675              ../../csdk/stack/include/internal/ocpayloadcbor.h \
 676              ../../csdk/stack/include/internal/ocresource.h \
 677              ../../csdk/stack/include/internal/ocresourcehandler.h \
 678              ../../csdk/stack/include/internal/ocserverrequest.h \
 679              ../../csdk/stack/include/internal/ocstackinternal.h \
 680              ../../csdk/stack/include/internal/oicgroup.h \
 681              ../../csdk/stack/include/internal/oickeepalive.h \
 682              guides \
 683              ../../csdk/security/include \
 684              ../../csdk/security/include\internal \
 685              ../../csdk/security/provisioning/include \
 686              ../../csdk/security/provisioning/include/internal \
 687              ../../csdk/security/provisioning/include/oxm \
 688              ../../csdk/security/provisioning/include/cloud \
 689              ../../csdk/resource-directory/include \
 690              ../../csdk/routing/include \
 691              ../../../service/easy-setup/inc \
 692              ../../../service/easy-setup/enrollee/inc \
 693              ../../../service/notification/include \
 694              ../../../service/coap-http-proxy/include \
 695
 696
 697 # This tag can be used to specify the character encoding of the source files
 698 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
 699 # also the default input encoding. Doxygen uses libiconv (or the iconv built
 700 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
 701 # the list of possible encodings.
 702
 703 INPUT_ENCODING         = UTF-8
 704
 705 # If the value of the INPUT tag contains directories, you can use the
 706 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 707 # and *.h) to filter out the source-files in the directories. If left
 708 # blank the following patterns are tested:
 709 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
 710 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
 711 # *.f90 *.f *.for *.vhd *.vhdl
 712
 713 FILE_PATTERNS          = *.c \
 714                          *.cc \
 715                          *.cxx \
 716                          *.cpp \
 717                          *.c++ \
 718                          *.d \
 719                          *.java \
 720                          *.ii \
 721                          *.ixx \
 722                          *.ipp \
 723                          *.i++ \
 724                          *.inl \
 725                          *.h \
 726                          *.hh \
 727                          *.hxx \
 728                          *.hpp \
 729                          *.h++ \
 730                          *.idl \
 731                          *.odl \
 732                          *.cs \
 733                          *.php \
 734                          *.php3 \
 735                          *.inc \
 736                          *.m \
 737                          *.markdown \
 738                          *.md \
 739                          *.mm \
 740                          *.dox \
 741                          *.py \
 742                          *.f90 \
 743                          *.f \
 744                          *.for \
 745                          *.vhd \
 746                          *.vhdl \
 747                          *.txt
 748
 749 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 750 # should be searched for input files as well. Possible values are YES and NO.
 751 # If left blank NO is used.
 752
 753 RECURSIVE              = NO
 754
 755 # The EXCLUDE tag can be used to specify files and/or directories that should be
 756 # excluded from the INPUT source files. This way you can easily exclude a
 757 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 758 # Note that relative paths are relative to the directory from which doxygen is
 759 # run.
 760
 761 EXCLUDE                =
 762
 763 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 764 # directories that are symbolic links (a Unix file system feature) are excluded
 765 # from the input.
 766
 767 EXCLUDE_SYMLINKS       = NO
 768
 769 # If the value of the INPUT tag contains directories, you can use the
 770 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
 771 # certain files from those directories. Note that the wildcards are matched
 772 # against the file with absolute path, so to exclude all test directories
 773 # for example use the pattern */test/*
 774
 775 EXCLUDE_PATTERNS       =
 776
 777 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 778 # (namespaces, classes, functions, etc.) that should be excluded from the
 779 # output. The symbol name can be a fully qualified name, a word, or if the
 780 # wildcard * is used, a substring. Examples: ANamespace, AClass,
 781 # AClass::ANamespace, ANamespace::*Test
 782
 783 EXCLUDE_SYMBOLS        =
 784
 785 # The EXAMPLE_PATH tag can be used to specify one or more files or
 786 # directories that contain example code fragments that are included (see
 787 # the \include command).
 788
 789 EXAMPLE_PATH           =
 790
 791 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 792 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 793 # and *.h) to filter out the source-files in the directories. If left
 794 # blank all files are included.
 795
 796 EXAMPLE_PATTERNS       = *
 797
 798 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
 799 # searched for input files to be used with the \include or \dontinclude
 800 # commands irrespective of the value of the RECURSIVE tag.
 801 # Possible values are YES and NO. If left blank NO is used.
 802
 803 EXAMPLE_RECURSIVE      = NO
 804
 805 # The IMAGE_PATH tag can be used to specify one or more files or
 806 # directories that contain image that are included in the documentation (see
 807 # the \image command).
 808
 809 IMAGE_PATH             = img
 810
 811 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 812 # invoke to filter for each input file. Doxygen will invoke the filter program
 813 # by executing (via popen()) the command <filter> <input-file>, where <filter>
 814 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
 815 # input file. Doxygen will then use the output that the filter program writes
 816 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
 817 # ignored.
 818
 819 INPUT_FILTER           =
 820
 821 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
 822 # basis.  Doxygen will compare the file name with each pattern and apply the
 823 # filter if there is a match.  The filters are a list of the form:
 824 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
 825 # info on how filters are used. If FILTER_PATTERNS is empty or if
 826 # non of the patterns match the file name, INPUT_FILTER is applied.
 827
 828 FILTER_PATTERNS        =
 829
 830 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
 831 # INPUT_FILTER) will be used to filter the input files when producing source
 832 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
 833
 834 FILTER_SOURCE_FILES    = NO
 835
 836 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
 837 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
 838 # and it is also possible to disable source filtering for a specific pattern
 839 # using *.ext= (so without naming a filter). This option only has effect when
 840 # FILTER_SOURCE_FILES is enabled.
 841
 842 FILTER_SOURCE_PATTERNS =
 843
 844 #---------------------------------------------------------------------------
 845 # configuration options related to source browsing
 846 #---------------------------------------------------------------------------
 847
 848 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
 849 # be generated. Documented entities will be cross-referenced with these sources.
 850 # Note: To get rid of all source code in the generated output, make sure also
 851 # VERBATIM_HEADERS is set to NO.
 852
 853 SOURCE_BROWSER         = NO
 854
 855 # Setting the INLINE_SOURCES tag to YES will include the body
 856 # of functions and classes directly in the documentation.
 857
 858 INLINE_SOURCES         = NO
 859
 860 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
 861 # doxygen to hide any special comment blocks from generated source code
 862 # fragments. Normal C, C++ and Fortran comments will always remain visible.
 863
 864 STRIP_CODE_COMMENTS    = YES
 865
 866 # If the REFERENCED_BY_RELATION tag is set to YES
 867 # then for each documented function all documented
 868 # functions referencing it will be listed.
 869
 870 REFERENCED_BY_RELATION = NO
 871
 872 # If the REFERENCES_RELATION tag is set to YES
 873 # then for each documented function all documented entities
 874 # called/used by that function will be listed.
 875
 876 REFERENCES_RELATION    = NO
 877
 878 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
 879 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
 880 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
 881 # link to the source code.  Otherwise they will link to the documentation.
 882
 883 REFERENCES_LINK_SOURCE = YES
 884
 885 # If the USE_HTAGS tag is set to YES then the references to source code
 886 # will point to the HTML generated by the htags(1) tool instead of doxygen
 887 # built-in source browser. The htags tool is part of GNU's global source
 888 # tagging system (see http://www.gnu.org/software/global/global.html). You
 889 # will need version 4.8.6 or higher.
 890
 891 USE_HTAGS              = NO
 892
 893 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
 894 # will generate a verbatim copy of the header file for each class for
 895 # which an include is specified. Set to NO to disable this.
 896
 897 VERBATIM_HEADERS       = YES
 898
 899 #---------------------------------------------------------------------------
 900 # configuration options related to the alphabetical class index
 901 #---------------------------------------------------------------------------
 902
 903 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
 904 # of all compounds will be generated. Enable this if the project
 905 # contains a lot of classes, structs, unions or interfaces.
 906
 907 ALPHABETICAL_INDEX     = YES
 908
 909 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
 910 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
 911 # in which this list will be split (can be a number in the range [1..20])
 912
 913 COLS_IN_ALPHA_INDEX    = 5
 914
 915 # In case all classes in a project start with a common prefix, all
 916 # classes will be put under the same header in the alphabetical index.
 917 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
 918 # should be ignored while generating the index headers.
 919
 920 IGNORE_PREFIX          =
 921
 922 #---------------------------------------------------------------------------
 923 # configuration options related to the HTML output
 924 #---------------------------------------------------------------------------
 925
 926 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
 927 # generate HTML output.
 928
 929 GENERATE_HTML          = YES
 930
 931 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
 932 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 933 # put in front of it. If left blank `html' will be used as the default path.
 934
 935 HTML_OUTPUT            = html
 936
 937 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
 938 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
 939 # doxygen will generate files with .html extension.
 940
 941 HTML_FILE_EXTENSION    = .html
 942
 943 # The HTML_HEADER tag can be used to specify a personal HTML header for
 944 # each generated HTML page. If it is left blank doxygen will generate a
 945 # standard header. Note that when using a custom header you are responsible
 946 # for the proper inclusion of any scripts and style sheets that doxygen
 947 # needs, which is dependent on the configuration options used.
 948 # It is advised to generate a default header using "doxygen -w html
 949 # header.html footer.html stylesheet.css YourConfigFile" and then modify
 950 # that header. Note that the header is subject to change so you typically
 951 # have to redo this when upgrading to a newer version of doxygen or when
 952 # changing the value of configuration settings such as GENERATE_TREEVIEW!
 953
 954 HTML_HEADER            =
 955
 956 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 957 # each generated HTML page. If it is left blank doxygen will generate a
 958 # standard footer.
 959
 960 HTML_FOOTER            = html/footer.html
 961
 962 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
 963 # style sheet that is used by each HTML page. It can be used to
 964 # fine-tune the look of the HTML output. If left blank doxygen will
 965 # generate a default style sheet. Note that it is recommended to use
 966 # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
 967 # tag will in the future become obsolete.
 968
 969 HTML_STYLESHEET        =
 970
 971 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
 972 # user-defined cascading style sheet that is included after the standard
 973 # style sheets created by doxygen. Using this option one can overrule
 974 # certain style aspects. This is preferred over using HTML_STYLESHEET
 975 # since it does not replace the standard style sheet and is therefor more
 976 # robust against future updates. Doxygen will copy the style sheet file to
 977 # the output directory.
 978
 979 HTML_EXTRA_STYLESHEET  =
 980
 981 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 982 # other source files which should be copied to the HTML output directory. Note
 983 # that these files will be copied to the base HTML output directory. Use the
 984 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
 985 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
 986 # the files will be copied as-is; there are no commands or markers available.
 987
 988 HTML_EXTRA_FILES       =
 989
 990 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
 991 # Doxygen will adjust the colors in the style sheet and background images
 992 # according to this color. Hue is specified as an angle on a colorwheel,
 993 # see http://en.wikipedia.org/wiki/Hue for more information.
 994 # For instance the value 0 represents red, 60 is yellow, 120 is green,
 995 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
 996 # The allowed range is 0 to 359.
 997
 998 HTML_COLORSTYLE_HUE    = 220
 999
1000 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
1001 # the colors in the HTML output. For a value of 0 the output will use
1002 # grayscales only. A value of 255 will produce the most vivid colors.
1003
1004 HTML_COLORSTYLE_SAT    = 100
1005
1006 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
1007 # the luminance component of the colors in the HTML output. Values below
1008 # 100 gradually make the output lighter, whereas values above 100 make
1009 # the output darker. The value divided by 100 is the actual gamma applied,
1010 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1011 # and 100 does not change the gamma.
1012
1013 HTML_COLORSTYLE_GAMMA  = 80
1014
1015 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1016 # page will contain the date and time when the page was generated. Setting
1017 # this to NO can help when comparing the output of multiple runs.
1018
1019 HTML_TIMESTAMP         = YES
1020
1021 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1022 # documentation will contain sections that can be hidden and shown after the
1023 # page has loaded.
1024
1025 HTML_DYNAMIC_SECTIONS  = NO
1026
1027 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
1028 # entries shown in the various tree structured indices initially; the user
1029 # can expand and collapse entries dynamically later on. Doxygen will expand
1030 # the tree to such a level that at most the specified number of entries are
1031 # visible (unless a fully collapsed tree already exceeds this amount).
1032 # So setting the number of entries 1 will produce a full collapsed tree by
1033 # default. 0 is a special value representing an infinite number of entries
1034 # and will result in a full expanded tree by default.
1035
1036 HTML_INDEX_NUM_ENTRIES = 100
1037
1038 # If the GENERATE_DOCSET tag is set to YES, additional index files
1039 # will be generated that can be used as input for Apple's Xcode 3
1040 # integrated development environment, introduced with OSX 10.5 (Leopard).
1041 # To create a documentation set, doxygen will generate a Makefile in the
1042 # HTML output directory. Running make will produce the docset in that
1043 # directory and running "make install" will install the docset in
1044 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1045 # it at startup.
1046 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1047 # for more information.
1048
1049 GENERATE_DOCSET        = NO
1050
1051 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1052 # feed. A documentation feed provides an umbrella under which multiple
1053 # documentation sets from a single provider (such as a company or product suite)
1054 # can be grouped.
1055
1056 DOCSET_FEEDNAME        = "Doxygen generated docs"
1057
1058 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1059 # should uniquely identify the documentation set bundle. This should be a
1060 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1061 # will append .docset to the name.
1062
1063 DOCSET_BUNDLE_ID       = org.doxygen.Project
1064
1065 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
1066 # identify the documentation publisher. This should be a reverse domain-name
1067 # style string, e.g. com.mycompany.MyDocSet.documentation.
1068
1069 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1070
1071 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1072
1073 DOCSET_PUBLISHER_NAME  = Publisher
1074
1075 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1076 # will be generated that can be used as input for tools like the
1077 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1078 # of the generated HTML documentation.
1079
1080 GENERATE_HTMLHELP      = NO
1081
1082 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1083 # be used to specify the file name of the resulting .chm file. You
1084 # can add a path in front of the file if the result should not be
1085 # written to the html output directory.
1086
1087 CHM_FILE               =
1088
1089 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1090 # be used to specify the location (absolute path including file name) of
1091 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1092 # the HTML help compiler on the generated index.hhp.
1093
1094 HHC_LOCATION           =
1095
1096 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1097 # controls if a separate .chi index file is generated (YES) or that
1098 # it should be included in the master .chm file (NO).
1099
1100 GENERATE_CHI           = NO
1101
1102 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1103 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1104 # content.
1105
1106 CHM_INDEX_ENCODING     =
1107
1108 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1109 # controls whether a binary table of contents is generated (YES) or a
1110 # normal table of contents (NO) in the .chm file.
1111
1112 BINARY_TOC             = NO
1113
1114 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1115 # to the contents of the HTML help documentation and to the tree view.
1116
1117 TOC_EXPAND             = NO
1118
1119 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1120 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1121 # that can be used as input for Qt's qhelpgenerator to generate a
1122 # Qt Compressed Help (.qch) of the generated HTML documentation.
1123
1124 GENERATE_QHP           = NO
1125
1126 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1127 # be used to specify the file name of the resulting .qch file.
1128 # The path specified is relative to the HTML output folder.
1129
1130 QCH_FILE               =
1131
1132 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1133 # Qt Help Project output. For more information please see
1134 # http://doc.trolltech.com/qthelpproject.html#namespace
1135
1136 QHP_NAMESPACE          = org.doxygen.Project
1137
1138 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1139 # Qt Help Project output. For more information please see
1140 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1141
1142 QHP_VIRTUAL_FOLDER     = doc
1143
1144 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1145 # add. For more information please see
1146 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1147
1148 QHP_CUST_FILTER_NAME   =
1149
1150 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1151 # custom filter to add. For more information please see
1152 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1153 # Qt Help Project / Custom Filters</a>.
1154
1155 QHP_CUST_FILTER_ATTRS  =
1156
1157 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1158 # project's
1159 # filter section matches.
1160 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1161 # Qt Help Project / Filter Attributes</a>.
1162
1163 QHP_SECT_FILTER_ATTRS  =
1164
1165 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1166 # be used to specify the location of Qt's qhelpgenerator.
1167 # If non-empty doxygen will try to run qhelpgenerator on the generated
1168 # .qhp file.
1169
1170 QHG_LOCATION           =
1171
1172 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1173 # will be generated, which together with the HTML files, form an Eclipse help
1174 # plugin. To install this plugin and make it available under the help contents
1175 # menu in Eclipse, the contents of the directory containing the HTML and XML
1176 # files needs to be copied into the plugins directory of eclipse. The name of
1177 # the directory within the plugins directory should be the same as
1178 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1179 # the help appears.
1180
1181 GENERATE_ECLIPSEHELP   = NO
1182
1183 # A unique identifier for the eclipse help plugin. When installing the plugin
1184 # the directory name containing the HTML and XML files should also have
1185 # this name.
1186
1187 ECLIPSE_DOC_ID         = org.doxygen.Project
1188
1189 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1190 # at top of each HTML page. The value NO (the default) enables the index and
1191 # the value YES disables it. Since the tabs have the same information as the
1192 # navigation tree you can set this option to NO if you already set
1193 # GENERATE_TREEVIEW to YES.
1194
1195 DISABLE_INDEX          = NO
1196
1197 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1198 # structure should be generated to display hierarchical information.
1199 # If the tag value is set to YES, a side panel will be generated
1200 # containing a tree-like index structure (just like the one that
1201 # is generated for HTML Help). For this to work a browser that supports
1202 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1203 # Windows users are probably better off using the HTML help feature.
1204 # Since the tree basically has the same information as the tab index you
1205 # could consider to set DISABLE_INDEX to NO when enabling this option.
1206
1207 GENERATE_TREEVIEW      = YES
1208
1209 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1210 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1211 # documentation. Note that a value of 0 will completely suppress the enum
1212 # values from appearing in the overview section.
1213
1214 ENUM_VALUES_PER_LINE   = 4
1215
1216 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1217 # used to set the initial width (in pixels) of the frame in which the tree
1218 # is shown.
1219
1220 TREEVIEW_WIDTH         = 250
1221
1222 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1223 # links to external symbols imported via tag files in a separate window.
1224
1225 EXT_LINKS_IN_WINDOW    = NO
1226
1227 # Use this tag to change the font size of Latex formulas included
1228 # as images in the HTML documentation. The default is 10. Note that
1229 # when you change the font size after a successful doxygen run you need
1230 # to manually remove any form_*.png images from the HTML output directory
1231 # to force them to be regenerated.
1232
1233 FORMULA_FONTSIZE       = 10
1234
1235 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1236 # generated for formulas are transparent PNGs. Transparent PNGs are
1237 # not supported properly for IE 6.0, but are supported on all modern browsers.
1238 # Note that when changing this option you need to delete any form_*.png files
1239 # in the HTML output before the changes have effect.
1240
1241 FORMULA_TRANSPARENT    = YES
1242
1243 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1244 # (see http://www.mathjax.org) which uses client side Javascript for the
1245 # rendering instead of using prerendered bitmaps. Use this if you do not
1246 # have LaTeX installed or if you want to formulas look prettier in the HTML
1247 # output. When enabled you may also need to install MathJax separately and
1248 # configure the path to it using the MATHJAX_RELPATH option.
1249
1250 USE_MATHJAX            = NO
1251
1252 # When MathJax is enabled you need to specify the location relative to the
1253 # HTML output directory using the MATHJAX_RELPATH option. The destination
1254 # directory should contain the MathJax.js script. For instance, if the mathjax
1255 # directory is located at the same level as the HTML output directory, then
1256 # MATHJAX_RELPATH should be ../mathjax. The default value points to
1257 # the MathJax Content Delivery Network so you can quickly see the result without
1258 # installing MathJax.  However, it is strongly recommended to install a local
1259 # copy of MathJax from http://www.mathjax.org before deployment.
1260
1261 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1262
1263 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1264 # names that should be enabled during MathJax rendering.
1265
1266 MATHJAX_EXTENSIONS     =
1267
1268 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1269 # for the HTML output. The underlying search engine uses javascript
1270 # and DHTML and should work on any modern browser. Note that when using
1271 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1272 # (GENERATE_DOCSET) there is already a search function so this one should
1273 # typically be disabled. For large projects the javascript based search engine
1274 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1275
1276 SEARCHENGINE           = YES
1277
1278 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1279 # implemented using a PHP enabled web server instead of at the web client
1280 # using Javascript. Doxygen will generate the search PHP script and index
1281 # file to put on the web server. The advantage of the server
1282 # based approach is that it scales better to large projects and allows
1283 # full text search. The disadvantages are that it is more difficult to setup
1284 # and does not have live searching capabilities.
1285
1286 SERVER_BASED_SEARCH    = NO
1287
1288 #---------------------------------------------------------------------------
1289 # configuration options related to the LaTeX output
1290 #---------------------------------------------------------------------------
1291
1292 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1293 # generate Latex output.
1294
1295 GENERATE_LATEX         = NO
1296
1297 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1298 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1299 # put in front of it. If left blank `latex' will be used as the default path.
1300
1301 LATEX_OUTPUT           = latex
1302
1303 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1304 # invoked. If left blank `latex' will be used as the default command name.
1305 # Note that when enabling USE_PDFLATEX this option is only used for
1306 # generating bitmaps for formulas in the HTML output, but not in the
1307 # Makefile that is written to the output directory.
1308
1309 LATEX_CMD_NAME         = latex
1310
1311 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1312 # generate index for LaTeX. If left blank `makeindex' will be used as the
1313 # default command name.
1314
1315 MAKEINDEX_CMD_NAME     = makeindex
1316
1317 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1318 # LaTeX documents. This may be useful for small projects and may help to
1319 # save some trees in general.
1320
1321 COMPACT_LATEX          = NO
1322
1323 # The PAPER_TYPE tag can be used to set the paper type that is used
1324 # by the printer. Possible values are: a4, letter, legal and
1325 # executive. If left blank a4wide will be used.
1326
1327 PAPER_TYPE             = a4
1328
1329 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1330 # packages that should be included in the LaTeX output.
1331
1332 EXTRA_PACKAGES         =
1333
1334 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1335 # the generated latex document. The header should contain everything until
1336 # the first chapter. If it is left blank doxygen will generate a
1337 # standard header. Notice: only use this tag if you know what you are doing!
1338
1339 LATEX_HEADER           =
1340
1341 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1342 # the generated latex document. The footer should contain everything after
1343 # the last chapter. If it is left blank doxygen will generate a
1344 # standard footer. Notice: only use this tag if you know what you are doing!
1345
1346 LATEX_FOOTER           =
1347
1348 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1349 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1350 # contain links (just like the HTML output) instead of page references
1351 # This makes the output suitable for online browsing using a pdf viewer.
1352
1353 PDF_HYPERLINKS         = YES
1354
1355 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1356 # plain latex in the generated Makefile. Set this option to YES to get a
1357 # higher quality PDF documentation.
1358
1359 USE_PDFLATEX           = YES
1360
1361 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1362 # command to the generated LaTeX files. This will instruct LaTeX to keep
1363 # running if errors occur, instead of asking the user for help.
1364 # This option is also used when generating formulas in HTML.
1365
1366 LATEX_BATCHMODE        = NO
1367
1368 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1369 # include the index chapters (such as File Index, Compound Index, etc.)
1370 # in the output.
1371
1372 LATEX_HIDE_INDICES     = NO
1373
1374 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1375 # source code with syntax highlighting in the LaTeX output.
1376 # Note that which sources are shown also depends on other settings
1377 # such as SOURCE_BROWSER.
1378
1379 LATEX_SOURCE_CODE      = NO
1380
1381 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1382 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1383 # http://en.wikipedia.org/wiki/BibTeX for more info.
1384
1385 LATEX_BIB_STYLE        = plain
1386
1387 #---------------------------------------------------------------------------
1388 # configuration options related to the RTF output
1389 #---------------------------------------------------------------------------
1390
1391 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1392 # The RTF output is optimized for Word 97 and may not look very pretty with
1393 # other RTF readers or editors.
1394
1395 GENERATE_RTF           = NO
1396
1397 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1398 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1399 # put in front of it. If left blank `rtf' will be used as the default path.
1400
1401 RTF_OUTPUT             = rtf
1402
1403 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1404 # RTF documents. This may be useful for small projects and may help to
1405 # save some trees in general.
1406
1407 COMPACT_RTF            = NO
1408
1409 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1410 # will contain hyperlink fields. The RTF file will
1411 # contain links (just like the HTML output) instead of page references.
1412 # This makes the output suitable for online browsing using WORD or other
1413 # programs which support those fields.
1414 # Note: wordpad (write) and others do not support links.
1415
1416 RTF_HYPERLINKS         = NO
1417
1418 # Load style sheet definitions from file. Syntax is similar to doxygen's
1419 # config file, i.e. a series of assignments. You only have to provide
1420 # replacements, missing definitions are set to their default value.
1421
1422 RTF_STYLESHEET_FILE    =
1423
1424 # Set optional variables used in the generation of an rtf document.
1425 # Syntax is similar to doxygen's config file.
1426
1427 RTF_EXTENSIONS_FILE    =
1428
1429 #---------------------------------------------------------------------------
1430 # configuration options related to the man page output
1431 #---------------------------------------------------------------------------
1432
1433 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1434 # generate man pages
1435
1436 GENERATE_MAN           = NO
1437
1438 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1439 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1440 # put in front of it. If left blank `man' will be used as the default path.
1441
1442 MAN_OUTPUT             = man
1443
1444 # The MAN_EXTENSION tag determines the extension that is added to
1445 # the generated man pages (default is the subroutine's section .3)
1446
1447 MAN_EXTENSION          = .3
1448
1449 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1450 # then it will generate one additional man file for each entity
1451 # documented in the real man page(s). These additional files
1452 # only source the real man page, but without them the man command
1453 # would be unable to find the correct page. The default is NO.
1454
1455 MAN_LINKS              = NO
1456
1457 #---------------------------------------------------------------------------
1458 # configuration options related to the XML output
1459 #---------------------------------------------------------------------------
1460
1461 # If the GENERATE_XML tag is set to YES Doxygen will
1462 # generate an XML file that captures the structure of
1463 # the code including all documentation.
1464
1465 GENERATE_XML           = NO
1466
1467 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1468 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1469 # put in front of it. If left blank `xml' will be used as the default path.
1470
1471 XML_OUTPUT             = xml
1472
1473 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1474 # dump the program listings (including syntax highlighting
1475 # and cross-referencing information) to the XML output. Note that
1476 # enabling this will significantly increase the size of the XML output.
1477
1478 XML_PROGRAMLISTING     = YES
1479
1480 #---------------------------------------------------------------------------
1481 # configuration options for the AutoGen Definitions output
1482 #---------------------------------------------------------------------------
1483
1484 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1485 # generate an AutoGen Definitions (see autogen.sf.net) file
1486 # that captures the structure of the code including all
1487 # documentation. Note that this feature is still experimental
1488 # and incomplete at the moment.
1489
1490 GENERATE_AUTOGEN_DEF   = NO
1491
1492 #---------------------------------------------------------------------------
1493 # configuration options related to the Perl module output
1494 #---------------------------------------------------------------------------
1495
1496 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1497 # generate a Perl module file that captures the structure of
1498 # the code including all documentation. Note that this
1499 # feature is still experimental and incomplete at the
1500 # moment.
1501
1502 GENERATE_PERLMOD       = NO
1503
1504 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1505 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1506 # to generate PDF and DVI output from the Perl module output.
1507
1508 PERLMOD_LATEX          = NO
1509
1510 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1511 # nicely formatted so it can be parsed by a human reader.  This is useful
1512 # if you want to understand what is going on.  On the other hand, if this
1513 # tag is set to NO the size of the Perl module output will be much smaller
1514 # and Perl will parse it just the same.
1515
1516 PERLMOD_PRETTY         = YES
1517
1518 # The names of the make variables in the generated doxyrules.make file
1519 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1520 # This is useful so different doxyrules.make files included by the same
1521 # Makefile don't overwrite each other's variables.
1522
1523 PERLMOD_MAKEVAR_PREFIX =
1524
1525 #---------------------------------------------------------------------------
1526 # Configuration options related to the preprocessor
1527 #---------------------------------------------------------------------------
1528
1529 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1530 # evaluate all C-preprocessor directives found in the sources and include
1531 # files.
1532
1533 ENABLE_PREPROCESSING   = YES
1534
1535 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1536 # names in the source code. If set to NO (the default) only conditional
1537 # compilation will be performed. Macro expansion can be done in a controlled
1538 # way by setting EXPAND_ONLY_PREDEF to YES.
1539
1540 MACRO_EXPANSION        = NO
1541
1542 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1543 # then the macro expansion is limited to the macros specified with the
1544 # PREDEFINED and EXPAND_AS_DEFINED tags.
1545
1546 EXPAND_ONLY_PREDEF     = NO
1547
1548 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1549 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1550
1551 SEARCH_INCLUDES        = YES
1552
1553 # The INCLUDE_PATH tag can be used to specify one or more directories that
1554 # contain include files that are not input files but should be processed by
1555 # the preprocessor.
1556
1557 INCLUDE_PATH           =
1558
1559 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1560 # patterns (like *.h and *.hpp) to filter out the header-files in the
1561 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1562 # be used.
1563
1564 INCLUDE_FILE_PATTERNS  =
1565
1566 # The PREDEFINED tag can be used to specify one or more macro names that
1567 # are defined before the preprocessor is started (similar to the -D option of
1568 # gcc). The argument of the tag is a list of macros of the form: name
1569 # or name=definition (no spaces). If the definition and the = are
1570 # omitted =1 is assumed. To prevent a macro definition from being
1571 # undefined via #undef or recursively expanded use the := operator
1572 # instead of the = operator.
1573
1574 PREDEFINED             =
1575
1576 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1577 # this tag can be used to specify a list of macro names that should be expanded.
1578 # The macro definition that is found in the sources will be used.
1579 # Use the PREDEFINED tag if you want to use a different macro definition that
1580 # overrules the definition found in the source code.
1581
1582 EXPAND_AS_DEFINED      =
1583
1584 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1585 # doxygen's preprocessor will remove all references to function-like macros
1586 # that are alone on a line, have an all uppercase name, and do not end with a
1587 # semicolon, because these will confuse the parser if not removed.
1588
1589 SKIP_FUNCTION_MACROS   = YES
1590
1591 #---------------------------------------------------------------------------
1592 # Configuration::additions related to external references
1593 #---------------------------------------------------------------------------
1594
1595 # The TAGFILES option can be used to specify one or more tagfiles. For each
1596 # tag file the location of the external documentation should be added. The
1597 # format of a tag file without this location is as follows:
1598 #   TAGFILES = file1 file2 ...
1599 # Adding location for the tag files is done as follows:
1600 #   TAGFILES = file1=loc1 "file2 = loc2" ...
1601 # where "loc1" and "loc2" can be relative or absolute paths
1602 # or URLs. Note that each tag file must have a unique name (where the name does
1603 # NOT include the path). If a tag file is not located in the directory in which
1604 # doxygen is run, you must also specify the path to the tagfile here.
1605
1606 TAGFILES               =
1607
1608 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1609 # a tag file that is based on the input files it reads.
1610
1611 GENERATE_TAGFILE       =
1612
1613 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1614 # in the class index. If set to NO only the inherited external classes
1615 # will be listed.
1616
1617 ALLEXTERNALS           = NO
1618
1619 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1620 # in the modules index. If set to NO, only the current project's groups will
1621 # be listed.
1622
1623 EXTERNAL_GROUPS        = YES
1624
1625 # The PERL_PATH should be the absolute path and name of the perl script
1626 # interpreter (i.e. the result of `which perl').
1627
1628 PERL_PATH              = /usr/bin/perl
1629
1630 #---------------------------------------------------------------------------
1631 # Configuration options related to the dot tool
1632 #---------------------------------------------------------------------------
1633
1634 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1635 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1636 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1637 # this option also works with HAVE_DOT disabled, but it is recommended to
1638 # install and use dot, since it yields more powerful graphs.
1639
1640 CLASS_DIAGRAMS         = NO
1641
1642 # You can define message sequence charts within doxygen comments using the \msc
1643 # command. Doxygen will then run the mscgen tool (see
1644 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1645 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1646 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1647 # default search path.
1648
1649 MSCGEN_PATH            =
1650
1651 # If set to YES, the inheritance and collaboration graphs will hide
1652 # inheritance and usage relations if the target is undocumented
1653 # or is not a class.
1654
1655 HIDE_UNDOC_RELATIONS   = YES
1656
1657 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1658 # available from the path. This tool is part of Graphviz, a graph visualization
1659 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1660 # have no effect if this option is set to NO (the default)
1661
1662 HAVE_DOT               = NO
1663
1664 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1665 # allowed to run in parallel. When set to 0 (the default) doxygen will
1666 # base this on the number of processors available in the system. You can set it
1667 # explicitly to a value larger than 0 to get control over the balance
1668 # between CPU load and processing speed.
1669
1670 DOT_NUM_THREADS        = 0
1671
1672 # By default doxygen will use the Helvetica font for all dot files that
1673 # doxygen generates. When you want a differently looking font you can specify
1674 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1675 # the font, which can be done by putting it in a standard location or by setting
1676 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1677 # directory containing the font.
1678
1679 DOT_FONTNAME           = Helvetica
1680
1681 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1682 # The default size is 10pt.
1683
1684 DOT_FONTSIZE           = 10
1685
1686 # By default doxygen will tell dot to use the Helvetica font.
1687 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1688 # set the path where dot can find it.
1689
1690 DOT_FONTPATH           =
1691
1692 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1693 # will generate a graph for each documented class showing the direct and
1694 # indirect inheritance relations. Setting this tag to YES will force the
1695 # CLASS_DIAGRAMS tag to NO.
1696
1697 CLASS_GRAPH            = YES
1698
1699 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1700 # will generate a graph for each documented class showing the direct and
1701 # indirect implementation dependencies (inheritance, containment, and
1702 # class references variables) of the class with other documented classes.
1703
1704 COLLABORATION_GRAPH    = YES
1705
1706 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1707 # will generate a graph for groups, showing the direct groups dependencies
1708
1709 GROUP_GRAPHS           = YES
1710
1711 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1712 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1713 # Language.
1714
1715 UML_LOOK               = NO
1716
1717 # If the UML_LOOK tag is enabled, the fields and methods are shown inside
1718 # the class node. If there are many fields or methods and many nodes the
1719 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1720 # threshold limits the number of items for each type to make the size more
1721 # managable. Set this to 0 for no limit. Note that the threshold may be
1722 # exceeded by 50% before the limit is enforced.
1723
1724 UML_LIMIT_NUM_FIELDS   = 10
1725
1726 # If set to YES, the inheritance and collaboration graphs will show the
1727 # relations between templates and their instances.
1728
1729 TEMPLATE_RELATIONS     = NO
1730
1731 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1732 # tags are set to YES then doxygen will generate a graph for each documented
1733 # file showing the direct and indirect include dependencies of the file with
1734 # other documented files.
1735
1736 INCLUDE_GRAPH          = YES
1737
1738 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1739 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1740 # documented header file showing the documented files that directly or
1741 # indirectly include this file.
1742
1743 INCLUDED_BY_GRAPH      = YES
1744
1745 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1746 # doxygen will generate a call dependency graph for every global function
1747 # or class method. Note that enabling this option will significantly increase
1748 # the time of a run. So in most cases it will be better to enable call graphs
1749 # for selected functions only using the \callgraph command.
1750
1751 CALL_GRAPH             = NO
1752
1753 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1754 # doxygen will generate a caller dependency graph for every global function
1755 # or class method. Note that enabling this option will significantly increase
1756 # the time of a run. So in most cases it will be better to enable caller
1757 # graphs for selected functions only using the \callergraph command.
1758
1759 CALLER_GRAPH           = NO
1760
1761 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1762 # will generate a graphical hierarchy of all classes instead of a textual one.
1763
1764 GRAPHICAL_HIERARCHY    = YES
1765
1766 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1767 # then doxygen will show the dependencies a directory has on other directories
1768 # in a graphical way. The dependency relations are determined by the #include
1769 # relations between the files in the directories.
1770
1771 DIRECTORY_GRAPH        = YES
1772
1773 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1774 # generated by dot. Possible values are svg, png, jpg, or gif.
1775 # If left blank png will be used. If you choose svg you need to set
1776 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1777 # visible in IE 9+ (other browsers do not have this requirement).
1778
1779 DOT_IMAGE_FORMAT       = png
1780
1781 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1782 # enable generation of interactive SVG images that allow zooming and panning.
1783 # Note that this requires a modern browser other than Internet Explorer.
1784 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1785 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1786 # visible. Older versions of IE do not have SVG support.
1787
1788 INTERACTIVE_SVG        = NO
1789
1790 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1791 # found. If left blank, it is assumed the dot tool can be found in the path.
1792
1793 DOT_PATH               =
1794
1795 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1796 # contain dot files that are included in the documentation (see the
1797 # \dotfile command).
1798
1799 DOTFILE_DIRS           =
1800
1801 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1802 # contain msc files that are included in the documentation (see the
1803 # \mscfile command).
1804
1805 MSCFILE_DIRS           =
1806
1807 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1808 # nodes that will be shown in the graph. If the number of nodes in a graph
1809 # becomes larger than this value, doxygen will truncate the graph, which is
1810 # visualized by representing a node as a red box. Note that doxygen if the
1811 # number of direct children of the root node in a graph is already larger than
1812 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1813 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1814
1815 DOT_GRAPH_MAX_NODES    = 50
1816
1817 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1818 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1819 # from the root by following a path via at most 3 edges will be shown. Nodes
1820 # that lay further from the root node will be omitted. Note that setting this
1821 # option to 1 or 2 may greatly reduce the computation time needed for large
1822 # code bases. Also note that the size of a graph can be further restricted by
1823 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1824
1825 MAX_DOT_GRAPH_DEPTH    = 0
1826
1827 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1828 # background. This is disabled by default, because dot on Windows does not
1829 # seem to support this out of the box. Warning: Depending on the platform used,
1830 # enabling this option may lead to badly anti-aliased labels on the edges of
1831 # a graph (i.e. they become hard to read).
1832
1833 DOT_TRANSPARENT        = NO
1834
1835 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1836 # files in one run (i.e. multiple -o and -T options on the command line). This
1837 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1838 # support this, this feature is disabled by default.
1839
1840 DOT_MULTI_TARGETS      = NO
1841
1842 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1843 # generate a legend page explaining the meaning of the various boxes and
1844 # arrows in the dot generated graphs.
1845
1846 GENERATE_LEGEND        = YES
1847
1848 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1849 # remove the intermediate dot files that are used to generate
1850 # the various graphs.
1851
1852 DOT_CLEANUP            = YES