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