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