1# Doxyfile 1.8.3.1 2 3# This file describes the settings to be used by the documentation system 4# doxygen (www.doxygen.org) for a project. 5# 6# All text after a hash (#) is considered a comment and will be ignored. 7# The format is: 8# TAG = value [value, ...] 9# For lists items can also be appended using: 10# TAG += value [value, ...] 11# Values that contain spaces should be placed between quotes (" "). 12 13#--------------------------------------------------------------------------- 14# Project related configuration options 15#--------------------------------------------------------------------------- 16 17# This tag specifies the encoding used for all characters in the config file 18# that follow. The default is UTF-8 which is also the encoding used for all 19# text before the first occurrence of this tag. Doxygen uses libiconv (or the 20# iconv built into libc) for the transcoding. See 21# http://www.gnu.org/software/libiconv for the list of possible encodings. 22 23DOXYFILE_ENCODING = UTF-8 24 25# The PROJECT_NAME tag is a single word (or sequence of words) that should 26# identify the project. Note that if you do not use Doxywizard you need 27# to put quotes around the project name if it contains spaces. 28 29PROJECT_NAME = "GLFW" 30 31# The PROJECT_NUMBER tag can be used to enter a project or revision number. 32# This could be handy for archiving the generated documentation or 33# if some version control system is used. 34 35PROJECT_NUMBER = @GLFW_VERSION@ 36 37# Using the PROJECT_BRIEF tag one can provide an optional one line description 38# for a project that appears at the top of each page and should give viewer 39# a quick idea about the purpose of the project. Keep the description short. 40 41PROJECT_BRIEF = "A multi-platform library for OpenGL, window and input" 42 43# With the PROJECT_LOGO tag one can specify an logo or icon that is 44# included in the documentation. The maximum height of the logo should not 45# exceed 55 pixels and the maximum width should not exceed 200 pixels. 46# Doxygen will copy the logo to the output directory. 47 48PROJECT_LOGO = 49 50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 51# base path where the generated documentation will be put. 52# If a relative path is entered, it will be relative to the location 53# where doxygen was started. If left blank the current directory will be used. 54 55OUTPUT_DIRECTORY = "@GLFW_BINARY_DIR@/docs" 56 57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 58# 4096 sub-directories (in 2 levels) under the output directory of each output 59# format and will distribute the generated files over these directories. 60# Enabling this option can be useful when feeding doxygen a huge amount of 61# source files, where putting all generated files in the same directory would 62# otherwise cause performance problems for the file system. 63 64CREATE_SUBDIRS = NO 65 66# The OUTPUT_LANGUAGE tag is used to specify the language in which all 67# documentation generated by doxygen is written. Doxygen will use this 68# information to generate all constant output in the proper language. 69# The default language is English, other supported languages are: 70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 76 77OUTPUT_LANGUAGE = English 78 79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 80# include brief member descriptions after the members that are listed in 81# the file and class documentation (similar to JavaDoc). 82# Set to NO to disable this. 83 84BRIEF_MEMBER_DESC = YES 85 86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 87# the brief description of a member or function before the detailed description. 88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 89# brief descriptions will be completely suppressed. 90 91REPEAT_BRIEF = NO 92 93# This tag implements a quasi-intelligent brief description abbreviator 94# that is used to form the text in various listings. Each string 95# in this list, if found as the leading text of the brief description, will be 96# stripped from the text and the result after processing the whole list, is 97# used as the annotated text. Otherwise, the brief description is used as-is. 98# If left blank, the following values are used ("$name" is automatically 99# replaced with the name of the entity): "The $name class" "The $name widget" 100# "The $name file" "is" "provides" "specifies" "contains" 101# "represents" "a" "an" "the" 102 103ABBREVIATE_BRIEF = 104 105# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 106# Doxygen will generate a detailed section even if there is only a brief 107# description. 108 109ALWAYS_DETAILED_SEC = YES 110 111# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 112# inherited members of a class in the documentation of that class as if those 113# members were ordinary class members. Constructors, destructors and assignment 114# operators of the base classes will not be shown. 115 116INLINE_INHERITED_MEMB = NO 117 118# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 119# path before files name in the file list and in the header files. If set 120# to NO the shortest path that makes the file name unique will be used. 121 122FULL_PATH_NAMES = NO 123 124# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 125# can be used to strip a user-defined part of the path. Stripping is 126# only done if one of the specified strings matches the left-hand part of 127# the path. The tag can be used to show relative paths in the file list. 128# If left blank the directory from which doxygen is run is used as the 129# path to strip. Note that you specify absolute paths here, but also 130# relative paths, which will be relative from the directory where doxygen is 131# started. 132 133STRIP_FROM_PATH = 134 135# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 136# the path mentioned in the documentation of a class, which tells 137# the reader which header file to include in order to use a class. 138# If left blank only the name of the header file containing the class 139# definition is used. Otherwise one should specify the include paths that 140# are normally passed to the compiler using the -I flag. 141 142STRIP_FROM_INC_PATH = 143 144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 145# (but less readable) file names. This can be useful if your file system 146# doesn't support long names like on DOS, Mac, or CD-ROM. 147 148SHORT_NAMES = NO 149 150# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 151# will interpret the first line (until the first dot) of a JavaDoc-style 152# comment as the brief description. If set to NO, the JavaDoc 153# comments will behave just like regular Qt-style comments 154# (thus requiring an explicit @brief command for a brief description.) 155 156JAVADOC_AUTOBRIEF = NO 157 158# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 159# interpret the first line (until the first dot) of a Qt-style 160# comment as the brief description. If set to NO, the comments 161# will behave just like regular Qt-style comments (thus requiring 162# an explicit \brief command for a brief description.) 163 164QT_AUTOBRIEF = NO 165 166# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 167# treat a multi-line C++ special comment block (i.e. a block of //! or /// 168# comments) as a brief description. This used to be the default behaviour. 169# The new default is to treat a multi-line C++ comment block as a detailed 170# description. Set this tag to YES if you prefer the old behaviour instead. 171 172MULTILINE_CPP_IS_BRIEF = NO 173 174# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 175# member inherits the documentation from any documented member that it 176# re-implements. 177 178INHERIT_DOCS = YES 179 180# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 181# a new page for each member. If set to NO, the documentation of a member will 182# be part of the file/class/namespace that contains it. 183 184SEPARATE_MEMBER_PAGES = NO 185 186# The TAB_SIZE tag can be used to set the number of spaces in a tab. 187# Doxygen uses this value to replace tabs by spaces in code fragments. 188 189TAB_SIZE = 8 190 191# This tag can be used to specify a number of aliases that acts 192# as commands in the documentation. An alias has the form "name=value". 193# For example adding "sideeffect=\par Side Effects:\n" will allow you to 194# put the command \sideeffect (or @sideeffect) in the documentation, which 195# will result in a user-defined paragraph with heading "Side Effects:". 196# You can put \n's in the value part of an alias to insert newlines. 197 198ALIASES = "thread_safety=@par Thread safety^^" \ 199 "pointer_lifetime=@par Pointer lifetime^^" \ 200 "analysis=@par Analysis^^" \ 201 "reentrancy=@par Reentrancy^^" \ 202 "errors=@par Errors^^" \ 203 "callback_signature=@par Callback signature^^" \ 204 "glfw3=__GLFW 3:__" \ 205 "x11=__X11:__" \ 206 "wayland=__Wayland:__" \ 207 "win32=__Windows:__" \ 208 "macos=__macOS:__" \ 209 "linux=__Linux:__" 210 211# This tag can be used to specify a number of word-keyword mappings (TCL only). 212# A mapping has the form "name=value". For example adding 213# "class=itcl::class" will allow you to use the command class in the 214# itcl::class meaning. 215 216TCL_SUBST = 217 218# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 219# sources only. Doxygen will then generate output that is more tailored for C. 220# For instance, some of the names that are used will be different. The list 221# of all members will be omitted, etc. 222 223OPTIMIZE_OUTPUT_FOR_C = YES 224 225# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 226# sources only. Doxygen will then generate output that is more tailored for 227# Java. For instance, namespaces will be presented as packages, qualified 228# scopes will look different, etc. 229 230OPTIMIZE_OUTPUT_JAVA = NO 231 232# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 233# sources only. Doxygen will then generate output that is more tailored for 234# Fortran. 235 236OPTIMIZE_FOR_FORTRAN = NO 237 238# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 239# sources. Doxygen will then generate output that is tailored for 240# VHDL. 241 242OPTIMIZE_OUTPUT_VHDL = NO 243 244# Doxygen selects the parser to use depending on the extension of the files it 245# parses. With this tag you can assign which parser to use for a given 246# extension. Doxygen has a built-in mapping, but you can override or extend it 247# using this tag. The format is ext=language, where ext is a file extension, 248# and language is one of the parsers supported by doxygen: IDL, Java, 249# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 250# C++. For instance to make doxygen treat .inc files as Fortran files (default 251# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 252# that for custom extensions you also need to set FILE_PATTERNS otherwise the 253# files are not read by doxygen. 254 255EXTENSION_MAPPING = 256 257# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 258# comments according to the Markdown format, which allows for more readable 259# documentation. See http://daringfireball.net/projects/markdown/ for details. 260# The output of markdown processing is further processed by doxygen, so you 261# can mix doxygen, HTML, and XML commands with Markdown formatting. 262# Disable only in case of backward compatibilities issues. 263 264MARKDOWN_SUPPORT = YES 265 266# When enabled doxygen tries to link words that correspond to documented classes, 267# or namespaces to their corresponding documentation. Such a link can be 268# prevented in individual cases by putting a % sign in front of the word or 269# globally by setting AUTOLINK_SUPPORT to NO. 270 271AUTOLINK_SUPPORT = YES 272 273# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 274# to include (a tag file for) the STL sources as input, then you should 275# set this tag to YES in order to let doxygen match functions declarations and 276# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 277# func(std::string) {}). This also makes the inheritance and collaboration 278# diagrams that involve STL classes more complete and accurate. 279 280BUILTIN_STL_SUPPORT = NO 281 282# If you use Microsoft's C++/CLI language, you should set this option to YES to 283# enable parsing support. 284 285CPP_CLI_SUPPORT = NO 286 287# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 288# Doxygen will parse them like normal C++ but will assume all classes use public 289# instead of private inheritance when no explicit protection keyword is present. 290 291SIP_SUPPORT = NO 292 293# For Microsoft's IDL there are propget and propput attributes to indicate 294# getter and setter methods for a property. Setting this option to YES (the 295# default) will make doxygen replace the get and set methods by a property in 296# the documentation. This will only work if the methods are indeed getting or 297# setting a simple type. If this is not the case, or you want to show the 298# methods anyway, you should set this option to NO. 299 300IDL_PROPERTY_SUPPORT = NO 301 302# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 303# tag is set to YES, then doxygen will reuse the documentation of the first 304# member in the group (if any) for the other members of the group. By default 305# all members of a group must be documented explicitly. 306 307DISTRIBUTE_GROUP_DOC = NO 308 309# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 310# the same type (for instance a group of public functions) to be put as a 311# subgroup of that type (e.g. under the Public Functions section). Set it to 312# NO to prevent subgrouping. Alternatively, this can be done per class using 313# the \nosubgrouping command. 314 315SUBGROUPING = YES 316 317# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 318# unions are shown inside the group in which they are included (e.g. using 319# @ingroup) instead of on a separate page (for HTML and Man pages) or 320# section (for LaTeX and RTF). 321 322INLINE_GROUPED_CLASSES = NO 323 324# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 325# unions with only public data fields will be shown inline in the documentation 326# of the scope in which they are defined (i.e. file, namespace, or group 327# documentation), provided this scope is documented. If set to NO (the default), 328# structs, classes, and unions are shown on a separate page (for HTML and Man 329# pages) or section (for LaTeX and RTF). 330 331INLINE_SIMPLE_STRUCTS = NO 332 333# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 334# is documented as struct, union, or enum with the name of the typedef. So 335# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 336# with name TypeT. When disabled the typedef will appear as a member of a file, 337# namespace, or class. And the struct will be named TypeS. This can typically 338# be useful for C code in case the coding convention dictates that all compound 339# types are typedef'ed and only the typedef is referenced, never the tag name. 340 341TYPEDEF_HIDES_STRUCT = NO 342 343# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 344# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 345# their name and scope. Since this can be an expensive process and often the 346# same symbol appear multiple times in the code, doxygen keeps a cache of 347# pre-resolved symbols. If the cache is too small doxygen will become slower. 348# If the cache is too large, memory is wasted. The cache size is given by this 349# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 350# corresponding to a cache size of 2^16 = 65536 symbols. 351 352LOOKUP_CACHE_SIZE = 0 353 354#--------------------------------------------------------------------------- 355# Build related configuration options 356#--------------------------------------------------------------------------- 357 358# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 359# documentation are documented, even if no documentation was available. 360# Private class members and static file members will be hidden unless 361# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 362 363EXTRACT_ALL = YES 364 365# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 366# will be included in the documentation. 367 368EXTRACT_PRIVATE = NO 369 370# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 371# scope will be included in the documentation. 372 373EXTRACT_PACKAGE = NO 374 375# If the EXTRACT_STATIC tag is set to YES all static members of a file 376# will be included in the documentation. 377 378EXTRACT_STATIC = NO 379 380# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 381# defined locally in source files will be included in the documentation. 382# If set to NO only classes defined in header files are included. 383 384EXTRACT_LOCAL_CLASSES = YES 385 386# This flag is only useful for Objective-C code. When set to YES local 387# methods, which are defined in the implementation section but not in 388# the interface are included in the documentation. 389# If set to NO (the default) only methods in the interface are included. 390 391EXTRACT_LOCAL_METHODS = NO 392 393# If this flag is set to YES, the members of anonymous namespaces will be 394# extracted and appear in the documentation as a namespace called 395# 'anonymous_namespace{file}', where file will be replaced with the base 396# name of the file that contains the anonymous namespace. By default 397# anonymous namespaces are hidden. 398 399EXTRACT_ANON_NSPACES = NO 400 401# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 402# undocumented members of documented classes, files or namespaces. 403# If set to NO (the default) these members will be included in the 404# various overviews, but no documentation section is generated. 405# This option has no effect if EXTRACT_ALL is enabled. 406 407HIDE_UNDOC_MEMBERS = NO 408 409# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 410# undocumented classes that are normally visible in the class hierarchy. 411# If set to NO (the default) these classes will be included in the various 412# overviews. This option has no effect if EXTRACT_ALL is enabled. 413 414HIDE_UNDOC_CLASSES = NO 415 416# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 417# friend (class|struct|union) declarations. 418# If set to NO (the default) these declarations will be included in the 419# documentation. 420 421HIDE_FRIEND_COMPOUNDS = NO 422 423# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 424# documentation blocks found inside the body of a function. 425# If set to NO (the default) these blocks will be appended to the 426# function's detailed documentation block. 427 428HIDE_IN_BODY_DOCS = NO 429 430# The INTERNAL_DOCS tag determines if documentation 431# that is typed after a \internal command is included. If the tag is set 432# to NO (the default) then the documentation will be excluded. 433# Set it to YES to include the internal documentation. 434 435INTERNAL_DOCS = NO 436 437# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 438# file names in lower-case letters. If set to YES upper-case letters are also 439# allowed. This is useful if you have classes or files whose names only differ 440# in case and if your file system supports case sensitive file names. Windows 441# and Mac users are advised to set this option to NO. 442 443CASE_SENSE_NAMES = YES 444 445# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 446# will show members with their full class and namespace scopes in the 447# documentation. If set to YES the scope will be hidden. 448 449HIDE_SCOPE_NAMES = NO 450 451# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 452# will put a list of the files that are included by a file in the documentation 453# of that file. 454 455SHOW_INCLUDE_FILES = NO 456 457# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 458# will list include files with double quotes in the documentation 459# rather than with sharp brackets. 460 461FORCE_LOCAL_INCLUDES = NO 462 463# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 464# is inserted in the documentation for inline members. 465 466INLINE_INFO = YES 467 468# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 469# will sort the (detailed) documentation of file and class members 470# alphabetically by member name. If set to NO the members will appear in 471# declaration order. 472 473SORT_MEMBER_DOCS = NO 474 475# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 476# brief documentation of file, namespace and class members alphabetically 477# by member name. If set to NO (the default) the members will appear in 478# declaration order. 479 480SORT_BRIEF_DOCS = NO 481 482# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 483# will sort the (brief and detailed) documentation of class members so that 484# constructors and destructors are listed first. If set to NO (the default) 485# the constructors will appear in the respective orders defined by 486# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 487# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 488# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 489 490SORT_MEMBERS_CTORS_1ST = NO 491 492# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 493# hierarchy of group names into alphabetical order. If set to NO (the default) 494# the group names will appear in their defined order. 495 496SORT_GROUP_NAMES = YES 497 498# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 499# sorted by fully-qualified names, including namespaces. If set to 500# NO (the default), the class list will be sorted only by class name, 501# not including the namespace part. 502# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 503# Note: This option applies only to the class list, not to the 504# alphabetical list. 505 506SORT_BY_SCOPE_NAME = NO 507 508# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 509# do proper type resolution of all parameters of a function it will reject a 510# match between the prototype and the implementation of a member function even 511# if there is only one candidate or it is obvious which candidate to choose 512# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 513# will still accept a match between prototype and implementation in such cases. 514 515STRICT_PROTO_MATCHING = NO 516 517# The GENERATE_TODOLIST tag can be used to enable (YES) or 518# disable (NO) the todo list. This list is created by putting \todo 519# commands in the documentation. 520 521GENERATE_TODOLIST = YES 522 523# The GENERATE_TESTLIST tag can be used to enable (YES) or 524# disable (NO) the test list. This list is created by putting \test 525# commands in the documentation. 526 527GENERATE_TESTLIST = YES 528 529# The GENERATE_BUGLIST tag can be used to enable (YES) or 530# disable (NO) the bug list. This list is created by putting \bug 531# commands in the documentation. 532 533GENERATE_BUGLIST = YES 534 535# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 536# disable (NO) the deprecated list. This list is created by putting 537# \deprecated commands in the documentation. 538 539GENERATE_DEPRECATEDLIST= YES 540 541# The ENABLED_SECTIONS tag can be used to enable conditional 542# documentation sections, marked by \if section-label ... \endif 543# and \cond section-label ... \endcond blocks. 544 545ENABLED_SECTIONS = 546 547# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 548# the initial value of a variable or macro consists of for it to appear in 549# the documentation. If the initializer consists of more lines than specified 550# here it will be hidden. Use a value of 0 to hide initializers completely. 551# The appearance of the initializer of individual variables and macros in the 552# documentation can be controlled using \showinitializer or \hideinitializer 553# command in the documentation regardless of this setting. 554 555MAX_INITIALIZER_LINES = 30 556 557# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 558# at the bottom of the documentation of classes and structs. If set to YES the 559# list will mention the files that were used to generate the documentation. 560 561SHOW_USED_FILES = YES 562 563# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 564# This will remove the Files entry from the Quick Index and from the 565# Folder Tree View (if specified). The default is YES. 566 567SHOW_FILES = YES 568 569# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 570# Namespaces page. 571# This will remove the Namespaces entry from the Quick Index 572# and from the Folder Tree View (if specified). The default is YES. 573 574SHOW_NAMESPACES = NO 575 576# The FILE_VERSION_FILTER tag can be used to specify a program or script that 577# doxygen should invoke to get the current version for each file (typically from 578# the version control system). Doxygen will invoke the program by executing (via 579# popen()) the command <command> <input-file>, where <command> is the value of 580# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 581# provided by doxygen. Whatever the program writes to standard output 582# is used as the file version. See the manual for examples. 583 584FILE_VERSION_FILTER = 585 586# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 587# by doxygen. The layout file controls the global structure of the generated 588# output files in an output format independent way. To create the layout file 589# that represents doxygen's defaults, run doxygen with the -l option. 590# You can optionally specify a file name after the option, if omitted 591# DoxygenLayout.xml will be used as the name of the layout file. 592 593LAYOUT_FILE = "@GLFW_SOURCE_DIR@/docs/DoxygenLayout.xml" 594 595# The CITE_BIB_FILES tag can be used to specify one or more bib files 596# containing the references data. This must be a list of .bib files. The 597# .bib extension is automatically appended if omitted. Using this command 598# requires the bibtex tool to be installed. See also 599# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 600# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 601# feature you need bibtex and perl available in the search path. Do not use 602# file names with spaces, bibtex cannot handle them. 603 604CITE_BIB_FILES = 605 606#--------------------------------------------------------------------------- 607# configuration options related to warning and progress messages 608#--------------------------------------------------------------------------- 609 610# The QUIET tag can be used to turn on/off the messages that are generated 611# by doxygen. Possible values are YES and NO. If left blank NO is used. 612 613QUIET = YES 614 615# The WARNINGS tag can be used to turn on/off the warning messages that are 616# generated by doxygen. Possible values are YES and NO. If left blank 617# NO is used. 618 619WARNINGS = YES 620 621# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 622# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 623# automatically be disabled. 624 625WARN_IF_UNDOCUMENTED = YES 626 627# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 628# potential errors in the documentation, such as not documenting some 629# parameters in a documented function, or documenting parameters that 630# don't exist or using markup commands wrongly. 631 632WARN_IF_DOC_ERROR = YES 633 634# The WARN_NO_PARAMDOC option can be enabled to get warnings for 635# functions that are documented, but have no documentation for their parameters 636# or return value. If set to NO (the default) doxygen will only warn about 637# wrong or incomplete parameter documentation, but not about the absence of 638# documentation. 639 640WARN_NO_PARAMDOC = YES 641 642# The WARN_FORMAT tag determines the format of the warning messages that 643# doxygen can produce. The string should contain the $file, $line, and $text 644# tags, which will be replaced by the file and line number from which the 645# warning originated and the warning text. Optionally the format may contain 646# $version, which will be replaced by the version of the file (if it could 647# be obtained via FILE_VERSION_FILTER) 648 649WARN_FORMAT = "$file:$line: $text" 650 651# The WARN_LOGFILE tag can be used to specify a file to which warning 652# and error messages should be written. If left blank the output is written 653# to stderr. 654 655WARN_LOGFILE = "@GLFW_BINARY_DIR@/docs/warnings.txt" 656 657#--------------------------------------------------------------------------- 658# configuration options related to the input files 659#--------------------------------------------------------------------------- 660 661# The INPUT tag can be used to specify the files and/or directories that contain 662# documented source files. You may enter file names like "myfile.cpp" or 663# directories like "/usr/src/myproject". Separate the files or directories 664# with spaces. 665 666INPUT = @GLFW_DOXYGEN_INPUT@ 667 668# This tag can be used to specify the character encoding of the source files 669# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 670# also the default input encoding. Doxygen uses libiconv (or the iconv built 671# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 672# the list of possible encodings. 673 674INPUT_ENCODING = UTF-8 675 676# If the value of the INPUT tag contains directories, you can use the 677# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 678# and *.h) to filter out the source-files in the directories. If left 679# blank the following patterns are tested: 680# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 681# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 682# *.f90 *.f *.for *.vhd *.vhdl 683 684FILE_PATTERNS = *.h *.dox 685 686# The RECURSIVE tag can be used to turn specify whether or not subdirectories 687# should be searched for input files as well. Possible values are YES and NO. 688# If left blank NO is used. 689 690RECURSIVE = NO 691 692# The EXCLUDE tag can be used to specify files and/or directories that should be 693# excluded from the INPUT source files. This way you can easily exclude a 694# subdirectory from a directory tree whose root is specified with the INPUT tag. 695# Note that relative paths are relative to the directory from which doxygen is 696# run. 697 698EXCLUDE = 699 700# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 701# directories that are symbolic links (a Unix file system feature) are excluded 702# from the input. 703 704EXCLUDE_SYMLINKS = NO 705 706# If the value of the INPUT tag contains directories, you can use the 707# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 708# certain files from those directories. Note that the wildcards are matched 709# against the file with absolute path, so to exclude all test directories 710# for example use the pattern */test/* 711 712EXCLUDE_PATTERNS = 713 714# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 715# (namespaces, classes, functions, etc.) that should be excluded from the 716# output. The symbol name can be a fully qualified name, a word, or if the 717# wildcard * is used, a substring. Examples: ANamespace, AClass, 718# AClass::ANamespace, ANamespace::*Test 719 720EXCLUDE_SYMBOLS = APIENTRY GLFWAPI 721 722# The EXAMPLE_PATH tag can be used to specify one or more files or 723# directories that contain example code fragments that are included (see 724# the \include command). 725 726EXAMPLE_PATH = "@GLFW_SOURCE_DIR@/examples" 727 728# If the value of the EXAMPLE_PATH tag contains directories, you can use the 729# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 730# and *.h) to filter out the source-files in the directories. If left 731# blank all files are included. 732 733EXAMPLE_PATTERNS = 734 735# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 736# searched for input files to be used with the \include or \dontinclude 737# commands irrespective of the value of the RECURSIVE tag. 738# Possible values are YES and NO. If left blank NO is used. 739 740EXAMPLE_RECURSIVE = NO 741 742# The IMAGE_PATH tag can be used to specify one or more files or 743# directories that contain image that are included in the documentation (see 744# the \image command). 745 746IMAGE_PATH = 747 748# The INPUT_FILTER tag can be used to specify a program that doxygen should 749# invoke to filter for each input file. Doxygen will invoke the filter program 750# by executing (via popen()) the command <filter> <input-file>, where <filter> 751# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 752# input file. Doxygen will then use the output that the filter program writes 753# to standard output. 754# If FILTER_PATTERNS is specified, this tag will be 755# ignored. 756 757INPUT_FILTER = 758 759# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 760# basis. 761# Doxygen will compare the file name with each pattern and apply the 762# filter if there is a match. 763# The filters are a list of the form: 764# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 765# info on how filters are used. If FILTER_PATTERNS is empty or if 766# non of the patterns match the file name, INPUT_FILTER is applied. 767 768FILTER_PATTERNS = 769 770# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 771# INPUT_FILTER) will be used to filter the input files when producing source 772# files to browse (i.e. when SOURCE_BROWSER is set to YES). 773 774FILTER_SOURCE_FILES = NO 775 776# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 777# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 778# and it is also possible to disable source filtering for a specific pattern 779# using *.ext= (so without naming a filter). This option only has effect when 780# FILTER_SOURCE_FILES is enabled. 781 782FILTER_SOURCE_PATTERNS = 783 784# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that 785# is part of the input, its contents will be placed on the main page (index.html). 786# This can be useful if you have a project on for instance GitHub and want reuse 787# the introduction page also for the doxygen output. 788 789USE_MDFILE_AS_MAINPAGE = 790 791#--------------------------------------------------------------------------- 792# configuration options related to source browsing 793#--------------------------------------------------------------------------- 794 795# If the SOURCE_BROWSER tag is set to YES then a list of source files will 796# be generated. Documented entities will be cross-referenced with these sources. 797# Note: To get rid of all source code in the generated output, make sure also 798# VERBATIM_HEADERS is set to NO. 799 800SOURCE_BROWSER = NO 801 802# Setting the INLINE_SOURCES tag to YES will include the body 803# of functions and classes directly in the documentation. 804 805INLINE_SOURCES = NO 806 807# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 808# doxygen to hide any special comment blocks from generated source code 809# fragments. Normal C, C++ and Fortran comments will always remain visible. 810 811STRIP_CODE_COMMENTS = YES 812 813# If the REFERENCED_BY_RELATION tag is set to YES 814# then for each documented function all documented 815# functions referencing it will be listed. 816 817REFERENCED_BY_RELATION = NO 818 819# If the REFERENCES_RELATION tag is set to YES 820# then for each documented function all documented entities 821# called/used by that function will be listed. 822 823REFERENCES_RELATION = NO 824 825# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 826# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 827# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 828# link to the source code. 829# Otherwise they will link to the documentation. 830 831REFERENCES_LINK_SOURCE = YES 832 833# If the USE_HTAGS tag is set to YES then the references to source code 834# will point to the HTML generated by the htags(1) tool instead of doxygen 835# built-in source browser. The htags tool is part of GNU's global source 836# tagging system (see http://www.gnu.org/software/global/global.html). You 837# will need version 4.8.6 or higher. 838 839USE_HTAGS = NO 840 841# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 842# will generate a verbatim copy of the header file for each class for 843# which an include is specified. Set to NO to disable this. 844 845VERBATIM_HEADERS = YES 846 847#--------------------------------------------------------------------------- 848# configuration options related to the alphabetical class index 849#--------------------------------------------------------------------------- 850 851# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 852# of all compounds will be generated. Enable this if the project 853# contains a lot of classes, structs, unions or interfaces. 854 855ALPHABETICAL_INDEX = YES 856 857# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 858# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 859# in which this list will be split (can be a number in the range [1..20]) 860 861COLS_IN_ALPHA_INDEX = 5 862 863# In case all classes in a project start with a common prefix, all 864# classes will be put under the same header in the alphabetical index. 865# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 866# should be ignored while generating the index headers. 867 868IGNORE_PREFIX = glfw GLFW_ 869 870#--------------------------------------------------------------------------- 871# configuration options related to the HTML output 872#--------------------------------------------------------------------------- 873 874# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 875# generate HTML output. 876 877GENERATE_HTML = YES 878 879# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 880# If a relative path is entered the value of OUTPUT_DIRECTORY will be 881# put in front of it. If left blank `html' will be used as the default path. 882 883HTML_OUTPUT = html 884 885# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 886# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 887# doxygen will generate files with .html extension. 888 889HTML_FILE_EXTENSION = .html 890 891# The HTML_HEADER tag can be used to specify a personal HTML header for 892# each generated HTML page. If it is left blank doxygen will generate a 893# standard header. Note that when using a custom header you are responsible 894# for the proper inclusion of any scripts and style sheets that doxygen 895# needs, which is dependent on the configuration options used. 896# It is advised to generate a default header using "doxygen -w html 897# header.html footer.html stylesheet.css YourConfigFile" and then modify 898# that header. Note that the header is subject to change so you typically 899# have to redo this when upgrading to a newer version of doxygen or when 900# changing the value of configuration settings such as GENERATE_TREEVIEW! 901 902HTML_HEADER = "@GLFW_SOURCE_DIR@/docs/header.html" 903 904# The HTML_FOOTER tag can be used to specify a personal HTML footer for 905# each generated HTML page. If it is left blank doxygen will generate a 906# standard footer. 907 908HTML_FOOTER = "@GLFW_SOURCE_DIR@/docs/footer.html" 909 910# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 911# style sheet that is used by each HTML page. It can be used to 912# fine-tune the look of the HTML output. If left blank doxygen will 913# generate a default style sheet. Note that it is recommended to use 914# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 915# tag will in the future become obsolete. 916 917HTML_STYLESHEET = 918 919# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 920# user-defined cascading style sheet that is included after the standard 921# style sheets created by doxygen. Using this option one can overrule 922# certain style aspects. This is preferred over using HTML_STYLESHEET 923# since it does not replace the standard style sheet and is therefor more 924# robust against future updates. Doxygen will copy the style sheet file to 925# the output directory. 926 927HTML_EXTRA_STYLESHEET = "@GLFW_SOURCE_DIR@/docs/extra.css" 928 929# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 930# other source files which should be copied to the HTML output directory. Note 931# that these files will be copied to the base HTML output directory. Use the 932# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 933# files. In the HTML_STYLESHEET file, use the file name only. Also note that 934# the files will be copied as-is; there are no commands or markers available. 935 936HTML_EXTRA_FILES = "@GLFW_SOURCE_DIR@/docs/spaces.svg" 937 938# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 939# Doxygen will adjust the colors in the style sheet and background images 940# according to this color. Hue is specified as an angle on a colorwheel, 941# see http://en.wikipedia.org/wiki/Hue for more information. 942# For instance the value 0 represents red, 60 is yellow, 120 is green, 943# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 944# The allowed range is 0 to 359. 945 946HTML_COLORSTYLE_HUE = 220 947 948# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 949# the colors in the HTML output. For a value of 0 the output will use 950# grayscales only. A value of 255 will produce the most vivid colors. 951 952HTML_COLORSTYLE_SAT = 100 953 954# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 955# the luminance component of the colors in the HTML output. Values below 956# 100 gradually make the output lighter, whereas values above 100 make 957# the output darker. The value divided by 100 is the actual gamma applied, 958# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 959# and 100 does not change the gamma. 960 961HTML_COLORSTYLE_GAMMA = 80 962 963# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 964# page will contain the date and time when the page was generated. Setting 965# this to NO can help when comparing the output of multiple runs. 966 967HTML_TIMESTAMP = YES 968 969# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 970# documentation will contain sections that can be hidden and shown after the 971# page has loaded. 972 973HTML_DYNAMIC_SECTIONS = NO 974 975# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 976# entries shown in the various tree structured indices initially; the user 977# can expand and collapse entries dynamically later on. Doxygen will expand 978# the tree to such a level that at most the specified number of entries are 979# visible (unless a fully collapsed tree already exceeds this amount). 980# So setting the number of entries 1 will produce a full collapsed tree by 981# default. 0 is a special value representing an infinite number of entries 982# and will result in a full expanded tree by default. 983 984HTML_INDEX_NUM_ENTRIES = 100 985 986# If the GENERATE_DOCSET tag is set to YES, additional index files 987# will be generated that can be used as input for Apple's Xcode 3 988# integrated development environment, introduced with OSX 10.5 (Leopard). 989# To create a documentation set, doxygen will generate a Makefile in the 990# HTML output directory. Running make will produce the docset in that 991# directory and running "make install" will install the docset in 992# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 993# it at startup. 994# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 995# for more information. 996 997GENERATE_DOCSET = NO 998 999# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 1000# feed. A documentation feed provides an umbrella under which multiple 1001# documentation sets from a single provider (such as a company or product suite) 1002# can be grouped. 1003 1004DOCSET_FEEDNAME = "Doxygen generated docs" 1005 1006# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 1007# should uniquely identify the documentation set bundle. This should be a 1008# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 1009# will append .docset to the name. 1010 1011DOCSET_BUNDLE_ID = org.doxygen.Project 1012 1013# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 1014# identify the documentation publisher. This should be a reverse domain-name 1015# style string, e.g. com.mycompany.MyDocSet.documentation. 1016 1017DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1018 1019# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1020 1021DOCSET_PUBLISHER_NAME = Publisher 1022 1023# If the GENERATE_HTMLHELP tag is set to YES, additional index files 1024# will be generated that can be used as input for tools like the 1025# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1026# of the generated HTML documentation. 1027 1028GENERATE_HTMLHELP = NO 1029 1030# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1031# be used to specify the file name of the resulting .chm file. You 1032# can add a path in front of the file if the result should not be 1033# written to the html output directory. 1034 1035CHM_FILE = 1036 1037# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1038# be used to specify the location (absolute path including file name) of 1039# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1040# the HTML help compiler on the generated index.hhp. 1041 1042HHC_LOCATION = 1043 1044# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1045# controls if a separate .chi index file is generated (YES) or that 1046# it should be included in the master .chm file (NO). 1047 1048GENERATE_CHI = NO 1049 1050# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1051# is used to encode HtmlHelp index (hhk), content (hhc) and project file 1052# content. 1053 1054CHM_INDEX_ENCODING = 1055 1056# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1057# controls whether a binary table of contents is generated (YES) or a 1058# normal table of contents (NO) in the .chm file. 1059 1060BINARY_TOC = NO 1061 1062# The TOC_EXPAND flag can be set to YES to add extra items for group members 1063# to the contents of the HTML help documentation and to the tree view. 1064 1065TOC_EXPAND = NO 1066 1067# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1068# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1069# that can be used as input for Qt's qhelpgenerator to generate a 1070# Qt Compressed Help (.qch) of the generated HTML documentation. 1071 1072GENERATE_QHP = NO 1073 1074# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1075# be used to specify the file name of the resulting .qch file. 1076# The path specified is relative to the HTML output folder. 1077 1078QCH_FILE = 1079 1080# The QHP_NAMESPACE tag specifies the namespace to use when generating 1081# Qt Help Project output. For more information please see 1082# http://doc.trolltech.com/qthelpproject.html#namespace 1083 1084QHP_NAMESPACE = org.doxygen.Project 1085 1086# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1087# Qt Help Project output. For more information please see 1088# http://doc.trolltech.com/qthelpproject.html#virtual-folders 1089 1090QHP_VIRTUAL_FOLDER = doc 1091 1092# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1093# add. For more information please see 1094# http://doc.trolltech.com/qthelpproject.html#custom-filters 1095 1096QHP_CUST_FILTER_NAME = 1097 1098# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1099# custom filter to add. For more information please see 1100# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1101# Qt Help Project / Custom Filters</a>. 1102 1103QHP_CUST_FILTER_ATTRS = 1104 1105# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1106# project's 1107# filter section matches. 1108# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1109# Qt Help Project / Filter Attributes</a>. 1110 1111QHP_SECT_FILTER_ATTRS = 1112 1113# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1114# be used to specify the location of Qt's qhelpgenerator. 1115# If non-empty doxygen will try to run qhelpgenerator on the generated 1116# .qhp file. 1117 1118QHG_LOCATION = 1119 1120# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1121# will be generated, which together with the HTML files, form an Eclipse help 1122# plugin. To install this plugin and make it available under the help contents 1123# menu in Eclipse, the contents of the directory containing the HTML and XML 1124# files needs to be copied into the plugins directory of eclipse. The name of 1125# the directory within the plugins directory should be the same as 1126# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1127# the help appears. 1128 1129GENERATE_ECLIPSEHELP = NO 1130 1131# A unique identifier for the eclipse help plugin. When installing the plugin 1132# the directory name containing the HTML and XML files should also have 1133# this name. 1134 1135ECLIPSE_DOC_ID = org.doxygen.Project 1136 1137# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1138# at top of each HTML page. The value NO (the default) enables the index and 1139# the value YES disables it. Since the tabs have the same information as the 1140# navigation tree you can set this option to NO if you already set 1141# GENERATE_TREEVIEW to YES. 1142 1143DISABLE_INDEX = NO 1144 1145# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1146# structure should be generated to display hierarchical information. 1147# If the tag value is set to YES, a side panel will be generated 1148# containing a tree-like index structure (just like the one that 1149# is generated for HTML Help). For this to work a browser that supports 1150# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1151# Windows users are probably better off using the HTML help feature. 1152# Since the tree basically has the same information as the tab index you 1153# could consider to set DISABLE_INDEX to NO when enabling this option. 1154 1155GENERATE_TREEVIEW = NO 1156 1157# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1158# (range [0,1..20]) that doxygen will group on one line in the generated HTML 1159# documentation. Note that a value of 0 will completely suppress the enum 1160# values from appearing in the overview section. 1161 1162ENUM_VALUES_PER_LINE = 4 1163 1164# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1165# used to set the initial width (in pixels) of the frame in which the tree 1166# is shown. 1167 1168TREEVIEW_WIDTH = 300 1169 1170# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1171# links to external symbols imported via tag files in a separate window. 1172 1173EXT_LINKS_IN_WINDOW = NO 1174 1175# Use this tag to change the font size of Latex formulas included 1176# as images in the HTML documentation. The default is 10. Note that 1177# when you change the font size after a successful doxygen run you need 1178# to manually remove any form_*.png images from the HTML output directory 1179# to force them to be regenerated. 1180 1181FORMULA_FONTSIZE = 10 1182 1183# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1184# generated for formulas are transparent PNGs. Transparent PNGs are 1185# not supported properly for IE 6.0, but are supported on all modern browsers. 1186# Note that when changing this option you need to delete any form_*.png files 1187# in the HTML output before the changes have effect. 1188 1189FORMULA_TRANSPARENT = YES 1190 1191# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1192# (see http://www.mathjax.org) which uses client side Javascript for the 1193# rendering instead of using prerendered bitmaps. Use this if you do not 1194# have LaTeX installed or if you want to formulas look prettier in the HTML 1195# output. When enabled you may also need to install MathJax separately and 1196# configure the path to it using the MATHJAX_RELPATH option. 1197 1198USE_MATHJAX = NO 1199 1200# When MathJax is enabled you can set the default output format to be used for 1201# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and 1202# SVG. The default value is HTML-CSS, which is slower, but has the best 1203# compatibility. 1204 1205MATHJAX_FORMAT = HTML-CSS 1206 1207# When MathJax is enabled you need to specify the location relative to the 1208# HTML output directory using the MATHJAX_RELPATH option. The destination 1209# directory should contain the MathJax.js script. For instance, if the mathjax 1210# directory is located at the same level as the HTML output directory, then 1211# MATHJAX_RELPATH should be ../mathjax. The default value points to 1212# the MathJax Content Delivery Network so you can quickly see the result without 1213# installing MathJax. 1214# However, it is strongly recommended to install a local 1215# copy of MathJax from http://www.mathjax.org before deployment. 1216 1217MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1218 1219# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1220# names that should be enabled during MathJax rendering. 1221 1222MATHJAX_EXTENSIONS = 1223 1224# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1225# for the HTML output. The underlying search engine uses javascript 1226# and DHTML and should work on any modern browser. Note that when using 1227# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1228# (GENERATE_DOCSET) there is already a search function so this one should 1229# typically be disabled. For large projects the javascript based search engine 1230# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1231 1232SEARCHENGINE = YES 1233 1234# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1235# implemented using a web server instead of a web client using Javascript. 1236# There are two flavours of web server based search depending on the 1237# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 1238# searching and an index file used by the script. When EXTERNAL_SEARCH is 1239# enabled the indexing and searching needs to be provided by external tools. 1240# See the manual for details. 1241 1242SERVER_BASED_SEARCH = NO 1243 1244# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP 1245# script for searching. Instead the search results are written to an XML file 1246# which needs to be processed by an external indexer. Doxygen will invoke an 1247# external search engine pointed to by the SEARCHENGINE_URL option to obtain 1248# the search results. Doxygen ships with an example indexer (doxyindexer) and 1249# search engine (doxysearch.cgi) which are based on the open source search engine 1250# library Xapian. See the manual for configuration details. 1251 1252EXTERNAL_SEARCH = NO 1253 1254# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1255# which will returned the search results when EXTERNAL_SEARCH is enabled. 1256# Doxygen ships with an example search engine (doxysearch) which is based on 1257# the open source search engine library Xapian. See the manual for configuration 1258# details. 1259 1260SEARCHENGINE_URL = 1261 1262# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1263# search data is written to a file for indexing by an external tool. With the 1264# SEARCHDATA_FILE tag the name of this file can be specified. 1265 1266SEARCHDATA_FILE = searchdata.xml 1267 1268# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the 1269# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1270# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1271# projects and redirect the results back to the right project. 1272 1273EXTERNAL_SEARCH_ID = 1274 1275# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1276# projects other than the one defined by this configuration file, but that are 1277# all added to the same external search index. Each project needs to have a 1278# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id 1279# of to a relative location where the documentation can be found. 1280# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... 1281 1282EXTRA_SEARCH_MAPPINGS = 1283 1284#--------------------------------------------------------------------------- 1285# configuration options related to the LaTeX output 1286#--------------------------------------------------------------------------- 1287 1288# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1289# generate Latex output. 1290 1291GENERATE_LATEX = NO 1292 1293# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1294# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1295# put in front of it. If left blank `latex' will be used as the default path. 1296 1297LATEX_OUTPUT = latex 1298 1299# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1300# invoked. If left blank `latex' will be used as the default command name. 1301# Note that when enabling USE_PDFLATEX this option is only used for 1302# generating bitmaps for formulas in the HTML output, but not in the 1303# Makefile that is written to the output directory. 1304 1305LATEX_CMD_NAME = latex 1306 1307# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1308# generate index for LaTeX. If left blank `makeindex' will be used as the 1309# default command name. 1310 1311MAKEINDEX_CMD_NAME = makeindex 1312 1313# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1314# LaTeX documents. This may be useful for small projects and may help to 1315# save some trees in general. 1316 1317COMPACT_LATEX = NO 1318 1319# The PAPER_TYPE tag can be used to set the paper type that is used 1320# by the printer. Possible values are: a4, letter, legal and 1321# executive. If left blank a4wide will be used. 1322 1323PAPER_TYPE = a4 1324 1325# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1326# packages that should be included in the LaTeX output. 1327 1328EXTRA_PACKAGES = 1329 1330# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1331# the generated latex document. The header should contain everything until 1332# the first chapter. If it is left blank doxygen will generate a 1333# standard header. Notice: only use this tag if you know what you are doing! 1334 1335LATEX_HEADER = 1336 1337# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1338# the generated latex document. The footer should contain everything after 1339# the last chapter. If it is left blank doxygen will generate a 1340# standard footer. Notice: only use this tag if you know what you are doing! 1341 1342LATEX_FOOTER = 1343 1344# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1345# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1346# contain links (just like the HTML output) instead of page references 1347# This makes the output suitable for online browsing using a pdf viewer. 1348 1349PDF_HYPERLINKS = YES 1350 1351# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1352# plain latex in the generated Makefile. Set this option to YES to get a 1353# higher quality PDF documentation. 1354 1355USE_PDFLATEX = YES 1356 1357# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1358# command to the generated LaTeX files. This will instruct LaTeX to keep 1359# running if errors occur, instead of asking the user for help. 1360# This option is also used when generating formulas in HTML. 1361 1362LATEX_BATCHMODE = NO 1363 1364# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1365# include the index chapters (such as File Index, Compound Index, etc.) 1366# in the output. 1367 1368LATEX_HIDE_INDICES = NO 1369 1370# If LATEX_SOURCE_CODE is set to YES then doxygen will include 1371# source code with syntax highlighting in the LaTeX output. 1372# Note that which sources are shown also depends on other settings 1373# such as SOURCE_BROWSER. 1374 1375LATEX_SOURCE_CODE = NO 1376 1377# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1378# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1379# http://en.wikipedia.org/wiki/BibTeX for more info. 1380 1381LATEX_BIB_STYLE = plain 1382 1383#--------------------------------------------------------------------------- 1384# configuration options related to the RTF output 1385#--------------------------------------------------------------------------- 1386 1387# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1388# The RTF output is optimized for Word 97 and may not look very pretty with 1389# other RTF readers or editors. 1390 1391GENERATE_RTF = NO 1392 1393# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1394# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1395# put in front of it. If left blank `rtf' will be used as the default path. 1396 1397RTF_OUTPUT = rtf 1398 1399# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1400# RTF documents. This may be useful for small projects and may help to 1401# save some trees in general. 1402 1403COMPACT_RTF = NO 1404 1405# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1406# will contain hyperlink fields. The RTF file will 1407# contain links (just like the HTML output) instead of page references. 1408# This makes the output suitable for online browsing using WORD or other 1409# programs which support those fields. 1410# Note: wordpad (write) and others do not support links. 1411 1412RTF_HYPERLINKS = NO 1413 1414# Load style sheet definitions from file. Syntax is similar to doxygen's 1415# config file, i.e. a series of assignments. You only have to provide 1416# replacements, missing definitions are set to their default value. 1417 1418RTF_STYLESHEET_FILE = 1419 1420# Set optional variables used in the generation of an rtf document. 1421# Syntax is similar to doxygen's config file. 1422 1423RTF_EXTENSIONS_FILE = 1424 1425#--------------------------------------------------------------------------- 1426# configuration options related to the man page output 1427#--------------------------------------------------------------------------- 1428 1429# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1430# generate man pages 1431 1432GENERATE_MAN = NO 1433 1434# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1435# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1436# put in front of it. If left blank `man' will be used as the default path. 1437 1438MAN_OUTPUT = man 1439 1440# The MAN_EXTENSION tag determines the extension that is added to 1441# the generated man pages (default is the subroutine's section .3) 1442 1443MAN_EXTENSION = .3 1444 1445# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1446# then it will generate one additional man file for each entity 1447# documented in the real man page(s). These additional files 1448# only source the real man page, but without them the man command 1449# would be unable to find the correct page. The default is NO. 1450 1451MAN_LINKS = NO 1452 1453#--------------------------------------------------------------------------- 1454# configuration options related to the XML output 1455#--------------------------------------------------------------------------- 1456 1457# If the GENERATE_XML tag is set to YES Doxygen will 1458# generate an XML file that captures the structure of 1459# the code including all documentation. 1460 1461GENERATE_XML = NO 1462 1463# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1464# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1465# put in front of it. If left blank `xml' will be used as the default path. 1466 1467XML_OUTPUT = xml 1468 1469# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1470# dump the program listings (including syntax highlighting 1471# and cross-referencing information) to the XML output. Note that 1472# enabling this will significantly increase the size of the XML output. 1473 1474XML_PROGRAMLISTING = YES 1475 1476#--------------------------------------------------------------------------- 1477# configuration options for the AutoGen Definitions output 1478#--------------------------------------------------------------------------- 1479 1480# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1481# generate an AutoGen Definitions (see autogen.sf.net) file 1482# that captures the structure of the code including all 1483# documentation. Note that this feature is still experimental 1484# and incomplete at the moment. 1485 1486GENERATE_AUTOGEN_DEF = NO 1487 1488#--------------------------------------------------------------------------- 1489# configuration options related to the Perl module output 1490#--------------------------------------------------------------------------- 1491 1492# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1493# generate a Perl module file that captures the structure of 1494# the code including all documentation. Note that this 1495# feature is still experimental and incomplete at the 1496# moment. 1497 1498GENERATE_PERLMOD = NO 1499 1500# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1501# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1502# to generate PDF and DVI output from the Perl module output. 1503 1504PERLMOD_LATEX = NO 1505 1506# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1507# nicely formatted so it can be parsed by a human reader. 1508# This is useful 1509# if you want to understand what is going on. 1510# On the other hand, if this 1511# tag is set to NO the size of the Perl module output will be much smaller 1512# and Perl will parse it just the same. 1513 1514PERLMOD_PRETTY = YES 1515 1516# The names of the make variables in the generated doxyrules.make file 1517# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1518# This is useful so different doxyrules.make files included by the same 1519# Makefile don't overwrite each other's variables. 1520 1521PERLMOD_MAKEVAR_PREFIX = 1522 1523#--------------------------------------------------------------------------- 1524# Configuration options related to the preprocessor 1525#--------------------------------------------------------------------------- 1526 1527# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1528# evaluate all C-preprocessor directives found in the sources and include 1529# files. 1530 1531ENABLE_PREPROCESSING = YES 1532 1533# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1534# names in the source code. If set to NO (the default) only conditional 1535# compilation will be performed. Macro expansion can be done in a controlled 1536# way by setting EXPAND_ONLY_PREDEF to YES. 1537 1538MACRO_EXPANSION = YES 1539 1540# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1541# then the macro expansion is limited to the macros specified with the 1542# PREDEFINED and EXPAND_AS_DEFINED tags. 1543 1544EXPAND_ONLY_PREDEF = YES 1545 1546# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1547# pointed to by INCLUDE_PATH will be searched when a #include is found. 1548 1549SEARCH_INCLUDES = YES 1550 1551# The INCLUDE_PATH tag can be used to specify one or more directories that 1552# contain include files that are not input files but should be processed by 1553# the preprocessor. 1554 1555INCLUDE_PATH = 1556 1557# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1558# patterns (like *.h and *.hpp) to filter out the header-files in the 1559# directories. If left blank, the patterns specified with FILE_PATTERNS will 1560# be used. 1561 1562INCLUDE_FILE_PATTERNS = 1563 1564# The PREDEFINED tag can be used to specify one or more macro names that 1565# are defined before the preprocessor is started (similar to the -D option of 1566# gcc). The argument of the tag is a list of macros of the form: name 1567# or name=definition (no spaces). If the definition and the = are 1568# omitted =1 is assumed. To prevent a macro definition from being 1569# undefined via #undef or recursively expanded use the := operator 1570# instead of the = operator. 1571 1572PREDEFINED = GLFWAPI= \ 1573 GLFW_EXPOSE_NATIVE_WIN32 \ 1574 GLFW_EXPOSE_NATIVE_WGL \ 1575 GLFW_EXPOSE_NATIVE_X11 \ 1576 GLFW_EXPOSE_NATIVE_WAYLAND \ 1577 GLFW_EXPOSE_NATIVE_GLX \ 1578 GLFW_EXPOSE_NATIVE_COCOA \ 1579 GLFW_EXPOSE_NATIVE_NSGL \ 1580 GLFW_EXPOSE_NATIVE_EGL \ 1581 GLFW_EXPOSE_NATIVE_OSMESA \ 1582 VK_VERSION_1_0 1583 1584# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1585# this tag can be used to specify a list of macro names that should be expanded. 1586# The macro definition that is found in the sources will be used. 1587# Use the PREDEFINED tag if you want to use a different macro definition that 1588# overrules the definition found in the source code. 1589 1590EXPAND_AS_DEFINED = 1591 1592# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1593# doxygen's preprocessor will remove all references to function-like macros 1594# that are alone on a line, have an all uppercase name, and do not end with a 1595# semicolon, because these will confuse the parser if not removed. 1596 1597SKIP_FUNCTION_MACROS = YES 1598 1599#--------------------------------------------------------------------------- 1600# Configuration::additions related to external references 1601#--------------------------------------------------------------------------- 1602 1603# The TAGFILES option can be used to specify one or more tagfiles. For each 1604# tag file the location of the external documentation should be added. The 1605# format of a tag file without this location is as follows: 1606# 1607# TAGFILES = file1 file2 ... 1608# Adding location for the tag files is done as follows: 1609# 1610# TAGFILES = file1=loc1 "file2 = loc2" ... 1611# where "loc1" and "loc2" can be relative or absolute paths 1612# or URLs. Note that each tag file must have a unique name (where the name does 1613# NOT include the path). If a tag file is not located in the directory in which 1614# doxygen is run, you must also specify the path to the tagfile here. 1615 1616TAGFILES = 1617 1618# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1619# a tag file that is based on the input files it reads. 1620 1621GENERATE_TAGFILE = 1622 1623# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1624# in the class index. If set to NO only the inherited external classes 1625# will be listed. 1626 1627ALLEXTERNALS = NO 1628 1629# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1630# in the modules index. If set to NO, only the current project's groups will 1631# be listed. 1632 1633EXTERNAL_GROUPS = YES 1634 1635#--------------------------------------------------------------------------- 1636# Configuration options related to the dot tool 1637#--------------------------------------------------------------------------- 1638 1639# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1640# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1641# or super classes. Setting the tag to NO turns the diagrams off. Note that 1642# this option also works with HAVE_DOT disabled, but it is recommended to 1643# install and use dot, since it yields more powerful graphs. 1644 1645CLASS_DIAGRAMS = YES 1646 1647# If set to YES, the inheritance and collaboration graphs will hide 1648# inheritance and usage relations if the target is undocumented 1649# or is not a class. 1650 1651HIDE_UNDOC_RELATIONS = YES 1652 1653# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1654# available from the path. This tool is part of Graphviz, a graph visualization 1655# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1656# have no effect if this option is set to NO (the default) 1657 1658HAVE_DOT = NO 1659 1660# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1661# allowed to run in parallel. When set to 0 (the default) doxygen will 1662# base this on the number of processors available in the system. You can set it 1663# explicitly to a value larger than 0 to get control over the balance 1664# between CPU load and processing speed. 1665 1666DOT_NUM_THREADS = 0 1667 1668# By default doxygen will use the Helvetica font for all dot files that 1669# doxygen generates. When you want a differently looking font you can specify 1670# the font name using DOT_FONTNAME. You need to make sure dot is able to find 1671# the font, which can be done by putting it in a standard location or by setting 1672# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1673# directory containing the font. 1674 1675DOT_FONTNAME = Helvetica 1676 1677# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1678# The default size is 10pt. 1679 1680DOT_FONTSIZE = 10 1681 1682# By default doxygen will tell dot to use the Helvetica font. 1683# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1684# set the path where dot can find it. 1685 1686DOT_FONTPATH = 1687 1688# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1689# will generate a graph for each documented class showing the direct and 1690# indirect inheritance relations. Setting this tag to YES will force the 1691# CLASS_DIAGRAMS tag to NO. 1692 1693CLASS_GRAPH = YES 1694 1695# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1696# will generate a graph for each documented class showing the direct and 1697# indirect implementation dependencies (inheritance, containment, and 1698# class references variables) of the class with other documented classes. 1699 1700COLLABORATION_GRAPH = YES 1701 1702# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1703# will generate a graph for groups, showing the direct groups dependencies 1704 1705GROUP_GRAPHS = YES 1706 1707# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1708# collaboration diagrams in a style similar to the OMG's Unified Modeling 1709# Language. 1710 1711UML_LOOK = NO 1712 1713# If the UML_LOOK tag is enabled, the fields and methods are shown inside 1714# the class node. If there are many fields or methods and many nodes the 1715# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1716# threshold limits the number of items for each type to make the size more 1717# manageable. Set this to 0 for no limit. Note that the threshold may be 1718# exceeded by 50% before the limit is enforced. 1719 1720UML_LIMIT_NUM_FIELDS = 10 1721 1722# If set to YES, the inheritance and collaboration graphs will show the 1723# relations between templates and their instances. 1724 1725TEMPLATE_RELATIONS = NO 1726 1727# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1728# tags are set to YES then doxygen will generate a graph for each documented 1729# file showing the direct and indirect include dependencies of the file with 1730# other documented files. 1731 1732INCLUDE_GRAPH = YES 1733 1734# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1735# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1736# documented header file showing the documented files that directly or 1737# indirectly include this file. 1738 1739INCLUDED_BY_GRAPH = YES 1740 1741# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1742# doxygen will generate a call dependency graph for every global function 1743# or class method. Note that enabling this option will significantly increase 1744# the time of a run. So in most cases it will be better to enable call graphs 1745# for selected functions only using the \callgraph command. 1746 1747CALL_GRAPH = NO 1748 1749# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1750# doxygen will generate a caller dependency graph for every global function 1751# or class method. Note that enabling this option will significantly increase 1752# the time of a run. So in most cases it will be better to enable caller 1753# graphs for selected functions only using the \callergraph command. 1754 1755CALLER_GRAPH = NO 1756 1757# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1758# will generate a graphical hierarchy of all classes instead of a textual one. 1759 1760GRAPHICAL_HIERARCHY = YES 1761 1762# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1763# then doxygen will show the dependencies a directory has on other directories 1764# in a graphical way. The dependency relations are determined by the #include 1765# relations between the files in the directories. 1766 1767DIRECTORY_GRAPH = YES 1768 1769# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1770# generated by dot. Possible values are svg, png, jpg, or gif. 1771# If left blank png will be used. If you choose svg you need to set 1772# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1773# visible in IE 9+ (other browsers do not have this requirement). 1774 1775DOT_IMAGE_FORMAT = png 1776 1777# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1778# enable generation of interactive SVG images that allow zooming and panning. 1779# Note that this requires a modern browser other than Internet Explorer. 1780# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1781# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1782# visible. Older versions of IE do not have SVG support. 1783 1784INTERACTIVE_SVG = NO 1785 1786# The tag DOT_PATH can be used to specify the path where the dot tool can be 1787# found. If left blank, it is assumed the dot tool can be found in the path. 1788 1789DOT_PATH = 1790 1791# The DOTFILE_DIRS tag can be used to specify one or more directories that 1792# contain dot files that are included in the documentation (see the 1793# \dotfile command). 1794 1795DOTFILE_DIRS = 1796 1797# The MSCFILE_DIRS tag can be used to specify one or more directories that 1798# contain msc files that are included in the documentation (see the 1799# \mscfile command). 1800 1801MSCFILE_DIRS = 1802 1803# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1804# nodes that will be shown in the graph. If the number of nodes in a graph 1805# becomes larger than this value, doxygen will truncate the graph, which is 1806# visualized by representing a node as a red box. Note that doxygen if the 1807# number of direct children of the root node in a graph is already larger than 1808# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1809# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1810 1811DOT_GRAPH_MAX_NODES = 50 1812 1813# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1814# graphs generated by dot. A depth value of 3 means that only nodes reachable 1815# from the root by following a path via at most 3 edges will be shown. Nodes 1816# that lay further from the root node will be omitted. Note that setting this 1817# option to 1 or 2 may greatly reduce the computation time needed for large 1818# code bases. Also note that the size of a graph can be further restricted by 1819# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1820 1821MAX_DOT_GRAPH_DEPTH = 0 1822 1823# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1824# background. This is disabled by default, because dot on Windows does not 1825# seem to support this out of the box. Warning: Depending on the platform used, 1826# enabling this option may lead to badly anti-aliased labels on the edges of 1827# a graph (i.e. they become hard to read). 1828 1829DOT_TRANSPARENT = NO 1830 1831# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1832# files in one run (i.e. multiple -o and -T options on the command line). This 1833# makes dot run faster, but since only newer versions of dot (>1.8.10) 1834# support this, this feature is disabled by default. 1835 1836DOT_MULTI_TARGETS = NO 1837 1838# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1839# generate a legend page explaining the meaning of the various boxes and 1840# arrows in the dot generated graphs. 1841 1842GENERATE_LEGEND = YES 1843 1844# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1845# remove the intermediate dot files that are used to generate 1846# the various graphs. 1847 1848DOT_CLEANUP = YES 1849