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