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