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