1# Doxyfile 1.6.1 2 3# Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. 4# 5# This program is free software; you can redistribute it and/or modify 6# it under the terms of the GNU General Public License, version 2.0, 7# as published by the Free Software Foundation. 8# 9# This program is also distributed with certain software (including 10# but not limited to OpenSSL) that is licensed under separate terms, 11# as designated in a particular file or component or in included license 12# documentation. The authors of MySQL hereby grant you an additional 13# permission to link the program and your derivative works with the 14# separately licensed software that they have included with MySQL. 15# 16# This program is distributed in the hope that it will be useful, 17# but WITHOUT ANY WARRANTY; without even the implied warranty of 18# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19# GNU General Public License, version 2.0, for more details. 20# 21# You should have received a copy of the GNU General Public License 22# along with this program; if not, write to the Free Software 23# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ 24 25# This is a Doxyfile to generate doc from opt trace code files 26 27# This file describes the settings to be used by the documentation system 28# doxygen (www.doxygen.org) for a project 29# 30# All text after a hash (#) is considered a comment and will be ignored 31# The format is: 32# TAG = value [value, ...] 33# For lists items can also be appended using: 34# TAG += value [value, ...] 35# Values that contain spaces should be placed between quotes (" ") 36 37#--------------------------------------------------------------------------- 38# Project related configuration options 39#--------------------------------------------------------------------------- 40 41# This tag specifies the encoding used for all characters in the config file 42# that follow. The default is UTF-8 which is also the encoding used for all 43# text before the first occurrence of this tag. Doxygen uses libiconv (or the 44# iconv built into libc) for the transcoding. See 45# http://www.gnu.org/software/libiconv for the list of possible encodings. 46 47DOXYFILE_ENCODING = UTF-8 48 49# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 50# by quotes) that should identify the project. 51 52PROJECT_NAME = "MySQL" 53 54# The PROJECT_NUMBER tag can be used to enter a project or revision number. 55# This could be handy for archiving the generated documentation or 56# if some version control system is used. 57 58PROJECT_NUMBER = 59 60# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 61# base path where the generated documentation will be put. 62# If a relative path is entered, it will be relative to the location 63# where doxygen was started. If left blank the current directory will be used. 64 65OUTPUT_DIRECTORY = /m/doxygen/mysql-wl4800 66 67# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 68# 4096 sub-directories (in 2 levels) under the output directory of each output 69# format and will distribute the generated files over these directories. 70# Enabling this option can be useful when feeding doxygen a huge amount of 71# source files, where putting all generated files in the same directory would 72# otherwise cause performance problems for the file system. 73 74CREATE_SUBDIRS = NO 75 76# The OUTPUT_LANGUAGE tag is used to specify the language in which all 77# documentation generated by doxygen is written. Doxygen will use this 78# information to generate all constant output in the proper language. 79# The default language is English, other supported languages are: 80# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 81# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 82# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 83# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 84# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 85# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 86 87OUTPUT_LANGUAGE = English 88 89# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 90# include brief member descriptions after the members that are listed in 91# the file and class documentation (similar to JavaDoc). 92# Set to NO to disable this. 93 94BRIEF_MEMBER_DESC = YES 95 96# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 97# the brief description of a member or function before the detailed description. 98# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 99# brief descriptions will be completely suppressed. 100 101REPEAT_BRIEF = YES 102 103# This tag implements a quasi-intelligent brief description abbreviator 104# that is used to form the text in various listings. Each string 105# in this list, if found as the leading text of the brief description, will be 106# stripped from the text and the result after processing the whole list, is 107# used as the annotated text. Otherwise, the brief description is used as-is. 108# If left blank, the following values are used ("$name" is automatically 109# replaced with the name of the entity): "The $name class" "The $name widget" 110# "The $name file" "is" "provides" "specifies" "contains" 111# "represents" "a" "an" "the" 112 113ABBREVIATE_BRIEF = "The $name class" \ 114 "The $name widget" \ 115 "The $name file" \ 116 is \ 117 provides \ 118 specifies \ 119 contains \ 120 represents \ 121 a \ 122 an \ 123 the 124 125# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 126# Doxygen will generate a detailed section even if there is only a brief 127# description. 128 129ALWAYS_DETAILED_SEC = NO 130 131# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 132# inherited members of a class in the documentation of that class as if those 133# members were ordinary class members. Constructors, destructors and assignment 134# operators of the base classes will not be shown. 135 136INLINE_INHERITED_MEMB = NO 137 138# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 139# path before files name in the file list and in the header files. If set 140# to NO the shortest path that makes the file name unique will be used. 141 142FULL_PATH_NAMES = YES 143 144# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 145# can be used to strip a user-defined part of the path. Stripping is 146# only done if one of the specified strings matches the left-hand part of 147# the path. The tag can be used to show relative paths in the file list. 148# If left blank the directory from which doxygen is run is used as the 149# path to strip. 150 151STRIP_FROM_PATH = 152 153# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 154# the path mentioned in the documentation of a class, which tells 155# the reader which header file to include in order to use a class. 156# If left blank only the name of the header file containing the class 157# definition is used. Otherwise one should specify the include paths that 158# are normally passed to the compiler using the -I flag. 159 160STRIP_FROM_INC_PATH = 161 162# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 163# (but less readable) file names. This can be useful is your file systems 164# doesn't support long names like on DOS, Mac, or CD-ROM. 165 166SHORT_NAMES = NO 167 168# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 169# will interpret the first line (until the first dot) of a JavaDoc-style 170# comment as the brief description. If set to NO, the JavaDoc 171# comments will behave just like regular Qt-style comments 172# (thus requiring an explicit @brief command for a brief description.) 173 174JAVADOC_AUTOBRIEF = YES 175 176# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 177# interpret the first line (until the first dot) of a Qt-style 178# comment as the brief description. If set to NO, the comments 179# will behave just like regular Qt-style comments (thus requiring 180# an explicit \brief command for a brief description.) 181 182QT_AUTOBRIEF = NO 183 184# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 185# treat a multi-line C++ special comment block (i.e. a block of //! or /// 186# comments) as a brief description. This used to be the default behaviour. 187# The new default is to treat a multi-line C++ comment block as a detailed 188# description. Set this tag to YES if you prefer the old behaviour instead. 189 190MULTILINE_CPP_IS_BRIEF = NO 191 192# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 193# member inherits the documentation from any documented member that it 194# re-implements. 195 196INHERIT_DOCS = YES 197 198# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 199# a new page for each member. If set to NO, the documentation of a member will 200# be part of the file/class/namespace that contains it. 201 202SEPARATE_MEMBER_PAGES = NO 203 204# The TAB_SIZE tag can be used to set the number of spaces in a tab. 205# Doxygen uses this value to replace tabs by spaces in code fragments. 206 207TAB_SIZE = 8 208 209# This tag can be used to specify a number of aliases that acts 210# as commands in the documentation. An alias has the form "name=value". 211# For example adding "sideeffect=\par Side Effects:\n" will allow you to 212# put the command \sideeffect (or @sideeffect) in the documentation, which 213# will result in a user-defined paragraph with heading "Side Effects:". 214# You can put \n's in the value part of an alias to insert newlines. 215 216ALIASES = 217 218# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 219# sources only. Doxygen will then generate output that is more tailored for C. 220# For instance, some of the names that are used will be different. The list 221# of all members will be omitted, etc. 222 223OPTIMIZE_OUTPUT_FOR_C = NO 224 225# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 226# sources only. Doxygen will then generate output that is more tailored for 227# Java. For instance, namespaces will be presented as packages, qualified 228# scopes will look different, etc. 229 230OPTIMIZE_OUTPUT_JAVA = NO 231 232# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 233# sources only. Doxygen will then generate output that is more tailored for 234# Fortran. 235 236OPTIMIZE_FOR_FORTRAN = NO 237 238# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 239# sources. Doxygen will then generate output that is tailored for 240# VHDL. 241 242OPTIMIZE_OUTPUT_VHDL = NO 243 244# Doxygen selects the parser to use depending on the extension of the files it parses. 245# With this tag you can assign which parser to use for a given extension. 246# Doxygen has a built-in mapping, but you can override or extend it using this tag. 247# The format is ext=language, where ext is a file extension, and language is one of 248# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 249# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 250# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 251# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 252 253EXTENSION_MAPPING = 254 255# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 256# to include (a tag file for) the STL sources as input, then you should 257# set this tag to YES in order to let doxygen match functions declarations and 258# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 259# func(std::string) {}). This also make the inheritance and collaboration 260# diagrams that involve STL classes more complete and accurate. 261 262BUILTIN_STL_SUPPORT = NO 263 264# If you use Microsoft's C++/CLI language, you should set this option to YES to 265# enable parsing support. 266 267CPP_CLI_SUPPORT = NO 268 269# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 270# Doxygen will parse them like normal C++ but will assume all classes use public 271# instead of private inheritance when no explicit protection keyword is present. 272 273SIP_SUPPORT = NO 274 275# For Microsoft's IDL there are propget and propput attributes to indicate getter 276# and setter methods for a property. Setting this option to YES (the default) 277# will make doxygen to replace the get and set methods by a property in the 278# documentation. This will only work if the methods are indeed getting or 279# setting a simple type. If this is not the case, or you want to show the 280# methods anyway, you should set this option to NO. 281 282IDL_PROPERTY_SUPPORT = YES 283 284# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 285# tag is set to YES, then doxygen will reuse the documentation of the first 286# member in the group (if any) for the other members of the group. By default 287# all members of a group must be documented explicitly. 288 289DISTRIBUTE_GROUP_DOC = NO 290 291# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 292# the same type (for instance a group of public functions) to be put as a 293# subgroup of that type (e.g. under the Public Functions section). Set it to 294# NO to prevent subgrouping. Alternatively, this can be done per class using 295# the \nosubgrouping command. 296 297SUBGROUPING = YES 298 299# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 300# is documented as struct, union, or enum with the name of the typedef. So 301# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 302# with name TypeT. When disabled the typedef will appear as a member of a file, 303# namespace, or class. And the struct will be named TypeS. This can typically 304# be useful for C code in case the coding convention dictates that all compound 305# types are typedef'ed and only the typedef is referenced, never the tag name. 306 307TYPEDEF_HIDES_STRUCT = NO 308 309# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 310# determine which symbols to keep in memory and which to flush to disk. 311# When the cache is full, less often used symbols will be written to disk. 312# For small to medium size projects (<1000 input files) the default value is 313# probably good enough. For larger projects a too small cache size can cause 314# doxygen to be busy swapping symbols to and from disk most of the time 315# causing a significant performance penality. 316# If the system has enough physical memory increasing the cache will improve the 317# performance by keeping more symbols in memory. Note that the value works on 318# a logarithmic scale so increasing the size by one will rougly double the 319# memory usage. The cache size is given by this formula: 320# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 321# corresponding to a cache size of 2^16 = 65536 symbols 322 323SYMBOL_CACHE_SIZE = 0 324 325#--------------------------------------------------------------------------- 326# Build related configuration options 327#--------------------------------------------------------------------------- 328 329# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 330# documentation are documented, even if no documentation was available. 331# Private class members and static file members will be hidden unless 332# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 333 334EXTRACT_ALL = NO 335 336# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 337# will be included in the documentation. 338 339EXTRACT_PRIVATE = YES 340 341# If the EXTRACT_STATIC tag is set to YES all static members of a file 342# will be included in the documentation. 343 344EXTRACT_STATIC = YES 345 346# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 347# defined locally in source files will be included in the documentation. 348# If set to NO only classes defined in header files are included. 349 350EXTRACT_LOCAL_CLASSES = YES 351 352# This flag is only useful for Objective-C code. When set to YES local 353# methods, which are defined in the implementation section but not in 354# the interface are included in the documentation. 355# If set to NO (the default) only methods in the interface are included. 356 357EXTRACT_LOCAL_METHODS = NO 358 359# If this flag is set to YES, the members of anonymous namespaces will be 360# extracted and appear in the documentation as a namespace called 361# 'anonymous_namespace{file}', where file will be replaced with the base 362# name of the file that contains the anonymous namespace. By default 363# anonymous namespace are hidden. 364 365EXTRACT_ANON_NSPACES = NO 366 367# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 368# undocumented members of documented classes, files or namespaces. 369# If set to NO (the default) these members will be included in the 370# various overviews, but no documentation section is generated. 371# This option has no effect if EXTRACT_ALL is enabled. 372 373HIDE_UNDOC_MEMBERS = NO 374 375# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 376# undocumented classes that are normally visible in the class hierarchy. 377# If set to NO (the default) these classes will be included in the various 378# overviews. This option has no effect if EXTRACT_ALL is enabled. 379 380HIDE_UNDOC_CLASSES = NO 381 382# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 383# friend (class|struct|union) declarations. 384# If set to NO (the default) these declarations will be included in the 385# documentation. 386 387HIDE_FRIEND_COMPOUNDS = NO 388 389# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 390# documentation blocks found inside the body of a function. 391# If set to NO (the default) these blocks will be appended to the 392# function's detailed documentation block. 393 394HIDE_IN_BODY_DOCS = NO 395 396# The INTERNAL_DOCS tag determines if documentation 397# that is typed after a \internal command is included. If the tag is set 398# to NO (the default) then the documentation will be excluded. 399# Set it to YES to include the internal documentation. 400 401INTERNAL_DOCS = YES 402 403# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 404# file names in lower-case letters. If set to YES upper-case letters are also 405# allowed. This is useful if you have classes or files whose names only differ 406# in case and if your file system supports case sensitive file names. Windows 407# and Mac users are advised to set this option to NO. 408 409CASE_SENSE_NAMES = YES 410 411# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 412# will show members with their full class and namespace scopes in the 413# documentation. If set to YES the scope will be hidden. 414 415HIDE_SCOPE_NAMES = NO 416 417# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 418# will put a list of the files that are included by a file in the documentation 419# of that file. 420 421SHOW_INCLUDE_FILES = YES 422 423# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 424# is inserted in the documentation for inline members. 425 426INLINE_INFO = YES 427 428# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 429# will sort the (detailed) documentation of file and class members 430# alphabetically by member name. If set to NO the members will appear in 431# declaration order. 432 433SORT_MEMBER_DOCS = YES 434 435# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 436# brief documentation of file, namespace and class members alphabetically 437# by member name. If set to NO (the default) the members will appear in 438# declaration order. 439 440SORT_BRIEF_DOCS = NO 441 442# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 443 444SORT_MEMBERS_CTORS_1ST = NO 445 446# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 447# hierarchy of group names into alphabetical order. If set to NO (the default) 448# the group names will appear in their defined order. 449 450SORT_GROUP_NAMES = NO 451 452# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 453# sorted by fully-qualified names, including namespaces. If set to 454# NO (the default), the class list will be sorted only by class name, 455# not including the namespace part. 456# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 457# Note: This option applies only to the class list, not to the 458# alphabetical list. 459 460SORT_BY_SCOPE_NAME = NO 461 462# The GENERATE_TODOLIST tag can be used to enable (YES) or 463# disable (NO) the todo list. This list is created by putting \todo 464# commands in the documentation. 465 466GENERATE_TODOLIST = YES 467 468# The GENERATE_TESTLIST tag can be used to enable (YES) or 469# disable (NO) the test list. This list is created by putting \test 470# commands in the documentation. 471 472GENERATE_TESTLIST = YES 473 474# The GENERATE_BUGLIST tag can be used to enable (YES) or 475# disable (NO) the bug list. This list is created by putting \bug 476# commands in the documentation. 477 478GENERATE_BUGLIST = YES 479 480# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 481# disable (NO) the deprecated list. This list is created by putting 482# \deprecated commands in the documentation. 483 484GENERATE_DEPRECATEDLIST= YES 485 486# The ENABLED_SECTIONS tag can be used to enable conditional 487# documentation sections, marked by \if sectionname ... \endif. 488 489ENABLED_SECTIONS = 490 491# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 492# the initial value of a variable or define consists of for it to appear in 493# the documentation. If the initializer consists of more lines than specified 494# here it will be hidden. Use a value of 0 to hide initializers completely. 495# The appearance of the initializer of individual variables and defines in the 496# documentation can be controlled using \showinitializer or \hideinitializer 497# command in the documentation regardless of this setting. 498 499MAX_INITIALIZER_LINES = 30 500 501# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 502# at the bottom of the documentation of classes and structs. If set to YES the 503# list will mention the files that were used to generate the documentation. 504 505SHOW_USED_FILES = YES 506 507# If the sources in your project are distributed over multiple directories 508# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 509# in the documentation. The default is NO. 510 511SHOW_DIRECTORIES = NO 512 513# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 514# This will remove the Files entry from the Quick Index and from the 515# Folder Tree View (if specified). The default is YES. 516 517SHOW_FILES = YES 518 519# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 520# Namespaces page. 521# This will remove the Namespaces entry from the Quick Index 522# and from the Folder Tree View (if specified). The default is YES. 523 524SHOW_NAMESPACES = YES 525 526# The FILE_VERSION_FILTER tag can be used to specify a program or script that 527# doxygen should invoke to get the current version for each file (typically from 528# the version control system). Doxygen will invoke the program by executing (via 529# popen()) the command <command> <input-file>, where <command> is the value of 530# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 531# provided by doxygen. Whatever the program writes to standard output 532# is used as the file version. See the manual for examples. 533 534FILE_VERSION_FILTER = 535 536# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 537# doxygen. The layout file controls the global structure of the generated output files 538# in an output format independent way. The create the layout file that represents 539# doxygen's defaults, run doxygen with the -l option. You can optionally specify a 540# file name after the option, if omitted DoxygenLayout.xml will be used as the name 541# of the layout file. 542 543LAYOUT_FILE = 544 545#--------------------------------------------------------------------------- 546# configuration options related to warning and progress messages 547#--------------------------------------------------------------------------- 548 549# The QUIET tag can be used to turn on/off the messages that are generated 550# by doxygen. Possible values are YES and NO. If left blank NO is used. 551 552QUIET = NO 553 554# The WARNINGS tag can be used to turn on/off the warning messages that are 555# generated by doxygen. Possible values are YES and NO. If left blank 556# NO is used. 557 558WARNINGS = YES 559 560# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 561# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 562# automatically be disabled. 563 564WARN_IF_UNDOCUMENTED = YES 565 566# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 567# potential errors in the documentation, such as not documenting some 568# parameters in a documented function, or documenting parameters that 569# don't exist or using markup commands wrongly. 570 571WARN_IF_DOC_ERROR = YES 572 573# This WARN_NO_PARAMDOC option can be abled to get warnings for 574# functions that are documented, but have no documentation for their parameters 575# or return value. If set to NO (the default) doxygen will only warn about 576# wrong or incomplete parameter documentation, but not about the absence of 577# documentation. 578 579WARN_NO_PARAMDOC = YES 580 581# The WARN_FORMAT tag determines the format of the warning messages that 582# doxygen can produce. The string should contain the $file, $line, and $text 583# tags, which will be replaced by the file and line number from which the 584# warning originated and the warning text. Optionally the format may contain 585# $version, which will be replaced by the version of the file (if it could 586# be obtained via FILE_VERSION_FILTER) 587 588WARN_FORMAT = "$file:$line: $text" 589 590# The WARN_LOGFILE tag can be used to specify a file to which warning 591# and error messages should be written. If left blank the output is written 592# to stderr. 593 594WARN_LOGFILE = doxygen.err 595 596#--------------------------------------------------------------------------- 597# configuration options related to the input files 598#--------------------------------------------------------------------------- 599 600# The INPUT tag can be used to specify the files and/or directories that contain 601# documented source files. You may enter file names like "myfile.cpp" or 602# directories like "/usr/src/myproject". Separate the files or directories 603# with spaces. 604 605INPUT = ./sql/opt_trace_context.h ./sql/opt_trace.h ./sql/opt_trace.cc ./sql/opt_trace2server.cc ./sql/sys_vars.cc 606# This tag can be used to specify the character encoding of the source files 607# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 608# also the default input encoding. Doxygen uses libiconv (or the iconv built 609# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 610# the list of possible encodings. 611 612INPUT_ENCODING = UTF-8 613 614# If the value of the INPUT tag contains directories, you can use the 615# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 616# and *.h) to filter out the source-files in the directories. If left 617# blank the following patterns are tested: 618# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 619# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 620 621FILE_PATTERNS = *.c \ 622 *.cc \ 623 *.cxx \ 624 *.cpp \ 625 *.c++ \ 626 *.d \ 627 *.java \ 628 *.ii \ 629 *.ixx \ 630 *.ipp \ 631 *.i++ \ 632 *.inl \ 633 *.h \ 634 *.hh \ 635 *.hxx \ 636 *.hpp \ 637 *.h++ \ 638 *.idl \ 639 *.odl \ 640 *.cs \ 641 *.php \ 642 *.php3 \ 643 *.inc \ 644 *.m \ 645 *.mm \ 646 *.dox \ 647 *.py \ 648 *.C \ 649 *.CC \ 650 *.C++ \ 651 *.II \ 652 *.I++ \ 653 *.H \ 654 *.HH \ 655 *.H++ \ 656 *.CS \ 657 *.PHP \ 658 *.PHP3 \ 659 *.M \ 660 *.MM \ 661 *.PY 662 663# The RECURSIVE tag can be used to turn specify whether or not subdirectories 664# should be searched for input files as well. Possible values are YES and NO. 665# If left blank NO is used. 666 667RECURSIVE = NO 668 669# The EXCLUDE tag can be used to specify files and/or directories that should 670# excluded from the INPUT source files. This way you can easily exclude a 671# subdirectory from a directory tree whose root is specified with the INPUT tag. 672 673EXCLUDE = libmysqld \ 674 netware \ 675 Docs \ 676 dbug \ 677 BUILD \ 678 config \ 679 autom4te.cache \ 680 man \ 681 scripts \ 682 support-files \ 683 win \ 684 mysql-test 685 686# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 687# directories that are symbolic links (a Unix filesystem feature) are excluded 688# from the input. 689 690EXCLUDE_SYMLINKS = NO 691 692# If the value of the INPUT tag contains directories, you can use the 693# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 694# certain files from those directories. Note that the wildcards are matched 695# against the file with absolute path, so to exclude all test directories 696# for example use the pattern */test/* 697 698EXCLUDE_PATTERNS = */test/* \ 699 */bld*/* \ 700 */scripts/* \ 701 */config/* \ 702 */man/* \ 703 */autom4te.cache/* \ 704 */BUILD/* \ 705 */netware/* \ 706 */libmysqld/* \ 707 */Docs/* \ 708 */dbug/* \ 709 */win/* \ 710 */mysql-test/* \ 711 */support-files/* 712 713# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 714# (namespaces, classes, functions, etc.) that should be excluded from the 715# output. The symbol name can be a fully qualified name, a word, or if the 716# wildcard * is used, a substring. Examples: ANamespace, AClass, 717# AClass::ANamespace, ANamespace::*Test 718 719EXCLUDE_SYMBOLS = 720 721# The EXAMPLE_PATH tag can be used to specify one or more files or 722# directories that contain example code fragments that are included (see 723# the \include command). 724 725EXAMPLE_PATH = 726 727# If the value of the EXAMPLE_PATH tag contains directories, you can use the 728# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 729# and *.h) to filter out the source-files in the directories. If left 730# blank all files are included. 731 732EXAMPLE_PATTERNS = * 733 734# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 735# searched for input files to be used with the \include or \dontinclude 736# commands irrespective of the value of the RECURSIVE tag. 737# Possible values are YES and NO. If left blank NO is used. 738 739EXAMPLE_RECURSIVE = NO 740 741# The IMAGE_PATH tag can be used to specify one or more files or 742# directories that contain image that are included in the documentation (see 743# the \image command). 744 745IMAGE_PATH = 746 747# The INPUT_FILTER tag can be used to specify a program that doxygen should 748# invoke to filter for each input file. Doxygen will invoke the filter program 749# by executing (via popen()) the command <filter> <input-file>, where <filter> 750# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 751# input file. Doxygen will then use the output that the filter program writes 752# to standard output. 753# If FILTER_PATTERNS is specified, this tag will be 754# ignored. 755 756INPUT_FILTER = 757 758# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 759# basis. 760# Doxygen will compare the file name with each pattern and apply the 761# filter if there is a match. 762# The filters are a list of the form: 763# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 764# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 765# is applied to all files. 766 767FILTER_PATTERNS = 768 769# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 770# INPUT_FILTER) will be used to filter the input files when producing source 771# files to browse (i.e. when SOURCE_BROWSER is set to YES). 772 773FILTER_SOURCE_FILES = NO 774 775#--------------------------------------------------------------------------- 776# configuration options related to source browsing 777#--------------------------------------------------------------------------- 778 779# If the SOURCE_BROWSER tag is set to YES then a list of source files will 780# be generated. Documented entities will be cross-referenced with these sources. 781# Note: To get rid of all source code in the generated output, make sure also 782# VERBATIM_HEADERS is set to NO. 783 784SOURCE_BROWSER = YES 785 786# Setting the INLINE_SOURCES tag to YES will include the body 787# of functions and classes directly in the documentation. 788 789INLINE_SOURCES = YES 790 791# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 792# doxygen to hide any special comment blocks from generated source code 793# fragments. Normal C and C++ comments will always remain visible. 794 795STRIP_CODE_COMMENTS = YES 796 797# If the REFERENCED_BY_RELATION tag is set to YES 798# then for each documented function all documented 799# functions referencing it will be listed. 800 801REFERENCED_BY_RELATION = YES 802 803# If the REFERENCES_RELATION tag is set to YES 804# then for each documented function all documented entities 805# called/used by that function will be listed. 806 807REFERENCES_RELATION = YES 808 809# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 810# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 811# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 812# link to the source code. 813# Otherwise they will link to the documentation. 814 815REFERENCES_LINK_SOURCE = YES 816 817# If the USE_HTAGS tag is set to YES then the references to source code 818# will point to the HTML generated by the htags(1) tool instead of doxygen 819# built-in source browser. The htags tool is part of GNU's global source 820# tagging system (see http://www.gnu.org/software/global/global.html). You 821# will need version 4.8.6 or higher. 822 823USE_HTAGS = NO 824 825# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 826# will generate a verbatim copy of the header file for each class for 827# which an include is specified. Set to NO to disable this. 828 829VERBATIM_HEADERS = YES 830 831#--------------------------------------------------------------------------- 832# configuration options related to the alphabetical class index 833#--------------------------------------------------------------------------- 834 835# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 836# of all compounds will be generated. Enable this if the project 837# contains a lot of classes, structs, unions or interfaces. 838 839ALPHABETICAL_INDEX = YES 840 841# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 842# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 843# in which this list will be split (can be a number in the range [1..20]) 844 845COLS_IN_ALPHA_INDEX = 5 846 847# In case all classes in a project start with a common prefix, all 848# classes will be put under the same header in the alphabetical index. 849# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 850# should be ignored while generating the index headers. 851 852IGNORE_PREFIX = 853 854#--------------------------------------------------------------------------- 855# configuration options related to the HTML output 856#--------------------------------------------------------------------------- 857 858# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 859# generate HTML output. 860 861GENERATE_HTML = YES 862 863# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 864# If a relative path is entered the value of OUTPUT_DIRECTORY will be 865# put in front of it. If left blank `html' will be used as the default path. 866 867HTML_OUTPUT = html 868 869# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 870# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 871# doxygen will generate files with .html extension. 872 873HTML_FILE_EXTENSION = .html 874 875# The HTML_HEADER tag can be used to specify a personal HTML header for 876# each generated HTML page. If it is left blank doxygen will generate a 877# standard header. 878 879HTML_HEADER = 880 881# The HTML_FOOTER tag can be used to specify a personal HTML footer for 882# each generated HTML page. If it is left blank doxygen will generate a 883# standard footer. 884 885HTML_FOOTER = 886 887# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 888# style sheet that is used by each HTML page. It can be used to 889# fine-tune the look of the HTML output. If the tag is left blank doxygen 890# will generate a default style sheet. Note that doxygen will try to copy 891# the style sheet file to the HTML output directory, so don't put your own 892# stylesheet in the HTML output directory as well, or it will be erased! 893 894HTML_STYLESHEET = 895 896# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 897# files or namespaces will be aligned in HTML using tables. If set to 898# NO a bullet list will be used. 899 900HTML_ALIGN_MEMBERS = YES 901 902# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 903# documentation will contain sections that can be hidden and shown after the 904# page has loaded. For this to work a browser that supports 905# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 906# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 907 908HTML_DYNAMIC_SECTIONS = NO 909 910# If the GENERATE_DOCSET tag is set to YES, additional index files 911# will be generated that can be used as input for Apple's Xcode 3 912# integrated development environment, introduced with OSX 10.5 (Leopard). 913# To create a documentation set, doxygen will generate a Makefile in the 914# HTML output directory. Running make will produce the docset in that 915# directory and running "make install" will install the docset in 916# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 917# it at startup. 918# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 919 920GENERATE_DOCSET = NO 921 922# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 923# feed. A documentation feed provides an umbrella under which multiple 924# documentation sets from a single provider (such as a company or product suite) 925# can be grouped. 926 927DOCSET_FEEDNAME = "Doxygen generated docs" 928 929# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 930# should uniquely identify the documentation set bundle. This should be a 931# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 932# will append .docset to the name. 933 934DOCSET_BUNDLE_ID = org.doxygen.Project 935 936# If the GENERATE_HTMLHELP tag is set to YES, additional index files 937# will be generated that can be used as input for tools like the 938# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 939# of the generated HTML documentation. 940 941GENERATE_HTMLHELP = NO 942 943# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 944# be used to specify the file name of the resulting .chm file. You 945# can add a path in front of the file if the result should not be 946# written to the html output directory. 947 948CHM_FILE = 949 950# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 951# be used to specify the location (absolute path including file name) of 952# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 953# the HTML help compiler on the generated index.hhp. 954 955HHC_LOCATION = 956 957# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 958# controls if a separate .chi index file is generated (YES) or that 959# it should be included in the master .chm file (NO). 960 961GENERATE_CHI = NO 962 963# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 964# is used to encode HtmlHelp index (hhk), content (hhc) and project file 965# content. 966 967CHM_INDEX_ENCODING = 968 969# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 970# controls whether a binary table of contents is generated (YES) or a 971# normal table of contents (NO) in the .chm file. 972 973BINARY_TOC = NO 974 975# The TOC_EXPAND flag can be set to YES to add extra items for group members 976# to the contents of the HTML help documentation and to the tree view. 977 978TOC_EXPAND = NO 979 980# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 981# are set, an additional index file will be generated that can be used as input for 982# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 983# HTML documentation. 984 985GENERATE_QHP = NO 986 987# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 988# be used to specify the file name of the resulting .qch file. 989# The path specified is relative to the HTML output folder. 990 991QCH_FILE = 992 993# The QHP_NAMESPACE tag specifies the namespace to use when generating 994# Qt Help Project output. For more information please see 995# http://doc.trolltech.com/qthelpproject.html#namespace 996 997QHP_NAMESPACE = 998 999# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1000# Qt Help Project output. For more information please see 1001# http://doc.trolltech.com/qthelpproject.html#virtual-folders 1002 1003QHP_VIRTUAL_FOLDER = doc 1004 1005# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 1006# For more information please see 1007# http://doc.trolltech.com/qthelpproject.html#custom-filters 1008 1009QHP_CUST_FILTER_NAME = 1010 1011# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 1012# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 1013 1014QHP_CUST_FILTER_ATTRS = 1015 1016# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 1017# filter section matches. 1018# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 1019 1020QHP_SECT_FILTER_ATTRS = 1021 1022# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1023# be used to specify the location of Qt's qhelpgenerator. 1024# If non-empty doxygen will try to run qhelpgenerator on the generated 1025# .qhp file. 1026 1027QHG_LOCATION = 1028 1029# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 1030# top of each HTML page. The value NO (the default) enables the index and 1031# the value YES disables it. 1032 1033DISABLE_INDEX = NO 1034 1035# This tag can be used to set the number of enum values (range [1..20]) 1036# that doxygen will group on one line in the generated HTML documentation. 1037 1038ENUM_VALUES_PER_LINE = 4 1039 1040# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1041# structure should be generated to display hierarchical information. 1042# If the tag value is set to YES, a side panel will be generated 1043# containing a tree-like index structure (just like the one that 1044# is generated for HTML Help). For this to work a browser that supports 1045# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1046# Windows users are probably better off using the HTML help feature. 1047 1048GENERATE_TREEVIEW = NO 1049 1050# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 1051# and Class Hierarchy pages using a tree view instead of an ordered list. 1052 1053USE_INLINE_TREES = NO 1054 1055# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1056# used to set the initial width (in pixels) of the frame in which the tree 1057# is shown. 1058 1059TREEVIEW_WIDTH = 250 1060 1061# Use this tag to change the font size of Latex formulas included 1062# as images in the HTML documentation. The default is 10. Note that 1063# when you change the font size after a successful doxygen run you need 1064# to manually remove any form_*.png images from the HTML output directory 1065# to force them to be regenerated. 1066 1067FORMULA_FONTSIZE = 10 1068 1069# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript 1070# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) 1071# there is already a search function so this one should typically 1072# be disabled. 1073 1074SEARCHENGINE = YES 1075 1076#--------------------------------------------------------------------------- 1077# configuration options related to the LaTeX output 1078#--------------------------------------------------------------------------- 1079 1080# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1081# generate Latex output. 1082 1083GENERATE_LATEX = NO 1084 1085# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1086# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1087# put in front of it. If left blank `latex' will be used as the default path. 1088 1089LATEX_OUTPUT = latex 1090 1091# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1092# invoked. If left blank `latex' will be used as the default command name. 1093 1094LATEX_CMD_NAME = latex 1095 1096# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1097# generate index for LaTeX. If left blank `makeindex' will be used as the 1098# default command name. 1099 1100MAKEINDEX_CMD_NAME = makeindex 1101 1102# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1103# LaTeX documents. This may be useful for small projects and may help to 1104# save some trees in general. 1105 1106COMPACT_LATEX = NO 1107 1108# The PAPER_TYPE tag can be used to set the paper type that is used 1109# by the printer. Possible values are: a4, a4wide, letter, legal and 1110# executive. If left blank a4wide will be used. 1111 1112PAPER_TYPE = a4wide 1113 1114# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1115# packages that should be included in the LaTeX output. 1116 1117EXTRA_PACKAGES = 1118 1119# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1120# the generated latex document. The header should contain everything until 1121# the first chapter. If it is left blank doxygen will generate a 1122# standard header. Notice: only use this tag if you know what you are doing! 1123 1124LATEX_HEADER = 1125 1126# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1127# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1128# contain links (just like the HTML output) instead of page references 1129# This makes the output suitable for online browsing using a pdf viewer. 1130 1131PDF_HYPERLINKS = NO 1132 1133# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1134# plain latex in the generated Makefile. Set this option to YES to get a 1135# higher quality PDF documentation. 1136 1137USE_PDFLATEX = NO 1138 1139# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1140# command to the generated LaTeX files. This will instruct LaTeX to keep 1141# running if errors occur, instead of asking the user for help. 1142# This option is also used when generating formulas in HTML. 1143 1144LATEX_BATCHMODE = NO 1145 1146# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1147# include the index chapters (such as File Index, Compound Index, etc.) 1148# in the output. 1149 1150LATEX_HIDE_INDICES = NO 1151 1152# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. 1153 1154LATEX_SOURCE_CODE = NO 1155 1156#--------------------------------------------------------------------------- 1157# configuration options related to the RTF output 1158#--------------------------------------------------------------------------- 1159 1160# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1161# The RTF output is optimized for Word 97 and may not look very pretty with 1162# other RTF readers or editors. 1163 1164GENERATE_RTF = NO 1165 1166# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1167# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1168# put in front of it. If left blank `rtf' will be used as the default path. 1169 1170RTF_OUTPUT = rtf 1171 1172# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1173# RTF documents. This may be useful for small projects and may help to 1174# save some trees in general. 1175 1176COMPACT_RTF = NO 1177 1178# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1179# will contain hyperlink fields. The RTF file will 1180# contain links (just like the HTML output) instead of page references. 1181# This makes the output suitable for online browsing using WORD or other 1182# programs which support those fields. 1183# Note: wordpad (write) and others do not support links. 1184 1185RTF_HYPERLINKS = NO 1186 1187# Load stylesheet definitions from file. Syntax is similar to doxygen's 1188# config file, i.e. a series of assignments. You only have to provide 1189# replacements, missing definitions are set to their default value. 1190 1191RTF_STYLESHEET_FILE = 1192 1193# Set optional variables used in the generation of an rtf document. 1194# Syntax is similar to doxygen's config file. 1195 1196RTF_EXTENSIONS_FILE = 1197 1198#--------------------------------------------------------------------------- 1199# configuration options related to the man page output 1200#--------------------------------------------------------------------------- 1201 1202# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1203# generate man pages 1204 1205GENERATE_MAN = NO 1206 1207# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1208# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1209# put in front of it. If left blank `man' will be used as the default path. 1210 1211MAN_OUTPUT = man 1212 1213# The MAN_EXTENSION tag determines the extension that is added to 1214# the generated man pages (default is the subroutine's section .3) 1215 1216MAN_EXTENSION = .3 1217 1218# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1219# then it will generate one additional man file for each entity 1220# documented in the real man page(s). These additional files 1221# only source the real man page, but without them the man command 1222# would be unable to find the correct page. The default is NO. 1223 1224MAN_LINKS = NO 1225 1226#--------------------------------------------------------------------------- 1227# configuration options related to the XML output 1228#--------------------------------------------------------------------------- 1229 1230# If the GENERATE_XML tag is set to YES Doxygen will 1231# generate an XML file that captures the structure of 1232# the code including all documentation. 1233 1234GENERATE_XML = NO 1235 1236# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1237# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1238# put in front of it. If left blank `xml' will be used as the default path. 1239 1240XML_OUTPUT = xml 1241 1242# The XML_SCHEMA tag can be used to specify an XML schema, 1243# which can be used by a validating XML parser to check the 1244# syntax of the XML files. 1245 1246XML_SCHEMA = 1247 1248# The XML_DTD tag can be used to specify an XML DTD, 1249# which can be used by a validating XML parser to check the 1250# syntax of the XML files. 1251 1252XML_DTD = 1253 1254# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1255# dump the program listings (including syntax highlighting 1256# and cross-referencing information) to the XML output. Note that 1257# enabling this will significantly increase the size of the XML output. 1258 1259XML_PROGRAMLISTING = YES 1260 1261#--------------------------------------------------------------------------- 1262# configuration options for the AutoGen Definitions output 1263#--------------------------------------------------------------------------- 1264 1265# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1266# generate an AutoGen Definitions (see autogen.sf.net) file 1267# that captures the structure of the code including all 1268# documentation. Note that this feature is still experimental 1269# and incomplete at the moment. 1270 1271GENERATE_AUTOGEN_DEF = NO 1272 1273#--------------------------------------------------------------------------- 1274# configuration options related to the Perl module output 1275#--------------------------------------------------------------------------- 1276 1277# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1278# generate a Perl module file that captures the structure of 1279# the code including all documentation. Note that this 1280# feature is still experimental and incomplete at the 1281# moment. 1282 1283GENERATE_PERLMOD = NO 1284 1285# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1286# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1287# to generate PDF and DVI output from the Perl module output. 1288 1289PERLMOD_LATEX = NO 1290 1291# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1292# nicely formatted so it can be parsed by a human reader. 1293# This is useful 1294# if you want to understand what is going on. 1295# On the other hand, if this 1296# tag is set to NO the size of the Perl module output will be much smaller 1297# and Perl will parse it just the same. 1298 1299PERLMOD_PRETTY = YES 1300 1301# The names of the make variables in the generated doxyrules.make file 1302# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1303# This is useful so different doxyrules.make files included by the same 1304# Makefile don't overwrite each other's variables. 1305 1306PERLMOD_MAKEVAR_PREFIX = 1307 1308#--------------------------------------------------------------------------- 1309# Configuration options related to the preprocessor 1310#--------------------------------------------------------------------------- 1311 1312# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1313# evaluate all C-preprocessor directives found in the sources and include 1314# files. 1315 1316ENABLE_PREPROCESSING = YES 1317 1318# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1319# names in the source code. If set to NO (the default) only conditional 1320# compilation will be performed. Macro expansion can be done in a controlled 1321# way by setting EXPAND_ONLY_PREDEF to YES. 1322 1323MACRO_EXPANSION = NO 1324 1325# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1326# then the macro expansion is limited to the macros specified with the 1327# PREDEFINED and EXPAND_AS_DEFINED tags. 1328 1329EXPAND_ONLY_PREDEF = NO 1330 1331# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1332# in the INCLUDE_PATH (see below) will be search if a #include is found. 1333 1334SEARCH_INCLUDES = YES 1335 1336# The INCLUDE_PATH tag can be used to specify one or more directories that 1337# contain include files that are not input files but should be processed by 1338# the preprocessor. 1339 1340INCLUDE_PATH = . 1341 1342# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1343# patterns (like *.h and *.hpp) to filter out the header-files in the 1344# directories. If left blank, the patterns specified with FILE_PATTERNS will 1345# be used. 1346 1347INCLUDE_FILE_PATTERNS = 1348 1349# The PREDEFINED tag can be used to specify one or more macro names that 1350# are defined before the preprocessor is started (similar to the -D option of 1351# gcc). The argument of the tag is a list of macros of the form: name 1352# or name=definition (no spaces). If the definition and the = are 1353# omitted =1 is assumed. To prevent a macro definition from being 1354# undefined via #undef or recursively expanded use the := operator 1355# instead of the = operator. 1356 1357PREDEFINED = OPTIMIZER_TRACE 1358 1359# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1360# this tag can be used to specify a list of macro names that should be expanded. 1361# The macro definition that is found in the sources will be used. 1362# Use the PREDEFINED tag if you want to use a different macro definition. 1363 1364EXPAND_AS_DEFINED = 1365 1366# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1367# doxygen's preprocessor will remove all function-like macros that are alone 1368# on a line, have an all uppercase name, and do not end with a semicolon. Such 1369# function macros are typically used for boiler-plate code, and will confuse 1370# the parser if not removed. 1371 1372SKIP_FUNCTION_MACROS = YES 1373 1374#--------------------------------------------------------------------------- 1375# Configuration::additions related to external references 1376#--------------------------------------------------------------------------- 1377 1378# The TAGFILES option can be used to specify one or more tagfiles. 1379# Optionally an initial location of the external documentation 1380# can be added for each tagfile. The format of a tag file without 1381# this location is as follows: 1382# 1383# TAGFILES = file1 file2 ... 1384# Adding location for the tag files is done as follows: 1385# 1386# TAGFILES = file1=loc1 "file2 = loc2" ... 1387# where "loc1" and "loc2" can be relative or absolute paths or 1388# URLs. If a location is present for each tag, the installdox tool 1389# does not have to be run to correct the links. 1390# Note that each tag file must have a unique name 1391# (where the name does NOT include the path) 1392# If a tag file is not located in the directory in which doxygen 1393# is run, you must also specify the path to the tagfile here. 1394 1395TAGFILES = 1396 1397# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1398# a tag file that is based on the input files it reads. 1399 1400GENERATE_TAGFILE = 1401 1402# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1403# in the class index. If set to NO only the inherited external classes 1404# will be listed. 1405 1406ALLEXTERNALS = NO 1407 1408# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1409# in the modules index. If set to NO, only the current project's groups will 1410# be listed. 1411 1412EXTERNAL_GROUPS = YES 1413 1414# The PERL_PATH should be the absolute path and name of the perl script 1415# interpreter (i.e. the result of `which perl'). 1416 1417PERL_PATH = /usr/bin/perl 1418 1419#--------------------------------------------------------------------------- 1420# Configuration options related to the dot tool 1421#--------------------------------------------------------------------------- 1422 1423# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1424# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1425# or super classes. Setting the tag to NO turns the diagrams off. Note that 1426# this option is superseded by the HAVE_DOT option below. This is only a 1427# fallback. It is recommended to install and use dot, since it yields more 1428# powerful graphs. 1429 1430CLASS_DIAGRAMS = YES 1431 1432# You can define message sequence charts within doxygen comments using the \msc 1433# command. Doxygen will then run the mscgen tool (see 1434# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1435# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1436# the mscgen tool resides. If left empty the tool is assumed to be found in the 1437# default search path. 1438 1439MSCGEN_PATH = 1440 1441# If set to YES, the inheritance and collaboration graphs will hide 1442# inheritance and usage relations if the target is undocumented 1443# or is not a class. 1444 1445HIDE_UNDOC_RELATIONS = YES 1446 1447# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1448# available from the path. This tool is part of Graphviz, a graph visualization 1449# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1450# have no effect if this option is set to NO (the default) 1451 1452HAVE_DOT = YES 1453 1454# By default doxygen will write a font called FreeSans.ttf to the output 1455# directory and reference it in all dot files that doxygen generates. This 1456# font does not include all possible unicode characters however, so when you need 1457# these (or just want a differently looking font) you can specify the font name 1458# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1459# which can be done by putting it in a standard location or by setting the 1460# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1461# containing the font. 1462 1463DOT_FONTNAME = FreeSans 1464 1465# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1466# The default size is 10pt. 1467 1468DOT_FONTSIZE = 10 1469 1470# By default doxygen will tell dot to use the output directory to look for the 1471# FreeSans.ttf font (which doxygen will put there itself). If you specify a 1472# different font using DOT_FONTNAME you can set the path where dot 1473# can find it using this tag. 1474 1475DOT_FONTPATH = 1476 1477# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1478# will generate a graph for each documented class showing the direct and 1479# indirect inheritance relations. Setting this tag to YES will force the 1480# the CLASS_DIAGRAMS tag to NO. 1481 1482CLASS_GRAPH = YES 1483 1484# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1485# will generate a graph for each documented class showing the direct and 1486# indirect implementation dependencies (inheritance, containment, and 1487# class references variables) of the class with other documented classes. 1488 1489COLLABORATION_GRAPH = YES 1490 1491# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1492# will generate a graph for groups, showing the direct groups dependencies 1493 1494GROUP_GRAPHS = YES 1495 1496# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1497# collaboration diagrams in a style similar to the OMG's Unified Modeling 1498# Language. 1499 1500UML_LOOK = YES 1501 1502# If set to YES, the inheritance and collaboration graphs will show the 1503# relations between templates and their instances. 1504 1505TEMPLATE_RELATIONS = YES 1506 1507# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1508# tags are set to YES then doxygen will generate a graph for each documented 1509# file showing the direct and indirect include dependencies of the file with 1510# other documented files. 1511 1512INCLUDE_GRAPH = YES 1513 1514# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1515# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1516# documented header file showing the documented files that directly or 1517# indirectly include this file. 1518 1519INCLUDED_BY_GRAPH = YES 1520 1521# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1522# doxygen will generate a call dependency graph for every global function 1523# or class method. Note that enabling this option will significantly increase 1524# the time of a run. So in most cases it will be better to enable call graphs 1525# for selected functions only using the \callgraph command. 1526 1527CALL_GRAPH = NO 1528 1529# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1530# doxygen will generate a caller dependency graph for every global function 1531# or class method. Note that enabling this option will significantly increase 1532# the time of a run. So in most cases it will be better to enable caller 1533# graphs for selected functions only using the \callergraph command. 1534 1535CALLER_GRAPH = NO 1536 1537# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1538# will graphical hierarchy of all classes instead of a textual one. 1539 1540GRAPHICAL_HIERARCHY = YES 1541 1542# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1543# then doxygen will show the dependencies a directory has on other directories 1544# in a graphical way. The dependency relations are determined by the #include 1545# relations between the files in the directories. 1546 1547DIRECTORY_GRAPH = YES 1548 1549# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1550# generated by dot. Possible values are png, jpg, or gif 1551# If left blank png will be used. 1552 1553DOT_IMAGE_FORMAT = png 1554 1555# The tag DOT_PATH can be used to specify the path where the dot tool can be 1556# found. If left blank, it is assumed the dot tool can be found in the path. 1557 1558DOT_PATH = 1559 1560# The DOTFILE_DIRS tag can be used to specify one or more directories that 1561# contain dot files that are included in the documentation (see the 1562# \dotfile command). 1563 1564DOTFILE_DIRS = 1565 1566# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1567# nodes that will be shown in the graph. If the number of nodes in a graph 1568# becomes larger than this value, doxygen will truncate the graph, which is 1569# visualized by representing a node as a red box. Note that doxygen if the 1570# number of direct children of the root node in a graph is already larger than 1571# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1572# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1573 1574DOT_GRAPH_MAX_NODES = 50 1575 1576# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1577# graphs generated by dot. A depth value of 3 means that only nodes reachable 1578# from the root by following a path via at most 3 edges will be shown. Nodes 1579# that lay further from the root node will be omitted. Note that setting this 1580# option to 1 or 2 may greatly reduce the computation time needed for large 1581# code bases. Also note that the size of a graph can be further restricted by 1582# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1583 1584MAX_DOT_GRAPH_DEPTH = 1000 1585 1586# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1587# background. This is disabled by default, because dot on Windows does not 1588# seem to support this out of the box. Warning: Depending on the platform used, 1589# enabling this option may lead to badly anti-aliased labels on the edges of 1590# a graph (i.e. they become hard to read). 1591 1592DOT_TRANSPARENT = NO 1593 1594# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1595# files in one run (i.e. multiple -o and -T options on the command line). This 1596# makes dot run faster, but since only newer versions of dot (>1.8.10) 1597# support this, this feature is disabled by default. 1598 1599DOT_MULTI_TARGETS = YES 1600 1601# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1602# generate a legend page explaining the meaning of the various boxes and 1603# arrows in the dot generated graphs. 1604 1605GENERATE_LEGEND = YES 1606 1607# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1608# remove the intermediate dot files that are used to generate 1609# the various graphs. 1610 1611DOT_CLEANUP = YES 1612