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