1# Doxyfile 1.4.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# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 18# by quotes) that should identify the project. 19 20# XX - changed by weasel 21PROJECT_NAME = OpenPGP:SDK 22 23# The PROJECT_NUMBER tag can be used to enter a project or revision number. 24# This could be handy for archiving the generated documentation or 25# if some version control system is used. 26 27PROJECT_NUMBER = 28 29# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 30# base path where the generated documentation will be put. 31# If a relative path is entered, it will be relative to the location 32# where doxygen was started. If left blank the current directory will be used. 33 34OUTPUT_DIRECTORY = doxy-user 35 36# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 37# 4096 sub-directories (in 2 levels) under the output directory of each output 38# format and will distribute the generated files over these directories. 39# Enabling this option can be useful when feeding doxygen a huge amount of 40# source files, where putting all generated files in the same directory would 41# otherwise cause performance problems for the file system. 42 43CREATE_SUBDIRS = NO 44 45# The OUTPUT_LANGUAGE tag is used to specify the language in which all 46# documentation generated by doxygen is written. Doxygen will use this 47# information to generate all constant output in the proper language. 48# The default language is English, other supported languages are: 49# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 50# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 51# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 52# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 53# Swedish, and Ukrainian. 54 55OUTPUT_LANGUAGE = English 56 57# This tag can be used to specify the encoding used in the generated output. 58# The encoding is not always determined by the language that is chosen, 59# but also whether or not the output is meant for Windows or non-Windows users. 60# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 61# forces the Windows encoding (this is the default for the Windows binary), 62# whereas setting the tag to NO uses a Unix-style encoding (the default for 63# all platforms other than Windows). 64 65USE_WINDOWS_ENCODING = NO 66 67# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 68# include brief member descriptions after the members that are listed in 69# the file and class documentation (similar to JavaDoc). 70# Set to NO to disable this. 71 72BRIEF_MEMBER_DESC = YES 73 74# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 75# the brief description of a member or function before the detailed description. 76# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 77# brief descriptions will be completely suppressed. 78 79REPEAT_BRIEF = YES 80 81# This tag implements a quasi-intelligent brief description abbreviator 82# that is used to form the text in various listings. Each string 83# in this list, if found as the leading text of the brief description, will be 84# stripped from the text and the result after processing the whole list, is 85# used as the annotated text. Otherwise, the brief description is used as-is. 86# If left blank, the following values are used ("$name" is automatically 87# replaced with the name of the entity): "The $name class" "The $name widget" 88# "The $name file" "is" "provides" "specifies" "contains" 89# "represents" "a" "an" "the" 90 91ABBREVIATE_BRIEF = 92 93# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 94# Doxygen will generate a detailed section even if there is only a brief 95# description. 96 97ALWAYS_DETAILED_SEC = NO 98 99# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 100# inherited members of a class in the documentation of that class as if those 101# members were ordinary class members. Constructors, destructors and assignment 102# operators of the base classes will not be shown. 103 104INLINE_INHERITED_MEMB = NO 105 106# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 107# path before files name in the file list and in the header files. If set 108# to NO the shortest path that makes the file name unique will be used. 109 110FULL_PATH_NAMES = NO 111 112# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 113# can be used to strip a user-defined part of the path. Stripping is 114# only done if one of the specified strings matches the left-hand part of 115# the path. The tag can be used to show relative paths in the file list. 116# If left blank the directory from which doxygen is run is used as the 117# path to strip. 118 119STRIP_FROM_PATH = 120 121# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 122# the path mentioned in the documentation of a class, which tells 123# the reader which header file to include in order to use a class. 124# If left blank only the name of the header file containing the class 125# definition is used. Otherwise one should specify the include paths that 126# are normally passed to the compiler using the -I flag. 127 128STRIP_FROM_INC_PATH = 129 130# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 131# (but less readable) file names. This can be useful is your file systems 132# doesn't support long names like on DOS, Mac, or CD-ROM. 133 134SHORT_NAMES = NO 135 136# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 137# will interpret the first line (until the first dot) of a JavaDoc-style 138# comment as the brief description. If set to NO, the JavaDoc 139# comments will behave just like the Qt-style comments (thus requiring an 140# explicit @brief command for a brief description. 141 142# XX - changed by weasel 143JAVADOC_AUTOBRIEF = YES 144 145# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 146# treat a multi-line C++ special comment block (i.e. a block of //! or /// 147# comments) as a brief description. This used to be the default behaviour. 148# The new default is to treat a multi-line C++ comment block as a detailed 149# description. Set this tag to YES if you prefer the old behaviour instead. 150 151MULTILINE_CPP_IS_BRIEF = NO 152 153# If the DETAILS_AT_TOP tag is set to YES then Doxygen 154# will output the detailed description near the top, like JavaDoc. 155# If set to NO, the detailed description appears after the member 156# documentation. 157 158DETAILS_AT_TOP = NO 159 160# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 161# member inherits the documentation from any documented member that it 162# re-implements. 163 164INHERIT_DOCS = YES 165 166# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 167# tag is set to YES, then doxygen will reuse the documentation of the first 168# member in the group (if any) for the other members of the group. By default 169# all members of a group must be documented explicitly. 170 171DISTRIBUTE_GROUP_DOC = NO 172 173# The TAB_SIZE tag can be used to set the number of spaces in a tab. 174# Doxygen uses this value to replace tabs by spaces in code fragments. 175 176TAB_SIZE = 8 177 178# This tag can be used to specify a number of aliases that acts 179# as commands in the documentation. An alias has the form "name=value". 180# For example adding "sideeffect=\par Side Effects:\n" will allow you to 181# put the command \sideeffect (or @sideeffect) in the documentation, which 182# will result in a user-defined paragraph with heading "Side Effects:". 183# You can put \n's in the value part of an alias to insert newlines. 184 185ALIASES = 186 187# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 188# sources only. Doxygen will then generate output that is more tailored for C. 189# For instance, some of the names that are used will be different. The list 190# of all members will be omitted, etc. 191 192OPTIMIZE_OUTPUT_FOR_C = YES 193 194# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 195# only. Doxygen will then generate output that is more tailored for Java. 196# For instance, namespaces will be presented as packages, qualified scopes 197# will look different, etc. 198 199OPTIMIZE_OUTPUT_JAVA = NO 200 201# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 202# the same type (for instance a group of public functions) to be put as a 203# subgroup of that type (e.g. under the Public Functions section). Set it to 204# NO to prevent subgrouping. Alternatively, this can be done per class using 205# the \nosubgrouping command. 206 207SUBGROUPING = YES 208 209#--------------------------------------------------------------------------- 210# Build related configuration options 211#--------------------------------------------------------------------------- 212 213# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 214# documentation are documented, even if no documentation was available. 215# Private class members and static file members will be hidden unless 216# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 217 218EXTRACT_ALL = NO 219 220# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 221# will be included in the documentation. 222 223EXTRACT_PRIVATE = NO 224 225# If the EXTRACT_STATIC tag is set to YES all static members of a file 226# will be included in the documentation. 227 228EXTRACT_STATIC = NO 229 230# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 231# defined locally in source files will be included in the documentation. 232# If set to NO only classes defined in header files are included. 233 234EXTRACT_LOCAL_CLASSES = NO 235 236# This flag is only useful for Objective-C code. When set to YES local 237# methods, which are defined in the implementation section but not in 238# the interface are included in the documentation. 239# If set to NO (the default) only methods in the interface are included. 240 241EXTRACT_LOCAL_METHODS = NO 242 243# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 244# undocumented members of documented classes, files or namespaces. 245# If set to NO (the default) these members will be included in the 246# various overviews, but no documentation section is generated. 247# This option has no effect if EXTRACT_ALL is enabled. 248 249HIDE_UNDOC_MEMBERS = NO 250 251# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 252# undocumented classes that are normally visible in the class hierarchy. 253# If set to NO (the default) these classes will be included in the various 254# overviews. This option has no effect if EXTRACT_ALL is enabled. 255 256HIDE_UNDOC_CLASSES = NO 257 258# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 259# friend (class|struct|union) declarations. 260# If set to NO (the default) these declarations will be included in the 261# documentation. 262 263HIDE_FRIEND_COMPOUNDS = NO 264 265# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 266# documentation blocks found inside the body of a function. 267# If set to NO (the default) these blocks will be appended to the 268# function's detailed documentation block. 269 270HIDE_IN_BODY_DOCS = NO 271 272# The INTERNAL_DOCS tag determines if documentation 273# that is typed after a \internal command is included. If the tag is set 274# to NO (the default) then the documentation will be excluded. 275# Set it to YES to include the internal documentation. 276 277INTERNAL_DOCS = NO 278 279# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 280# file names in lower-case letters. If set to YES upper-case letters are also 281# allowed. This is useful if you have classes or files whose names only differ 282# in case and if your file system supports case sensitive file names. Windows 283# and Mac users are advised to set this option to NO. 284 285CASE_SENSE_NAMES = YES 286 287# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 288# will show members with their full class and namespace scopes in the 289# documentation. If set to YES the scope will be hidden. 290 291HIDE_SCOPE_NAMES = NO 292 293# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 294# will put a list of the files that are included by a file in the documentation 295# of that file. 296 297SHOW_INCLUDE_FILES = YES 298 299# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 300# is inserted in the documentation for inline members. 301 302INLINE_INFO = YES 303 304# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 305# will sort the (detailed) documentation of file and class members 306# alphabetically by member name. If set to NO the members will appear in 307# declaration order. 308 309SORT_MEMBER_DOCS = YES 310 311# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 312# brief documentation of file, namespace and class members alphabetically 313# by member name. If set to NO (the default) the members will appear in 314# declaration order. 315 316SORT_BRIEF_DOCS = NO 317 318# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 319# sorted by fully-qualified names, including namespaces. If set to 320# NO (the default), the class list will be sorted only by class name, 321# not including the namespace part. 322# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 323# Note: This option applies only to the class list, not to the 324# alphabetical list. 325 326SORT_BY_SCOPE_NAME = NO 327 328# The GENERATE_TODOLIST tag can be used to enable (YES) or 329# disable (NO) the todo list. This list is created by putting \todo 330# commands in the documentation. 331 332GENERATE_TODOLIST = YES 333 334# The GENERATE_TESTLIST tag can be used to enable (YES) or 335# disable (NO) the test list. This list is created by putting \test 336# commands in the documentation. 337 338GENERATE_TESTLIST = YES 339 340# The GENERATE_BUGLIST tag can be used to enable (YES) or 341# disable (NO) the bug list. This list is created by putting \bug 342# commands in the documentation. 343 344GENERATE_BUGLIST = YES 345 346# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 347# disable (NO) the deprecated list. This list is created by putting 348# \deprecated commands in the documentation. 349 350GENERATE_DEPRECATEDLIST= YES 351 352# The ENABLED_SECTIONS tag can be used to enable conditional 353# documentation sections, marked by \if sectionname ... \endif. 354 355ENABLED_SECTIONS = 356 357# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 358# the initial value of a variable or define consists of for it to appear in 359# the documentation. If the initializer consists of more lines than specified 360# here it will be hidden. Use a value of 0 to hide initializers completely. 361# The appearance of the initializer of individual variables and defines in the 362# documentation can be controlled using \showinitializer or \hideinitializer 363# command in the documentation regardless of this setting. 364 365MAX_INITIALIZER_LINES = 30 366 367# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 368# at the bottom of the documentation of classes and structs. If set to YES the 369# list will mention the files that were used to generate the documentation. 370 371SHOW_USED_FILES = YES 372 373# If the sources in your project are distributed over multiple directories 374# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 375# in the documentation. 376 377SHOW_DIRECTORIES = YES 378 379# The FILE_VERSION_FILTER tag can be used to specify a program or script that 380# doxygen should invoke to get the current version for each file (typically from the 381# version control system). Doxygen will invoke the program by executing (via 382# popen()) the command <command> <input-file>, where <command> is the value of 383# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 384# provided by doxygen. Whatever the progam writes to standard output 385# is used as the file version. See the manual for examples. 386 387FILE_VERSION_FILTER = 388 389#--------------------------------------------------------------------------- 390# configuration options related to warning and progress messages 391#--------------------------------------------------------------------------- 392 393# The QUIET tag can be used to turn on/off the messages that are generated 394# by doxygen. Possible values are YES and NO. If left blank NO is used. 395 396QUIET = NO 397 398# The WARNINGS tag can be used to turn on/off the warning messages that are 399# generated by doxygen. Possible values are YES and NO. If left blank 400# NO is used. 401 402WARNINGS = YES 403 404# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 405# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 406# automatically be disabled. 407 408WARN_IF_UNDOCUMENTED = YES 409 410# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 411# potential errors in the documentation, such as not documenting some 412# parameters in a documented function, or documenting parameters that 413# don't exist or using markup commands wrongly. 414 415WARN_IF_DOC_ERROR = YES 416 417# This WARN_NO_PARAMDOC option can be abled to get warnings for 418# functions that are documented, but have no documentation for their parameters 419# or return value. If set to NO (the default) doxygen will only warn about 420# wrong or incomplete parameter documentation, but not about the absence of 421# documentation. 422 423WARN_NO_PARAMDOC = NO 424 425# The WARN_FORMAT tag determines the format of the warning messages that 426# doxygen can produce. The string should contain the $file, $line, and $text 427# tags, which will be replaced by the file and line number from which the 428# warning originated and the warning text. Optionally the format may contain 429# $version, which will be replaced by the version of the file (if it could 430# be obtained via FILE_VERSION_FILTER) 431 432WARN_FORMAT = "$file:$line: $text" 433 434# The WARN_LOGFILE tag can be used to specify a file to which warning 435# and error messages should be written. If left blank the output is written 436# to stderr. 437 438WARN_LOGFILE = 439 440#--------------------------------------------------------------------------- 441# configuration options related to the input files 442#--------------------------------------------------------------------------- 443 444# The INPUT tag can be used to specify the files and/or directories that contain 445# documented source files. You may enter file names like "myfile.cpp" or 446# directories like "/usr/src/myproject". Separate the files or directories 447# with spaces. 448 449# XX - changed by weasel 450INPUT = ../src ../src/lib ../include/openpgpsdk 451 452# If the value of the INPUT tag contains directories, you can use the 453# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 454# and *.h) to filter out the source-files in the directories. If left 455# blank the following patterns are tested: 456# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 457# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm 458 459FILE_PATTERNS = 460 461# The RECURSIVE tag can be used to turn specify whether or not subdirectories 462# should be searched for input files as well. Possible values are YES and NO. 463# If left blank NO is used. 464 465RECURSIVE = NO 466 467# The EXCLUDE tag can be used to specify files and/or directories that should 468# excluded from the INPUT source files. This way you can easily exclude a 469# subdirectory from a directory tree whose root is specified with the INPUT tag. 470 471EXCLUDE = 472 473# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 474# directories that are symbolic links (a Unix filesystem feature) are excluded 475# from the input. 476 477EXCLUDE_SYMLINKS = NO 478 479# If the value of the INPUT tag contains directories, you can use the 480# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 481# certain files from those directories. 482 483EXCLUDE_PATTERNS = 484 485# The EXAMPLE_PATH tag can be used to specify one or more files or 486# directories that contain example code fragments that are included (see 487# the \include command). 488 489EXAMPLE_PATH = ../src/examples 490 491# If the value of the EXAMPLE_PATH tag contains directories, you can use the 492# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 493# and *.h) to filter out the source-files in the directories. If left 494# blank all files are included. 495 496EXAMPLE_PATTERNS = 497 498# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 499# searched for input files to be used with the \include or \dontinclude 500# commands irrespective of the value of the RECURSIVE tag. 501# Possible values are YES and NO. If left blank NO is used. 502 503EXAMPLE_RECURSIVE = NO 504 505# The IMAGE_PATH tag can be used to specify one or more files or 506# directories that contain image that are included in the documentation (see 507# the \image command). 508 509IMAGE_PATH = 510 511# The INPUT_FILTER tag can be used to specify a program that doxygen should 512# invoke to filter for each input file. Doxygen will invoke the filter program 513# by executing (via popen()) the command <filter> <input-file>, where <filter> 514# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 515# input file. Doxygen will then use the output that the filter program writes 516# to standard output. If FILTER_PATTERNS is specified, this tag will be 517# ignored. 518 519INPUT_FILTER = 520 521# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 522# basis. Doxygen will compare the file name with each pattern and apply the 523# filter if there is a match. The filters are a list of the form: 524# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 525# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 526# is applied to all files. 527 528FILTER_PATTERNS = 529 530# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 531# INPUT_FILTER) will be used to filter the input files when producing source 532# files to browse (i.e. when SOURCE_BROWSER is set to YES). 533 534FILTER_SOURCE_FILES = NO 535 536#--------------------------------------------------------------------------- 537# configuration options related to source browsing 538#--------------------------------------------------------------------------- 539 540# If the SOURCE_BROWSER tag is set to YES then a list of source files will 541# be generated. Documented entities will be cross-referenced with these sources. 542# Note: To get rid of all source code in the generated output, make sure also 543# VERBATIM_HEADERS is set to NO. 544 545SOURCE_BROWSER = NO 546 547# Setting the INLINE_SOURCES tag to YES will include the body 548# of functions and classes directly in the documentation. 549 550INLINE_SOURCES = NO 551 552# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 553# doxygen to hide any special comment blocks from generated source code 554# fragments. Normal C and C++ comments will always remain visible. 555 556STRIP_CODE_COMMENTS = YES 557 558# If the REFERENCED_BY_RELATION tag is set to YES (the default) 559# then for each documented function all documented 560# functions referencing it will be listed. 561 562REFERENCED_BY_RELATION = YES 563 564# If the REFERENCES_RELATION tag is set to YES (the default) 565# then for each documented function all documented entities 566# called/used by that function will be listed. 567 568REFERENCES_RELATION = YES 569 570# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 571# will generate a verbatim copy of the header file for each class for 572# which an include is specified. Set to NO to disable this. 573 574VERBATIM_HEADERS = YES 575 576#--------------------------------------------------------------------------- 577# configuration options related to the alphabetical class index 578#--------------------------------------------------------------------------- 579 580# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 581# of all compounds will be generated. Enable this if the project 582# contains a lot of classes, structs, unions or interfaces. 583 584ALPHABETICAL_INDEX = NO 585 586# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 587# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 588# in which this list will be split (can be a number in the range [1..20]) 589 590COLS_IN_ALPHA_INDEX = 5 591 592# In case all classes in a project start with a common prefix, all 593# classes will be put under the same header in the alphabetical index. 594# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 595# should be ignored while generating the index headers. 596 597IGNORE_PREFIX = 598 599#--------------------------------------------------------------------------- 600# configuration options related to the HTML output 601#--------------------------------------------------------------------------- 602 603# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 604# generate HTML output. 605 606GENERATE_HTML = YES 607 608# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 609# If a relative path is entered the value of OUTPUT_DIRECTORY will be 610# put in front of it. If left blank `html' will be used as the default path. 611 612HTML_OUTPUT = html 613 614# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 615# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 616# doxygen will generate files with .html extension. 617 618HTML_FILE_EXTENSION = .html 619 620# The HTML_HEADER tag can be used to specify a personal HTML header for 621# each generated HTML page. If it is left blank doxygen will generate a 622# standard header. 623 624HTML_HEADER = 625 626# The HTML_FOOTER tag can be used to specify a personal HTML footer for 627# each generated HTML page. If it is left blank doxygen will generate a 628# standard footer. 629 630HTML_FOOTER = 631 632# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 633# style sheet that is used by each HTML page. It can be used to 634# fine-tune the look of the HTML output. If the tag is left blank doxygen 635# will generate a default style sheet. Note that doxygen will try to copy 636# the style sheet file to the HTML output directory, so don't put your own 637# stylesheet in the HTML output directory as well, or it will be erased! 638 639HTML_STYLESHEET = 640 641# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 642# files or namespaces will be aligned in HTML using tables. If set to 643# NO a bullet list will be used. 644 645HTML_ALIGN_MEMBERS = YES 646 647# If the GENERATE_HTMLHELP tag is set to YES, additional index files 648# will be generated that can be used as input for tools like the 649# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 650# of the generated HTML documentation. 651 652GENERATE_HTMLHELP = NO 653 654# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 655# be used to specify the file name of the resulting .chm file. You 656# can add a path in front of the file if the result should not be 657# written to the html output directory. 658 659CHM_FILE = 660 661# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 662# be used to specify the location (absolute path including file name) of 663# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 664# the HTML help compiler on the generated index.hhp. 665 666HHC_LOCATION = 667 668# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 669# controls if a separate .chi index file is generated (YES) or that 670# it should be included in the master .chm file (NO). 671 672GENERATE_CHI = NO 673 674# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 675# controls whether a binary table of contents is generated (YES) or a 676# normal table of contents (NO) in the .chm file. 677 678BINARY_TOC = NO 679 680# The TOC_EXPAND flag can be set to YES to add extra items for group members 681# to the contents of the HTML help documentation and to the tree view. 682 683TOC_EXPAND = NO 684 685# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 686# top of each HTML page. The value NO (the default) enables the index and 687# the value YES disables it. 688 689DISABLE_INDEX = NO 690 691# This tag can be used to set the number of enum values (range [1..20]) 692# that doxygen will group on one line in the generated HTML documentation. 693 694ENUM_VALUES_PER_LINE = 4 695 696# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 697# generated containing a tree-like index structure (just like the one that 698# is generated for HTML Help). For this to work a browser that supports 699# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 700# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 701# probably better off using the HTML help feature. 702 703GENERATE_TREEVIEW = YES 704 705# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 706# used to set the initial width (in pixels) of the frame in which the tree 707# is shown. 708 709TREEVIEW_WIDTH = 250 710 711#--------------------------------------------------------------------------- 712# configuration options related to the LaTeX output 713#--------------------------------------------------------------------------- 714 715# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 716# generate Latex output. 717 718GENERATE_LATEX = YES 719 720# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 721# If a relative path is entered the value of OUTPUT_DIRECTORY will be 722# put in front of it. If left blank `latex' will be used as the default path. 723 724LATEX_OUTPUT = latex 725 726# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 727# invoked. If left blank `latex' will be used as the default command name. 728 729LATEX_CMD_NAME = latex 730 731# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 732# generate index for LaTeX. If left blank `makeindex' will be used as the 733# default command name. 734 735MAKEINDEX_CMD_NAME = makeindex 736 737# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 738# LaTeX documents. This may be useful for small projects and may help to 739# save some trees in general. 740 741COMPACT_LATEX = NO 742 743# The PAPER_TYPE tag can be used to set the paper type that is used 744# by the printer. Possible values are: a4, a4wide, letter, legal and 745# executive. If left blank a4wide will be used. 746 747PAPER_TYPE = a4wide 748 749# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 750# packages that should be included in the LaTeX output. 751 752EXTRA_PACKAGES = 753 754# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 755# the generated latex document. The header should contain everything until 756# the first chapter. If it is left blank doxygen will generate a 757# standard header. Notice: only use this tag if you know what you are doing! 758 759LATEX_HEADER = 760 761# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 762# is prepared for conversion to pdf (using ps2pdf). The pdf file will 763# contain links (just like the HTML output) instead of page references 764# This makes the output suitable for online browsing using a pdf viewer. 765 766PDF_HYPERLINKS = NO 767 768# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 769# plain latex in the generated Makefile. Set this option to YES to get a 770# higher quality PDF documentation. 771 772USE_PDFLATEX = NO 773 774# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 775# command to the generated LaTeX files. This will instruct LaTeX to keep 776# running if errors occur, instead of asking the user for help. 777# This option is also used when generating formulas in HTML. 778 779LATEX_BATCHMODE = NO 780 781# If LATEX_HIDE_INDICES is set to YES then doxygen will not 782# include the index chapters (such as File Index, Compound Index, etc.) 783# in the output. 784 785LATEX_HIDE_INDICES = NO 786 787#--------------------------------------------------------------------------- 788# configuration options related to the RTF output 789#--------------------------------------------------------------------------- 790 791# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 792# The RTF output is optimized for Word 97 and may not look very pretty with 793# other RTF readers or editors. 794 795GENERATE_RTF = NO 796 797# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 798# If a relative path is entered the value of OUTPUT_DIRECTORY will be 799# put in front of it. If left blank `rtf' will be used as the default path. 800 801RTF_OUTPUT = rtf 802 803# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 804# RTF documents. This may be useful for small projects and may help to 805# save some trees in general. 806 807COMPACT_RTF = NO 808 809# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 810# will contain hyperlink fields. The RTF file will 811# contain links (just like the HTML output) instead of page references. 812# This makes the output suitable for online browsing using WORD or other 813# programs which support those fields. 814# Note: wordpad (write) and others do not support links. 815 816RTF_HYPERLINKS = NO 817 818# Load stylesheet definitions from file. Syntax is similar to doxygen's 819# config file, i.e. a series of assignments. You only have to provide 820# replacements, missing definitions are set to their default value. 821 822RTF_STYLESHEET_FILE = 823 824# Set optional variables used in the generation of an rtf document. 825# Syntax is similar to doxygen's config file. 826 827RTF_EXTENSIONS_FILE = 828 829#--------------------------------------------------------------------------- 830# configuration options related to the man page output 831#--------------------------------------------------------------------------- 832 833# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 834# generate man pages 835 836GENERATE_MAN = YES 837 838# The MAN_OUTPUT tag is used to specify where the man pages will be put. 839# If a relative path is entered the value of OUTPUT_DIRECTORY will be 840# put in front of it. If left blank `man' will be used as the default path. 841 842MAN_OUTPUT = man 843 844# The MAN_EXTENSION tag determines the extension that is added to 845# the generated man pages (default is the subroutine's section .3) 846 847MAN_EXTENSION = .3 848 849# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 850# then it will generate one additional man file for each entity 851# documented in the real man page(s). These additional files 852# only source the real man page, but without them the man command 853# would be unable to find the correct page. The default is NO. 854 855MAN_LINKS = NO 856 857#--------------------------------------------------------------------------- 858# configuration options related to the XML output 859#--------------------------------------------------------------------------- 860 861# If the GENERATE_XML tag is set to YES Doxygen will 862# generate an XML file that captures the structure of 863# the code including all documentation. 864 865GENERATE_XML = NO 866 867# The XML_OUTPUT tag is used to specify where the XML pages will be put. 868# If a relative path is entered the value of OUTPUT_DIRECTORY will be 869# put in front of it. If left blank `xml' will be used as the default path. 870 871XML_OUTPUT = xml 872 873# The XML_SCHEMA tag can be used to specify an XML schema, 874# which can be used by a validating XML parser to check the 875# syntax of the XML files. 876 877XML_SCHEMA = 878 879# The XML_DTD tag can be used to specify an XML DTD, 880# which can be used by a validating XML parser to check the 881# syntax of the XML files. 882 883XML_DTD = 884 885# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 886# dump the program listings (including syntax highlighting 887# and cross-referencing information) to the XML output. Note that 888# enabling this will significantly increase the size of the XML output. 889 890XML_PROGRAMLISTING = YES 891 892#--------------------------------------------------------------------------- 893# configuration options for the AutoGen Definitions output 894#--------------------------------------------------------------------------- 895 896# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 897# generate an AutoGen Definitions (see autogen.sf.net) file 898# that captures the structure of the code including all 899# documentation. Note that this feature is still experimental 900# and incomplete at the moment. 901 902GENERATE_AUTOGEN_DEF = NO 903 904#--------------------------------------------------------------------------- 905# configuration options related to the Perl module output 906#--------------------------------------------------------------------------- 907 908# If the GENERATE_PERLMOD tag is set to YES Doxygen will 909# generate a Perl module file that captures the structure of 910# the code including all documentation. Note that this 911# feature is still experimental and incomplete at the 912# moment. 913 914GENERATE_PERLMOD = NO 915 916# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 917# the necessary Makefile rules, Perl scripts and LaTeX code to be able 918# to generate PDF and DVI output from the Perl module output. 919 920PERLMOD_LATEX = NO 921 922# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 923# nicely formatted so it can be parsed by a human reader. This is useful 924# if you want to understand what is going on. On the other hand, if this 925# tag is set to NO the size of the Perl module output will be much smaller 926# and Perl will parse it just the same. 927 928PERLMOD_PRETTY = YES 929 930# The names of the make variables in the generated doxyrules.make file 931# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 932# This is useful so different doxyrules.make files included by the same 933# Makefile don't overwrite each other's variables. 934 935PERLMOD_MAKEVAR_PREFIX = 936 937#--------------------------------------------------------------------------- 938# Configuration options related to the preprocessor 939#--------------------------------------------------------------------------- 940 941# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 942# evaluate all C-preprocessor directives found in the sources and include 943# files. 944 945ENABLE_PREPROCESSING = YES 946 947# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 948# names in the source code. If set to NO (the default) only conditional 949# compilation will be performed. Macro expansion can be done in a controlled 950# way by setting EXPAND_ONLY_PREDEF to YES. 951 952MACRO_EXPANSION = NO 953 954# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 955# then the macro expansion is limited to the macros specified with the 956# PREDEFINED and EXPAND_AS_PREDEFINED tags. 957 958EXPAND_ONLY_PREDEF = NO 959 960# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 961# in the INCLUDE_PATH (see below) will be search if a #include is found. 962 963SEARCH_INCLUDES = YES 964 965# The INCLUDE_PATH tag can be used to specify one or more directories that 966# contain include files that are not input files but should be processed by 967# the preprocessor. 968 969INCLUDE_PATH = 970 971# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 972# patterns (like *.h and *.hpp) to filter out the header-files in the 973# directories. If left blank, the patterns specified with FILE_PATTERNS will 974# be used. 975 976INCLUDE_FILE_PATTERNS = 977 978# The PREDEFINED tag can be used to specify one or more macro names that 979# are defined before the preprocessor is started (similar to the -D option of 980# gcc). The argument of the tag is a list of macros of the form: name 981# or name=definition (no spaces). If the definition and the = are 982# omitted =1 is assumed. To prevent a macro definition from being 983# undefined via #undef or recursively expanded use the := operator 984# instead of the = operator. 985 986PREDEFINED = 987 988# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 989# this tag can be used to specify a list of macro names that should be expanded. 990# The macro definition that is found in the sources will be used. 991# Use the PREDEFINED tag if you want to use a different macro definition. 992 993EXPAND_AS_DEFINED = 994 995# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 996# doxygen's preprocessor will remove all function-like macros that are alone 997# on a line, have an all uppercase name, and do not end with a semicolon. Such 998# function macros are typically used for boiler-plate code, and will confuse 999# the parser if not removed. 1000 1001SKIP_FUNCTION_MACROS = YES 1002 1003#--------------------------------------------------------------------------- 1004# Configuration::additions related to external references 1005#--------------------------------------------------------------------------- 1006 1007# The TAGFILES option can be used to specify one or more tagfiles. 1008# Optionally an initial location of the external documentation 1009# can be added for each tagfile. The format of a tag file without 1010# this location is as follows: 1011# TAGFILES = file1 file2 ... 1012# Adding location for the tag files is done as follows: 1013# TAGFILES = file1=loc1 "file2 = loc2" ... 1014# where "loc1" and "loc2" can be relative or absolute paths or 1015# URLs. If a location is present for each tag, the installdox tool 1016# does not have to be run to correct the links. 1017# Note that each tag file must have a unique name 1018# (where the name does NOT include the path) 1019# If a tag file is not located in the directory in which doxygen 1020# is run, you must also specify the path to the tagfile here. 1021 1022TAGFILES = 1023 1024# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1025# a tag file that is based on the input files it reads. 1026 1027GENERATE_TAGFILE = 1028 1029# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1030# in the class index. If set to NO only the inherited external classes 1031# will be listed. 1032 1033ALLEXTERNALS = NO 1034 1035# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1036# in the modules index. If set to NO, only the current project's groups will 1037# be listed. 1038 1039EXTERNAL_GROUPS = YES 1040 1041# The PERL_PATH should be the absolute path and name of the perl script 1042# interpreter (i.e. the result of `which perl'). 1043 1044PERL_PATH = /usr/bin/perl 1045 1046#--------------------------------------------------------------------------- 1047# Configuration options related to the dot tool 1048#--------------------------------------------------------------------------- 1049 1050# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1051# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1052# or super classes. Setting the tag to NO turns the diagrams off. Note that 1053# this option is superseded by the HAVE_DOT option below. This is only a 1054# fallback. It is recommended to install and use dot, since it yields more 1055# powerful graphs. 1056 1057CLASS_DIAGRAMS = YES 1058 1059# If set to YES, the inheritance and collaboration graphs will hide 1060# inheritance and usage relations if the target is undocumented 1061# or is not a class. 1062 1063HIDE_UNDOC_RELATIONS = YES 1064 1065# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1066# available from the path. This tool is part of Graphviz, a graph visualization 1067# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1068# have no effect if this option is set to NO (the default) 1069 1070HAVE_DOT = NO 1071 1072# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1073# will generate a graph for each documented class showing the direct and 1074# indirect inheritance relations. Setting this tag to YES will force the 1075# the CLASS_DIAGRAMS tag to NO. 1076 1077CLASS_GRAPH = YES 1078 1079# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1080# will generate a graph for each documented class showing the direct and 1081# indirect implementation dependencies (inheritance, containment, and 1082# class references variables) of the class with other documented classes. 1083 1084COLLABORATION_GRAPH = YES 1085 1086# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1087# will generate a graph for groups, showing the direct groups dependencies 1088 1089GROUP_GRAPHS = YES 1090 1091# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1092# collaboration diagrams in a style similar to the OMG's Unified Modeling 1093# Language. 1094 1095UML_LOOK = NO 1096 1097# If set to YES, the inheritance and collaboration graphs will show the 1098# relations between templates and their instances. 1099 1100TEMPLATE_RELATIONS = NO 1101 1102# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1103# tags are set to YES then doxygen will generate a graph for each documented 1104# file showing the direct and indirect include dependencies of the file with 1105# other documented files. 1106 1107INCLUDE_GRAPH = YES 1108 1109# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1110# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1111# documented header file showing the documented files that directly or 1112# indirectly include this file. 1113 1114INCLUDED_BY_GRAPH = YES 1115 1116# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1117# generate a call dependency graph for every global function or class method. 1118# Note that enabling this option will significantly increase the time of a run. 1119# So in most cases it will be better to enable call graphs for selected 1120# functions only using the \callgraph command. 1121 1122CALL_GRAPH = NO 1123 1124# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1125# will graphical hierarchy of all classes instead of a textual one. 1126 1127GRAPHICAL_HIERARCHY = YES 1128 1129# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1130# then doxygen will show the dependencies a directory has on other directories 1131# in a graphical way. The dependency relations are determined by the #include 1132# relations between the files in the directories. 1133 1134DIRECTORY_GRAPH = YES 1135 1136# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1137# generated by dot. Possible values are png, jpg, or gif 1138# If left blank png will be used. 1139 1140DOT_IMAGE_FORMAT = png 1141 1142# The tag DOT_PATH can be used to specify the path where the dot tool can be 1143# found. If left blank, it is assumed the dot tool can be found in the path. 1144 1145DOT_PATH = 1146 1147# The DOTFILE_DIRS tag can be used to specify one or more directories that 1148# contain dot files that are included in the documentation (see the 1149# \dotfile command). 1150 1151DOTFILE_DIRS = 1152 1153# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 1154# (in pixels) of the graphs generated by dot. If a graph becomes larger than 1155# this value, doxygen will try to truncate the graph, so that it fits within 1156# the specified constraint. Beware that most browsers cannot cope with very 1157# large images. 1158 1159MAX_DOT_GRAPH_WIDTH = 1024 1160 1161# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 1162# (in pixels) of the graphs generated by dot. If a graph becomes larger than 1163# this value, doxygen will try to truncate the graph, so that it fits within 1164# the specified constraint. Beware that most browsers cannot cope with very 1165# large images. 1166 1167MAX_DOT_GRAPH_HEIGHT = 1024 1168 1169# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1170# graphs generated by dot. A depth value of 3 means that only nodes reachable 1171# from the root by following a path via at most 3 edges will be shown. Nodes 1172# that lay further from the root node will be omitted. Note that setting this 1173# option to 1 or 2 may greatly reduce the computation time needed for large 1174# code bases. Also note that a graph may be further truncated if the graph's 1175# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 1176# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 1177# the graph is not depth-constrained. 1178 1179MAX_DOT_GRAPH_DEPTH = 0 1180 1181# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1182# background. This is disabled by default, which results in a white background. 1183# Warning: Depending on the platform used, enabling this option may lead to 1184# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1185# read). 1186 1187DOT_TRANSPARENT = NO 1188 1189# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1190# files in one run (i.e. multiple -o and -T options on the command line). This 1191# makes dot run faster, but since only newer versions of dot (>1.8.10) 1192# support this, this feature is disabled by default. 1193 1194DOT_MULTI_TARGETS = NO 1195 1196# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1197# generate a legend page explaining the meaning of the various boxes and 1198# arrows in the dot generated graphs. 1199 1200GENERATE_LEGEND = YES 1201 1202# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1203# remove the intermediate dot files that are used to generate 1204# the various graphs. 1205 1206DOT_CLEANUP = YES 1207 1208#--------------------------------------------------------------------------- 1209# Configuration::additions related to the search engine 1210#--------------------------------------------------------------------------- 1211 1212# The SEARCHENGINE tag specifies whether or not a search engine should be 1213# used. If set to NO the values of all tags below this one will be ignored. 1214 1215SEARCHENGINE = NO 1216