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