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