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