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