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