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