/Tools/Documentation/Cappuccino.doxygen
Unknown | 2353 lines | 1825 code | 528 blank | 0 comment | 0 complexity | 79d888f4fedafdfff08504e66287477a MD5 | raw file
Large files files are truncated, but you can click here to view the full file
1# Doxyfile 1.8.7 2 3# This file describes the settings to be used by the documentation system 4# doxygen (www.doxygen.org) for a project. 5# 6# All text after a double hash (##) is considered a comment and is placed in 7# front of the TAG it is preceding. 8# 9# All text after a single hash (#) is considered a comment and will be ignored. 10# The format is: 11# TAG = value [value, ...] 12# For lists, items can also be appended using: 13# TAG += value [value, ...] 14# Values that contain spaces should be placed between quotes (\" \"). 15 16#--------------------------------------------------------------------------- 17# Project related configuration options 18#--------------------------------------------------------------------------- 19 20# This tag specifies the encoding used for all characters in the config file 21# that follow. The default is UTF-8 which is also the encoding used for all text 22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24# 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 = " API" 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 = 0.9.7-1 42 43# Using the PROJECT_BRIEF tag one can provide an optional one line description 44# for a project that appears at the top of each page and should give viewer a 45# quick idea about the purpose of the project. Keep the description short. 46 47PROJECT_BRIEF = 48 49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50# the documentation. The maximum height of the logo should not exceed 55 pixels 51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52# to the output directory. 53 54PROJECT_LOGO = ./Tools/Documentation/logo.png 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 = Documentation 62 63# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 64# directories (in 2 levels) under the output directory of each output format and 65# will distribute the generated files over these directories. Enabling this 66# option can be useful when feeding doxygen a huge amount of source files, where 67# putting all generated files in the same directory would otherwise causes 68# performance problems for the file system. 69# The default value is: NO. 70 71CREATE_SUBDIRS = NO 72 73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74# characters to appear in the names of generated files. If set to NO, non-ASCII 75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76# U+3044. 77# The default value is: NO. 78 79ALLOW_UNICODE_NAMES = NO 80 81# The OUTPUT_LANGUAGE tag is used to specify the language in which all 82# documentation generated by doxygen is written. Doxygen will use this 83# information to generate all constant output in the proper language. 84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91# Ukrainian and Vietnamese. 92# The default value is: English. 93 94OUTPUT_LANGUAGE = English 95 96# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 97# descriptions after the members that are listed in the file and class 98# documentation (similar to Javadoc). Set to NO to disable this. 99# The default value is: YES. 100 101BRIEF_MEMBER_DESC = YES 102 103# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 104# description of a member or function before the detailed description 105# 106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107# brief descriptions will be completely suppressed. 108# The default value is: YES. 109 110REPEAT_BRIEF = YES 111 112# This tag implements a quasi-intelligent brief description abbreviator that is 113# used to form the text in various listings. Each string in this list, if found 114# as the leading text of the brief description, will be stripped from the text 115# and the result, after processing the whole list, is used as the annotated 116# text. Otherwise, the brief description is used as-is. If left blank, the 117# following values are used ($name is automatically replaced with the name of 118# the entity):The $name class, The $name widget, The $name file, is, provides, 119# specifies, contains, represents, a, an and the. 120 121ABBREVIATE_BRIEF = "The $name class" \ 122 "The $name widget" \ 123 "The $name file" \ 124 is \ 125 provides \ 126 specifies \ 127 contains \ 128 represents \ 129 a \ 130 an \ 131 the 132 133# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134# doxygen will generate a detailed section even if there is only a brief 135# description. 136# The default value is: NO. 137 138ALWAYS_DETAILED_SEC = NO 139 140# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141# inherited members of a class in the documentation of that class as if those 142# members were ordinary class members. Constructors, destructors and assignment 143# operators of the base classes will not be shown. 144# The default value is: NO. 145 146INLINE_INHERITED_MEMB = NO 147 148# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 149# before files name in the file list and in the header files. If set to NO the 150# shortest path that makes the file name unique will be used 151# The default value is: YES. 152 153FULL_PATH_NAMES = YES 154 155# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156# Stripping is only done if one of the specified strings matches the left-hand 157# part of the path. The tag can be used to show relative paths in the file list. 158# If left blank the directory from which doxygen is run is used as the path to 159# strip. 160# 161# Note that you can specify absolute paths here, but also relative paths, which 162# will be relative from the directory where doxygen is started. 163# This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 165STRIP_FROM_PATH = 166 167# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168# path mentioned in the documentation of a class, which tells the reader which 169# header file to include in order to use a class. If left blank only the name of 170# the header file containing the class definition is used. Otherwise one should 171# specify the list of include paths that are normally passed to the compiler 172# using the -I flag. 173 174STRIP_FROM_INC_PATH = 175 176# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177# less readable) file names. This can be useful is your file systems doesn't 178# support long names like on DOS, Mac, or CD-ROM. 179# The default value is: NO. 180 181SHORT_NAMES = NO 182 183# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184# first line (until the first dot) of a Javadoc-style comment as the brief 185# description. If set to NO, the Javadoc-style will behave just like regular Qt- 186# style comments (thus requiring an explicit @brief command for a brief 187# description.) 188# The default value is: NO. 189 190JAVADOC_AUTOBRIEF = NO 191 192# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193# line (until the first dot) of a Qt-style comment as the brief description. If 194# set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195# requiring an explicit \brief command for a brief description.) 196# The default value is: NO. 197 198QT_AUTOBRIEF = NO 199 200# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201# multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202# a brief description. This used to be the default behavior. The new default is 203# to treat a multi-line C++ comment block as a detailed description. Set this 204# tag to YES if you prefer the old behavior instead. 205# 206# Note that setting this tag to YES also means that rational rose comments are 207# not recognized any more. 208# The default value is: NO. 209 210MULTILINE_CPP_IS_BRIEF = NO 211 212# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213# documentation from any documented member that it re-implements. 214# The default value is: YES. 215 216INHERIT_DOCS = YES 217 218# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 219# new page for each member. If set to NO, the documentation of a member will be 220# part of the file/class/namespace that contains it. 221# The default value is: NO. 222 223SEPARATE_MEMBER_PAGES = NO 224 225# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226# uses this value to replace tabs by spaces in code fragments. 227# Minimum value: 1, maximum value: 16, default value: 4. 228 229TAB_SIZE = 8 230 231# This tag can be used to specify a number of aliases that act as commands in 232# the documentation. An alias has the form: 233# name=value 234# For example adding 235# "sideeffect=@par Side Effects:\n" 236# will allow you to put the command \sideeffect (or @sideeffect) in the 237# documentation, which will result in a user-defined paragraph with heading 238# "Side Effects:". You can put \n's in the value part of an alias to insert 239# newlines. 240 241ALIASES = 242 243# This tag can be used to specify a number of word-keyword mappings (TCL only). 244# A mapping has the form "name=value". For example adding "class=itcl::class" 245# will allow you to use the command class in the itcl::class meaning. 246 247TCL_SUBST = 248 249# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250# only. Doxygen will then generate output that is more tailored for C. For 251# instance, some of the names that are used will be different. The list of all 252# members will be omitted, etc. 253# The default value is: NO. 254 255OPTIMIZE_OUTPUT_FOR_C = NO 256 257# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258# Python sources only. Doxygen will then generate output that is more tailored 259# for that language. For instance, namespaces will be presented as packages, 260# qualified scopes will look different, etc. 261# The default value is: NO. 262 263OPTIMIZE_OUTPUT_JAVA = NO 264 265# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266# sources. Doxygen will then generate output that is tailored for Fortran. 267# The default value is: NO. 268 269OPTIMIZE_FOR_FORTRAN = NO 270 271# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272# sources. Doxygen will then generate output that is tailored for VHDL. 273# The default value is: NO. 274 275OPTIMIZE_OUTPUT_VHDL = NO 276 277# Doxygen selects the parser to use depending on the extension of the files it 278# parses. With this tag you can assign which parser to use for a given 279# extension. Doxygen has a built-in mapping, but you can override or extend it 280# using this tag. The format is ext=language, where ext is a file extension, and 281# language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284# Fortran. In the later case the parser tries to guess whether the code is fixed 285# or free formatted code, this is the default for Fortran type files), VHDL. For 286# instance to make doxygen treat .inc files as Fortran files (default is PHP), 287# and .f files as C (default is Fortran), use: inc=Fortran f=C. 288# 289# Note For files without extension you can use no_extension as a placeholder. 290# 291# Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292# the files are not read by doxygen. 293 294EXTENSION_MAPPING = j=Objective-C 295 296# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297# according to the Markdown format, which allows for more readable 298# documentation. See http://daringfireball.net/projects/markdown/ for details. 299# The output of markdown processing is further processed by doxygen, so you can 300# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301# case of backward compatibilities issues. 302# The default value is: YES. 303 304MARKDOWN_SUPPORT = YES 305 306# When enabled doxygen tries to link words that correspond to documented 307# classes, or namespaces to their corresponding documentation. Such a link can 308# be prevented in individual cases by by putting a % sign in front of the word 309# or globally by setting AUTOLINK_SUPPORT to NO. 310# The default value is: YES. 311 312AUTOLINK_SUPPORT = YES 313 314# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 315# to include (a tag file for) the STL sources as input, then you should set this 316# tag to YES in order to let doxygen match functions declarations and 317# definitions whose arguments contain STL classes (e.g. func(std::string); 318# versus func(std::string) {}). This also make the inheritance and collaboration 319# diagrams that involve STL classes more complete and accurate. 320# The default value is: NO. 321 322BUILTIN_STL_SUPPORT = NO 323 324# If you use Microsoft's C++/CLI language, you should set this option to YES to 325# enable parsing support. 326# The default value is: NO. 327 328CPP_CLI_SUPPORT = NO 329 330# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 331# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 332# will parse them like normal C++ but will assume all classes use public instead 333# of private inheritance when no explicit protection keyword is present. 334# The default value is: NO. 335 336SIP_SUPPORT = NO 337 338# For Microsoft's IDL there are propget and propput attributes to indicate 339# getter and setter methods for a property. Setting this option to YES will make 340# doxygen to replace the get and set methods by a property in the documentation. 341# This will only work if the methods are indeed getting or setting a simple 342# type. If this is not the case, or you want to show the methods anyway, you 343# should set this option to NO. 344# The default value is: YES. 345 346IDL_PROPERTY_SUPPORT = NO 347 348# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 349# tag is set to YES, then doxygen will reuse the documentation of the first 350# member in the group (if any) for the other members of the group. By default 351# all members of a group must be documented explicitly. 352# The default value is: NO. 353 354DISTRIBUTE_GROUP_DOC = NO 355 356# Set the SUBGROUPING tag to YES to allow class member groups of the same type 357# (for instance a group of public functions) to be put as a subgroup of that 358# type (e.g. under the Public Functions section). Set it to NO to prevent 359# subgrouping. Alternatively, this can be done per class using the 360# \nosubgrouping command. 361# The default value is: YES. 362 363SUBGROUPING = YES 364 365# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 366# are shown inside the group in which they are included (e.g. using \ingroup) 367# instead of on a separate page (for HTML and Man pages) or section (for LaTeX 368# and RTF). 369# 370# Note that this feature does not work in combination with 371# SEPARATE_MEMBER_PAGES. 372# The default value is: NO. 373 374INLINE_GROUPED_CLASSES = NO 375 376# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 377# with only public data fields or simple typedef fields will be shown inline in 378# the documentation of the scope in which they are defined (i.e. file, 379# namespace, or group documentation), provided this scope is documented. If set 380# to NO, structs, classes, and unions are shown on a separate page (for HTML and 381# Man pages) or section (for LaTeX and RTF). 382# The default value is: NO. 383 384INLINE_SIMPLE_STRUCTS = NO 385 386# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 387# enum is documented as struct, union, or enum with the name of the typedef. So 388# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 389# with name TypeT. When disabled the typedef will appear as a member of a file, 390# namespace, or class. And the struct will be named TypeS. This can typically be 391# useful for C code in case the coding convention dictates that all compound 392# types are typedef'ed and only the typedef is referenced, never the tag name. 393# The default value is: NO. 394 395TYPEDEF_HIDES_STRUCT = NO 396 397# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 398# cache is used to resolve symbols given their name and scope. Since this can be 399# an expensive process and often the same symbol appears multiple times in the 400# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 401# doxygen will become slower. If the cache is too large, memory is wasted. The 402# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 403# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 404# symbols. At the end of a run doxygen will report the cache usage and suggest 405# the optimal cache size from a speed point of view. 406# Minimum value: 0, maximum value: 9, default value: 0. 407 408LOOKUP_CACHE_SIZE = 0 409 410#--------------------------------------------------------------------------- 411# Build related configuration options 412#--------------------------------------------------------------------------- 413 414# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 415# documentation are documented, even if no documentation was available. Private 416# class members and static file members will be hidden unless the 417# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 418# Note: This will also disable the warnings about undocumented members that are 419# normally produced when WARNINGS is set to YES. 420# The default value is: NO. 421 422EXTRACT_ALL = YES 423 424# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 425# be included in the documentation. 426# The default value is: NO. 427 428EXTRACT_PRIVATE = YES 429 430# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 431# scope will be included in the documentation. 432# The default value is: NO. 433 434EXTRACT_PACKAGE = NO 435 436# If the EXTRACT_STATIC tag is set to YES all static members of a file will be 437# included in the documentation. 438# The default value is: NO. 439 440EXTRACT_STATIC = YES 441 442# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 443# locally in source files will be included in the documentation. If set to NO 444# only classes defined in header files are included. Does not have any effect 445# for Java sources. 446# The default value is: YES. 447 448EXTRACT_LOCAL_CLASSES = YES 449 450# This flag is only useful for Objective-C code. When set to YES local methods, 451# which are defined in the implementation section but not in the interface are 452# included in the documentation. If set to NO only methods in the interface are 453# included. 454# The default value is: NO. 455 456EXTRACT_LOCAL_METHODS = YES 457 458# If this flag is set to YES, the members of anonymous namespaces will be 459# extracted and appear in the documentation as a namespace called 460# 'anonymous_namespace{file}', where file will be replaced with the base name of 461# the file that contains the anonymous namespace. By default anonymous namespace 462# are hidden. 463# The default value is: NO. 464 465EXTRACT_ANON_NSPACES = NO 466 467# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 468# undocumented members inside documented classes or files. If set to NO these 469# members will be included in the various overviews, but no documentation 470# section is generated. This option has no effect if EXTRACT_ALL is enabled. 471# The default value is: NO. 472 473HIDE_UNDOC_MEMBERS = NO 474 475# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 476# undocumented classes that are normally visible in the class hierarchy. If set 477# to NO these classes will be included in the various overviews. This option has 478# no effect if EXTRACT_ALL is enabled. 479# The default value is: NO. 480 481HIDE_UNDOC_CLASSES = NO 482 483# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 484# (class|struct|union) declarations. If set to NO these declarations will be 485# included in the documentation. 486# The default value is: NO. 487 488HIDE_FRIEND_COMPOUNDS = NO 489 490# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 491# documentation blocks found inside the body of a function. If set to NO these 492# blocks will be appended to the function's detailed documentation block. 493# The default value is: NO. 494 495HIDE_IN_BODY_DOCS = NO 496 497# The INTERNAL_DOCS tag determines if documentation that is typed after a 498# \internal command is included. If the tag is set to NO then the documentation 499# will be excluded. Set it to YES to include the internal documentation. 500# The default value is: NO. 501 502INTERNAL_DOCS = NO 503 504# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 505# names in lower-case letters. If set to YES upper-case letters are also 506# allowed. This is useful if you have classes or files whose names only differ 507# in case and if your file system supports case sensitive file names. Windows 508# and Mac users are advised to set this option to NO. 509# The default value is: system dependent. 510 511CASE_SENSE_NAMES = NO 512 513# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 514# their full class and namespace scopes in the documentation. If set to YES the 515# scope will be hidden. 516# The default value is: NO. 517 518HIDE_SCOPE_NAMES = NO 519 520# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 521# the files that are included by a file in the documentation of that file. 522# The default value is: YES. 523 524SHOW_INCLUDE_FILES = YES 525 526# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 527# grouped member an include statement to the documentation, telling the reader 528# which file to include in order to use the member. 529# The default value is: NO. 530 531SHOW_GROUPED_MEMB_INC = NO 532 533# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 534# files with double quotes in the documentation rather than with sharp brackets. 535# The default value is: NO. 536 537FORCE_LOCAL_INCLUDES = NO 538 539# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 540# documentation for inline members. 541# The default value is: YES. 542 543INLINE_INFO = YES 544 545# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 546# (detailed) documentation of file and class members alphabetically by member 547# name. If set to NO the members will appear in declaration order. 548# The default value is: YES. 549 550SORT_MEMBER_DOCS = YES 551 552# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 553# descriptions of file, namespace and class members alphabetically by member 554# name. If set to NO the members will appear in declaration order. Note that 555# this will also influence the order of the classes in the class list. 556# The default value is: NO. 557 558SORT_BRIEF_DOCS = YES 559 560# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 561# (brief and detailed) documentation of class members so that constructors and 562# destructors are listed first. If set to NO the constructors will appear in the 563# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 564# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 565# member documentation. 566# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 567# detailed member documentation. 568# The default value is: NO. 569 570SORT_MEMBERS_CTORS_1ST = NO 571 572# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 573# of group names into alphabetical order. If set to NO the group names will 574# appear in their defined order. 575# The default value is: NO. 576 577SORT_GROUP_NAMES = YES 578 579# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 580# fully-qualified names, including namespaces. If set to NO, the class list will 581# be sorted only by class name, not including the namespace part. 582# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 583# Note: This option applies only to the class list, not to the alphabetical 584# list. 585# The default value is: NO. 586 587SORT_BY_SCOPE_NAME = NO 588 589# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 590# type resolution of all parameters of a function it will reject a match between 591# the prototype and the implementation of a member function even if there is 592# only one candidate or it is obvious which candidate to choose by doing a 593# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 594# accept a match between prototype and implementation in such cases. 595# The default value is: NO. 596 597STRICT_PROTO_MATCHING = NO 598 599# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 600# todo list. This list is created by putting \todo commands in the 601# documentation. 602# The default value is: YES. 603 604GENERATE_TODOLIST = NO 605 606# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 607# test list. This list is created by putting \test commands in the 608# documentation. 609# The default value is: YES. 610 611GENERATE_TESTLIST = NO 612 613# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 614# list. This list is created by putting \bug commands in the documentation. 615# The default value is: YES. 616 617GENERATE_BUGLIST = NO 618 619# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 620# the deprecated list. This list is created by putting \deprecated commands in 621# the documentation. 622# The default value is: YES. 623 624GENERATE_DEPRECATEDLIST= YES 625 626# The ENABLED_SECTIONS tag can be used to enable conditional documentation 627# sections, marked by \if <section_label> ... \endif and \cond <section_label> 628# ... \endcond blocks. 629 630ENABLED_SECTIONS = 631 632# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 633# initial value of a variable or macro / define can have for it to appear in the 634# documentation. If the initializer consists of more lines than specified here 635# it will be hidden. Use a value of 0 to hide initializers completely. The 636# appearance of the value of individual variables and macros / defines can be 637# controlled using \showinitializer or \hideinitializer command in the 638# documentation regardless of this setting. 639# Minimum value: 0, maximum value: 10000, default value: 30. 640 641MAX_INITIALIZER_LINES = 30 642 643# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 644# the bottom of the documentation of classes and structs. If set to YES the list 645# will mention the files that were used to generate the documentation. 646# The default value is: YES. 647 648SHOW_USED_FILES = YES 649 650# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 651# will remove the Files entry from the Quick Index and from the Folder Tree View 652# (if specified). 653# The default value is: YES. 654 655SHOW_FILES = YES 656 657# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 658# page. This will remove the Namespaces entry from the Quick Index and from the 659# Folder Tree View (if specified). 660# The default value is: YES. 661 662SHOW_NAMESPACES = YES 663 664# The FILE_VERSION_FILTER tag can be used to specify a program or script that 665# doxygen should invoke to get the current version for each file (typically from 666# the version control system). Doxygen will invoke the program by executing (via 667# popen()) the command command input-file, where command is the value of the 668# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 669# by doxygen. Whatever the program writes to standard output is used as the file 670# version. For an example see the documentation. 671 672FILE_VERSION_FILTER = 673 674# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 675# by doxygen. The layout file controls the global structure of the generated 676# output files in an output format independent way. To create the layout file 677# that represents doxygen's defaults, run doxygen with the -l option. You can 678# optionally specify a file name after the option, if omitted DoxygenLayout.xml 679# will be used as the name of the layout file. 680# 681# Note that if you run doxygen from a directory containing a file called 682# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 683# tag is left empty. 684 685LAYOUT_FILE = 686 687# The CITE_BIB_FILES tag can be used to specify one or more bib files containing 688# the reference definitions. This must be a list of .bib files. The .bib 689# extension is automatically appended if omitted. This requires the bibtex tool 690# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 691# For LaTeX the style of the bibliography can be controlled using 692# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 693# search path. Do not use file names with spaces, bibtex cannot handle them. See 694# also \cite for info how to create references. 695 696CITE_BIB_FILES = 697 698#--------------------------------------------------------------------------- 699# Configuration options related to warning and progress messages 700#--------------------------------------------------------------------------- 701 702# The QUIET tag can be used to turn on/off the messages that are generated to 703# standard output by doxygen. If QUIET is set to YES this implies that the 704# messages are off. 705# The default value is: NO. 706 707QUIET = NO 708 709# The WARNINGS tag can be used to turn on/off the warning messages that are 710# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 711# this implies that the warnings are on. 712# 713# Tip: Turn warnings on while writing the documentation. 714# The default value is: YES. 715 716WARNINGS = YES 717 718# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 719# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 720# will automatically be disabled. 721# The default value is: YES. 722 723WARN_IF_UNDOCUMENTED = NO 724 725# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 726# potential errors in the documentation, such as not documenting some parameters 727# in a documented function, or documenting parameters that don't exist or using 728# markup commands wrongly. 729# The default value is: YES. 730 731WARN_IF_DOC_ERROR = NO 732 733# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 734# are documented, but have no documentation for their parameters or return 735# value. If set to NO doxygen will only warn about wrong or incomplete parameter 736# documentation, but not about the absence of documentation. 737# The default value is: NO. 738 739WARN_NO_PARAMDOC = NO 740 741# The WARN_FORMAT tag determines the format of the warning messages that doxygen 742# can produce. The string should contain the $file, $line, and $text tags, which 743# will be replaced by the file and line number from which the warning originated 744# and the warning text. Optionally the format may contain $version, which will 745# be replaced by the version of the file (if it could be obtained via 746# FILE_VERSION_FILTER) 747# The default value is: $file:$line: $text. 748 749WARN_FORMAT = "$file:$line: $text" 750 751# The WARN_LOGFILE tag can be used to specify a file to which warning and error 752# messages should be written. If left blank the output is written to standard 753# error (stderr). 754 755WARN_LOGFILE = debug.txt 756 757#--------------------------------------------------------------------------- 758# Configuration options related to the input files 759#--------------------------------------------------------------------------- 760 761# The INPUT tag is used to specify the files and/or directories that contain 762# documented source files. You may enter file names like myfile.cpp or 763# directories like /usr/src/myproject. Separate the files or directories with 764# spaces. 765# Note: If this tag is empty the current directory is searched. 766 767INPUT = AppKit.doc \ 768 Foundation.doc 769 770# This tag can be used to specify the character encoding of the source files 771# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 772# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 773# documentation (see: http://www.gnu.org/software/libiconv) for the list of 774# possible encodings. 775# The default value is: UTF-8. 776 777INPUT_ENCODING = UTF-8 778 779# If the value of the INPUT tag contains directories, you can use the 780# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 781# *.h) to filter out the source-files in the directories. If left blank the 782# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 783# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 784# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 785# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 786# *.qsf, *.as and *.js. 787 788FILE_PATTERNS = *.c \ 789 *.cc \ 790 *.cxx \ 791 *.cpp \ 792 *.c++ \ 793 *.d \ 794 *.java \ 795 *.ii \ 796 *.ixx \ 797 *.ipp \ 798 *.i++ \ 799 *.inl \ 800 *.h \ 801 *.hh \ 802 *.hxx \ 803 *.hpp \ 804 *.h++ \ 805 *.idl \ 806 *.odl \ 807 *.cs \ 808 *.php \ 809 *.php3 \ 810 *.inc \ 811 *.m \ 812 *.mm \ 813 *.dox \ 814 *.py \ 815 *.f90 \ 816 *.f \ 817 *.vhd \ 818 *.vhdl \ 819 *.j 820 821# The RECURSIVE tag can be used to specify whether or not subdirectories should 822# be searched for input files as well. 823# The default value is: NO. 824 825RECURSIVE = YES 826 827# The EXCLUDE tag can be used to specify files and/or directories that should be 828# excluded from the INPUT source files. This way you can easily exclude a 829# subdirectory from a directory tree whose root is specified with the INPUT tag. 830# 831# Note that relative paths are relative to the directory from which doxygen is 832# run. 833 834EXCLUDE = 835 836# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 837# directories that are symbolic links (a Unix file system feature) are excluded 838# from the input. 839# The default value is: NO. 840 841EXCLUDE_SYMLINKS = NO 842 843# If the value of the INPUT tag contains directories, you can use the 844# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 845# certain files from those directories. 846# 847# Note that the wildcards are matched against the file with absolute path, so to 848# exclude all test directories for example use the pattern */test/* 849 850EXCLUDE_PATTERNS = _* 851 852# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 853# (namespaces, classes, functions, etc.) that should be excluded from the 854# output. The symbol name can be a fully qualified name, a word, or if the 855# wildcard * is used, a substring. Examples: ANamespace, AClass, 856# AClass::ANamespace, ANamespace::*Test 857# 858# Note that the wildcards are matched against the file with absolute path, so to 859# exclude all test directories use the pattern */test/* 860 861EXCLUDE_SYMBOLS = _* 862 863# The EXAMPLE_PATH tag can be used to specify one or more files or directories 864# that contain example code fragments that are included (see the \include 865# command). 866 867EXAMPLE_PATH = ./Tools/Documentation/README.html \ 868 ./LICENSE 869 870# If the value of the EXAMPLE_PATH tag contains directories, you can use the 871# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 872# *.h) to filter out the source-files in the directories. If left blank all 873# files are included. 874 875EXAMPLE_PATTERNS = * 876 877# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 878# searched for input files to be used with the \include or \dontinclude commands 879# irrespective of the value of the RECURSIVE tag. 880# The default value is: NO. 881 882EXAMPLE_RECURSIVE = NO 883 884# The IMAGE_PATH tag can be used to specify one or more files or directories 885# that contain images that are to be included in the documentation (see the 886# \image command). 887 888IMAGE_PATH = 889 890# The INPUT_FILTER tag can be used to specify a program that doxygen should 891# invoke to filter for each input file. Doxygen will invoke the filter program 892# by executing (via popen()) the command: 893# 894# <filter> <input-file> 895# 896# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 897# name of an input file. Doxygen will then use the output that the filter 898# program writes to standard output. If FILTER_PATTERNS is specified, this tag 899# will be ignored. 900# 901# Note that the filter must not add or remove lines; it is applied before the 902# code is scanned, but not when the output code is generated. If lines are added 903# or removed, the anchors will not be placed correctly. 904 905INPUT_FILTER = 906 907# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 908# basis. Doxygen will compare the file name with each pattern and apply the 909# filter if there is a match. The filters are a list of the form: pattern=filter 910# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 911# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 912# patterns match the file name, INPUT_FILTER is applied. 913 914FILTER_PATTERNS = 915 916# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 917# INPUT_FILTER ) will also be used to filter the input files that are used for 918# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 919# The default value is: NO. 920 921FILTER_SOURCE_FILES = NO 922 923# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 924# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 925# it is also possible to disable source filtering for a specific pattern using 926# *.ext= (so without naming a filter). 927# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 928 929FILTER_SOURCE_PATTERNS = 930 931# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 932# is part of the input, its contents will be placed on the main page 933# (index.html). This can be useful if you have a project on for instance GitHub 934# and want to reuse the introduction page also for the doxygen output. 935 936USE_MDFILE_AS_MAINPAGE = 937 938#--------------------------------------------------------------------------- 939# Configuration options related to source browsing 940#--------------------------------------------------------------------------- 941 942# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 943# generated. Documented entities will be cross-referenced with these sources. 944# 945# Note: To get rid of all source code in the generated output, make sure that 946# also VERBATIM_HEADERS is set to NO. 947# The default value is: NO. 948 949SOURCE_BROWSER = YES 950 951# Setting the INLINE_SOURCES tag to YES will include the body of functions, 952# classes and enums directly into the documentation. 953# The default value is: NO. 954 955INLINE_SOURCES = NO 956 957# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 958# special comment blocks from generated source code fragments. Normal C, C++ and 959# Fortran comments will always remain visible. 960# The default value is: YES. 961 962STRIP_CODE_COMMENTS = YES 963 964# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 965# function all documented functions referencing it will be listed. 966# The default value is: NO. 967 968REFERENCED_BY_RELATION = NO 969 970# If the REFERENCES_RELATION tag is set to YES then for each documented function 971# all documented entities called/used by that function will be listed. 972# The default value is: NO. 973 974REFERENCES_RELATION = NO 975 976# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 977# to YES, then the hyperlinks from functions in REFERENCES_RELATION and 978# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 979# link to the documentation. 980# The default value is: YES. 981 982REFERENCES_LINK_SOURCE = YES 983 984# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 985# source code will show a tooltip with additional information such as prototype, 986# brief description and links to the definition and documentation. Since this 987# will make the HTML file larger and loading of large files a bit slower, you 988# can opt to disable this feature. 989# The default value is: YES. 990# This tag requires that the tag SOURCE_BROWSER is set to YES. 991 992SOURCE_TOOLTIPS = YES 993 994# If the USE_HTAGS tag is set to YES then the references to source code will 995# point to the HTML generated by the htags(1) tool instead of doxygen built-in 996# source browser. The htags tool is part of GNU's global source tagging system 997# (see http://www.gnu.org/software/global/global.html). You will need version 998# 4.8.6 or higher. 999# 1000# To use it do the following: 1001# - Install the latest version of global 1002# - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1003# - Make sure the INPUT points to the root of the source tree 1004# - Run doxygen as normal 1005# 1006# Doxygen will invoke htags (and that will in turn invoke gtags), so these 1007# tools must be available from the command line (i.e. in the search path). 1008# 1009# The result: instead of the source browser generated by doxygen, the links to 1010# source code will now point to the output of htags. 1011# The default value is: NO. 1012# This tag requires that the tag SOURCE_BROWSER is set to YES. 1013 1014USE_HTAGS = NO 1015 1016# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1017# verbatim copy of the header file for each class for which an include is 1018# specified. Set to NO to disable this. 1019# See also: Section \class. 1020# The default value is: YES. 1021 1022VERBATIM_HEADERS = YES 1023 1024#--------------------------------------------------------------------------- 1025# Configuration options related to the alphabetical class index 1026#--------------------------------------------------------------------------- 1027 1028# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1029# compounds will be generated. Enable this if the project contains a lot of 1030# classes, structs, unions or interfaces. 1031# The default value is: YES. 1032 1033ALPHABETICAL_INDEX = YES 1034 1035# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1036# which the alphabetical index list will be split. 1037# Minimum value: 1, maximum value: 20, default value: 5. 1038# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1039 1040COLS_IN_ALPHA_INDEX = 5 1041 1042# In case all classes in a project start with a common prefix, all classes will 1043# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1044# can be used to specify a prefix (or a list of prefixes) that should be ignored 1045# while generating the index headers. 1046# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1047 1048IGNORE_PREFIX = 1049 1050#--------------------------------------------------------------------------- 1051# Configuration options related to the HTML output 1052#--------------------------------------------------------------------------- 1053 1054# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 1055# The default value is: YES. 1056 1057GENERATE_HTML = YES 1058 1059# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1060# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1061# it. 1062# The default directory is: html. 1063# This tag requires that the tag GENERATE_HTML is set to YES. 1064 1065HTML_OUTPUT = html 1066 1067# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1068# generated HTML page (for example: .htm, .php, .asp). 1069# The default value is: .html. 1070# This tag requires that the tag GENERATE_HTML is set to YES. 1071 1072HTML_FILE_EXTENSION = .html 1073 1074# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1075# each generated HTML page. If the tag is left blank doxygen will generate a 1076# standard header. 1077# 1078# To get valid HTML the header file that includes any scripts and style sheets 1079# that doxygen needs, which is dependent on the configuration options used (e.g. 1080# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1081# default header using 1082# doxygen -w html new_header.html new_footer.html new_stylesheet.css 1083# YourConfigFile 1084# and then modify the file new_header.html. See also section "Doxygen usage" 1085# for information on how to generate the default header that doxygen normally 1086# uses. 1087# Note: The header is subject to change so you typically have to regenerate the 1088# default header when upgrading to a newer version of doxygen. For a description 1089# of the possible markers and block names see the documentation. 1090# This tag requires that the tag GENERATE_HTML is set to YES. 1091 1092HTML_HEADER = 1093 1094# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1095# generated HTML page. If the tag is left blank doxygen will generate a standard 1096# footer. See HTML_HEADER for more information on how to generate a default 1097# footer and what special commands can be used inside the footer. See also 1098# section "Doxygen usage" for information on how to generate the default footer 1099# that doxygen normally uses. 1100# This tag requires that the tag GENERATE_HTML is set to YES. 1101 1102HTML_FOOTER = 1103 1104# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1105# sheet that is used by each HTML page. It can be used to fine-tune the look of 1106# the HTML output. If left blank doxygen will generate a default style sheet. 1107# See also section "Doxygen usage" for information on how to generate the style 1108# sheet that doxygen normally uses. 1109# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1110# it is more robust and this tag (HTML_STYLESHEET) will in the future become 1111# obsolete. 1112# This tag requires that the tag GENERATE_HTML is set to YES. 1113 1114HTML_STYLESHEET = 1115 1116# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- 1117# defined cascading style sheet that is included after the standard style sheets 1118# created by doxygen. Using this option one can overrule certain style aspects. 1119# This is preferred over using HTML_STYLESHEET since it does not replace the 1120# standard style sheet and is therefor more robust against future updates. 1121# Doxygen will copy the style sheet file to the output directory. For an example 1122# see the documentation. 1123# This tag requires that the tag GENERATE_HTML is set to YES. 1124 1125HTML_EXTRA_STYLESHEET = 1126 1127# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1128# other source files which should be copied to the HTML output directory. Note 1129# that these files will be copied to the base HTML output directory. Use the 1130# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1131# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1132# files will be copied as-is; there are no commands or markers available. 1133# This tag requires that the tag GENERATE_HTML is set to YES. 1134 1135HTML_EXTRA_FILES = 1136 1137# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1138# will adjust the colors in the stylesheet and background images according to 1139# this color. Hue is specified as an angle on a colorwheel, see 1140# http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1141# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1142# purple, and 360 is red again. 1143# Minimum value: 0, maximum value: 359, default value: 220. 1144# This tag requires that the tag GENERATE_HTML is set to YES. 1145 1146HTML_COLORSTYLE_HUE = 220 1147 1148# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1149# in the HTML output. For a value of 0 the output will use grayscales only. A 1150# value of 255 will produce the most vivid colors. 1151# Minimum value: 0, maximum value: 255, default value: 100. 1152# This tag requires that the tag GENERATE_HTML is set to YES. 1153 1154HTML_COLORSTYLE_SAT = 98 1155 1156# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1157# luminance component of the colors in the HTML output. Values below 100 1158# gradually make the output lighter, whereas values above 100 make the output 1159# darker. The value divided by 100 is the actual gamma applied, so 80 represents 1160# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1161# change t…
Large files files are truncated, but you can click here to view the full file