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