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