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