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