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 29DOXYFILE_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 37PROJECT_NAME = "GRPC Objective-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 43PROJECT_NUMBER = 1.35.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 49PROJECT_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 56PROJECT_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 63OUTPUT_DIRECTORY = doc/ref/objc.internal 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 73CREATE_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 81ALLOW_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 96OUTPUT_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 103BRIEF_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 112REPEAT_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 123ABBREVIATE_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 130ALWAYS_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 138INLINE_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 145FULL_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 157STRIP_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 166STRIP_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 173SHORT_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 182JAVADOC_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 190QT_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 202MULTILINE_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 208INHERIT_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 215SEPARATE_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 221TAB_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 233ALIASES = 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 239TCL_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 247OPTIMIZE_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 255OPTIMIZE_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 261OPTIMIZE_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 267OPTIMIZE_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 286EXTENSION_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 296MARKDOWN_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 304AUTOLINK_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 314BUILTIN_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 320CPP_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 328SIP_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 338IDL_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 346DISTRIBUTE_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 355SUBGROUPING = 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 366INLINE_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 376INLINE_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 387TYPEDEF_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 400LOOKUP_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 414EXTRACT_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 420EXTRACT_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 426EXTRACT_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 432EXTRACT_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 440EXTRACT_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 448EXTRACT_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 457EXTRACT_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 465HIDE_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 473HIDE_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 480HIDE_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 487HIDE_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 494INTERNAL_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 503CASE_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 510HIDE_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 517HIDE_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 523SHOW_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 530SHOW_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 536FORCE_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 542INLINE_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 549SORT_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 557SORT_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 569SORT_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 576SORT_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 586SORT_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 596STRICT_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 602GENERATE_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 608GENERATE_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 614GENERATE_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 621GENERATE_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 627ENABLED_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 638MAX_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 645SHOW_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 652SHOW_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 659SHOW_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 669FILE_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 682LAYOUT_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 692CITE_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 703QUIET = 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 712WARNINGS = 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 719WARN_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 727WARN_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 735WARN_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 745WARN_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 751WARN_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 763INPUT = doc/PROTOCOL-HTTP2.md \ 764doc/PROTOCOL-WEB.md \ 765doc/binary-logging.md \ 766doc/c-style-guide.md \ 767doc/command_line_tool.md \ 768doc/compression.md \ 769doc/compression_cookbook.md \ 770doc/connection-backoff-interop-test-description.md \ 771doc/connection-backoff.md \ 772doc/connectivity-semantics-and-api.md \ 773doc/cpp-style-guide.md \ 774doc/environment_variables.md \ 775doc/fail_fast.md \ 776doc/fork_support.md \ 777doc/g_stands_for.md \ 778doc/grpc_release_schedule.md \ 779doc/grpc_xds_features.md \ 780doc/health-checking.md \ 781doc/http-grpc-status-mapping.md \ 782doc/http2-interop-test-descriptions.md \ 783doc/internationalization.md \ 784doc/interop-test-descriptions.md \ 785doc/keepalive.md \ 786doc/load-balancing.md \ 787doc/naming.md \ 788doc/security_audit.md \ 789doc/server-reflection.md \ 790doc/server_reflection_tutorial.md \ 791doc/server_side_auth.md \ 792doc/service_config.md \ 793doc/ssl-performance.md \ 794doc/status_ordering.md \ 795doc/statuscodes.md \ 796doc/unit_testing.md \ 797doc/versioning.md \ 798doc/wait-for-ready.md \ 799doc/workarounds.md \ 800doc/xds-test-descriptions.md \ 801src/objective-c/GRPCClient/GRPCCall+ChannelArg.h \ 802src/objective-c/GRPCClient/GRPCCall+ChannelCredentials.h \ 803src/objective-c/GRPCClient/GRPCCall+Cronet.h \ 804src/objective-c/GRPCClient/GRPCCall+GID.h \ 805src/objective-c/GRPCClient/GRPCCall+Interceptor.h \ 806src/objective-c/GRPCClient/GRPCCall+OAuth2.h \ 807src/objective-c/GRPCClient/GRPCCall+Tests.h \ 808src/objective-c/GRPCClient/GRPCCall.h \ 809src/objective-c/GRPCClient/GRPCCallLegacy.h \ 810src/objective-c/GRPCClient/GRPCCallOptions.h \ 811src/objective-c/GRPCClient/GRPCDispatchable.h \ 812src/objective-c/GRPCClient/GRPCInterceptor.h \ 813src/objective-c/GRPCClient/GRPCTransport.h \ 814src/objective-c/GRPCClient/GRPCTypes.h \ 815src/objective-c/GRPCClient/README.md \ 816src/objective-c/GRPCClient/internal/GRPCCallOptions+Internal.h \ 817src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.h \ 818src/objective-c/GRPCClient/private/GRPCCore/ChannelArgsUtil.h \ 819src/objective-c/GRPCClient/private/GRPCCore/GRPCCall+V2API.h \ 820src/objective-c/GRPCClient/private/GRPCCore/GRPCCallInternal.h \ 821src/objective-c/GRPCClient/private/GRPCCore/GRPCChannel.h \ 822src/objective-c/GRPCClient/private/GRPCCore/GRPCChannelFactory.h \ 823src/objective-c/GRPCClient/private/GRPCCore/GRPCChannelPool+Test.h \ 824src/objective-c/GRPCClient/private/GRPCCore/GRPCChannelPool.h \ 825src/objective-c/GRPCClient/private/GRPCCore/GRPCCompletionQueue.h \ 826src/objective-c/GRPCClient/private/GRPCCore/GRPCCoreCronet/GRPCCoreCronetFactory.h \ 827src/objective-c/GRPCClient/private/GRPCCore/GRPCCoreCronet/GRPCCronetChannelFactory.h \ 828src/objective-c/GRPCClient/private/GRPCCore/GRPCCoreFactory.h \ 829src/objective-c/GRPCClient/private/GRPCCore/GRPCHost.h \ 830src/objective-c/GRPCClient/private/GRPCCore/GRPCInsecureChannelFactory.h \ 831src/objective-c/GRPCClient/private/GRPCCore/GRPCOpBatchLog.h \ 832src/objective-c/GRPCClient/private/GRPCCore/GRPCReachabilityFlagNames.xmacro.h \ 833src/objective-c/GRPCClient/private/GRPCCore/GRPCRequestHeaders.h \ 834src/objective-c/GRPCClient/private/GRPCCore/GRPCSecureChannelFactory.h \ 835src/objective-c/GRPCClient/private/GRPCCore/GRPCWrappedCall.h \ 836src/objective-c/GRPCClient/private/GRPCCore/NSData+GRPC.h \ 837src/objective-c/GRPCClient/private/GRPCCore/NSDictionary+GRPC.h \ 838src/objective-c/GRPCClient/private/GRPCCore/NSError+GRPC.h \ 839src/objective-c/GRPCClient/private/GRPCTransport+Private.h \ 840src/objective-c/GRPCClient/version.h \ 841src/objective-c/NetworkTransitionBehavior.md \ 842src/objective-c/ProtoRPC/ProtoMethod.h \ 843src/objective-c/ProtoRPC/ProtoRPC.h \ 844src/objective-c/ProtoRPC/ProtoRPCLegacy.h \ 845src/objective-c/ProtoRPC/ProtoService.h \ 846src/objective-c/ProtoRPC/ProtoServiceLegacy.h \ 847src/objective-c/README-CFSTREAM.md \ 848src/objective-c/README.md \ 849src/objective-c/RxLibrary/GRXBufferedPipe.h \ 850src/objective-c/RxLibrary/GRXConcurrentWriteable.h \ 851src/objective-c/RxLibrary/GRXForwardingWriter.h \ 852src/objective-c/RxLibrary/GRXImmediateSingleWriter.h \ 853src/objective-c/RxLibrary/GRXImmediateWriter.h \ 854src/objective-c/RxLibrary/GRXMappingWriter.h \ 855src/objective-c/RxLibrary/GRXWriteable.h \ 856src/objective-c/RxLibrary/GRXWriter+Immediate.h \ 857src/objective-c/RxLibrary/GRXWriter+Transformations.h \ 858src/objective-c/RxLibrary/GRXWriter.h \ 859src/objective-c/RxLibrary/NSEnumerator+GRXUtil.h \ 860src/objective-c/RxLibrary/README.md \ 861src/objective-c/RxLibrary/private/GRXNSBlockEnumerator.h \ 862src/objective-c/RxLibrary/private/GRXNSFastEnumerator.h \ 863src/objective-c/RxLibrary/private/GRXNSScalarEnumerator.h \ 864src/objective-c/examples/Sample/README.md \ 865src/objective-c/tests/Connectivity/README.md 866 867# This tag can be used to specify the character encoding of the source files 868# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 869# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 870# documentation (see: http://www.gnu.org/software/libiconv) for the list of 871# possible encodings. 872# The default value is: UTF-8. 873 874INPUT_ENCODING = UTF-8 875 876# If the value of the INPUT tag contains directories, you can use the 877# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 878# *.h) to filter out the source-files in the directories. If left blank the 879# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 880# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 881# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 882# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 883# *.qsf, *.as and *.js. 884 885FILE_PATTERNS = 886 887# The RECURSIVE tag can be used to specify whether or not subdirectories should 888# be searched for input files as well. 889# The default value is: NO. 890 891RECURSIVE = NO 892 893# The EXCLUDE tag can be used to specify files and/or directories that should be 894# excluded from the INPUT source files. This way you can easily exclude a 895# subdirectory from a directory tree whose root is specified with the INPUT tag. 896# 897# Note that relative paths are relative to the directory from which doxygen is 898# run. 899 900EXCLUDE = 901 902# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 903# directories that are symbolic links (a Unix file system feature) are excluded 904# from the input. 905# The default value is: NO. 906 907EXCLUDE_SYMLINKS = NO 908 909# If the value of the INPUT tag contains directories, you can use the 910# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 911# certain files from those directories. 912# 913# Note that the wildcards are matched against the file with absolute path, so to 914# exclude all test directories for example use the pattern */test/* 915 916EXCLUDE_PATTERNS = 917 918# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 919# (namespaces, classes, functions, etc.) that should be excluded from the 920# output. The symbol name can be a fully qualified name, a word, or if the 921# wildcard * is used, a substring. Examples: ANamespace, AClass, 922# AClass::ANamespace, ANamespace::*Test 923# 924# Note that the wildcards are matched against the file with absolute path, so to 925# exclude all test directories use the pattern */test/* 926 927EXCLUDE_SYMBOLS = 928 929# The EXAMPLE_PATH tag can be used to specify one or more files or directories 930# that contain example code fragments that are included (see the \include 931# command). 932 933EXAMPLE_PATH = 934 935# If the value of the EXAMPLE_PATH tag contains directories, you can use the 936# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 937# *.h) to filter out the source-files in the directories. If left blank all 938# files are included. 939 940EXAMPLE_PATTERNS = 941 942# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 943# searched for input files to be used with the \include or \dontinclude commands 944# irrespective of the value of the RECURSIVE tag. 945# The default value is: NO. 946 947EXAMPLE_RECURSIVE = NO 948 949# The IMAGE_PATH tag can be used to specify one or more files or directories 950# that contain images that are to be included in the documentation (see the 951# \image command). 952 953IMAGE_PATH = 954 955# The INPUT_FILTER tag can be used to specify a program that doxygen should 956# invoke to filter for each input file. Doxygen will invoke the filter program 957# by executing (via popen()) the command: 958# 959# <filter> <input-file> 960# 961# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 962# name of an input file. Doxygen will then use the output that the filter 963# program writes to standard output. If FILTER_PATTERNS is specified, this tag 964# will be ignored. 965# 966# Note that the filter must not add or remove lines; it is applied before the 967# code is scanned, but not when the output code is generated. If lines are added 968# or removed, the anchors will not be placed correctly. 969 970INPUT_FILTER = 971 972# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 973# basis. Doxygen will compare the file name with each pattern and apply the 974# filter if there is a match. The filters are a list of the form: pattern=filter 975# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 976# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 977# patterns match the file name, INPUT_FILTER is applied. 978 979FILTER_PATTERNS = 980 981# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 982# INPUT_FILTER) will also be used to filter the input files that are used for 983# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 984# The default value is: NO. 985 986FILTER_SOURCE_FILES = NO 987 988# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 989# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 990# it is also possible to disable source filtering for a specific pattern using 991# *.ext= (so without naming a filter). 992# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 993 994FILTER_SOURCE_PATTERNS = 995 996# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 997# is part of the input, its contents will be placed on the main page 998# (index.html). This can be useful if you have a project on for instance GitHub 999# and want to reuse the introduction page also for the doxygen output. 1000 1001USE_MDFILE_AS_MAINPAGE = 1002 1003#--------------------------------------------------------------------------- 1004# Configuration options related to source browsing 1005#--------------------------------------------------------------------------- 1006 1007# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1008# generated. Documented entities will be cross-referenced with these sources. 1009# 1010# Note: To get rid of all source code in the generated output, make sure that 1011# also VERBATIM_HEADERS is set to NO. 1012# The default value is: NO. 1013 1014SOURCE_BROWSER = NO 1015 1016# Setting the INLINE_SOURCES tag to YES will include the body of functions, 1017# classes and enums directly into the documentation. 1018# The default value is: NO. 1019 1020INLINE_SOURCES = NO 1021 1022# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1023# special comment blocks from generated source code fragments. Normal C, C++ and 1024# Fortran comments will always remain visible. 1025# The default value is: YES. 1026 1027STRIP_CODE_COMMENTS = YES 1028 1029# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1030# function all documented functions referencing it will be listed. 1031# The default value is: NO. 1032 1033REFERENCED_BY_RELATION = NO 1034 1035# If the REFERENCES_RELATION tag is set to YES then for each documented function 1036# all documented entities called/used by that function will be listed. 1037# The default value is: NO. 1038 1039REFERENCES_RELATION = NO 1040 1041# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1042# to YES then the hyperlinks from functions in REFERENCES_RELATION and 1043# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1044# link to the documentation. 1045# The default value is: YES. 1046 1047REFERENCES_LINK_SOURCE = YES 1048 1049# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1050# source code will show a tooltip with additional information such as prototype, 1051# brief description and links to the definition and documentation. Since this 1052# will make the HTML file larger and loading of large files a bit slower, you 1053# can opt to disable this feature. 1054# The default value is: YES. 1055# This tag requires that the tag SOURCE_BROWSER is set to YES. 1056 1057SOURCE_TOOLTIPS = YES 1058 1059# If the USE_HTAGS tag is set to YES then the references to source code will 1060# point to the HTML generated by the htags(1) tool instead of doxygen built-in 1061# source browser. The htags tool is part of GNU's global source tagging system 1062# (see http://www.gnu.org/software/global/global.html). You will need version 1063# 4.8.6 or higher. 1064# 1065# To use it do the following: 1066# - Install the latest version of global 1067# - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1068# - Make sure the INPUT points to the root of the source tree 1069# - Run doxygen as normal 1070# 1071# Doxygen will invoke htags (and that will in turn invoke gtags), so these 1072# tools must be available from the command line (i.e. in the search path). 1073# 1074# The result: instead of the source browser generated by doxygen, the links to 1075# source code will now point to the output of htags. 1076# The default value is: NO. 1077# This tag requires that the tag SOURCE_BROWSER is set to YES. 1078 1079USE_HTAGS = NO 1080 1081# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1082# verbatim copy of the header file for each class for which an include is 1083# specified. Set to NO to disable this. 1084# See also: Section \class. 1085# The default value is: YES. 1086 1087VERBATIM_HEADERS = YES 1088 1089#--------------------------------------------------------------------------- 1090# Configuration options related to the alphabetical class index 1091#--------------------------------------------------------------------------- 1092 1093# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1094# compounds will be generated. Enable this if the project contains a lot of 1095# classes, structs, unions or interfaces. 1096# The default value is: YES. 1097 1098ALPHABETICAL_INDEX = YES 1099 1100# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1101# which the alphabetical index list will be split. 1102# Minimum value: 1, maximum value: 20, default value: 5. 1103# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1104 1105COLS_IN_ALPHA_INDEX = 5 1106 1107# In case all classes in a project start with a common prefix, all classes will 1108# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1109# can be used to specify a prefix (or a list of prefixes) that should be ignored 1110# while generating the index headers. 1111# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1112 1113IGNORE_PREFIX = 1114 1115#--------------------------------------------------------------------------- 1116# Configuration options related to the HTML output 1117#--------------------------------------------------------------------------- 1118 1119# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1120# The default value is: YES. 1121 1122GENERATE_HTML = YES 1123 1124# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1125# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1126# it. 1127# The default directory is: html. 1128# This tag requires that the tag GENERATE_HTML is set to YES. 1129 1130HTML_OUTPUT = html 1131 1132# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1133# generated HTML page (for example: .htm, .php, .asp). 1134# The default value is: .html. 1135# This tag requires that the tag GENERATE_HTML is set to YES. 1136 1137HTML_FILE_EXTENSION = .html 1138 1139# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1140# each generated HTML page. If the tag is left blank doxygen will generate a 1141# standard header. 1142# 1143# To get valid HTML the header file that includes any scripts and style sheets 1144# that doxygen needs, which is dependent on the configuration options used (e.g. 1145# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1146# default header using 1147# doxygen -w html new_header.html new_footer.html new_stylesheet.css 1148# YourConfigFile 1149# and then modify the file new_header.html. See also section "Doxygen usage" 1150# for information on how to generate the default header that doxygen normally 1151# uses. 1152# Note: The header is subject to change so you typically have to regenerate the 1153# default header when upgrading to a newer version of doxygen. For a description 1154# of the possible markers and block names see the documentation. 1155# This tag requires that the tag GENERATE_HTML is set to YES. 1156 1157HTML_HEADER = 1158 1159# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1160# generated HTML page. If the tag is left blank doxygen will generate a standard 1161# footer. See HTML_HEADER for more information on how to generate a default 1162# footer and what special commands can be used inside the footer. See also 1163# section "Doxygen usage" for information on how to generate the default footer 1164# that doxygen normally uses. 1165# This tag requires that the tag GENERATE_HTML is set to YES. 1166 1167HTML_FOOTER = 1168 1169# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1170# sheet that is used by each HTML page. It can be used to fine-tune the look of 1171# the HTML output. If left blank doxygen will generate a default style sheet. 1172# See also section "Doxygen usage" for information on how to generate the style 1173# sheet that doxygen normally uses. 1174# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1175# it is more robust and this tag (HTML_STYLESHEET) will in the future become 1176# obsolete. 1177# This tag requires that the tag GENERATE_HTML is set to YES. 1178 1179HTML_STYLESHEET = 1180 1181# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1182# cascading style sheets that are included after the standard style sheets 1183# created by doxygen. Using this option one can overrule certain style aspects. 1184# This is preferred over using HTML_STYLESHEET since it does not replace the 1185# standard style sheet and is therefore more robust against future updates. 1186# Doxygen will copy the style sheet files to the output directory. 1187# Note: The order of the extra style sheet files is of importance (e.g. the last 1188# style sheet in the list overrules the setting of the previous ones in the 1189# list). For an example see the documentation. 1190# This tag requires that the tag GENERATE_HTML is set to YES. 1191 1192HTML_EXTRA_STYLESHEET = 1193 1194# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1195# other source files which should be copied to the HTML output directory. Note 1196# that these files will be copied to the base HTML output directory. Use the 1197# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1198# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1199# files will be copied as-is; there are no commands or markers available. 1200# This tag requires that the tag GENERATE_HTML is set to YES. 1201 1202HTML_EXTRA_FILES = 1203 1204# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1205# will adjust the colors in the style sheet and background images according to 1206# this color. Hue is specified as an angle on a colorwheel, see 1207# http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1208# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1209# purple, and 360 is red again. 1210# Minimum value: 0, maximum value: 359, default value: 220. 1211# This tag requires that the tag GENERATE_HTML is set to YES. 1212 1213HTML_COLORSTYLE_HUE = 220 1214 1215# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1216# in the HTML output. For a value of 0 the output will use grayscales only. A 1217# value of 255 will produce the most vivid colors. 1218# Minimum value: 0, maximum value: 255, default value: 100. 1219# This tag requires that the tag GENERATE_HTML is set to YES. 1220 1221HTML_COLORSTYLE_SAT = 100 1222 1223# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1224# luminance component of the colors in the HTML output. Values below 100 1225# gradually make the output lighter, whereas values above 100 make the output 1226# darker. The value divided by 100 is the actual gamma applied, so 80 represents 1227# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1228# change the gamma. 1229# Minimum value: 40, maximum value: 240, default value: 80. 1230# This tag requires that the tag GENERATE_HTML is set to YES. 1231 1232HTML_COLORSTYLE_GAMMA = 80 1233 1234# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1235# page will contain the date and time when the page was generated. Setting this 1236# to NO can help when comparing the output of multiple runs. 1237# The default value is: YES. 1238# This tag requires that the tag GENERATE_HTML is set to YES. 1239 1240HTML_TIMESTAMP = YES 1241 1242# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1243# documentation will contain sections that can be hidden and shown after the 1244# page has loaded. 1245# The default value is: NO. 1246# This tag requires that the tag GENERATE_HTML is set to YES. 1247 1248HTML_DYNAMIC_SECTIONS = NO 1249 1250# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1251# shown in the various tree structured indices initially; the user can expand 1252# and collapse entries dynamically later on. Doxygen will expand the tree to 1253# such a level that at most the specified number of entries are visible (unless 1254# a fully collapsed tree already exceeds this amount). So setting the number of 1255# entries 1 will produce a full collapsed tree by default. 0 is a special value 1256# representing an infinite number of entries and will result in a full expanded 1257# tree by default. 1258# Minimum value: 0, maximum value: 9999, default value: 100. 1259# This tag requires that the tag GENERATE_HTML is set to YES. 1260 1261HTML_INDEX_NUM_ENTRIES = 100 1262 1263# If the GENERATE_DOCSET tag is set to YES, additional index files will be 1264# generated that can be used as input for Apple's Xcode 3 integrated development 1265# environment (see: http://developer.apple.com/tools/xcode/), introduced with 1266# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1267# Makefile in the HTML output directory. Running make will produce the docset in 1268# that directory and running make install will install the docset in 1269# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1270# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1271# for more information. 1272# The default value is: NO. 1273# This tag requires that the tag GENERATE_HTML is set to YES. 1274 1275GENERATE_DOCSET = NO 1276 1277# This tag determines the name of the docset feed. A documentation feed provides 1278# an umbrella under which multiple documentation sets from a single provider 1279# (such as a company or product suite) can be grouped. 1280# The default value is: Doxygen generated docs. 1281# This tag requires that the tag GENERATE_DOCSET is set to YES. 1282 1283DOCSET_FEEDNAME = "Doxygen generated docs" 1284 1285# This tag specifies a string that should uniquely identify the documentation 1286# set bundle. This should be a reverse domain-name style string, e.g. 1287# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1288# The default value is: org.doxygen.Project. 1289# This tag requires that the tag GENERATE_DOCSET is set to YES. 1290 1291DOCSET_BUNDLE_ID = org.doxygen.Project 1292 1293# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1294# the documentation publisher. This should be a reverse domain-name style 1295# string, e.g. com.mycompany.MyDocSet.documentation. 1296# The default value is: org.doxygen.Publisher. 1297# This tag requires that the tag GENERATE_DOCSET is set to YES. 1298 1299DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1300 1301# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1302# The default value is: Publisher. 1303# This tag requires that the tag GENERATE_DOCSET is set to YES. 1304 1305DOCSET_PUBLISHER_NAME = Publisher 1306 1307# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1308# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1309# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1310# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1311# Windows. 1312# 1313# The HTML Help Workshop contains a compiler that can convert all HTML output 1314# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1315# files are now used as the Windows 98 help format, and will replace the old 1316# Windows help format (.hlp) on all Windows platforms in the future. Compressed 1317# HTML files also contain an index, a table of contents, and you can search for 1318# words in the documentation. The HTML workshop also contains a viewer for 1319# compressed HTML files. 1320# The default value is: NO. 1321# This tag requires that the tag GENERATE_HTML is set to YES. 1322 1323GENERATE_HTMLHELP = NO 1324 1325# The CHM_FILE tag can be used to specify the file name of the resulting .chm 1326# file. You can add a path in front of the file if the result should not be 1327# written to the html output directory. 1328# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1329 1330CHM_FILE = 1331 1332# The HHC_LOCATION tag can be used to specify the location (absolute path 1333# including file name) of the HTML help compiler (hhc.exe). If non-empty, 1334# doxygen will try to run the HTML help compiler on the generated index.hhp. 1335# The file has to be specified with full path. 1336# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1337 1338HHC_LOCATION = 1339 1340# The GENERATE_CHI flag controls if a separate .chi index file is generated 1341# (YES) or that it should be included in the master .chm file (NO). 1342# The default value is: NO. 1343# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1344 1345GENERATE_CHI = NO 1346 1347# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1348# and project file content. 1349# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1350 1351CHM_INDEX_ENCODING = 1352 1353# The BINARY_TOC flag controls whether a binary table of contents is generated 1354# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1355# enables the Previous and Next buttons. 1356# The default value is: NO. 1357# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1358 1359BINARY_TOC = NO 1360 1361# The TOC_EXPAND flag can be set to YES to add extra items for group members to 1362# the table of contents of the HTML help documentation and to the tree view. 1363# The default value is: NO. 1364# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1365 1366TOC_EXPAND = NO 1367 1368# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1369# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1370# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1371# (.qch) of the generated HTML documentation. 1372# The default value is: NO. 1373# This tag requires that the tag GENERATE_HTML is set to YES. 1374 1375GENERATE_QHP = NO 1376 1377# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1378# the file name of the resulting .qch file. The path specified is relative to 1379# the HTML output folder. 1380# This tag requires that the tag GENERATE_QHP is set to YES. 1381 1382QCH_FILE = 1383 1384# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1385# Project output. For more information please see Qt Help Project / Namespace 1386# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1387# The default value is: org.doxygen.Project. 1388# This tag requires that the tag GENERATE_QHP is set to YES. 1389 1390QHP_NAMESPACE = org.doxygen.Project 1391 1392# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1393# Help Project output. For more information please see Qt Help Project / Virtual 1394# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1395# folders). 1396# The default value is: doc. 1397# This tag requires that the tag GENERATE_QHP is set to YES. 1398 1399QHP_VIRTUAL_FOLDER = doc 1400 1401# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1402# filter to add. For more information please see Qt Help Project / Custom 1403# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1404# filters). 1405# This tag requires that the tag GENERATE_QHP is set to YES. 1406 1407QHP_CUST_FILTER_NAME = 1408 1409# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1410# custom filter to add. For more information please see Qt Help Project / Custom 1411# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1412# filters). 1413# This tag requires that the tag GENERATE_QHP is set to YES. 1414 1415QHP_CUST_FILTER_ATTRS = 1416 1417# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1418# project's filter section matches. Qt Help Project / Filter Attributes (see: 1419# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1420# This tag requires that the tag GENERATE_QHP is set to YES. 1421 1422QHP_SECT_FILTER_ATTRS = 1423 1424# The QHG_LOCATION tag can be used to specify the location of Qt's 1425# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1426# generated .qhp file. 1427# This tag requires that the tag GENERATE_QHP is set to YES. 1428 1429QHG_LOCATION = 1430 1431# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1432# generated, together with the HTML files, they form an Eclipse help plugin. To 1433# install this plugin and make it available under the help contents menu in 1434# Eclipse, the contents of the directory containing the HTML and XML files needs 1435# to be copied into the plugins directory of eclipse. The name of the directory 1436# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1437# After copying Eclipse needs to be restarted before the help appears. 1438# The default value is: NO. 1439# This tag requires that the tag GENERATE_HTML is set to YES. 1440 1441GENERATE_ECLIPSEHELP = NO 1442 1443# A unique identifier for the Eclipse help plugin. When installing the plugin 1444# the directory name containing the HTML and XML files should also have this 1445# name. Each documentation set should have its own identifier. 1446# The default value is: org.doxygen.Project. 1447# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1448 1449ECLIPSE_DOC_ID = org.doxygen.Project 1450 1451# If you want full control over the layout of the generated HTML pages it might 1452# be necessary to disable the index and replace it with your own. The 1453# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1454# of each HTML page. A value of NO enables the index and the value YES disables 1455# it. Since the tabs in the index contain the same information as the navigation 1456# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1457# The default value is: NO. 1458# This tag requires that the tag GENERATE_HTML is set to YES. 1459 1460DISABLE_INDEX = NO 1461 1462# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1463# structure should be generated to display hierarchical information. If the tag 1464# value is set to YES, a side panel will be generated containing a tree-like 1465# index structure (just like the one that is generated for HTML Help). For this 1466# to work a browser that supports JavaScript, DHTML, CSS and frames is required 1467# (i.e. any modern browser). Windows users are probably better off using the 1468# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1469# further fine-tune the look of the index. As an example, the default style 1470# sheet generated by doxygen has an example that shows how to put an image at 1471# the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1472# the same information as the tab index, you could consider setting 1473# DISABLE_INDEX to YES when enabling this option. 1474# The default value is: NO. 1475# This tag requires that the tag GENERATE_HTML is set to YES. 1476 1477GENERATE_TREEVIEW = NO 1478 1479# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1480# doxygen will group on one line in the generated HTML documentation. 1481# 1482# Note that a value of 0 will completely suppress the enum values from appearing 1483# in the overview section. 1484# Minimum value: 0, maximum value: 20, default value: 4. 1485# This tag requires that the tag GENERATE_HTML is set to YES. 1486 1487ENUM_VALUES_PER_LINE = 4 1488 1489# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1490# to set the initial width (in pixels) of the frame in which the tree is shown. 1491# Minimum value: 0, maximum value: 1500, default value: 250. 1492# This tag requires that the tag GENERATE_HTML is set to YES. 1493 1494TREEVIEW_WIDTH = 250 1495 1496# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1497# external symbols imported via tag files in a separate window. 1498# The default value is: NO. 1499# This tag requires that the tag GENERATE_HTML is set to YES. 1500 1501EXT_LINKS_IN_WINDOW = NO 1502 1503# Use this tag to change the font size of LaTeX formulas included as images in 1504# the HTML documentation. When you change the font size after a successful 1505# doxygen run you need to manually remove any form_*.png images from the HTML 1506# output directory to force them to be regenerated. 1507# Minimum value: 8, maximum value: 50, default value: 10. 1508# This tag requires that the tag GENERATE_HTML is set to YES. 1509 1510FORMULA_FONTSIZE = 10 1511 1512# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1513# generated for formulas are transparent PNGs. Transparent PNGs are not 1514# supported properly for IE 6.0, but are supported on all modern browsers. 1515# 1516# Note that when changing this option you need to delete any form_*.png files in 1517# the HTML output directory before the changes have effect. 1518# The default value is: YES. 1519# This tag requires that the tag GENERATE_HTML is set to YES. 1520 1521FORMULA_TRANSPARENT = YES 1522 1523# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1524# http://www.mathjax.org) which uses client side Javascript for the rendering 1525# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1526# installed or if you want to formulas look prettier in the HTML output. When 1527# enabled you may also need to install MathJax separately and configure the path 1528# to it using the MATHJAX_RELPATH option. 1529# The default value is: NO. 1530# This tag requires that the tag GENERATE_HTML is set to YES. 1531 1532USE_MATHJAX = NO 1533 1534# When MathJax is enabled you can set the default output format to be used for 1535# the MathJax output. See the MathJax site (see: 1536# http://docs.mathjax.org/en/latest/output.html) for more details. 1537# Possible values are: HTML-CSS (which is slower, but has the best 1538# compatibility), NativeMML (i.e. MathML) and SVG. 1539# The default value is: HTML-CSS. 1540# This tag requires that the tag USE_MATHJAX is set to YES. 1541 1542MATHJAX_FORMAT = HTML-CSS 1543 1544# When MathJax is enabled you need to specify the location relative to the HTML 1545# output directory using the MATHJAX_RELPATH option. The destination directory 1546# should contain the MathJax.js script. For instance, if the mathjax directory 1547# is located at the same level as the HTML output directory, then 1548# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1549# Content Delivery Network so you can quickly see the result without installing 1550# MathJax. However, it is strongly recommended to install a local copy of 1551# MathJax from http://www.mathjax.org before deployment. 1552# The default value is: http://cdn.mathjax.org/mathjax/latest. 1553# This tag requires that the tag USE_MATHJAX is set to YES. 1554 1555MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1556 1557# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1558# extension names that should be enabled during MathJax rendering. For example 1559# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1560# This tag requires that the tag USE_MATHJAX is set to YES. 1561 1562MATHJAX_EXTENSIONS = 1563 1564# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1565# of code that will be used on startup of the MathJax code. See the MathJax site 1566# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1567# example see the documentation. 1568# This tag requires that the tag USE_MATHJAX is set to YES. 1569 1570MATHJAX_CODEFILE = 1571 1572# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1573# the HTML output. The underlying search engine uses javascript and DHTML and 1574# should work on any modern browser. Note that when using HTML help 1575# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1576# there is already a search function so this one should typically be disabled. 1577# For large projects the javascript based search engine can be slow, then 1578# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1579# search using the keyboard; to jump to the search box use <access key> + S 1580# (what the <access key> is depends on the OS and browser, but it is typically 1581# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1582# key> to jump into the search results window, the results can be navigated 1583# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1584# the search. The filter options can be selected when the cursor is inside the 1585# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1586# to select a filter and <Enter> or <escape> to activate or cancel the filter 1587# option. 1588# The default value is: YES. 1589# This tag requires that the tag GENERATE_HTML is set to YES. 1590 1591SEARCHENGINE = YES 1592 1593# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1594# implemented using a web server instead of a web client using Javascript. There 1595# are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1596# setting. When disabled, doxygen will generate a PHP script for searching and 1597# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1598# and searching needs to be provided by external tools. See the section 1599# "External Indexing and Searching" for details. 1600# The default value is: NO. 1601# This tag requires that the tag SEARCHENGINE is set to YES. 1602 1603SERVER_BASED_SEARCH = NO 1604 1605# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1606# script for searching. Instead the search results are written to an XML file 1607# which needs to be processed by an external indexer. Doxygen will invoke an 1608# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1609# search results. 1610# 1611# Doxygen ships with an example indexer (doxyindexer) and search engine 1612# (doxysearch.cgi) which are based on the open source search engine library 1613# Xapian (see: http://xapian.org/). 1614# 1615# See the section "External Indexing and Searching" for details. 1616# The default value is: NO. 1617# This tag requires that the tag SEARCHENGINE is set to YES. 1618 1619EXTERNAL_SEARCH = NO 1620 1621# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1622# which will return the search results when EXTERNAL_SEARCH is enabled. 1623# 1624# Doxygen ships with an example indexer (doxyindexer) and search engine 1625# (doxysearch.cgi) which are based on the open source search engine library 1626# Xapian (see: http://xapian.org/). See the section "External Indexing and 1627# Searching" for details. 1628# This tag requires that the tag SEARCHENGINE is set to YES. 1629 1630SEARCHENGINE_URL = 1631 1632# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1633# search data is written to a file for indexing by an external tool. With the 1634# SEARCHDATA_FILE tag the name of this file can be specified. 1635# The default file is: searchdata.xml. 1636# This tag requires that the tag SEARCHENGINE is set to YES. 1637 1638SEARCHDATA_FILE = searchdata.xml 1639 1640# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1641# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1642# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1643# projects and redirect the results back to the right project. 1644# This tag requires that the tag SEARCHENGINE is set to YES. 1645 1646EXTERNAL_SEARCH_ID = 1647 1648# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1649# projects other than the one defined by this configuration file, but that are 1650# all added to the same external search index. Each project needs to have a 1651# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1652# to a relative location where the documentation can be found. The format is: 1653# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1654# This tag requires that the tag SEARCHENGINE is set to YES. 1655 1656EXTRA_SEARCH_MAPPINGS = 1657 1658#--------------------------------------------------------------------------- 1659# Configuration options related to the LaTeX output 1660#--------------------------------------------------------------------------- 1661 1662# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1663# The default value is: YES. 1664 1665GENERATE_LATEX = NO 1666 1667# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1668# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1669# it. 1670# The default directory is: latex. 1671# This tag requires that the tag GENERATE_LATEX is set to YES. 1672 1673LATEX_OUTPUT = latex 1674 1675# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1676# invoked. 1677# 1678# Note that when enabling USE_PDFLATEX this option is only used for generating 1679# bitmaps for formulas in the HTML output, but not in the Makefile that is 1680# written to the output directory. 1681# The default file is: latex. 1682# This tag requires that the tag GENERATE_LATEX is set to YES. 1683 1684LATEX_CMD_NAME = latex 1685 1686# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1687# index for LaTeX. 1688# The default file is: makeindex. 1689# This tag requires that the tag GENERATE_LATEX is set to YES. 1690 1691MAKEINDEX_CMD_NAME = makeindex 1692 1693# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1694# documents. This may be useful for small projects and may help to save some 1695# trees in general. 1696# The default value is: NO. 1697# This tag requires that the tag GENERATE_LATEX is set to YES. 1698 1699COMPACT_LATEX = NO 1700 1701# The PAPER_TYPE tag can be used to set the paper type that is used by the 1702# printer. 1703# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1704# 14 inches) and executive (7.25 x 10.5 inches). 1705# The default value is: a4. 1706# This tag requires that the tag GENERATE_LATEX is set to YES. 1707 1708PAPER_TYPE = a4 1709 1710# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1711# that should be included in the LaTeX output. To get the times font for 1712# instance you can specify 1713# EXTRA_PACKAGES=times 1714# If left blank no extra packages will be included. 1715# This tag requires that the tag GENERATE_LATEX is set to YES. 1716 1717EXTRA_PACKAGES = 1718 1719# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1720# generated LaTeX document. The header should contain everything until the first 1721# chapter. If it is left blank doxygen will generate a standard header. See 1722# section "Doxygen usage" for information on how to let doxygen write the 1723# default header to a separate file. 1724# 1725# Note: Only use a user-defined header if you know what you are doing! The 1726# following commands have a special meaning inside the header: $title, 1727# $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1728# $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1729# string, for the replacement values of the other commands the user is referred 1730# to HTML_HEADER. 1731# This tag requires that the tag GENERATE_LATEX is set to YES. 1732 1733LATEX_HEADER = 1734 1735# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1736# generated LaTeX document. The footer should contain everything after the last 1737# chapter. If it is left blank doxygen will generate a standard footer. See 1738# LATEX_HEADER for more information on how to generate a default footer and what 1739# special commands can be used inside the footer. 1740# 1741# Note: Only use a user-defined footer if you know what you are doing! 1742# This tag requires that the tag GENERATE_LATEX is set to YES. 1743 1744LATEX_FOOTER = 1745 1746# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1747# LaTeX style sheets that are included after the standard style sheets created 1748# by doxygen. Using this option one can overrule certain style aspects. Doxygen 1749# will copy the style sheet files to the output directory. 1750# Note: The order of the extra style sheet files is of importance (e.g. the last 1751# style sheet in the list overrules the setting of the previous ones in the 1752# list). 1753# This tag requires that the tag GENERATE_LATEX is set to YES. 1754 1755LATEX_EXTRA_STYLESHEET = 1756 1757# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1758# other source files which should be copied to the LATEX_OUTPUT output 1759# directory. Note that the files will be copied as-is; there are no commands or 1760# markers available. 1761# This tag requires that the tag GENERATE_LATEX is set to YES. 1762 1763LATEX_EXTRA_FILES = 1764 1765# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1766# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1767# contain links (just like the HTML output) instead of page references. This 1768# makes the output suitable for online browsing using a PDF viewer. 1769# The default value is: YES. 1770# This tag requires that the tag GENERATE_LATEX is set to YES. 1771 1772PDF_HYPERLINKS = YES 1773 1774# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1775# the PDF file directly from the LaTeX files. Set this option to YES, to get a 1776# higher quality PDF documentation. 1777# The default value is: YES. 1778# This tag requires that the tag GENERATE_LATEX is set to YES. 1779 1780USE_PDFLATEX = YES 1781 1782# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1783# command to the generated LaTeX files. This will instruct LaTeX to keep running 1784# if errors occur, instead of asking the user for help. This option is also used 1785# when generating formulas in HTML. 1786# The default value is: NO. 1787# This tag requires that the tag GENERATE_LATEX is set to YES. 1788 1789LATEX_BATCHMODE = NO 1790 1791# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1792# index chapters (such as File Index, Compound Index, etc.) in the output. 1793# The default value is: NO. 1794# This tag requires that the tag GENERATE_LATEX is set to YES. 1795 1796LATEX_HIDE_INDICES = NO 1797 1798# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1799# code with syntax highlighting in the LaTeX output. 1800# 1801# Note that which sources are shown also depends on other settings such as 1802# SOURCE_BROWSER. 1803# The default value is: NO. 1804# This tag requires that the tag GENERATE_LATEX is set to YES. 1805 1806LATEX_SOURCE_CODE = NO 1807 1808# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1809# bibliography, e.g. plainnat, or ieeetr. See 1810# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1811# The default value is: plain. 1812# This tag requires that the tag GENERATE_LATEX is set to YES. 1813 1814LATEX_BIB_STYLE = plain 1815 1816#--------------------------------------------------------------------------- 1817# Configuration options related to the RTF output 1818#--------------------------------------------------------------------------- 1819 1820# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 1821# RTF output is optimized for Word 97 and may not look too pretty with other RTF 1822# readers/editors. 1823# The default value is: NO. 1824 1825GENERATE_RTF = NO 1826 1827# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1828# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1829# it. 1830# The default directory is: rtf. 1831# This tag requires that the tag GENERATE_RTF is set to YES. 1832 1833RTF_OUTPUT = rtf 1834 1835# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 1836# documents. This may be useful for small projects and may help to save some 1837# trees in general. 1838# The default value is: NO. 1839# This tag requires that the tag GENERATE_RTF is set to YES. 1840 1841COMPACT_RTF = NO 1842 1843# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1844# contain hyperlink fields. The RTF file will contain links (just like the HTML 1845# output) instead of page references. This makes the output suitable for online 1846# browsing using Word or some other Word compatible readers that support those 1847# fields. 1848# 1849# Note: WordPad (write) and others do not support links. 1850# The default value is: NO. 1851# This tag requires that the tag GENERATE_RTF is set to YES. 1852 1853RTF_HYPERLINKS = NO 1854 1855# Load stylesheet definitions from file. Syntax is similar to doxygen's config 1856# file, i.e. a series of assignments. You only have to provide replacements, 1857# missing definitions are set to their default value. 1858# 1859# See also section "Doxygen usage" for information on how to generate the 1860# default style sheet that doxygen normally uses. 1861# This tag requires that the tag GENERATE_RTF is set to YES. 1862 1863RTF_STYLESHEET_FILE = 1864 1865# Set optional variables used in the generation of an RTF document. Syntax is 1866# similar to doxygen's config file. A template extensions file can be generated 1867# using doxygen -e rtf extensionFile. 1868# This tag requires that the tag GENERATE_RTF is set to YES. 1869 1870RTF_EXTENSIONS_FILE = 1871 1872# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code 1873# with syntax highlighting in the RTF output. 1874# 1875# Note that which sources are shown also depends on other settings such as 1876# SOURCE_BROWSER. 1877# The default value is: NO. 1878# This tag requires that the tag GENERATE_RTF is set to YES. 1879 1880RTF_SOURCE_CODE = NO 1881 1882#--------------------------------------------------------------------------- 1883# Configuration options related to the man page output 1884#--------------------------------------------------------------------------- 1885 1886# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 1887# classes and files. 1888# The default value is: NO. 1889 1890GENERATE_MAN = NO 1891 1892# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 1893# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1894# it. A directory man3 will be created inside the directory specified by 1895# MAN_OUTPUT. 1896# The default directory is: man. 1897# This tag requires that the tag GENERATE_MAN is set to YES. 1898 1899MAN_OUTPUT = man 1900 1901# The MAN_EXTENSION tag determines the extension that is added to the generated 1902# man pages. In case the manual section does not start with a number, the number 1903# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 1904# optional. 1905# The default value is: .3. 1906# This tag requires that the tag GENERATE_MAN is set to YES. 1907 1908MAN_EXTENSION = .3 1909 1910# The MAN_SUBDIR tag determines the name of the directory created within 1911# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 1912# MAN_EXTENSION with the initial . removed. 1913# This tag requires that the tag GENERATE_MAN is set to YES. 1914 1915MAN_SUBDIR = 1916 1917# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1918# will generate one additional man file for each entity documented in the real 1919# man page(s). These additional files only source the real man page, but without 1920# them the man command would be unable to find the correct page. 1921# The default value is: NO. 1922# This tag requires that the tag GENERATE_MAN is set to YES. 1923 1924MAN_LINKS = NO 1925 1926#--------------------------------------------------------------------------- 1927# Configuration options related to the XML output 1928#--------------------------------------------------------------------------- 1929 1930# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 1931# captures the structure of the code including all documentation. 1932# The default value is: NO. 1933 1934GENERATE_XML = NO 1935 1936# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 1937# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1938# it. 1939# The default directory is: xml. 1940# This tag requires that the tag GENERATE_XML is set to YES. 1941 1942XML_OUTPUT = xml 1943 1944# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 1945# listings (including syntax highlighting and cross-referencing information) to 1946# the XML output. Note that enabling this will significantly increase the size 1947# of the XML output. 1948# The default value is: YES. 1949# This tag requires that the tag GENERATE_XML is set to YES. 1950 1951XML_PROGRAMLISTING = YES 1952 1953#--------------------------------------------------------------------------- 1954# Configuration options related to the DOCBOOK output 1955#--------------------------------------------------------------------------- 1956 1957# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 1958# that can be used to generate PDF. 1959# The default value is: NO. 1960 1961GENERATE_DOCBOOK = NO 1962 1963# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 1964# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 1965# front of it. 1966# The default directory is: docbook. 1967# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1968 1969DOCBOOK_OUTPUT = docbook 1970 1971# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the 1972# program listings (including syntax highlighting and cross-referencing 1973# information) to the DOCBOOK output. Note that enabling this will significantly 1974# increase the size of the DOCBOOK output. 1975# The default value is: NO. 1976# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1977 1978DOCBOOK_PROGRAMLISTING = NO 1979 1980#--------------------------------------------------------------------------- 1981# Configuration options for the AutoGen Definitions output 1982#--------------------------------------------------------------------------- 1983 1984# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 1985# AutoGen Definitions (see http://autogen.sf.net) file that captures the 1986# structure of the code including all documentation. Note that this feature is 1987# still experimental and incomplete at the moment. 1988# The default value is: NO. 1989 1990GENERATE_AUTOGEN_DEF = NO 1991 1992#--------------------------------------------------------------------------- 1993# Configuration options related to the Perl module output 1994#--------------------------------------------------------------------------- 1995 1996# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 1997# file that captures the structure of the code including all documentation. 1998# 1999# Note that this feature is still experimental and incomplete at the moment. 2000# The default value is: NO. 2001 2002GENERATE_PERLMOD = NO 2003 2004# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 2005# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 2006# output from the Perl module output. 2007# The default value is: NO. 2008# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2009 2010PERLMOD_LATEX = NO 2011 2012# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 2013# formatted so it can be parsed by a human reader. This is useful if you want to 2014# understand what is going on. On the other hand, if this tag is set to NO, the 2015# size of the Perl module output will be much smaller and Perl will parse it 2016# just the same. 2017# The default value is: YES. 2018# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2019 2020PERLMOD_PRETTY = YES 2021 2022# The names of the make variables in the generated doxyrules.make file are 2023# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 2024# so different doxyrules.make files included by the same Makefile don't 2025# overwrite each other's variables. 2026# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2027 2028PERLMOD_MAKEVAR_PREFIX = 2029 2030#--------------------------------------------------------------------------- 2031# Configuration options related to the preprocessor 2032#--------------------------------------------------------------------------- 2033 2034# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 2035# C-preprocessor directives found in the sources and include files. 2036# The default value is: YES. 2037 2038ENABLE_PREPROCESSING = YES 2039 2040# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 2041# in the source code. If set to NO, only conditional compilation will be 2042# performed. Macro expansion can be done in a controlled way by setting 2043# EXPAND_ONLY_PREDEF to YES. 2044# The default value is: NO. 2045# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2046 2047MACRO_EXPANSION = YES 2048 2049# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 2050# the macro expansion is limited to the macros specified with the PREDEFINED and 2051# EXPAND_AS_DEFINED tags. 2052# The default value is: NO. 2053# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2054 2055EXPAND_ONLY_PREDEF = NO 2056 2057# If the SEARCH_INCLUDES tag is set to YES, the include files in the 2058# INCLUDE_PATH will be searched if a #include is found. 2059# The default value is: YES. 2060# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2061 2062SEARCH_INCLUDES = YES 2063 2064# The INCLUDE_PATH tag can be used to specify one or more directories that 2065# contain include files that are not input files but should be processed by the 2066# preprocessor. 2067# This tag requires that the tag SEARCH_INCLUDES is set to YES. 2068 2069INCLUDE_PATH = 2070 2071# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2072# patterns (like *.h and *.hpp) to filter out the header-files in the 2073# directories. If left blank, the patterns specified with FILE_PATTERNS will be 2074# used. 2075# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2076 2077INCLUDE_FILE_PATTERNS = 2078 2079# The PREDEFINED tag can be used to specify one or more macro names that are 2080# defined before the preprocessor is started (similar to the -D option of e.g. 2081# gcc). The argument of the tag is a list of macros of the form: name or 2082# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 2083# is assumed. To prevent a macro definition from being undefined via #undef or 2084# recursively expanded use the := operator instead of the = operator. 2085# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2086 2087PREDEFINED = GRPC_FINAL= GRPC_OVERIDE= 2088 2089# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2090# tag can be used to specify a list of macro names that should be expanded. The 2091# macro definition that is found in the sources will be used. Use the PREDEFINED 2092# tag if you want to use a different macro definition that overrules the 2093# definition found in the source code. 2094# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2095 2096EXPAND_AS_DEFINED = 2097 2098# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2099# remove all references to function-like macros that are alone on a line, have 2100# an all uppercase name, and do not end with a semicolon. Such function macros 2101# are typically used for boiler-plate code, and will confuse the parser if not 2102# removed. 2103# The default value is: YES. 2104# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2105 2106SKIP_FUNCTION_MACROS = YES 2107 2108#--------------------------------------------------------------------------- 2109# Configuration options related to external references 2110#--------------------------------------------------------------------------- 2111 2112# The TAGFILES tag can be used to specify one or more tag files. For each tag 2113# file the location of the external documentation should be added. The format of 2114# a tag file without this location is as follows: 2115# TAGFILES = file1 file2 ... 2116# Adding location for the tag files is done as follows: 2117# TAGFILES = file1=loc1 "file2 = loc2" ... 2118# where loc1 and loc2 can be relative or absolute paths or URLs. See the 2119# section "Linking to external documentation" for more information about the use 2120# of tag files. 2121# Note: Each tag file must have a unique name (where the name does NOT include 2122# the path). If a tag file is not located in the directory in which doxygen is 2123# run, you must also specify the path to the tagfile here. 2124 2125TAGFILES = 2126 2127# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2128# tag file that is based on the input files it reads. See section "Linking to 2129# external documentation" for more information about the usage of tag files. 2130 2131GENERATE_TAGFILE = 2132 2133# If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2134# the class index. If set to NO, only the inherited external classes will be 2135# listed. 2136# The default value is: NO. 2137 2138ALLEXTERNALS = NO 2139 2140# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2141# in the modules index. If set to NO, only the current project's groups will be 2142# listed. 2143# The default value is: YES. 2144 2145EXTERNAL_GROUPS = YES 2146 2147# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2148# the related pages index. If set to NO, only the current project's pages will 2149# be listed. 2150# The default value is: YES. 2151 2152EXTERNAL_PAGES = YES 2153 2154# The PERL_PATH should be the absolute path and name of the perl script 2155# interpreter (i.e. the result of 'which perl'). 2156# The default file (with absolute path) is: /usr/bin/perl. 2157 2158PERL_PATH = /usr/bin/perl 2159 2160#--------------------------------------------------------------------------- 2161# Configuration options related to the dot tool 2162#--------------------------------------------------------------------------- 2163 2164# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram 2165# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2166# NO turns the diagrams off. Note that this option also works with HAVE_DOT 2167# disabled, but it is recommended to install and use dot, since it yields more 2168# powerful graphs. 2169# The default value is: YES. 2170 2171CLASS_DIAGRAMS = YES 2172 2173# You can define message sequence charts within doxygen comments using the \msc 2174# command. Doxygen will then run the mscgen tool (see: 2175# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 2176# documentation. The MSCGEN_PATH tag allows you to specify the directory where 2177# the mscgen tool resides. If left empty the tool is assumed to be found in the 2178# default search path. 2179 2180MSCGEN_PATH = 2181 2182# You can include diagrams made with dia in doxygen documentation. Doxygen will 2183# then run dia to produce the diagram and insert it in the documentation. The 2184# DIA_PATH tag allows you to specify the directory where the dia binary resides. 2185# If left empty dia is assumed to be found in the default search path. 2186 2187DIA_PATH = 2188 2189# If set to YES the inheritance and collaboration graphs will hide inheritance 2190# and usage relations if the target is undocumented or is not a class. 2191# The default value is: YES. 2192 2193HIDE_UNDOC_RELATIONS = YES 2194 2195# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2196# available from the path. This tool is part of Graphviz (see: 2197# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2198# Bell Labs. The other options in this section have no effect if this option is 2199# set to NO 2200# The default value is: NO. 2201 2202HAVE_DOT = YES 2203 2204# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2205# to run in parallel. When set to 0 doxygen will base this on the number of 2206# processors available in the system. You can set it explicitly to a value 2207# larger than 0 to get control over the balance between CPU load and processing 2208# speed. 2209# Minimum value: 0, maximum value: 32, default value: 0. 2210# This tag requires that the tag HAVE_DOT is set to YES. 2211 2212DOT_NUM_THREADS = 0 2213 2214# When you want a differently looking font in the dot files that doxygen 2215# generates you can specify the font name using DOT_FONTNAME. You need to make 2216# sure dot is able to find the font, which can be done by putting it in a 2217# standard location or by setting the DOTFONTPATH environment variable or by 2218# setting DOT_FONTPATH to the directory containing the font. 2219# The default value is: Helvetica. 2220# This tag requires that the tag HAVE_DOT is set to YES. 2221 2222DOT_FONTNAME = Helvetica 2223 2224# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2225# dot graphs. 2226# Minimum value: 4, maximum value: 24, default value: 10. 2227# This tag requires that the tag HAVE_DOT is set to YES. 2228 2229DOT_FONTSIZE = 10 2230 2231# By default doxygen will tell dot to use the default font as specified with 2232# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2233# the path where dot can find it using this tag. 2234# This tag requires that the tag HAVE_DOT is set to YES. 2235 2236DOT_FONTPATH = 2237 2238# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2239# each documented class showing the direct and indirect inheritance relations. 2240# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2241# The default value is: YES. 2242# This tag requires that the tag HAVE_DOT is set to YES. 2243 2244CLASS_GRAPH = NO 2245 2246# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2247# graph for each documented class showing the direct and indirect implementation 2248# dependencies (inheritance, containment, and class references variables) of the 2249# class with other documented classes. 2250# The default value is: YES. 2251# This tag requires that the tag HAVE_DOT is set to YES. 2252 2253COLLABORATION_GRAPH = NO 2254 2255# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2256# groups, showing the direct groups dependencies. 2257# The default value is: YES. 2258# This tag requires that the tag HAVE_DOT is set to YES. 2259 2260GROUP_GRAPHS = NO 2261 2262# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2263# collaboration diagrams in a style similar to the OMG's Unified Modeling 2264# Language. 2265# The default value is: NO. 2266# This tag requires that the tag HAVE_DOT is set to YES. 2267 2268UML_LOOK = NO 2269 2270# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2271# class node. If there are many fields or methods and many nodes the graph may 2272# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2273# number of items for each type to make the size more manageable. Set this to 0 2274# for no limit. Note that the threshold may be exceeded by 50% before the limit 2275# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2276# but if the number exceeds 15, the total amount of fields shown is limited to 2277# 10. 2278# Minimum value: 0, maximum value: 100, default value: 10. 2279# This tag requires that the tag HAVE_DOT is set to YES. 2280 2281UML_LIMIT_NUM_FIELDS = 10 2282 2283# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2284# collaboration graphs will show the relations between templates and their 2285# instances. 2286# The default value is: NO. 2287# This tag requires that the tag HAVE_DOT is set to YES. 2288 2289TEMPLATE_RELATIONS = NO 2290 2291# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2292# YES then doxygen will generate a graph for each documented file showing the 2293# direct and indirect include dependencies of the file with other documented 2294# files. 2295# The default value is: YES. 2296# This tag requires that the tag HAVE_DOT is set to YES. 2297 2298INCLUDE_GRAPH = NO 2299 2300# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2301# set to YES then doxygen will generate a graph for each documented file showing 2302# the direct and indirect include dependencies of the file with other documented 2303# files. 2304# The default value is: YES. 2305# This tag requires that the tag HAVE_DOT is set to YES. 2306 2307INCLUDED_BY_GRAPH = NO 2308 2309# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2310# dependency graph for every global function or class method. 2311# 2312# Note that enabling this option will significantly increase the time of a run. 2313# So in most cases it will be better to enable call graphs for selected 2314# functions only using the \callgraph command. 2315# The default value is: NO. 2316# This tag requires that the tag HAVE_DOT is set to YES. 2317 2318CALL_GRAPH = NO 2319 2320# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2321# dependency graph for every global function or class method. 2322# 2323# Note that enabling this option will significantly increase the time of a run. 2324# So in most cases it will be better to enable caller graphs for selected 2325# functions only using the \callergraph command. 2326# The default value is: NO. 2327# This tag requires that the tag HAVE_DOT is set to YES. 2328 2329CALLER_GRAPH = NO 2330 2331# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2332# hierarchy of all classes instead of a textual one. 2333# The default value is: YES. 2334# This tag requires that the tag HAVE_DOT is set to YES. 2335 2336GRAPHICAL_HIERARCHY = NO 2337 2338# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2339# dependencies a directory has on other directories in a graphical way. The 2340# dependency relations are determined by the #include relations between the 2341# files in the directories. 2342# The default value is: YES. 2343# This tag requires that the tag HAVE_DOT is set to YES. 2344 2345DIRECTORY_GRAPH = NO 2346 2347# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2348# generated by dot. 2349# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2350# to make the SVG files visible in IE 9+ (other browsers do not have this 2351# requirement). 2352# Possible values are: png, jpg, gif and svg. 2353# The default value is: png. 2354# This tag requires that the tag HAVE_DOT is set to YES. 2355 2356DOT_IMAGE_FORMAT = png 2357 2358# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2359# enable generation of interactive SVG images that allow zooming and panning. 2360# 2361# Note that this requires a modern browser other than Internet Explorer. Tested 2362# and working are Firefox, Chrome, Safari, and Opera. 2363# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2364# the SVG files visible. Older versions of IE do not have SVG support. 2365# The default value is: NO. 2366# This tag requires that the tag HAVE_DOT is set to YES. 2367 2368INTERACTIVE_SVG = NO 2369 2370# The DOT_PATH tag can be used to specify the path where the dot tool can be 2371# found. If left blank, it is assumed the dot tool can be found in the path. 2372# This tag requires that the tag HAVE_DOT is set to YES. 2373 2374DOT_PATH = 2375 2376# The DOTFILE_DIRS tag can be used to specify one or more directories that 2377# contain dot files that are included in the documentation (see the \dotfile 2378# command). 2379# This tag requires that the tag HAVE_DOT is set to YES. 2380 2381DOTFILE_DIRS = 2382 2383# The MSCFILE_DIRS tag can be used to specify one or more directories that 2384# contain msc files that are included in the documentation (see the \mscfile 2385# command). 2386 2387MSCFILE_DIRS = 2388 2389# The DIAFILE_DIRS tag can be used to specify one or more directories that 2390# contain dia files that are included in the documentation (see the \diafile 2391# command). 2392 2393DIAFILE_DIRS = 2394 2395# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2396# path where java can find the plantuml.jar file. If left blank, it is assumed 2397# PlantUML is not used or called during a preprocessing step. Doxygen will 2398# generate a warning when it encounters a \startuml command in this case and 2399# will not generate output for the diagram. 2400 2401PLANTUML_JAR_PATH = 2402 2403# When using plantuml, the specified paths are searched for files specified by 2404# the !include statement in a plantuml block. 2405 2406PLANTUML_INCLUDE_PATH = 2407 2408# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2409# that will be shown in the graph. If the number of nodes in a graph becomes 2410# larger than this value, doxygen will truncate the graph, which is visualized 2411# by representing a node as a red box. Note that doxygen if the number of direct 2412# children of the root node in a graph is already larger than 2413# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2414# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2415# Minimum value: 0, maximum value: 10000, default value: 50. 2416# This tag requires that the tag HAVE_DOT is set to YES. 2417 2418DOT_GRAPH_MAX_NODES = 50 2419 2420# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2421# generated by dot. A depth value of 3 means that only nodes reachable from the 2422# root by following a path via at most 3 edges will be shown. Nodes that lay 2423# further from the root node will be omitted. Note that setting this option to 1 2424# or 2 may greatly reduce the computation time needed for large code bases. Also 2425# note that the size of a graph can be further restricted by 2426# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2427# Minimum value: 0, maximum value: 1000, default value: 0. 2428# This tag requires that the tag HAVE_DOT is set to YES. 2429 2430MAX_DOT_GRAPH_DEPTH = 0 2431 2432# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2433# background. This is disabled by default, because dot on Windows does not seem 2434# to support this out of the box. 2435# 2436# Warning: Depending on the platform used, enabling this option may lead to 2437# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 2438# read). 2439# The default value is: NO. 2440# This tag requires that the tag HAVE_DOT is set to YES. 2441 2442DOT_TRANSPARENT = NO 2443 2444# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2445# files in one run (i.e. multiple -o and -T options on the command line). This 2446# makes dot run faster, but since only newer versions of dot (>1.8.10) support 2447# this, this feature is disabled by default. 2448# The default value is: NO. 2449# This tag requires that the tag HAVE_DOT is set to YES. 2450 2451DOT_MULTI_TARGETS = NO 2452 2453# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2454# explaining the meaning of the various boxes and arrows in the dot generated 2455# graphs. 2456# The default value is: YES. 2457# This tag requires that the tag HAVE_DOT is set to YES. 2458 2459GENERATE_LEGEND = YES 2460 2461# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot 2462# files that are used to generate the various graphs. 2463# The default value is: YES. 2464# This tag requires that the tag HAVE_DOT is set to YES. 2465 2466DOT_CLEANUP = YES 2467 2468