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