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