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