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