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