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