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