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