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