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