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