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