Doxyfile.in
1 # Doxyfile 1.8.12 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 double hash (##) is considered a comment and is placed in 7 # front of the TAG it is preceding. 8 # 9 # All text after a single hash (#) is considered a comment and will be ignored. 10 # The format is: 11 # TAG = value [value, ...] 12 # For lists, items can also be appended using: 13 # TAG += value [value, ...] 14 # Values that contain spaces should be placed between quotes (\" \"). 15 16 #--------------------------------------------------------------------------- 17 # Project related configuration options 18 #--------------------------------------------------------------------------- 19 20 # This tag specifies the encoding used for all characters in the config file 21 # that follow. The default is UTF-8 which is also the encoding used for all text 22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 # for the list of possible encodings. 25 # The default value is: UTF-8. 26 27 DOXYFILE_ENCODING = UTF-8 28 29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 # double-quotes, unless you are using Doxywizard) that should identify the 31 # project for which the documentation is generated. This name is used in the 32 # title of most generated pages and in a few other places. 33 # The default value is: My Project. 34 35 PROJECT_NAME = "Bitcoin Core" 36 37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 # could be handy for archiving the generated documentation or if some version 39 # control system is used. 40 41 PROJECT_NUMBER = @CLIENT_VERSION_STRING@ 42 43 # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 # for a project that appears at the top of each page and should give viewer a 45 # quick idea about the purpose of the project. Keep the description short. 46 47 PROJECT_BRIEF = "P2P Digital Currency" 48 49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 # in the documentation. The maximum height of the logo should not exceed 55 51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 # the logo to the output directory. 53 54 PROJECT_LOGO = doc/bitcoin_logo_doxygen.png 55 56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 # into which the generated documentation will be written. If a relative path is 58 # entered, it will be relative to the location where doxygen was started. If 59 # left blank the current directory will be used. 60 61 OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc/doxygen 62 63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 # directories (in 2 levels) under the output directory of each output format and 65 # will distribute the generated files over these directories. Enabling this 66 # option can be useful when feeding doxygen a huge amount of source files, where 67 # putting all generated files in the same directory would otherwise causes 68 # performance problems for the file system. 69 # The default value is: NO. 70 71 CREATE_SUBDIRS = NO 72 73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 # characters to appear in the names of generated files. If set to NO, non-ASCII 75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 # U+3044. 77 # The default value is: NO. 78 79 ALLOW_UNICODE_NAMES = NO 80 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 # documentation generated by doxygen is written. Doxygen will use this 83 # information to generate all constant output in the proper language. 84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 # Ukrainian and Vietnamese. 92 # The default value is: English. 93 94 OUTPUT_LANGUAGE = English 95 96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 # descriptions after the members that are listed in the file and class 98 # documentation (similar to Javadoc). Set to NO to disable this. 99 # The default value is: YES. 100 101 BRIEF_MEMBER_DESC = YES 102 103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 # description of a member or function before the detailed description 105 # 106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 # brief descriptions will be completely suppressed. 108 # The default value is: YES. 109 110 REPEAT_BRIEF = YES 111 112 # This tag implements a quasi-intelligent brief description abbreviator that is 113 # used to form the text in various listings. Each string in this list, if found 114 # as the leading text of the brief description, will be stripped from the text 115 # and the result, after processing the whole list, is used as the annotated 116 # text. Otherwise, the brief description is used as-is. If left blank, the 117 # following values are used ($name is automatically replaced with the name of 118 # the entity):The $name class, The $name widget, The $name file, is, provides, 119 # specifies, contains, represents, a, an and the. 120 121 ABBREVIATE_BRIEF = "The $name class" \ 122 "The $name widget" \ 123 "The $name file" \ 124 is \ 125 provides \ 126 specifies \ 127 contains \ 128 represents \ 129 a \ 130 an \ 131 the 132 133 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 # doxygen will generate a detailed section even if there is only a brief 135 # description. 136 # The default value is: NO. 137 138 ALWAYS_DETAILED_SEC = NO 139 140 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 # inherited members of a class in the documentation of that class as if those 142 # members were ordinary class members. Constructors, destructors and assignment 143 # operators of the base classes will not be shown. 144 # The default value is: NO. 145 146 INLINE_INHERITED_MEMB = NO 147 148 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149 # before files name in the file list and in the header files. If set to NO the 150 # shortest path that makes the file name unique will be used 151 # The default value is: YES. 152 153 FULL_PATH_NAMES = YES 154 155 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 # Stripping is only done if one of the specified strings matches the left-hand 157 # part of the path. The tag can be used to show relative paths in the file list. 158 # If left blank the directory from which doxygen is run is used as the path to 159 # strip. 160 # 161 # Note that you can specify absolute paths here, but also relative paths, which 162 # will be relative from the directory where doxygen is started. 163 # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 165 STRIP_FROM_PATH = 166 167 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 # path mentioned in the documentation of a class, which tells the reader which 169 # header file to include in order to use a class. If left blank only the name of 170 # the header file containing the class definition is used. Otherwise one should 171 # specify the list of include paths that are normally passed to the compiler 172 # using the -I flag. 173 174 STRIP_FROM_INC_PATH = 175 176 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 # less readable) file names. This can be useful is your file systems doesn't 178 # support long names like on DOS, Mac, or CD-ROM. 179 # The default value is: NO. 180 181 SHORT_NAMES = NO 182 183 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 # first line (until the first dot) of a Javadoc-style comment as the brief 185 # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 # style comments (thus requiring an explicit @brief command for a brief 187 # description.) 188 # The default value is: NO. 189 190 JAVADOC_AUTOBRIEF = YES 191 192 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193 # line (until the first dot) of a Qt-style comment as the brief description. If 194 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195 # requiring an explicit \brief command for a brief description.) 196 # The default value is: NO. 197 198 QT_AUTOBRIEF = NO 199 200 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202 # a brief description. This used to be the default behavior. The new default is 203 # to treat a multi-line C++ comment block as a detailed description. Set this 204 # tag to YES if you prefer the old behavior instead. 205 # 206 # Note that setting this tag to YES also means that rational rose comments are 207 # not recognized any more. 208 # The default value is: NO. 209 210 MULTILINE_CPP_IS_BRIEF = NO 211 212 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213 # documentation from any documented member that it re-implements. 214 # The default value is: YES. 215 216 INHERIT_DOCS = YES 217 218 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 219 # page for each member. If set to NO, the documentation of a member will be part 220 # of the file/class/namespace that contains it. 221 # The default value is: NO. 222 223 SEPARATE_MEMBER_PAGES = NO 224 225 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226 # uses this value to replace tabs by spaces in code fragments. 227 # Minimum value: 1, maximum value: 16, default value: 4. 228 229 TAB_SIZE = 8 230 231 # This tag can be used to specify a number of aliases that act as commands in 232 # the documentation. An alias has the form: 233 # name=value 234 # For example adding 235 # "sideeffect=@par Side Effects:\n" 236 # will allow you to put the command \sideeffect (or @sideeffect) in the 237 # documentation, which will result in a user-defined paragraph with heading 238 # "Side Effects:". You can put \n's in the value part of an alias to insert 239 # newlines. 240 241 ALIASES = 242 243 # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 # A mapping has the form "name=value". For example adding "class=itcl::class" 245 # will allow you to use the command class in the itcl::class meaning. 246 247 TCL_SUBST = 248 249 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 # only. Doxygen will then generate output that is more tailored for C. For 251 # instance, some of the names that are used will be different. The list of all 252 # members will be omitted, etc. 253 # The default value is: NO. 254 255 OPTIMIZE_OUTPUT_FOR_C = NO 256 257 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 # Python sources only. Doxygen will then generate output that is more tailored 259 # for that language. For instance, namespaces will be presented as packages, 260 # qualified scopes will look different, etc. 261 # The default value is: NO. 262 263 OPTIMIZE_OUTPUT_JAVA = NO 264 265 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 # sources. Doxygen will then generate output that is tailored for Fortran. 267 # The default value is: NO. 268 269 OPTIMIZE_FOR_FORTRAN = NO 270 271 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 # sources. Doxygen will then generate output that is tailored for VHDL. 273 # The default value is: NO. 274 275 OPTIMIZE_OUTPUT_VHDL = NO 276 277 # Doxygen selects the parser to use depending on the extension of the files it 278 # parses. With this tag you can assign which parser to use for a given 279 # extension. Doxygen has a built-in mapping, but you can override or extend it 280 # using this tag. The format is ext=language, where ext is a file extension, and 281 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 # Fortran. In the later case the parser tries to guess whether the code is fixed 285 # or free formatted code, this is the default for Fortran type files), VHDL. For 286 # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 # 289 # Note: For files without extension you can use no_extension as a placeholder. 290 # 291 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 # the files are not read by doxygen. 293 294 EXTENSION_MAPPING = 295 296 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 # according to the Markdown format, which allows for more readable 298 # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 # The output of markdown processing is further processed by doxygen, so you can 300 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 # case of backward compatibilities issues. 302 # The default value is: YES. 303 304 MARKDOWN_SUPPORT = YES 305 306 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 307 # to that level are automatically included in the table of contents, even if 308 # they do not have an id attribute. 309 # Note: This feature currently applies only to Markdown headings. 310 # Minimum value: 0, maximum value: 99, default value: 0. 311 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 312 313 TOC_INCLUDE_HEADINGS = 0 314 315 # When enabled doxygen tries to link words that correspond to documented 316 # classes, or namespaces to their corresponding documentation. Such a link can 317 # be prevented in individual cases by putting a % sign in front of the word or 318 # globally by setting AUTOLINK_SUPPORT to NO. 319 # The default value is: YES. 320 321 AUTOLINK_SUPPORT = YES 322 323 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 324 # to include (a tag file for) the STL sources as input, then you should set this 325 # tag to YES in order to let doxygen match functions declarations and 326 # definitions whose arguments contain STL classes (e.g. func(std::string); 327 # versus func(std::string) {}). This also make the inheritance and collaboration 328 # diagrams that involve STL classes more complete and accurate. 329 # The default value is: NO. 330 331 BUILTIN_STL_SUPPORT = NO 332 333 # If you use Microsoft's C++/CLI language, you should set this option to YES to 334 # enable parsing support. 335 # The default value is: NO. 336 337 CPP_CLI_SUPPORT = NO 338 339 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 340 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 341 # will parse them like normal C++ but will assume all classes use public instead 342 # of private inheritance when no explicit protection keyword is present. 343 # The default value is: NO. 344 345 SIP_SUPPORT = NO 346 347 # For Microsoft's IDL there are propget and propput attributes to indicate 348 # getter and setter methods for a property. Setting this option to YES will make 349 # doxygen to replace the get and set methods by a property in the documentation. 350 # This will only work if the methods are indeed getting or setting a simple 351 # type. If this is not the case, or you want to show the methods anyway, you 352 # should set this option to NO. 353 # The default value is: YES. 354 355 IDL_PROPERTY_SUPPORT = YES 356 357 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 358 # tag is set to YES then doxygen will reuse the documentation of the first 359 # member in the group (if any) for the other members of the group. By default 360 # all members of a group must be documented explicitly. 361 # The default value is: NO. 362 363 DISTRIBUTE_GROUP_DOC = NO 364 365 # If one adds a struct or class to a group and this option is enabled, then also 366 # any nested class or struct is added to the same group. By default this option 367 # is disabled and one has to add nested compounds explicitly via \ingroup. 368 # The default value is: NO. 369 370 GROUP_NESTED_COMPOUNDS = NO 371 372 # Set the SUBGROUPING tag to YES to allow class member groups of the same type 373 # (for instance a group of public functions) to be put as a subgroup of that 374 # type (e.g. under the Public Functions section). Set it to NO to prevent 375 # subgrouping. Alternatively, this can be done per class using the 376 # \nosubgrouping command. 377 # The default value is: YES. 378 379 SUBGROUPING = YES 380 381 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 382 # are shown inside the group in which they are included (e.g. using \ingroup) 383 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 384 # and RTF). 385 # 386 # Note that this feature does not work in combination with 387 # SEPARATE_MEMBER_PAGES. 388 # The default value is: NO. 389 390 INLINE_GROUPED_CLASSES = NO 391 392 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 393 # with only public data fields or simple typedef fields will be shown inline in 394 # the documentation of the scope in which they are defined (i.e. file, 395 # namespace, or group documentation), provided this scope is documented. If set 396 # to NO, structs, classes, and unions are shown on a separate page (for HTML and 397 # Man pages) or section (for LaTeX and RTF). 398 # The default value is: NO. 399 400 INLINE_SIMPLE_STRUCTS = NO 401 402 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 403 # enum is documented as struct, union, or enum with the name of the typedef. So 404 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 405 # with name TypeT. When disabled the typedef will appear as a member of a file, 406 # namespace, or class. And the struct will be named TypeS. This can typically be 407 # useful for C code in case the coding convention dictates that all compound 408 # types are typedef'ed and only the typedef is referenced, never the tag name. 409 # The default value is: NO. 410 411 TYPEDEF_HIDES_STRUCT = NO 412 413 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 414 # cache is used to resolve symbols given their name and scope. Since this can be 415 # an expensive process and often the same symbol appears multiple times in the 416 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 417 # doxygen will become slower. If the cache is too large, memory is wasted. The 418 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 419 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 420 # symbols. At the end of a run doxygen will report the cache usage and suggest 421 # the optimal cache size from a speed point of view. 422 # Minimum value: 0, maximum value: 9, default value: 0. 423 424 LOOKUP_CACHE_SIZE = 0 425 426 #--------------------------------------------------------------------------- 427 # Build related configuration options 428 #--------------------------------------------------------------------------- 429 430 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 431 # documentation are documented, even if no documentation was available. Private 432 # class members and static file members will be hidden unless the 433 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 434 # Note: This will also disable the warnings about undocumented members that are 435 # normally produced when WARNINGS is set to YES. 436 # The default value is: NO. 437 438 EXTRACT_ALL = YES 439 440 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 441 # be included in the documentation. 442 # The default value is: NO. 443 444 EXTRACT_PRIVATE = YES 445 446 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 447 # scope will be included in the documentation. 448 # The default value is: NO. 449 450 EXTRACT_PACKAGE = NO 451 452 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 453 # included in the documentation. 454 # The default value is: NO. 455 456 EXTRACT_STATIC = YES 457 458 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 459 # locally in source files will be included in the documentation. If set to NO, 460 # only classes defined in header files are included. Does not have any effect 461 # for Java sources. 462 # The default value is: YES. 463 464 EXTRACT_LOCAL_CLASSES = YES 465 466 # This flag is only useful for Objective-C code. If set to YES, local methods, 467 # which are defined in the implementation section but not in the interface are 468 # included in the documentation. If set to NO, only methods in the interface are 469 # included. 470 # The default value is: NO. 471 472 EXTRACT_LOCAL_METHODS = NO 473 474 # If this flag is set to YES, the members of anonymous namespaces will be 475 # extracted and appear in the documentation as a namespace called 476 # 'anonymous_namespace{file}', where file will be replaced with the base name of 477 # the file that contains the anonymous namespace. By default anonymous namespace 478 # are hidden. 479 # The default value is: NO. 480 481 EXTRACT_ANON_NSPACES = NO 482 483 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 484 # undocumented members inside documented classes or files. If set to NO these 485 # members will be included in the various overviews, but no documentation 486 # section is generated. This option has no effect if EXTRACT_ALL is enabled. 487 # The default value is: NO. 488 489 HIDE_UNDOC_MEMBERS = NO 490 491 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 492 # undocumented classes that are normally visible in the class hierarchy. If set 493 # to NO, these classes will be included in the various overviews. This option 494 # has no effect if EXTRACT_ALL is enabled. 495 # The default value is: NO. 496 497 HIDE_UNDOC_CLASSES = NO 498 499 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 500 # (class|struct|union) declarations. If set to NO, these declarations will be 501 # included in the documentation. 502 # The default value is: NO. 503 504 HIDE_FRIEND_COMPOUNDS = NO 505 506 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 507 # documentation blocks found inside the body of a function. If set to NO, these 508 # blocks will be appended to the function's detailed documentation block. 509 # The default value is: NO. 510 511 HIDE_IN_BODY_DOCS = NO 512 513 # The INTERNAL_DOCS tag determines if documentation that is typed after a 514 # \internal command is included. If the tag is set to NO then the documentation 515 # will be excluded. Set it to YES to include the internal documentation. 516 # The default value is: NO. 517 518 INTERNAL_DOCS = NO 519 520 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 521 # names in lower-case letters. If set to YES, upper-case letters are also 522 # allowed. This is useful if you have classes or files whose names only differ 523 # in case and if your file system supports case sensitive file names. Windows 524 # and Mac users are advised to set this option to NO. 525 # The default value is: system dependent. 526 527 CASE_SENSE_NAMES = NO 528 529 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 530 # their full class and namespace scopes in the documentation. If set to YES, the 531 # scope will be hidden. 532 # The default value is: NO. 533 534 HIDE_SCOPE_NAMES = NO 535 536 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 537 # append additional text to a page's title, such as Class Reference. If set to 538 # YES the compound reference will be hidden. 539 # The default value is: NO. 540 541 HIDE_COMPOUND_REFERENCE= NO 542 543 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 544 # the files that are included by a file in the documentation of that file. 545 # The default value is: YES. 546 547 SHOW_INCLUDE_FILES = YES 548 549 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 550 # grouped member an include statement to the documentation, telling the reader 551 # which file to include in order to use the member. 552 # The default value is: NO. 553 554 SHOW_GROUPED_MEMB_INC = NO 555 556 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 557 # files with double quotes in the documentation rather than with sharp brackets. 558 # The default value is: NO. 559 560 FORCE_LOCAL_INCLUDES = NO 561 562 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 563 # documentation for inline members. 564 # The default value is: YES. 565 566 INLINE_INFO = YES 567 568 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 569 # (detailed) documentation of file and class members alphabetically by member 570 # name. If set to NO, the members will appear in declaration order. 571 # The default value is: YES. 572 573 SORT_MEMBER_DOCS = YES 574 575 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 576 # descriptions of file, namespace and class members alphabetically by member 577 # name. If set to NO, the members will appear in declaration order. Note that 578 # this will also influence the order of the classes in the class list. 579 # The default value is: NO. 580 581 SORT_BRIEF_DOCS = NO 582 583 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 584 # (brief and detailed) documentation of class members so that constructors and 585 # destructors are listed first. If set to NO the constructors will appear in the 586 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 587 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 588 # member documentation. 589 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 590 # detailed member documentation. 591 # The default value is: NO. 592 593 SORT_MEMBERS_CTORS_1ST = NO 594 595 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 596 # of group names into alphabetical order. If set to NO the group names will 597 # appear in their defined order. 598 # The default value is: NO. 599 600 SORT_GROUP_NAMES = NO 601 602 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 603 # fully-qualified names, including namespaces. If set to NO, the class list will 604 # be sorted only by class name, not including the namespace part. 605 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 606 # Note: This option applies only to the class list, not to the alphabetical 607 # list. 608 # The default value is: NO. 609 610 SORT_BY_SCOPE_NAME = NO 611 612 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 613 # type resolution of all parameters of a function it will reject a match between 614 # the prototype and the implementation of a member function even if there is 615 # only one candidate or it is obvious which candidate to choose by doing a 616 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 617 # accept a match between prototype and implementation in such cases. 618 # The default value is: NO. 619 620 STRICT_PROTO_MATCHING = NO 621 622 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 623 # list. This list is created by putting \todo commands in the documentation. 624 # The default value is: YES. 625 626 GENERATE_TODOLIST = YES 627 628 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 629 # list. This list is created by putting \test commands in the documentation. 630 # The default value is: YES. 631 632 GENERATE_TESTLIST = YES 633 634 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 635 # list. This list is created by putting \bug commands in the documentation. 636 # The default value is: YES. 637 638 GENERATE_BUGLIST = YES 639 640 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 641 # the deprecated list. This list is created by putting \deprecated commands in 642 # the documentation. 643 # The default value is: YES. 644 645 GENERATE_DEPRECATEDLIST= YES 646 647 # The ENABLED_SECTIONS tag can be used to enable conditional documentation 648 # sections, marked by \if <section_label> ... \endif and \cond <section_label> 649 # ... \endcond blocks. 650 651 ENABLED_SECTIONS = 652 653 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 654 # initial value of a variable or macro / define can have for it to appear in the 655 # documentation. If the initializer consists of more lines than specified here 656 # it will be hidden. Use a value of 0 to hide initializers completely. The 657 # appearance of the value of individual variables and macros / defines can be 658 # controlled using \showinitializer or \hideinitializer command in the 659 # documentation regardless of this setting. 660 # Minimum value: 0, maximum value: 10000, default value: 30. 661 662 MAX_INITIALIZER_LINES = 30 663 664 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 665 # the bottom of the documentation of classes and structs. If set to YES, the 666 # list will mention the files that were used to generate the documentation. 667 # The default value is: YES. 668 669 SHOW_USED_FILES = YES 670 671 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 672 # will remove the Files entry from the Quick Index and from the Folder Tree View 673 # (if specified). 674 # The default value is: YES. 675 676 SHOW_FILES = YES 677 678 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 679 # page. This will remove the Namespaces entry from the Quick Index and from the 680 # Folder Tree View (if specified). 681 # The default value is: YES. 682 683 SHOW_NAMESPACES = YES 684 685 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 686 # doxygen should invoke to get the current version for each file (typically from 687 # the version control system). Doxygen will invoke the program by executing (via 688 # popen()) the command command input-file, where command is the value of the 689 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 690 # by doxygen. Whatever the program writes to standard output is used as the file 691 # version. For an example see the documentation. 692 693 FILE_VERSION_FILTER = 694 695 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 696 # by doxygen. The layout file controls the global structure of the generated 697 # output files in an output format independent way. To create the layout file 698 # that represents doxygen's defaults, run doxygen with the -l option. You can 699 # optionally specify a file name after the option, if omitted DoxygenLayout.xml 700 # will be used as the name of the layout file. 701 # 702 # Note that if you run doxygen from a directory containing a file called 703 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 704 # tag is left empty. 705 706 LAYOUT_FILE = 707 708 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 709 # the reference definitions. This must be a list of .bib files. The .bib 710 # extension is automatically appended if omitted. This requires the bibtex tool 711 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 712 # For LaTeX the style of the bibliography can be controlled using 713 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 714 # search path. See also \cite for info how to create references. 715 716 CITE_BIB_FILES = 717 718 #--------------------------------------------------------------------------- 719 # Configuration options related to warning and progress messages 720 #--------------------------------------------------------------------------- 721 722 # The QUIET tag can be used to turn on/off the messages that are generated to 723 # standard output by doxygen. If QUIET is set to YES this implies that the 724 # messages are off. 725 # The default value is: NO. 726 727 QUIET = NO 728 729 # The WARNINGS tag can be used to turn on/off the warning messages that are 730 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 731 # this implies that the warnings are on. 732 # 733 # Tip: Turn warnings on while writing the documentation. 734 # The default value is: YES. 735 736 WARNINGS = YES 737 738 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 739 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 740 # will automatically be disabled. 741 # The default value is: YES. 742 743 WARN_IF_UNDOCUMENTED = YES 744 745 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 746 # potential errors in the documentation, such as not documenting some parameters 747 # in a documented function, or documenting parameters that don't exist or using 748 # markup commands wrongly. 749 # The default value is: YES. 750 751 WARN_IF_DOC_ERROR = YES 752 753 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 754 # are documented, but have no documentation for their parameters or return 755 # value. If set to NO, doxygen will only warn about wrong or incomplete 756 # parameter documentation, but not about the absence of documentation. 757 # The default value is: NO. 758 759 WARN_NO_PARAMDOC = NO 760 761 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 762 # a warning is encountered. 763 # The default value is: NO. 764 765 WARN_AS_ERROR = NO 766 767 # The WARN_FORMAT tag determines the format of the warning messages that doxygen 768 # can produce. The string should contain the $file, $line, and $text tags, which 769 # will be replaced by the file and line number from which the warning originated 770 # and the warning text. Optionally the format may contain $version, which will 771 # be replaced by the version of the file (if it could be obtained via 772 # FILE_VERSION_FILTER) 773 # The default value is: $file:$line: $text. 774 775 WARN_FORMAT = "$file:$line: $text" 776 777 # The WARN_LOGFILE tag can be used to specify a file to which warning and error 778 # messages should be written. If left blank the output is written to standard 779 # error (stderr). 780 781 WARN_LOGFILE = 782 783 #--------------------------------------------------------------------------- 784 # Configuration options related to the input files 785 #--------------------------------------------------------------------------- 786 787 # The INPUT tag is used to specify the files and/or directories that contain 788 # documented source files. You may enter file names like myfile.cpp or 789 # directories like /usr/src/myproject. Separate the files or directories with 790 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 791 # Note: If this tag is empty the current directory is searched. 792 793 INPUT = src doc/README_doxygen.md 794 795 # This tag can be used to specify the character encoding of the source files 796 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 797 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 798 # documentation (see: http://www.gnu.org/software/libiconv) for the list of 799 # possible encodings. 800 # The default value is: UTF-8. 801 802 INPUT_ENCODING = UTF-8 803 804 # If the value of the INPUT tag contains directories, you can use the 805 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 806 # *.h) to filter out the source-files in the directories. 807 # 808 # Note that for custom extensions or not directly supported extensions you also 809 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 810 # read by doxygen. 811 # 812 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 813 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 814 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 815 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 816 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 817 818 FILE_PATTERNS = *.c \ 819 *.cc \ 820 *.cxx \ 821 *.cpp \ 822 *.c++ \ 823 *.d \ 824 *.java \ 825 *.ii \ 826 *.ixx \ 827 *.ipp \ 828 *.i++ \ 829 *.inl \ 830 *.h \ 831 *.hh \ 832 *.hxx \ 833 *.hpp \ 834 *.h++ \ 835 *.idl \ 836 *.odl \ 837 *.cs \ 838 *.php \ 839 *.php3 \ 840 *.inc \ 841 *.m \ 842 *.mm \ 843 *.dox \ 844 *.py \ 845 *.f90 \ 846 *.f \ 847 *.for \ 848 *.vhd \ 849 *.vhdl 850 851 # The RECURSIVE tag can be used to specify whether or not subdirectories should 852 # be searched for input files as well. 853 # The default value is: NO. 854 855 RECURSIVE = YES 856 857 # The EXCLUDE tag can be used to specify files and/or directories that should be 858 # excluded from the INPUT source files. This way you can easily exclude a 859 # subdirectory from a directory tree whose root is specified with the INPUT tag. 860 # 861 # Note that relative paths are relative to the directory from which doxygen is 862 # run. 863 864 EXCLUDE = src/crc32c \ 865 src/leveldb \ 866 src/json 867 868 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 869 # directories that are symbolic links (a Unix file system feature) are excluded 870 # from the input. 871 # The default value is: NO. 872 873 EXCLUDE_SYMLINKS = NO 874 875 # If the value of the INPUT tag contains directories, you can use the 876 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 877 # certain files from those directories. 878 # 879 # Note that the wildcards are matched against the file with absolute path, so to 880 # exclude all test directories for example use the pattern */test/* 881 882 EXCLUDE_PATTERNS = 883 884 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 885 # (namespaces, classes, functions, etc.) that should be excluded from the 886 # output. The symbol name can be a fully qualified name, a word, or if the 887 # wildcard * is used, a substring. Examples: ANamespace, AClass, 888 # AClass::ANamespace, ANamespace::*Test 889 # 890 # Note that the wildcards are matched against the file with absolute path, so to 891 # exclude all test directories use the pattern */test/* 892 893 EXCLUDE_SYMBOLS = boost \ 894 google 895 896 # The EXAMPLE_PATH tag can be used to specify one or more files or directories 897 # that contain example code fragments that are included (see the \include 898 # command). 899 900 EXAMPLE_PATH = 901 902 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 903 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 904 # *.h) to filter out the source-files in the directories. If left blank all 905 # files are included. 906 907 EXAMPLE_PATTERNS = * 908 909 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 910 # searched for input files to be used with the \include or \dontinclude commands 911 # irrespective of the value of the RECURSIVE tag. 912 # The default value is: NO. 913 914 EXAMPLE_RECURSIVE = NO 915 916 # The IMAGE_PATH tag can be used to specify one or more files or directories 917 # that contain images that are to be included in the documentation (see the 918 # \image command). 919 920 IMAGE_PATH = 921 922 # The INPUT_FILTER tag can be used to specify a program that doxygen should 923 # invoke to filter for each input file. Doxygen will invoke the filter program 924 # by executing (via popen()) the command: 925 # 926 # <filter> <input-file> 927 # 928 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 929 # name of an input file. Doxygen will then use the output that the filter 930 # program writes to standard output. If FILTER_PATTERNS is specified, this tag 931 # will be ignored. 932 # 933 # Note that the filter must not add or remove lines; it is applied before the 934 # code is scanned, but not when the output code is generated. If lines are added 935 # or removed, the anchors will not be placed correctly. 936 # 937 # Note that for custom extensions or not directly supported extensions you also 938 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 939 # properly processed by doxygen. 940 941 INPUT_FILTER = 942 943 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 944 # basis. Doxygen will compare the file name with each pattern and apply the 945 # filter if there is a match. The filters are a list of the form: pattern=filter 946 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 947 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 948 # patterns match the file name, INPUT_FILTER is applied. 949 # 950 # Note that for custom extensions or not directly supported extensions you also 951 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 952 # properly processed by doxygen. 953 954 FILTER_PATTERNS = 955 956 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 957 # INPUT_FILTER) will also be used to filter the input files that are used for 958 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 959 # The default value is: NO. 960 961 FILTER_SOURCE_FILES = NO 962 963 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 964 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 965 # it is also possible to disable source filtering for a specific pattern using 966 # *.ext= (so without naming a filter). 967 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 968 969 FILTER_SOURCE_PATTERNS = 970 971 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 972 # is part of the input, its contents will be placed on the main page 973 # (index.html). This can be useful if you have a project on for instance GitHub 974 # and want to reuse the introduction page also for the doxygen output. 975 976 USE_MDFILE_AS_MAINPAGE = doc/README_doxygen.md 977 978 #--------------------------------------------------------------------------- 979 # Configuration options related to source browsing 980 #--------------------------------------------------------------------------- 981 982 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 983 # generated. Documented entities will be cross-referenced with these sources. 984 # 985 # Note: To get rid of all source code in the generated output, make sure that 986 # also VERBATIM_HEADERS is set to NO. 987 # The default value is: NO. 988 989 SOURCE_BROWSER = YES 990 991 # Setting the INLINE_SOURCES tag to YES will include the body of functions, 992 # classes and enums directly into the documentation. 993 # The default value is: NO. 994 995 INLINE_SOURCES = NO 996 997 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 998 # special comment blocks from generated source code fragments. Normal C, C++ and 999 # Fortran comments will always remain visible. 1000 # The default value is: YES. 1001 1002 STRIP_CODE_COMMENTS = YES 1003 1004 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1005 # function all documented functions referencing it will be listed. 1006 # The default value is: NO. 1007 1008 REFERENCED_BY_RELATION = NO 1009 1010 # If the REFERENCES_RELATION tag is set to YES then for each documented function 1011 # all documented entities called/used by that function will be listed. 1012 # The default value is: NO. 1013 1014 REFERENCES_RELATION = NO 1015 1016 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1017 # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1018 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1019 # link to the documentation. 1020 # The default value is: YES. 1021 1022 REFERENCES_LINK_SOURCE = YES 1023 1024 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1025 # source code will show a tooltip with additional information such as prototype, 1026 # brief description and links to the definition and documentation. Since this 1027 # will make the HTML file larger and loading of large files a bit slower, you 1028 # can opt to disable this feature. 1029 # The default value is: YES. 1030 # This tag requires that the tag SOURCE_BROWSER is set to YES. 1031 1032 SOURCE_TOOLTIPS = YES 1033 1034 # If the USE_HTAGS tag is set to YES then the references to source code will 1035 # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1036 # source browser. The htags tool is part of GNU's global source tagging system 1037 # (see http://www.gnu.org/software/global/global.html). You will need version 1038 # 4.8.6 or higher. 1039 # 1040 # To use it do the following: 1041 # - Install the latest version of global 1042 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1043 # - Make sure the INPUT points to the root of the source tree 1044 # - Run doxygen as normal 1045 # 1046 # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1047 # tools must be available from the command line (i.e. in the search path). 1048 # 1049 # The result: instead of the source browser generated by doxygen, the links to 1050 # source code will now point to the output of htags. 1051 # The default value is: NO. 1052 # This tag requires that the tag SOURCE_BROWSER is set to YES. 1053 1054 USE_HTAGS = NO 1055 1056 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1057 # verbatim copy of the header file for each class for which an include is 1058 # specified. Set to NO to disable this. 1059 # See also: Section \class. 1060 # The default value is: YES. 1061 1062 VERBATIM_HEADERS = YES 1063 1064 #--------------------------------------------------------------------------- 1065 # Configuration options related to the alphabetical class index 1066 #--------------------------------------------------------------------------- 1067 1068 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1069 # compounds will be generated. Enable this if the project contains a lot of 1070 # classes, structs, unions or interfaces. 1071 # The default value is: YES. 1072 1073 ALPHABETICAL_INDEX = YES 1074 1075 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1076 # which the alphabetical index list will be split. 1077 # Minimum value: 1, maximum value: 20, default value: 5. 1078 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1079 1080 COLS_IN_ALPHA_INDEX = 5 1081 1082 # In case all classes in a project start with a common prefix, all classes will 1083 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1084 # can be used to specify a prefix (or a list of prefixes) that should be ignored 1085 # while generating the index headers. 1086 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1087 1088 IGNORE_PREFIX = 1089 1090 #--------------------------------------------------------------------------- 1091 # Configuration options related to the HTML output 1092 #--------------------------------------------------------------------------- 1093 1094 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1095 # The default value is: YES. 1096 1097 GENERATE_HTML = YES 1098 1099 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1100 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1101 # it. 1102 # The default directory is: html. 1103 # This tag requires that the tag GENERATE_HTML is set to YES. 1104 1105 HTML_OUTPUT = html 1106 1107 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1108 # generated HTML page (for example: .htm, .php, .asp). 1109 # The default value is: .html. 1110 # This tag requires that the tag GENERATE_HTML is set to YES. 1111 1112 HTML_FILE_EXTENSION = .html 1113 1114 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1115 # each generated HTML page. If the tag is left blank doxygen will generate a 1116 # standard header. 1117 # 1118 # To get valid HTML the header file that includes any scripts and style sheets 1119 # that doxygen needs, which is dependent on the configuration options used (e.g. 1120 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1121 # default header using 1122 # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1123 # YourConfigFile 1124 # and then modify the file new_header.html. See also section "Doxygen usage" 1125 # for information on how to generate the default header that doxygen normally 1126 # uses. 1127 # Note: The header is subject to change so you typically have to regenerate the 1128 # default header when upgrading to a newer version of doxygen. For a description 1129 # of the possible markers and block names see the documentation. 1130 # This tag requires that the tag GENERATE_HTML is set to YES. 1131 1132 HTML_HEADER = 1133 1134 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1135 # generated HTML page. If the tag is left blank doxygen will generate a standard 1136 # footer. See HTML_HEADER for more information on how to generate a default 1137 # footer and what special commands can be used inside the footer. See also 1138 # section "Doxygen usage" for information on how to generate the default footer 1139 # that doxygen normally uses. 1140 # This tag requires that the tag GENERATE_HTML is set to YES. 1141 1142 HTML_FOOTER = 1143 1144 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1145 # sheet that is used by each HTML page. It can be used to fine-tune the look of 1146 # the HTML output. If left blank doxygen will generate a default style sheet. 1147 # See also section "Doxygen usage" for information on how to generate the style 1148 # sheet that doxygen normally uses. 1149 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1150 # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1151 # obsolete. 1152 # This tag requires that the tag GENERATE_HTML is set to YES. 1153 1154 HTML_STYLESHEET = 1155 1156 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1157 # cascading style sheets that are included after the standard style sheets 1158 # created by doxygen. Using this option one can overrule certain style aspects. 1159 # This is preferred over using HTML_STYLESHEET since it does not replace the 1160 # standard style sheet and is therefore more robust against future updates. 1161 # Doxygen will copy the style sheet files to the output directory. 1162 # Note: The order of the extra style sheet files is of importance (e.g. the last 1163 # style sheet in the list overrules the setting of the previous ones in the 1164 # list). For an example see the documentation. 1165 # This tag requires that the tag GENERATE_HTML is set to YES. 1166 1167 HTML_EXTRA_STYLESHEET = 1168 1169 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1170 # other source files which should be copied to the HTML output directory. Note 1171 # that these files will be copied to the base HTML output directory. Use the 1172 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1173 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1174 # files will be copied as-is; there are no commands or markers available. 1175 # This tag requires that the tag GENERATE_HTML is set to YES. 1176 1177 HTML_EXTRA_FILES = 1178 1179 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1180 # will adjust the colors in the style sheet and background images according to 1181 # this color. Hue is specified as an angle on a colorwheel, see 1182 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1183 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1184 # purple, and 360 is red again. 1185 # Minimum value: 0, maximum value: 359, default value: 220. 1186 # This tag requires that the tag GENERATE_HTML is set to YES. 1187 1188 HTML_COLORSTYLE_HUE = 220 1189 1190 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1191 # in the HTML output. For a value of 0 the output will use grayscales only. A 1192 # value of 255 will produce the most vivid colors. 1193 # Minimum value: 0, maximum value: 255, default value: 100. 1194 # This tag requires that the tag GENERATE_HTML is set to YES. 1195 1196 HTML_COLORSTYLE_SAT = 100 1197 1198 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1199 # luminance component of the colors in the HTML output. Values below 100 1200 # gradually make the output lighter, whereas values above 100 make the output 1201 # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1202 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1203 # change the gamma. 1204 # Minimum value: 40, maximum value: 240, default value: 80. 1205 # This tag requires that the tag GENERATE_HTML is set to YES. 1206 1207 HTML_COLORSTYLE_GAMMA = 80 1208 1209 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1210 # page will contain the date and time when the page was generated. Setting this 1211 # to YES can help to show when doxygen was last run and thus if the 1212 # documentation is up to date. 1213 # The default value is: NO. 1214 # This tag requires that the tag GENERATE_HTML is set to YES. 1215 1216 HTML_TIMESTAMP = YES 1217 1218 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1219 # documentation will contain sections that can be hidden and shown after the 1220 # page has loaded. 1221 # The default value is: NO. 1222 # This tag requires that the tag GENERATE_HTML is set to YES. 1223 1224 HTML_DYNAMIC_SECTIONS = NO 1225 1226 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1227 # shown in the various tree structured indices initially; the user can expand 1228 # and collapse entries dynamically later on. Doxygen will expand the tree to 1229 # such a level that at most the specified number of entries are visible (unless 1230 # a fully collapsed tree already exceeds this amount). So setting the number of 1231 # entries 1 will produce a full collapsed tree by default. 0 is a special value 1232 # representing an infinite number of entries and will result in a full expanded 1233 # tree by default. 1234 # Minimum value: 0, maximum value: 9999, default value: 100. 1235 # This tag requires that the tag GENERATE_HTML is set to YES. 1236 1237 HTML_INDEX_NUM_ENTRIES = 100 1238 1239 # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1240 # generated that can be used as input for Apple's Xcode 3 integrated development 1241 # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1242 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1243 # Makefile in the HTML output directory. Running make will produce the docset in 1244 # that directory and running make install will install the docset in 1245 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1246 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1247 # for more information. 1248 # The default value is: NO. 1249 # This tag requires that the tag GENERATE_HTML is set to YES. 1250 1251 GENERATE_DOCSET = NO 1252 1253 # This tag determines the name of the docset feed. A documentation feed provides 1254 # an umbrella under which multiple documentation sets from a single provider 1255 # (such as a company or product suite) can be grouped. 1256 # The default value is: Doxygen generated docs. 1257 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1258 1259 DOCSET_FEEDNAME = "Doxygen generated docs" 1260 1261 # This tag specifies a string that should uniquely identify the documentation 1262 # set bundle. This should be a reverse domain-name style string, e.g. 1263 # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1264 # The default value is: org.doxygen.Project. 1265 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1266 1267 DOCSET_BUNDLE_ID = org.bitcoin.Bitcoin-Core 1268 1269 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1270 # the documentation publisher. This should be a reverse domain-name style 1271 # string, e.g. com.mycompany.MyDocSet.documentation. 1272 # The default value is: org.doxygen.Publisher. 1273 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1274 1275 DOCSET_PUBLISHER_ID = org.bitcoin.Bitcoin-Core 1276 1277 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1278 # The default value is: Publisher. 1279 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1280 1281 DOCSET_PUBLISHER_NAME = Publisher 1282 1283 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1284 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1285 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1286 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1287 # Windows. 1288 # 1289 # The HTML Help Workshop contains a compiler that can convert all HTML output 1290 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1291 # files are now used as the Windows 98 help format, and will replace the old 1292 # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1293 # HTML files also contain an index, a table of contents, and you can search for 1294 # words in the documentation. The HTML workshop also contains a viewer for 1295 # compressed HTML files. 1296 # The default value is: NO. 1297 # This tag requires that the tag GENERATE_HTML is set to YES. 1298 1299 GENERATE_HTMLHELP = NO 1300 1301 # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1302 # file. You can add a path in front of the file if the result should not be 1303 # written to the html output directory. 1304 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1305 1306 CHM_FILE = 1307 1308 # The HHC_LOCATION tag can be used to specify the location (absolute path 1309 # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1310 # doxygen will try to run the HTML help compiler on the generated index.hhp. 1311 # The file has to be specified with full path. 1312 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1313 1314 HHC_LOCATION = 1315 1316 # The GENERATE_CHI flag controls if a separate .chi index file is generated 1317 # (YES) or that it should be included in the master .chm file (NO). 1318 # The default value is: NO. 1319 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1320 1321 GENERATE_CHI = NO 1322 1323 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1324 # and project file content. 1325 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1326 1327 CHM_INDEX_ENCODING = 1328 1329 # The BINARY_TOC flag controls whether a binary table of contents is generated 1330 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1331 # enables the Previous and Next buttons. 1332 # The default value is: NO. 1333 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1334 1335 BINARY_TOC = NO 1336 1337 # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1338 # the table of contents of the HTML help documentation and to the tree view. 1339 # The default value is: NO. 1340 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1341 1342 TOC_EXPAND = NO 1343 1344 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1345 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1346 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1347 # (.qch) of the generated HTML documentation. 1348 # The default value is: NO. 1349 # This tag requires that the tag GENERATE_HTML is set to YES. 1350 1351 GENERATE_QHP = NO 1352 1353 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1354 # the file name of the resulting .qch file. The path specified is relative to 1355 # the HTML output folder. 1356 # This tag requires that the tag GENERATE_QHP is set to YES. 1357 1358 QCH_FILE = 1359 1360 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1361 # Project output. For more information please see Qt Help Project / Namespace 1362 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1363 # The default value is: org.doxygen.Project. 1364 # This tag requires that the tag GENERATE_QHP is set to YES. 1365 1366 QHP_NAMESPACE = org.doxygen.Project 1367 1368 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1369 # Help Project output. For more information please see Qt Help Project / Virtual 1370 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1371 # folders). 1372 # The default value is: doc. 1373 # This tag requires that the tag GENERATE_QHP is set to YES. 1374 1375 QHP_VIRTUAL_FOLDER = doc 1376 1377 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1378 # filter to add. For more information please see Qt Help Project / Custom 1379 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1380 # filters). 1381 # This tag requires that the tag GENERATE_QHP is set to YES. 1382 1383 QHP_CUST_FILTER_NAME = 1384 1385 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1386 # custom filter to add. For more information please see Qt Help Project / Custom 1387 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1388 # filters). 1389 # This tag requires that the tag GENERATE_QHP is set to YES. 1390 1391 QHP_CUST_FILTER_ATTRS = 1392 1393 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1394 # project's filter section matches. Qt Help Project / Filter Attributes (see: 1395 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1396 # This tag requires that the tag GENERATE_QHP is set to YES. 1397 1398 QHP_SECT_FILTER_ATTRS = 1399 1400 # The QHG_LOCATION tag can be used to specify the location of Qt's 1401 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1402 # generated .qhp file. 1403 # This tag requires that the tag GENERATE_QHP is set to YES. 1404 1405 QHG_LOCATION = 1406 1407 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1408 # generated, together with the HTML files, they form an Eclipse help plugin. To 1409 # install this plugin and make it available under the help contents menu in 1410 # Eclipse, the contents of the directory containing the HTML and XML files needs 1411 # to be copied into the plugins directory of eclipse. The name of the directory 1412 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1413 # After copying Eclipse needs to be restarted before the help appears. 1414 # The default value is: NO. 1415 # This tag requires that the tag GENERATE_HTML is set to YES. 1416 1417 GENERATE_ECLIPSEHELP = NO 1418 1419 # A unique identifier for the Eclipse help plugin. When installing the plugin 1420 # the directory name containing the HTML and XML files should also have this 1421 # name. Each documentation set should have its own identifier. 1422 # The default value is: org.doxygen.Project. 1423 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1424 1425 ECLIPSE_DOC_ID = org.doxygen.Project 1426 1427 # If you want full control over the layout of the generated HTML pages it might 1428 # be necessary to disable the index and replace it with your own. The 1429 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1430 # of each HTML page. A value of NO enables the index and the value YES disables 1431 # it. Since the tabs in the index contain the same information as the navigation 1432 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1433 # The default value is: NO. 1434 # This tag requires that the tag GENERATE_HTML is set to YES. 1435 1436 DISABLE_INDEX = NO 1437 1438 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1439 # structure should be generated to display hierarchical information. If the tag 1440 # value is set to YES, a side panel will be generated containing a tree-like 1441 # index structure (just like the one that is generated for HTML Help). For this 1442 # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1443 # (i.e. any modern browser). Windows users are probably better off using the 1444 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1445 # further fine-tune the look of the index. As an example, the default style 1446 # sheet generated by doxygen has an example that shows how to put an image at 1447 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1448 # the same information as the tab index, you could consider setting 1449 # DISABLE_INDEX to YES when enabling this option. 1450 # The default value is: NO. 1451 # This tag requires that the tag GENERATE_HTML is set to YES. 1452 1453 GENERATE_TREEVIEW = NO 1454 1455 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1456 # doxygen will group on one line in the generated HTML documentation. 1457 # 1458 # Note that a value of 0 will completely suppress the enum values from appearing 1459 # in the overview section. 1460 # Minimum value: 0, maximum value: 20, default value: 4. 1461 # This tag requires that the tag GENERATE_HTML is set to YES. 1462 1463 ENUM_VALUES_PER_LINE = 4 1464 1465 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1466 # to set the initial width (in pixels) of the frame in which the tree is shown. 1467 # Minimum value: 0, maximum value: 1500, default value: 250. 1468 # This tag requires that the tag GENERATE_HTML is set to YES. 1469 1470 TREEVIEW_WIDTH = 250 1471 1472 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1473 # external symbols imported via tag files in a separate window. 1474 # The default value is: NO. 1475 # This tag requires that the tag GENERATE_HTML is set to YES. 1476 1477 EXT_LINKS_IN_WINDOW = NO 1478 1479 # Use this tag to change the font size of LaTeX formulas included as images in 1480 # the HTML documentation. When you change the font size after a successful 1481 # doxygen run you need to manually remove any form_*.png images from the HTML 1482 # output directory to force them to be regenerated. 1483 # Minimum value: 8, maximum value: 50, default value: 10. 1484 # This tag requires that the tag GENERATE_HTML is set to YES. 1485 1486 FORMULA_FONTSIZE = 10 1487 1488 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1489 # generated for formulas are transparent PNGs. Transparent PNGs are not 1490 # supported properly for IE 6.0, but are supported on all modern browsers. 1491 # 1492 # Note that when changing this option you need to delete any form_*.png files in 1493 # the HTML output directory before the changes have effect. 1494 # The default value is: YES. 1495 # This tag requires that the tag GENERATE_HTML is set to YES. 1496 1497 FORMULA_TRANSPARENT = YES 1498 1499 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1500 # http://www.mathjax.org) which uses client side Javascript for the rendering 1501 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1502 # installed or if you want to formulas look prettier in the HTML output. When 1503 # enabled you may also need to install MathJax separately and configure the path 1504 # to it using the MATHJAX_RELPATH option. 1505 # The default value is: NO. 1506 # This tag requires that the tag GENERATE_HTML is set to YES. 1507 1508 USE_MATHJAX = NO 1509 1510 # When MathJax is enabled you can set the default output format to be used for 1511 # the MathJax output. See the MathJax site (see: 1512 # http://docs.mathjax.org/en/latest/output.html) for more details. 1513 # Possible values are: HTML-CSS (which is slower, but has the best 1514 # compatibility), NativeMML (i.e. MathML) and SVG. 1515 # The default value is: HTML-CSS. 1516 # This tag requires that the tag USE_MATHJAX is set to YES. 1517 1518 MATHJAX_FORMAT = HTML-CSS 1519 1520 # When MathJax is enabled you need to specify the location relative to the HTML 1521 # output directory using the MATHJAX_RELPATH option. The destination directory 1522 # should contain the MathJax.js script. For instance, if the mathjax directory 1523 # is located at the same level as the HTML output directory, then 1524 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1525 # Content Delivery Network so you can quickly see the result without installing 1526 # MathJax. However, it is strongly recommended to install a local copy of 1527 # MathJax from http://www.mathjax.org before deployment. 1528 # The default value is: http://cdn.mathjax.org/mathjax/latest. 1529 # This tag requires that the tag USE_MATHJAX is set to YES. 1530 1531 MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1532 1533 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1534 # extension names that should be enabled during MathJax rendering. For example 1535 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1536 # This tag requires that the tag USE_MATHJAX is set to YES. 1537 1538 MATHJAX_EXTENSIONS = 1539 1540 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1541 # of code that will be used on startup of the MathJax code. See the MathJax site 1542 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1543 # example see the documentation. 1544 # This tag requires that the tag USE_MATHJAX is set to YES. 1545 1546 MATHJAX_CODEFILE = 1547 1548 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1549 # the HTML output. The underlying search engine uses javascript and DHTML and 1550 # should work on any modern browser. Note that when using HTML help 1551 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1552 # there is already a search function so this one should typically be disabled. 1553 # For large projects the javascript based search engine can be slow, then 1554 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1555 # search using the keyboard; to jump to the search box use <access key> + S 1556 # (what the <access key> is depends on the OS and browser, but it is typically 1557 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1558 # key> to jump into the search results window, the results can be navigated 1559 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1560 # the search. The filter options can be selected when the cursor is inside the 1561 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1562 # to select a filter and <Enter> or <escape> to activate or cancel the filter 1563 # option. 1564 # The default value is: YES. 1565 # This tag requires that the tag GENERATE_HTML is set to YES. 1566 1567 SEARCHENGINE = YES 1568 1569 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1570 # implemented using a web server instead of a web client using Javascript. There 1571 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1572 # setting. When disabled, doxygen will generate a PHP script for searching and 1573 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1574 # and searching needs to be provided by external tools. See the section 1575 # "External Indexing and Searching" for details. 1576 # The default value is: NO. 1577 # This tag requires that the tag SEARCHENGINE is set to YES. 1578 1579 SERVER_BASED_SEARCH = NO 1580 1581 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1582 # script for searching. Instead the search results are written to an XML file 1583 # which needs to be processed by an external indexer. Doxygen will invoke an 1584 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1585 # search results. 1586 # 1587 # Doxygen ships with an example indexer (doxyindexer) and search engine 1588 # (doxysearch.cgi) which are based on the open source search engine library 1589 # Xapian (see: http://xapian.org/). 1590 # 1591 # See the section "External Indexing and Searching" for details. 1592 # The default value is: NO. 1593 # This tag requires that the tag SEARCHENGINE is set to YES. 1594 1595 EXTERNAL_SEARCH = NO 1596 1597 # The SEARCHENGINE_URL should point to a search engine hosted by a web server 1598 # which will return the search results when EXTERNAL_SEARCH is enabled. 1599 # 1600 # Doxygen ships with an example indexer (doxyindexer) and search engine 1601 # (doxysearch.cgi) which are based on the open source search engine library 1602 # Xapian (see: http://xapian.org/). See the section "External Indexing and 1603 # Searching" for details. 1604 # This tag requires that the tag SEARCHENGINE is set to YES. 1605 1606 SEARCHENGINE_URL = 1607 1608 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1609 # search data is written to a file for indexing by an external tool. With the 1610 # SEARCHDATA_FILE tag the name of this file can be specified. 1611 # The default file is: searchdata.xml. 1612 # This tag requires that the tag SEARCHENGINE is set to YES. 1613 1614 SEARCHDATA_FILE = searchdata.xml 1615 1616 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1617 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1618 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1619 # projects and redirect the results back to the right project. 1620 # This tag requires that the tag SEARCHENGINE is set to YES. 1621 1622 EXTERNAL_SEARCH_ID = 1623 1624 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1625 # projects other than the one defined by this configuration file, but that are 1626 # all added to the same external search index. Each project needs to have a 1627 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1628 # to a relative location where the documentation can be found. The format is: 1629 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1630 # This tag requires that the tag SEARCHENGINE is set to YES. 1631 1632 EXTRA_SEARCH_MAPPINGS = 1633 1634 #--------------------------------------------------------------------------- 1635 # Configuration options related to the LaTeX output 1636 #--------------------------------------------------------------------------- 1637 1638 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1639 # The default value is: YES. 1640 1641 GENERATE_LATEX = NO 1642 1643 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1644 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1645 # it. 1646 # The default directory is: latex. 1647 # This tag requires that the tag GENERATE_LATEX is set to YES. 1648 1649 LATEX_OUTPUT = latex 1650 1651 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1652 # invoked. 1653 # 1654 # Note that when enabling USE_PDFLATEX this option is only used for generating 1655 # bitmaps for formulas in the HTML output, but not in the Makefile that is 1656 # written to the output directory. 1657 # The default file is: latex. 1658 # This tag requires that the tag GENERATE_LATEX is set to YES. 1659 1660 LATEX_CMD_NAME = latex 1661 1662 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1663 # index for LaTeX. 1664 # The default file is: makeindex. 1665 # This tag requires that the tag GENERATE_LATEX is set to YES. 1666 1667 MAKEINDEX_CMD_NAME = makeindex 1668 1669 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1670 # documents. This may be useful for small projects and may help to save some 1671 # trees in general. 1672 # The default value is: NO. 1673 # This tag requires that the tag GENERATE_LATEX is set to YES. 1674 1675 COMPACT_LATEX = NO 1676 1677 # The PAPER_TYPE tag can be used to set the paper type that is used by the 1678 # printer. 1679 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1680 # 14 inches) and executive (7.25 x 10.5 inches). 1681 # The default value is: a4. 1682 # This tag requires that the tag GENERATE_LATEX is set to YES. 1683 1684 PAPER_TYPE = a4 1685 1686 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1687 # that should be included in the LaTeX output. The package can be specified just 1688 # by its name or with the correct syntax as to be used with the LaTeX 1689 # \usepackage command. To get the times font for instance you can specify : 1690 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} 1691 # To use the option intlimits with the amsmath package you can specify: 1692 # EXTRA_PACKAGES=[intlimits]{amsmath} 1693 # If left blank no extra packages will be included. 1694 # This tag requires that the tag GENERATE_LATEX is set to YES. 1695 1696 EXTRA_PACKAGES = 1697 1698 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1699 # generated LaTeX document. The header should contain everything until the first 1700 # chapter. If it is left blank doxygen will generate a standard header. See 1701 # section "Doxygen usage" for information on how to let doxygen write the 1702 # default header to a separate file. 1703 # 1704 # Note: Only use a user-defined header if you know what you are doing! The 1705 # following commands have a special meaning inside the header: $title, 1706 # $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1707 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1708 # string, for the replacement values of the other commands the user is referred 1709 # to HTML_HEADER. 1710 # This tag requires that the tag GENERATE_LATEX is set to YES. 1711 1712 LATEX_HEADER = 1713 1714 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1715 # generated LaTeX document. The footer should contain everything after the last 1716 # chapter. If it is left blank doxygen will generate a standard footer. See 1717 # LATEX_HEADER for more information on how to generate a default footer and what 1718 # special commands can be used inside the footer. 1719 # 1720 # Note: Only use a user-defined footer if you know what you are doing! 1721 # This tag requires that the tag GENERATE_LATEX is set to YES. 1722 1723 LATEX_FOOTER = 1724 1725 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1726 # LaTeX style sheets that are included after the standard style sheets created 1727 # by doxygen. Using this option one can overrule certain style aspects. Doxygen 1728 # will copy the style sheet files to the output directory. 1729 # Note: The order of the extra style sheet files is of importance (e.g. the last 1730 # style sheet in the list overrules the setting of the previous ones in the 1731 # list). 1732 # This tag requires that the tag GENERATE_LATEX is set to YES. 1733 1734 LATEX_EXTRA_STYLESHEET = 1735 1736 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1737 # other source files which should be copied to the LATEX_OUTPUT output 1738 # directory. Note that the files will be copied as-is; there are no commands or 1739 # markers available. 1740 # This tag requires that the tag GENERATE_LATEX is set to YES. 1741 1742 LATEX_EXTRA_FILES = 1743 1744 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1745 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1746 # contain links (just like the HTML output) instead of page references. This 1747 # makes the output suitable for online browsing using a PDF viewer. 1748 # The default value is: YES. 1749 # This tag requires that the tag GENERATE_LATEX is set to YES. 1750 1751 PDF_HYPERLINKS = YES 1752 1753 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1754 # the PDF file directly from the LaTeX files. Set this option to YES, to get a 1755 # higher quality PDF documentation. 1756 # The default value is: YES. 1757 # This tag requires that the tag GENERATE_LATEX is set to YES. 1758 1759 USE_PDFLATEX = YES 1760 1761 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1762 # command to the generated LaTeX files. This will instruct LaTeX to keep running 1763 # if errors occur, instead of asking the user for help. This option is also used 1764 # when generating formulas in HTML. 1765 # The default value is: NO. 1766 # This tag requires that the tag GENERATE_LATEX is set to YES. 1767 1768 LATEX_BATCHMODE = NO 1769 1770 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1771 # index chapters (such as File Index, Compound Index, etc.) in the output. 1772 # The default value is: NO. 1773 # This tag requires that the tag GENERATE_LATEX is set to YES. 1774 1775 LATEX_HIDE_INDICES = NO 1776 1777 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1778 # code with syntax highlighting in the LaTeX output. 1779 # 1780 # Note that which sources are shown also depends on other settings such as 1781 # SOURCE_BROWSER. 1782 # The default value is: NO. 1783 # This tag requires that the tag GENERATE_LATEX is set to YES. 1784 1785 LATEX_SOURCE_CODE = NO 1786 1787 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1788 # bibliography, e.g. plainnat, or ieeetr. See 1789 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1790 # The default value is: plain. 1791 # This tag requires that the tag GENERATE_LATEX is set to YES. 1792 1793 LATEX_BIB_STYLE = plain 1794 1795 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated 1796 # page will contain the date and time when the page was generated. Setting this 1797 # to NO can help when comparing the output of multiple runs. 1798 # The default value is: NO. 1799 # This tag requires that the tag GENERATE_LATEX is set to YES. 1800 1801 LATEX_TIMESTAMP = NO 1802 1803 #--------------------------------------------------------------------------- 1804 # Configuration options related to the RTF output 1805 #--------------------------------------------------------------------------- 1806 1807 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 1808 # RTF output is optimized for Word 97 and may not look too pretty with other RTF 1809 # readers/editors. 1810 # The default value is: NO. 1811 1812 GENERATE_RTF = NO 1813 1814 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1815 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1816 # it. 1817 # The default directory is: rtf. 1818 # This tag requires that the tag GENERATE_RTF is set to YES. 1819 1820 RTF_OUTPUT = rtf 1821 1822 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 1823 # documents. This may be useful for small projects and may help to save some 1824 # trees in general. 1825 # The default value is: NO. 1826 # This tag requires that the tag GENERATE_RTF is set to YES. 1827 1828 COMPACT_RTF = NO 1829 1830 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1831 # contain hyperlink fields. The RTF file will contain links (just like the HTML 1832 # output) instead of page references. This makes the output suitable for online 1833 # browsing using Word or some other Word compatible readers that support those 1834 # fields. 1835 # 1836 # Note: WordPad (write) and others do not support links. 1837 # The default value is: NO. 1838 # This tag requires that the tag GENERATE_RTF is set to YES. 1839 1840 RTF_HYPERLINKS = NO 1841 1842 # Load stylesheet definitions from file. Syntax is similar to doxygen's config 1843 # file, i.e. a series of assignments. You only have to provide replacements, 1844 # missing definitions are set to their default value. 1845 # 1846 # See also section "Doxygen usage" for information on how to generate the 1847 # default style sheet that doxygen normally uses. 1848 # This tag requires that the tag GENERATE_RTF is set to YES. 1849 1850 RTF_STYLESHEET_FILE = 1851 1852 # Set optional variables used in the generation of an RTF document. Syntax is 1853 # similar to doxygen's config file. A template extensions file can be generated 1854 # using doxygen -e rtf extensionFile. 1855 # This tag requires that the tag GENERATE_RTF is set to YES. 1856 1857 RTF_EXTENSIONS_FILE = 1858 1859 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code 1860 # with syntax highlighting in the RTF output. 1861 # 1862 # Note that which sources are shown also depends on other settings such as 1863 # SOURCE_BROWSER. 1864 # The default value is: NO. 1865 # This tag requires that the tag GENERATE_RTF is set to YES. 1866 1867 RTF_SOURCE_CODE = NO 1868 1869 #--------------------------------------------------------------------------- 1870 # Configuration options related to the man page output 1871 #--------------------------------------------------------------------------- 1872 1873 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 1874 # classes and files. 1875 # The default value is: NO. 1876 1877 GENERATE_MAN = NO 1878 1879 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 1880 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1881 # it. A directory man3 will be created inside the directory specified by 1882 # MAN_OUTPUT. 1883 # The default directory is: man. 1884 # This tag requires that the tag GENERATE_MAN is set to YES. 1885 1886 MAN_OUTPUT = man 1887 1888 # The MAN_EXTENSION tag determines the extension that is added to the generated 1889 # man pages. In case the manual section does not start with a number, the number 1890 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 1891 # optional. 1892 # The default value is: .3. 1893 # This tag requires that the tag GENERATE_MAN is set to YES. 1894 1895 MAN_EXTENSION = .3 1896 1897 # The MAN_SUBDIR tag determines the name of the directory created within 1898 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 1899 # MAN_EXTENSION with the initial . removed. 1900 # This tag requires that the tag GENERATE_MAN is set to YES. 1901 1902 MAN_SUBDIR = 1903 1904 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1905 # will generate one additional man file for each entity documented in the real 1906 # man page(s). These additional files only source the real man page, but without 1907 # them the man command would be unable to find the correct page. 1908 # The default value is: NO. 1909 # This tag requires that the tag GENERATE_MAN is set to YES. 1910 1911 MAN_LINKS = NO 1912 1913 #--------------------------------------------------------------------------- 1914 # Configuration options related to the XML output 1915 #--------------------------------------------------------------------------- 1916 1917 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 1918 # captures the structure of the code including all documentation. 1919 # The default value is: NO. 1920 1921 GENERATE_XML = NO 1922 1923 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 1924 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1925 # it. 1926 # The default directory is: xml. 1927 # This tag requires that the tag GENERATE_XML is set to YES. 1928 1929 XML_OUTPUT = xml 1930 1931 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 1932 # listings (including syntax highlighting and cross-referencing information) to 1933 # the XML output. Note that enabling this will significantly increase the size 1934 # of the XML output. 1935 # The default value is: YES. 1936 # This tag requires that the tag GENERATE_XML is set to YES. 1937 1938 XML_PROGRAMLISTING = YES 1939 1940 #--------------------------------------------------------------------------- 1941 # Configuration options related to the DOCBOOK output 1942 #--------------------------------------------------------------------------- 1943 1944 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 1945 # that can be used to generate PDF. 1946 # The default value is: NO. 1947 1948 GENERATE_DOCBOOK = NO 1949 1950 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 1951 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 1952 # front of it. 1953 # The default directory is: docbook. 1954 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1955 1956 DOCBOOK_OUTPUT = docbook 1957 1958 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the 1959 # program listings (including syntax highlighting and cross-referencing 1960 # information) to the DOCBOOK output. Note that enabling this will significantly 1961 # increase the size of the DOCBOOK output. 1962 # The default value is: NO. 1963 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1964 1965 DOCBOOK_PROGRAMLISTING = NO 1966 1967 #--------------------------------------------------------------------------- 1968 # Configuration options for the AutoGen Definitions output 1969 #--------------------------------------------------------------------------- 1970 1971 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 1972 # AutoGen Definitions (see http://autogen.sf.net) file that captures the 1973 # structure of the code including all documentation. Note that this feature is 1974 # still experimental and incomplete at the moment. 1975 # The default value is: NO. 1976 1977 GENERATE_AUTOGEN_DEF = NO 1978 1979 #--------------------------------------------------------------------------- 1980 # Configuration options related to the Perl module output 1981 #--------------------------------------------------------------------------- 1982 1983 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 1984 # file that captures the structure of the code including all documentation. 1985 # 1986 # Note that this feature is still experimental and incomplete at the moment. 1987 # The default value is: NO. 1988 1989 GENERATE_PERLMOD = NO 1990 1991 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 1992 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 1993 # output from the Perl module output. 1994 # The default value is: NO. 1995 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 1996 1997 PERLMOD_LATEX = NO 1998 1999 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 2000 # formatted so it can be parsed by a human reader. This is useful if you want to 2001 # understand what is going on. On the other hand, if this tag is set to NO, the 2002 # size of the Perl module output will be much smaller and Perl will parse it 2003 # just the same. 2004 # The default value is: YES. 2005 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 2006 2007 PERLMOD_PRETTY = YES 2008 2009 # The names of the make variables in the generated doxyrules.make file are 2010 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 2011 # so different doxyrules.make files included by the same Makefile don't 2012 # overwrite each other's variables. 2013 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 2014 2015 PERLMOD_MAKEVAR_PREFIX = 2016 2017 #--------------------------------------------------------------------------- 2018 # Configuration options related to the preprocessor 2019 #--------------------------------------------------------------------------- 2020 2021 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 2022 # C-preprocessor directives found in the sources and include files. 2023 # The default value is: YES. 2024 2025 ENABLE_PREPROCESSING = YES 2026 2027 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 2028 # in the source code. If set to NO, only conditional compilation will be 2029 # performed. Macro expansion can be done in a controlled way by setting 2030 # EXPAND_ONLY_PREDEF to YES. 2031 # The default value is: NO. 2032 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2033 2034 MACRO_EXPANSION = NO 2035 2036 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 2037 # the macro expansion is limited to the macros specified with the PREDEFINED and 2038 # EXPAND_AS_DEFINED tags. 2039 # The default value is: NO. 2040 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2041 2042 EXPAND_ONLY_PREDEF = NO 2043 2044 # If the SEARCH_INCLUDES tag is set to YES, the include files in the 2045 # INCLUDE_PATH will be searched if a #include is found. 2046 # The default value is: YES. 2047 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2048 2049 SEARCH_INCLUDES = YES 2050 2051 # The INCLUDE_PATH tag can be used to specify one or more directories that 2052 # contain include files that are not input files but should be processed by the 2053 # preprocessor. 2054 # This tag requires that the tag SEARCH_INCLUDES is set to YES. 2055 2056 INCLUDE_PATH = 2057 2058 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2059 # patterns (like *.h and *.hpp) to filter out the header-files in the 2060 # directories. If left blank, the patterns specified with FILE_PATTERNS will be 2061 # used. 2062 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2063 2064 INCLUDE_FILE_PATTERNS = 2065 2066 # The PREDEFINED tag can be used to specify one or more macro names that are 2067 # defined before the preprocessor is started (similar to the -D option of e.g. 2068 # gcc). The argument of the tag is a list of macros of the form: name or 2069 # name=definition (no spaces). If the definition and the "=" are omitted, "=1" 2070 # is assumed. To prevent a macro definition from being undefined via #undef or 2071 # recursively expanded use the := operator instead of the = operator. 2072 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2073 2074 PREDEFINED = ENABLE_EXTERNAL_SIGNER 2075 2076 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2077 # tag can be used to specify a list of macro names that should be expanded. The 2078 # macro definition that is found in the sources will be used. Use the PREDEFINED 2079 # tag if you want to use a different macro definition that overrules the 2080 # definition found in the source code. 2081 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2082 2083 EXPAND_AS_DEFINED = 2084 2085 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2086 # remove all references to function-like macros that are alone on a line, have 2087 # an all uppercase name, and do not end with a semicolon. Such function macros 2088 # are typically used for boiler-plate code, and will confuse the parser if not 2089 # removed. 2090 # The default value is: YES. 2091 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2092 2093 SKIP_FUNCTION_MACROS = YES 2094 2095 #--------------------------------------------------------------------------- 2096 # Configuration options related to external references 2097 #--------------------------------------------------------------------------- 2098 2099 # The TAGFILES tag can be used to specify one or more tag files. For each tag 2100 # file the location of the external documentation should be added. The format of 2101 # a tag file without this location is as follows: 2102 # TAGFILES = file1 file2 ... 2103 # Adding location for the tag files is done as follows: 2104 # TAGFILES = file1=loc1 "file2 = loc2" ... 2105 # where loc1 and loc2 can be relative or absolute paths or URLs. See the 2106 # section "Linking to external documentation" for more information about the use 2107 # of tag files. 2108 # Note: Each tag file must have a unique name (where the name does NOT include 2109 # the path). If a tag file is not located in the directory in which doxygen is 2110 # run, you must also specify the path to the tagfile here. 2111 2112 TAGFILES = 2113 2114 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2115 # tag file that is based on the input files it reads. See section "Linking to 2116 # external documentation" for more information about the usage of tag files. 2117 2118 GENERATE_TAGFILE = 2119 2120 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2121 # the class index. If set to NO, only the inherited external classes will be 2122 # listed. 2123 # The default value is: NO. 2124 2125 ALLEXTERNALS = NO 2126 2127 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2128 # in the modules index. If set to NO, only the current project's groups will be 2129 # listed. 2130 # The default value is: YES. 2131 2132 EXTERNAL_GROUPS = YES 2133 2134 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2135 # the related pages index. If set to NO, only the current project's pages will 2136 # be listed. 2137 # The default value is: YES. 2138 2139 EXTERNAL_PAGES = YES 2140 2141 # The PERL_PATH should be the absolute path and name of the perl script 2142 # interpreter (i.e. the result of 'which perl'). 2143 # The default file (with absolute path) is: /usr/bin/perl. 2144 2145 PERL_PATH = /usr/bin/perl 2146 2147 #--------------------------------------------------------------------------- 2148 # Configuration options related to the dot tool 2149 #--------------------------------------------------------------------------- 2150 2151 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram 2152 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2153 # NO turns the diagrams off. Note that this option also works with HAVE_DOT 2154 # disabled, but it is recommended to install and use dot, since it yields more 2155 # powerful graphs. 2156 # The default value is: YES. 2157 2158 CLASS_DIAGRAMS = YES 2159 2160 # You can define message sequence charts within doxygen comments using the \msc 2161 # command. Doxygen will then run the mscgen tool (see: 2162 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 2163 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 2164 # the mscgen tool resides. If left empty the tool is assumed to be found in the 2165 # default search path. 2166 2167 MSCGEN_PATH = 2168 2169 # You can include diagrams made with dia in doxygen documentation. Doxygen will 2170 # then run dia to produce the diagram and insert it in the documentation. The 2171 # DIA_PATH tag allows you to specify the directory where the dia binary resides. 2172 # If left empty dia is assumed to be found in the default search path. 2173 2174 DIA_PATH = 2175 2176 # If set to YES the inheritance and collaboration graphs will hide inheritance 2177 # and usage relations if the target is undocumented or is not a class. 2178 # The default value is: YES. 2179 2180 HIDE_UNDOC_RELATIONS = YES 2181 2182 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2183 # available from the path. This tool is part of Graphviz (see: 2184 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2185 # Bell Labs. The other options in this section have no effect if this option is 2186 # set to NO 2187 # The default value is: NO. 2188 2189 HAVE_DOT = YES 2190 2191 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2192 # to run in parallel. When set to 0 doxygen will base this on the number of 2193 # processors available in the system. You can set it explicitly to a value 2194 # larger than 0 to get control over the balance between CPU load and processing 2195 # speed. 2196 # Minimum value: 0, maximum value: 32, default value: 0. 2197 # This tag requires that the tag HAVE_DOT is set to YES. 2198 2199 DOT_NUM_THREADS = 0 2200 2201 # When you want a differently looking font in the dot files that doxygen 2202 # generates you can specify the font name using DOT_FONTNAME. You need to make 2203 # sure dot is able to find the font, which can be done by putting it in a 2204 # standard location or by setting the DOTFONTPATH environment variable or by 2205 # setting DOT_FONTPATH to the directory containing the font. 2206 # The default value is: Helvetica. 2207 # This tag requires that the tag HAVE_DOT is set to YES. 2208 2209 DOT_FONTNAME = Helvetica 2210 2211 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2212 # dot graphs. 2213 # Minimum value: 4, maximum value: 24, default value: 10. 2214 # This tag requires that the tag HAVE_DOT is set to YES. 2215 2216 DOT_FONTSIZE = 10 2217 2218 # By default doxygen will tell dot to use the default font as specified with 2219 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2220 # the path where dot can find it using this tag. 2221 # This tag requires that the tag HAVE_DOT is set to YES. 2222 2223 DOT_FONTPATH = 2224 2225 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2226 # each documented class showing the direct and indirect inheritance relations. 2227 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2228 # The default value is: YES. 2229 # This tag requires that the tag HAVE_DOT is set to YES. 2230 2231 CLASS_GRAPH = YES 2232 2233 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2234 # graph for each documented class showing the direct and indirect implementation 2235 # dependencies (inheritance, containment, and class references variables) of the 2236 # class with other documented classes. 2237 # The default value is: YES. 2238 # This tag requires that the tag HAVE_DOT is set to YES. 2239 2240 COLLABORATION_GRAPH = YES 2241 2242 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2243 # groups, showing the direct groups dependencies. 2244 # The default value is: YES. 2245 # This tag requires that the tag HAVE_DOT is set to YES. 2246 2247 GROUP_GRAPHS = YES 2248 2249 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2250 # collaboration diagrams in a style similar to the OMG's Unified Modeling 2251 # Language. 2252 # The default value is: NO. 2253 # This tag requires that the tag HAVE_DOT is set to YES. 2254 2255 UML_LOOK = NO 2256 2257 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2258 # class node. If there are many fields or methods and many nodes the graph may 2259 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2260 # number of items for each type to make the size more manageable. Set this to 0 2261 # for no limit. Note that the threshold may be exceeded by 50% before the limit 2262 # is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2263 # but if the number exceeds 15, the total amount of fields shown is limited to 2264 # 10. 2265 # Minimum value: 0, maximum value: 100, default value: 10. 2266 # This tag requires that the tag HAVE_DOT is set to YES. 2267 2268 UML_LIMIT_NUM_FIELDS = 10 2269 2270 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2271 # collaboration graphs will show the relations between templates and their 2272 # instances. 2273 # The default value is: NO. 2274 # This tag requires that the tag HAVE_DOT is set to YES. 2275 2276 TEMPLATE_RELATIONS = NO 2277 2278 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2279 # YES then doxygen will generate a graph for each documented file showing the 2280 # direct and indirect include dependencies of the file with other documented 2281 # files. 2282 # The default value is: YES. 2283 # This tag requires that the tag HAVE_DOT is set to YES. 2284 2285 INCLUDE_GRAPH = YES 2286 2287 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2288 # set to YES then doxygen will generate a graph for each documented file showing 2289 # the direct and indirect include dependencies of the file with other documented 2290 # files. 2291 # The default value is: YES. 2292 # This tag requires that the tag HAVE_DOT is set to YES. 2293 2294 INCLUDED_BY_GRAPH = YES 2295 2296 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2297 # dependency graph for every global function or class method. 2298 # 2299 # Note that enabling this option will significantly increase the time of a run. 2300 # So in most cases it will be better to enable call graphs for selected 2301 # functions only using the \callgraph command. Disabling a call graph can be 2302 # accomplished by means of the command \hidecallgraph. 2303 # The default value is: NO. 2304 # This tag requires that the tag HAVE_DOT is set to YES. 2305 2306 CALL_GRAPH = YES 2307 2308 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2309 # dependency graph for every global function or class method. 2310 # 2311 # Note that enabling this option will significantly increase the time of a run. 2312 # So in most cases it will be better to enable caller graphs for selected 2313 # functions only using the \callergraph command. Disabling a caller graph can be 2314 # accomplished by means of the command \hidecallergraph. 2315 # The default value is: NO. 2316 # This tag requires that the tag HAVE_DOT is set to YES. 2317 2318 CALLER_GRAPH = YES 2319 2320 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2321 # hierarchy of all classes instead of a textual one. 2322 # The default value is: YES. 2323 # This tag requires that the tag HAVE_DOT is set to YES. 2324 2325 GRAPHICAL_HIERARCHY = YES 2326 2327 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2328 # dependencies a directory has on other directories in a graphical way. The 2329 # dependency relations are determined by the #include relations between the 2330 # files in the directories. 2331 # The default value is: YES. 2332 # This tag requires that the tag HAVE_DOT is set to YES. 2333 2334 DIRECTORY_GRAPH = YES 2335 2336 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2337 # generated by dot. For an explanation of the image formats see the section 2338 # output formats in the documentation of the dot tool (Graphviz (see: 2339 # http://www.graphviz.org/)). 2340 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2341 # to make the SVG files visible in IE 9+ (other browsers do not have this 2342 # requirement). 2343 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, 2344 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2345 # png:gdiplus:gdiplus. 2346 # The default value is: png. 2347 # This tag requires that the tag HAVE_DOT is set to YES. 2348 2349 DOT_IMAGE_FORMAT = svg 2350 2351 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2352 # enable generation of interactive SVG images that allow zooming and panning. 2353 # 2354 # Note that this requires a modern browser other than Internet Explorer. Tested 2355 # and working are Firefox, Chrome, Safari, and Opera. 2356 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2357 # the SVG files visible. Older versions of IE do not have SVG support. 2358 # The default value is: NO. 2359 # This tag requires that the tag HAVE_DOT is set to YES. 2360 2361 INTERACTIVE_SVG = NO 2362 2363 # The DOT_PATH tag can be used to specify the path where the dot tool can be 2364 # found. If left blank, it is assumed the dot tool can be found in the path. 2365 # This tag requires that the tag HAVE_DOT is set to YES. 2366 2367 DOT_PATH = 2368 2369 # The DOTFILE_DIRS tag can be used to specify one or more directories that 2370 # contain dot files that are included in the documentation (see the \dotfile 2371 # command). 2372 # This tag requires that the tag HAVE_DOT is set to YES. 2373 2374 DOTFILE_DIRS = 2375 2376 # The MSCFILE_DIRS tag can be used to specify one or more directories that 2377 # contain msc files that are included in the documentation (see the \mscfile 2378 # command). 2379 2380 MSCFILE_DIRS = 2381 2382 # The DIAFILE_DIRS tag can be used to specify one or more directories that 2383 # contain dia files that are included in the documentation (see the \diafile 2384 # command). 2385 2386 DIAFILE_DIRS = 2387 2388 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2389 # path where java can find the plantuml.jar file. If left blank, it is assumed 2390 # PlantUML is not used or called during a preprocessing step. Doxygen will 2391 # generate a warning when it encounters a \startuml command in this case and 2392 # will not generate output for the diagram. 2393 2394 PLANTUML_JAR_PATH = 2395 2396 # When using plantuml, the specified paths are searched for files specified by 2397 # the !include statement in a plantuml block. 2398 2399 PLANTUML_INCLUDE_PATH = 2400 2401 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2402 # that will be shown in the graph. If the number of nodes in a graph becomes 2403 # larger than this value, doxygen will truncate the graph, which is visualized 2404 # by representing a node as a red box. Note that doxygen if the number of direct 2405 # children of the root node in a graph is already larger than 2406 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2407 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2408 # Minimum value: 0, maximum value: 10000, default value: 50. 2409 # This tag requires that the tag HAVE_DOT is set to YES. 2410 2411 DOT_GRAPH_MAX_NODES = 50 2412 2413 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2414 # generated by dot. A depth value of 3 means that only nodes reachable from the 2415 # root by following a path via at most 3 edges will be shown. Nodes that lay 2416 # further from the root node will be omitted. Note that setting this option to 1 2417 # or 2 may greatly reduce the computation time needed for large code bases. Also 2418 # note that the size of a graph can be further restricted by 2419 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2420 # Minimum value: 0, maximum value: 1000, default value: 0. 2421 # This tag requires that the tag HAVE_DOT is set to YES. 2422 2423 MAX_DOT_GRAPH_DEPTH = 0 2424 2425 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2426 # background. This is disabled by default, because dot on Windows does not seem 2427 # to support this out of the box. 2428 # 2429 # Warning: Depending on the platform used, enabling this option may lead to 2430 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 2431 # read). 2432 # The default value is: NO. 2433 # This tag requires that the tag HAVE_DOT is set to YES. 2434 2435 DOT_TRANSPARENT = NO 2436 2437 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2438 # files in one run (i.e. multiple -o and -T options on the command line). This 2439 # makes dot run faster, but since only newer versions of dot (>1.8.10) support 2440 # this, this feature is disabled by default. 2441 # The default value is: NO. 2442 # This tag requires that the tag HAVE_DOT is set to YES. 2443 2444 DOT_MULTI_TARGETS = NO 2445 2446 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2447 # explaining the meaning of the various boxes and arrows in the dot generated 2448 # graphs. 2449 # The default value is: YES. 2450 # This tag requires that the tag HAVE_DOT is set to YES. 2451 2452 GENERATE_LEGEND = YES 2453 2454 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot 2455 # files that are used to generate the various graphs. 2456 # The default value is: YES. 2457 # This tag requires that the tag HAVE_DOT is set to YES. 2458 2459 DOT_CLEANUP = YES