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 = YES 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 posix \ 643 storage \ 644 support \ 645 translation \ 646 ../../headers/os/app \ 647 ../../headers/os/drivers/fs_interface.h \ 648 ../../headers/os/drivers/USB3.h \ 649 ../../headers/os/drivers/USB_spec.h \ 650 ../../headers/os/game \ 651 ../../headers/os/interface \ 652 ../../headers/os/locale \ 653 ../../headers/os/media \ 654 ../../headers/os/midi2 \ 655 ../../headers/os/storage \ 656 ../../headers/os/support \ 657 ../../headers/os/translation \ 658 ../../headers/posix/syslog.h \ 659 ../../src/kits/game/GameProducer.h 660 661# This tag can be used to specify the character encoding of the source files 662# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 663# also the default input encoding. Doxygen uses libiconv (or the iconv built 664# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 665# the list of possible encodings. 666 667INPUT_ENCODING = UTF-8 668 669# If the value of the INPUT tag contains directories, you can use the 670# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 671# and *.h) to filter out the source-files in the directories. If left 672# blank the following patterns are tested: 673# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 674# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 675# *.f90 *.f *.for *.vhd *.vhdl 676 677FILE_PATTERNS = *.dox \ 678 *.h \ 679 *.c \ 680 *.cpp 681 682# The RECURSIVE tag can be used to turn specify whether or not subdirectories 683# should be searched for input files as well. Possible values are YES and NO. 684# If left blank NO is used. 685 686RECURSIVE = NO 687 688# The EXCLUDE tag can be used to specify files and/or directories that should 689# excluded from the INPUT source files. This way you can easily exclude a 690# subdirectory from a directory tree whose root is specified with the INPUT tag. 691# Note that relative paths are relative to directory from which doxygen is run. 692 693EXCLUDE = 694 695# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 696# directories that are symbolic links (a Unix file system feature) are excluded 697# from the input. 698 699EXCLUDE_SYMLINKS = NO 700 701# If the value of the INPUT tag contains directories, you can use the 702# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 703# certain files from those directories. Note that the wildcards are matched 704# against the file with absolute path, so to exclude all test directories 705# for example use the pattern */test/* 706 707EXCLUDE_PATTERNS = */libkernelppp/_KPPP* 708 709# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 710# (namespaces, classes, functions, etc.) that should be excluded from the 711# output. The symbol name can be a fully qualified name, a word, or if the 712# wildcard * is used, a substring. Examples: ANamespace, AClass, 713# AClass::ANamespace, ANamespace::*Test 714 715EXCLUDE_SYMBOLS = 716 717# The EXAMPLE_PATH tag can be used to specify one or more files or 718# directories that contain example code fragments that are included (see 719# the \include command). 720 721EXAMPLE_PATH = 722 723# If the value of the EXAMPLE_PATH tag contains directories, you can use the 724# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 725# and *.h) to filter out the source-files in the directories. If left 726# blank all files are included. 727 728EXAMPLE_PATTERNS = 729 730# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 731# searched for input files to be used with the \include or \dontinclude 732# commands irrespective of the value of the RECURSIVE tag. 733# Possible values are YES and NO. If left blank NO is used. 734 735EXAMPLE_RECURSIVE = NO 736 737# The IMAGE_PATH tag can be used to specify one or more files or 738# directories that contain image that are included in the documentation (see 739# the \image command). 740 741IMAGE_PATH = . \ 742 interface/images \ 743 keyboard \ 744 midi2/images \ 745 storage/images 746 747# The INPUT_FILTER tag can be used to specify a program that doxygen should 748# invoke to filter for each input file. Doxygen will invoke the filter program 749# by executing (via popen()) the command <filter> <input-file>, where <filter> 750# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 751# input file. Doxygen will then use the output that the filter program writes 752# to standard output. 753# If FILTER_PATTERNS is specified, this tag will be 754# ignored. 755 756INPUT_FILTER = 757 758# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 759# basis. 760# Doxygen will compare the file name with each pattern and apply the 761# filter if there is a match. 762# The filters are a list of the form: 763# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 764# info on how filters are used. If FILTER_PATTERNS is empty or if 765# non of the patterns match the file name, INPUT_FILTER is applied. 766 767FILTER_PATTERNS = 768 769# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 770# INPUT_FILTER) will be used to filter the input files when producing source 771# files to browse (i.e. when SOURCE_BROWSER is set to YES). 772 773FILTER_SOURCE_FILES = NO 774 775# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 776# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 777# and it is also possible to disable source filtering for a specific pattern 778# using *.ext= (so without naming a filter). This option only has effect when 779# FILTER_SOURCE_FILES is enabled. 780 781FILTER_SOURCE_PATTERNS = 782 783#--------------------------------------------------------------------------- 784# configuration options related to source browsing 785#--------------------------------------------------------------------------- 786 787# If the SOURCE_BROWSER tag is set to YES then a list of source files will 788# be generated. Documented entities will be cross-referenced with these sources. 789# Note: To get rid of all source code in the generated output, make sure also 790# VERBATIM_HEADERS is set to NO. 791 792SOURCE_BROWSER = NO 793 794# Setting the INLINE_SOURCES tag to YES will include the body 795# of functions and classes directly in the documentation. 796 797INLINE_SOURCES = NO 798 799# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 800# doxygen to hide any special comment blocks from generated source code 801# fragments. Normal C and C++ comments will always remain visible. 802 803STRIP_CODE_COMMENTS = YES 804 805# If the REFERENCED_BY_RELATION tag is set to YES 806# then for each documented function all documented 807# functions referencing it will be listed. 808 809REFERENCED_BY_RELATION = YES 810 811# If the REFERENCES_RELATION tag is set to YES 812# then for each documented function all documented entities 813# called/used by that function will be listed. 814 815REFERENCES_RELATION = YES 816 817# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 818# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 819# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 820# link to the source code. 821# Otherwise they will link to the documentation. 822 823REFERENCES_LINK_SOURCE = NO 824 825# If the USE_HTAGS tag is set to YES then the references to source code 826# will point to the HTML generated by the htags(1) tool instead of doxygen 827# built-in source browser. The htags tool is part of GNU's global source 828# tagging system (see http://www.gnu.org/software/global/global.html). You 829# will need version 4.8.6 or higher. 830 831USE_HTAGS = NO 832 833# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 834# will generate a verbatim copy of the header file for each class for 835# which an include is specified. Set to NO to disable this. 836 837VERBATIM_HEADERS = NO 838 839#--------------------------------------------------------------------------- 840# configuration options related to the alphabetical class index 841#--------------------------------------------------------------------------- 842 843# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 844# of all compounds will be generated. Enable this if the project 845# contains a lot of classes, structs, unions or interfaces. 846 847ALPHABETICAL_INDEX = NO 848 849# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 850# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 851# in which this list will be split (can be a number in the range [1..20]) 852 853COLS_IN_ALPHA_INDEX = 5 854 855# In case all classes in a project start with a common prefix, all 856# classes will be put under the same header in the alphabetical index. 857# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 858# should be ignored while generating the index headers. 859 860IGNORE_PREFIX = 861 862#--------------------------------------------------------------------------- 863# configuration options related to the HTML output 864#--------------------------------------------------------------------------- 865 866# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 867# generate HTML output. 868 869GENERATE_HTML = YES 870 871# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 872# If a relative path is entered the value of OUTPUT_DIRECTORY will be 873# put in front of it. If left blank `html' will be used as the default path. 874 875HTML_OUTPUT = html 876 877# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 878# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 879# doxygen will generate files with .html extension. 880 881HTML_FILE_EXTENSION = .html 882 883# The HTML_HEADER tag can be used to specify a personal HTML header for 884# each generated HTML page. If it is left blank doxygen will generate a 885# standard header. Note that when using a custom header you are responsible 886# for the proper inclusion of any scripts and style sheets that doxygen 887# needs, which is dependent on the configuration options used. 888# It is adviced to generate a default header using "doxygen -w html 889# header.html footer.html stylesheet.css YourConfigFile" and then modify 890# that header. Note that the header is subject to change so you typically 891# have to redo this when upgrading to a newer version of doxygen or when 892# changing the value of configuration settings such as GENERATE_TREEVIEW! 893 894HTML_HEADER = header.html 895 896# The HTML_FOOTER tag can be used to specify a personal HTML footer for 897# each generated HTML page. If it is left blank doxygen will generate a 898# standard footer. 899 900HTML_FOOTER = footer.html 901 902# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 903# style sheet that is used by each HTML page. It can be used to 904# fine-tune the look of the HTML output. If the tag is left blank doxygen 905# will generate a default style sheet. Note that doxygen will try to copy 906# the style sheet file to the HTML output directory, so don't put your own 907# stylesheet in the HTML output directory as well, or it will be erased! 908 909HTML_STYLESHEET = book.css 910 911# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 912# other source files which should be copied to the HTML output directory. Note 913# that these files will be copied to the base HTML output directory. Use the 914# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 915# files. In the HTML_STYLESHEET file, use the file name only. Also note that 916# the files will be copied as-is; there are no commands or markers available. 917 918HTML_EXTRA_FILES = 919 920# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 921# Doxygen will adjust the colors in the stylesheet and background images 922# according to this color. Hue is specified as an angle on a colorwheel, 923# see http://en.wikipedia.org/wiki/Hue for more information. 924# For instance the value 0 represents red, 60 is yellow, 120 is green, 925# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 926# The allowed range is 0 to 359. 927 928HTML_COLORSTYLE_HUE = 220 929 930# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 931# the colors in the HTML output. For a value of 0 the output will use 932# grayscales only. A value of 255 will produce the most vivid colors. 933 934HTML_COLORSTYLE_SAT = 100 935 936# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 937# the luminance component of the colors in the HTML output. Values below 938# 100 gradually make the output lighter, whereas values above 100 make 939# the output darker. The value divided by 100 is the actual gamma applied, 940# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 941# and 100 does not change the gamma. 942 943HTML_COLORSTYLE_GAMMA = 80 944 945# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 946# page will contain the date and time when the page was generated. Setting 947# this to NO can help when comparing the output of multiple runs. 948 949HTML_TIMESTAMP = YES 950 951# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 952# files or namespaces will be aligned in HTML using tables. If set to 953# NO a bullet list will be used. 954 955HTML_ALIGN_MEMBERS = YES 956 957# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 958# documentation will contain sections that can be hidden and shown after the 959# page has loaded. For this to work a browser that supports 960# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 961# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 962 963HTML_DYNAMIC_SECTIONS = NO 964 965# If the GENERATE_DOCSET tag is set to YES, additional index files 966# will be generated that can be used as input for Apple's Xcode 3 967# integrated development environment, introduced with OSX 10.5 (Leopard). 968# To create a documentation set, doxygen will generate a Makefile in the 969# HTML output directory. Running make will produce the docset in that 970# directory and running "make install" will install the docset in 971# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 972# it at startup. 973# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 974# for more information. 975 976GENERATE_DOCSET = NO 977 978# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 979# feed. A documentation feed provides an umbrella under which multiple 980# documentation sets from a single provider (such as a company or product suite) 981# can be grouped. 982 983DOCSET_FEEDNAME = "Doxygen generated docs" 984 985# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 986# should uniquely identify the documentation set bundle. This should be a 987# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 988# will append .docset to the name. 989 990DOCSET_BUNDLE_ID = org.doxygen.Project 991 992# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 993# the documentation publisher. This should be a reverse domain-name style 994# string, e.g. com.mycompany.MyDocSet.documentation. 995 996DOCSET_PUBLISHER_ID = org.doxygen.Publisher 997 998# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 999 1000DOCSET_PUBLISHER_NAME = Publisher 1001 1002# If the GENERATE_HTMLHELP tag is set to YES, additional index files 1003# will be generated that can be used as input for tools like the 1004# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1005# of the generated HTML documentation. 1006 1007GENERATE_HTMLHELP = NO 1008 1009# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1010# be used to specify the file name of the resulting .chm file. You 1011# can add a path in front of the file if the result should not be 1012# written to the html output directory. 1013 1014CHM_FILE = 1015 1016# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1017# be used to specify the location (absolute path including file name) of 1018# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1019# the HTML help compiler on the generated index.hhp. 1020 1021HHC_LOCATION = 1022 1023# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1024# controls if a separate .chi index file is generated (YES) or that 1025# it should be included in the master .chm file (NO). 1026 1027GENERATE_CHI = NO 1028 1029# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1030# is used to encode HtmlHelp index (hhk), content (hhc) and project file 1031# content. 1032 1033CHM_INDEX_ENCODING = 1034 1035# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1036# controls whether a binary table of contents is generated (YES) or a 1037# normal table of contents (NO) in the .chm file. 1038 1039BINARY_TOC = NO 1040 1041# The TOC_EXPAND flag can be set to YES to add extra items for group members 1042# to the contents of the HTML help documentation and to the tree view. 1043 1044TOC_EXPAND = NO 1045 1046# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1047# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1048# that can be used as input for Qt's qhelpgenerator to generate a 1049# Qt Compressed Help (.qch) of the generated HTML documentation. 1050 1051GENERATE_QHP = NO 1052 1053# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1054# be used to specify the file name of the resulting .qch file. 1055# The path specified is relative to the HTML output folder. 1056 1057QCH_FILE = 1058 1059# The QHP_NAMESPACE tag specifies the namespace to use when generating 1060# Qt Help Project output. For more information please see 1061# http://doc.trolltech.com/qthelpproject.html#namespace 1062 1063QHP_NAMESPACE = org.doxygen.Project 1064 1065# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1066# Qt Help Project output. For more information please see 1067# http://doc.trolltech.com/qthelpproject.html#virtual-folders 1068 1069QHP_VIRTUAL_FOLDER = doc 1070 1071# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1072# add. For more information please see 1073# http://doc.trolltech.com/qthelpproject.html#custom-filters 1074 1075QHP_CUST_FILTER_NAME = 1076 1077# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1078# custom filter to add. For more information please see 1079# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1080# Qt Help Project / Custom Filters</a>. 1081 1082QHP_CUST_FILTER_ATTRS = 1083 1084# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1085# project's 1086# filter section matches. 1087# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1088# Qt Help Project / Filter Attributes</a>. 1089 1090QHP_SECT_FILTER_ATTRS = 1091 1092# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1093# be used to specify the location of Qt's qhelpgenerator. 1094# If non-empty doxygen will try to run qhelpgenerator on the generated 1095# .qhp file. 1096 1097QHG_LOCATION = 1098 1099# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1100# will be generated, which together with the HTML files, form an Eclipse help 1101# plugin. To install this plugin and make it available under the help contents 1102# menu in Eclipse, the contents of the directory containing the HTML and XML 1103# files needs to be copied into the plugins directory of eclipse. The name of 1104# the directory within the plugins directory should be the same as 1105# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1106# the help appears. 1107 1108GENERATE_ECLIPSEHELP = NO 1109 1110# A unique identifier for the eclipse help plugin. When installing the plugin 1111# the directory name containing the HTML and XML files should also have 1112# this name. 1113 1114ECLIPSE_DOC_ID = org.doxygen.Project 1115 1116# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 1117# top of each HTML page. The value NO (the default) enables the index and 1118# the value YES disables it. 1119 1120DISABLE_INDEX = NO 1121 1122# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1123# (range [0,1..20]) that doxygen will group on one line in the generated HTML 1124# documentation. Note that a value of 0 will completely suppress the enum 1125# values from appearing in the overview section. 1126 1127ENUM_VALUES_PER_LINE = 1 1128 1129# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1130# structure should be generated to display hierarchical information. 1131# If the tag value is set to YES, a side panel will be generated 1132# containing a tree-like index structure (just like the one that 1133# is generated for HTML Help). For this to work a browser that supports 1134# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1135# Windows users are probably better off using the HTML help feature. 1136 1137GENERATE_TREEVIEW = NO 1138 1139# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 1140# and Class Hierarchy pages using a tree view instead of an ordered list. 1141 1142USE_INLINE_TREES = NO 1143 1144# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1145# used to set the initial width (in pixels) of the frame in which the tree 1146# is shown. 1147 1148TREEVIEW_WIDTH = 250 1149 1150# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1151# links to external symbols imported via tag files in a separate window. 1152 1153EXT_LINKS_IN_WINDOW = NO 1154 1155# Use this tag to change the font size of Latex formulas included 1156# as images in the HTML documentation. The default is 10. Note that 1157# when you change the font size after a successful doxygen run you need 1158# to manually remove any form_*.png images from the HTML output directory 1159# to force them to be regenerated. 1160 1161FORMULA_FONTSIZE = 10 1162 1163# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1164# generated for formulas are transparent PNGs. Transparent PNGs are 1165# not supported properly for IE 6.0, but are supported on all modern browsers. 1166# Note that when changing this option you need to delete any form_*.png files 1167# in the HTML output before the changes have effect. 1168 1169FORMULA_TRANSPARENT = YES 1170 1171# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1172# (see http://www.mathjax.org) which uses client side Javascript for the 1173# rendering instead of using prerendered bitmaps. Use this if you do not 1174# have LaTeX installed or if you want to formulas look prettier in the HTML 1175# output. When enabled you also need to install MathJax separately and 1176# configure the path to it using the MATHJAX_RELPATH option. 1177 1178USE_MATHJAX = NO 1179 1180# When MathJax is enabled you need to specify the location relative to the 1181# HTML output directory using the MATHJAX_RELPATH option. The destination 1182# directory should contain the MathJax.js script. For instance, if the mathjax 1183# directory is located at the same level as the HTML output directory, then 1184# MATHJAX_RELPATH should be ../mathjax. The default value points to the 1185# mathjax.org site, so you can quickly see the result without installing 1186# MathJax, but it is strongly recommended to install a local copy of MathJax 1187# before deployment. 1188 1189MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1190 1191# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1192# names that should be enabled during MathJax rendering. 1193 1194MATHJAX_EXTENSIONS = 1195 1196# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1197# for the HTML output. The underlying search engine uses javascript 1198# and DHTML and should work on any modern browser. Note that when using 1199# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1200# (GENERATE_DOCSET) there is already a search function so this one should 1201# typically be disabled. For large projects the javascript based search engine 1202# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1203 1204SEARCHENGINE = NO 1205 1206# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1207# implemented using a PHP enabled web server instead of at the web client 1208# using Javascript. Doxygen will generate the search PHP script and index 1209# file to put on the web server. The advantage of the server 1210# based approach is that it scales better to large projects and allows 1211# full text search. The disadvantages are that it is more difficult to setup 1212# and does not have live searching capabilities. 1213 1214SERVER_BASED_SEARCH = NO 1215 1216#--------------------------------------------------------------------------- 1217# configuration options related to the LaTeX output 1218#--------------------------------------------------------------------------- 1219 1220# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1221# generate Latex output. 1222 1223GENERATE_LATEX = NO 1224 1225# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1226# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1227# put in front of it. If left blank `latex' will be used as the default path. 1228 1229LATEX_OUTPUT = latex 1230 1231# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1232# invoked. If left blank `latex' will be used as the default command name. 1233# Note that when enabling USE_PDFLATEX this option is only used for 1234# generating bitmaps for formulas in the HTML output, but not in the 1235# Makefile that is written to the output directory. 1236 1237LATEX_CMD_NAME = latex 1238 1239# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1240# generate index for LaTeX. If left blank `makeindex' will be used as the 1241# default command name. 1242 1243MAKEINDEX_CMD_NAME = makeindex 1244 1245# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1246# LaTeX documents. This may be useful for small projects and may help to 1247# save some trees in general. 1248 1249COMPACT_LATEX = NO 1250 1251# The PAPER_TYPE tag can be used to set the paper type that is used 1252# by the printer. Possible values are: a4, letter, legal and 1253# executive. If left blank a4wide will be used. 1254 1255PAPER_TYPE = a4wide 1256 1257# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1258# packages that should be included in the LaTeX output. 1259 1260EXTRA_PACKAGES = 1261 1262# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1263# the generated latex document. The header should contain everything until 1264# the first chapter. If it is left blank doxygen will generate a 1265# standard header. Notice: only use this tag if you know what you are doing! 1266 1267LATEX_HEADER = 1268 1269# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1270# the generated latex document. The footer should contain everything after 1271# the last chapter. If it is left blank doxygen will generate a 1272# standard footer. Notice: only use this tag if you know what you are doing! 1273 1274LATEX_FOOTER = 1275 1276# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1277# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1278# contain links (just like the HTML output) instead of page references 1279# This makes the output suitable for online browsing using a pdf viewer. 1280 1281PDF_HYPERLINKS = NO 1282 1283# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1284# plain latex in the generated Makefile. Set this option to YES to get a 1285# higher quality PDF documentation. 1286 1287USE_PDFLATEX = NO 1288 1289# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1290# command to the generated LaTeX files. This will instruct LaTeX to keep 1291# running if errors occur, instead of asking the user for help. 1292# This option is also used when generating formulas in HTML. 1293 1294LATEX_BATCHMODE = NO 1295 1296# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1297# include the index chapters (such as File Index, Compound Index, etc.) 1298# in the output. 1299 1300LATEX_HIDE_INDICES = NO 1301 1302# If LATEX_SOURCE_CODE is set to YES then doxygen will include 1303# source code with syntax highlighting in the LaTeX output. 1304# Note that which sources are shown also depends on other settings 1305# such as SOURCE_BROWSER. 1306 1307LATEX_SOURCE_CODE = NO 1308 1309# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1310# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1311# http://en.wikipedia.org/wiki/BibTeX for more info. 1312 1313LATEX_BIB_STYLE = plain 1314 1315#--------------------------------------------------------------------------- 1316# configuration options related to the RTF output 1317#--------------------------------------------------------------------------- 1318 1319# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1320# The RTF output is optimized for Word 97 and may not look very pretty with 1321# other RTF readers or editors. 1322 1323GENERATE_RTF = NO 1324 1325# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1326# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1327# put in front of it. If left blank `rtf' will be used as the default path. 1328 1329RTF_OUTPUT = rtf 1330 1331# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1332# RTF documents. This may be useful for small projects and may help to 1333# save some trees in general. 1334 1335COMPACT_RTF = NO 1336 1337# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1338# will contain hyperlink fields. The RTF file will 1339# contain links (just like the HTML output) instead of page references. 1340# This makes the output suitable for online browsing using WORD or other 1341# programs which support those fields. 1342# Note: wordpad (write) and others do not support links. 1343 1344RTF_HYPERLINKS = NO 1345 1346# Load stylesheet definitions from file. Syntax is similar to doxygen's 1347# config file, i.e. a series of assignments. You only have to provide 1348# replacements, missing definitions are set to their default value. 1349 1350RTF_STYLESHEET_FILE = 1351 1352# Set optional variables used in the generation of an rtf document. 1353# Syntax is similar to doxygen's config file. 1354 1355RTF_EXTENSIONS_FILE = 1356 1357#--------------------------------------------------------------------------- 1358# configuration options related to the man page output 1359#--------------------------------------------------------------------------- 1360 1361# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1362# generate man pages 1363 1364GENERATE_MAN = NO 1365 1366# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1367# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1368# put in front of it. If left blank `man' will be used as the default path. 1369 1370MAN_OUTPUT = man 1371 1372# The MAN_EXTENSION tag determines the extension that is added to 1373# the generated man pages (default is the subroutine's section .3) 1374 1375MAN_EXTENSION = .3 1376 1377# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1378# then it will generate one additional man file for each entity 1379# documented in the real man page(s). These additional files 1380# only source the real man page, but without them the man command 1381# would be unable to find the correct page. The default is NO. 1382 1383MAN_LINKS = NO 1384 1385#--------------------------------------------------------------------------- 1386# configuration options related to the XML output 1387#--------------------------------------------------------------------------- 1388 1389# If the GENERATE_XML tag is set to YES Doxygen will 1390# generate an XML file that captures the structure of 1391# the code including all documentation. 1392 1393GENERATE_XML = YES 1394 1395# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1396# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1397# put in front of it. If left blank `xml' will be used as the default path. 1398 1399XML_OUTPUT = xml 1400 1401# The XML_SCHEMA tag can be used to specify an XML schema, 1402# which can be used by a validating XML parser to check the 1403# syntax of the XML files. 1404 1405XML_SCHEMA = 1406 1407# The XML_DTD tag can be used to specify an XML DTD, 1408# which can be used by a validating XML parser to check the 1409# syntax of the XML files. 1410 1411XML_DTD = 1412 1413# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1414# dump the program listings (including syntax highlighting 1415# and cross-referencing information) to the XML output. Note that 1416# enabling this will significantly increase the size of the XML output. 1417 1418XML_PROGRAMLISTING = YES 1419 1420#--------------------------------------------------------------------------- 1421# configuration options for the AutoGen Definitions output 1422#--------------------------------------------------------------------------- 1423 1424# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1425# generate an AutoGen Definitions (see autogen.sf.net) file 1426# that captures the structure of the code including all 1427# documentation. Note that this feature is still experimental 1428# and incomplete at the moment. 1429 1430GENERATE_AUTOGEN_DEF = NO 1431 1432#--------------------------------------------------------------------------- 1433# configuration options related to the Perl module output 1434#--------------------------------------------------------------------------- 1435 1436# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1437# generate a Perl module file that captures the structure of 1438# the code including all documentation. Note that this 1439# feature is still experimental and incomplete at the 1440# moment. 1441 1442GENERATE_PERLMOD = NO 1443 1444# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1445# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1446# to generate PDF and DVI output from the Perl module output. 1447 1448PERLMOD_LATEX = NO 1449 1450# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1451# nicely formatted so it can be parsed by a human reader. 1452# This is useful 1453# if you want to understand what is going on. 1454# On the other hand, if this 1455# tag is set to NO the size of the Perl module output will be much smaller 1456# and Perl will parse it just the same. 1457 1458PERLMOD_PRETTY = YES 1459 1460# The names of the make variables in the generated doxyrules.make file 1461# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1462# This is useful so different doxyrules.make files included by the same 1463# Makefile don't overwrite each other's variables. 1464 1465PERLMOD_MAKEVAR_PREFIX = 1466 1467#--------------------------------------------------------------------------- 1468# Configuration options related to the preprocessor 1469#--------------------------------------------------------------------------- 1470 1471# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1472# evaluate all C-preprocessor directives found in the sources and include 1473# files. 1474 1475ENABLE_PREPROCESSING = YES 1476 1477# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1478# names in the source code. If set to NO (the default) only conditional 1479# compilation will be performed. Macro expansion can be done in a controlled 1480# way by setting EXPAND_ONLY_PREDEF to YES. 1481 1482MACRO_EXPANSION = NO 1483 1484# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1485# then the macro expansion is limited to the macros specified with the 1486# PREDEFINED and EXPAND_AS_DEFINED tags. 1487 1488EXPAND_ONLY_PREDEF = NO 1489 1490# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1491# pointed to by INCLUDE_PATH will be searched when a #include is found. 1492 1493SEARCH_INCLUDES = YES 1494 1495# The INCLUDE_PATH tag can be used to specify one or more directories that 1496# contain include files that are not input files but should be processed by 1497# the preprocessor. 1498 1499INCLUDE_PATH = 1500 1501# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1502# patterns (like *.h and *.hpp) to filter out the header-files in the 1503# directories. If left blank, the patterns specified with FILE_PATTERNS will 1504# be used. 1505 1506INCLUDE_FILE_PATTERNS = 1507 1508# The PREDEFINED tag can be used to specify one or more macro names that 1509# are defined before the preprocessor is started (similar to the -D option of 1510# gcc). The argument of the tag is a list of macros of the form: name 1511# or name=definition (no spaces). If the definition and the = are 1512# omitted =1 is assumed. To prevent a macro definition from being 1513# undefined via #undef or recursively expanded use the := operator 1514# instead of the = operator. 1515 1516PREDEFINED = __cplusplus \ 1517 _SYS_TYPES_H 1518 1519# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1520# this tag can be used to specify a list of macro names that should be expanded. 1521# The macro definition that is found in the sources will be used. 1522# Use the PREDEFINED tag if you want to use a different macro definition that 1523# overrules the definition found in the source code. 1524 1525EXPAND_AS_DEFINED = 1526 1527# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1528# doxygen's preprocessor will remove all references to function-like macros 1529# that are alone on a line, have an all uppercase name, and do not end with a 1530# semicolon, because these will confuse the parser if not removed. 1531 1532SKIP_FUNCTION_MACROS = YES 1533 1534#--------------------------------------------------------------------------- 1535# Configuration::additions related to external references 1536#--------------------------------------------------------------------------- 1537 1538# The TAGFILES option can be used to specify one or more tagfiles. 1539# Optionally an initial location of the external documentation 1540# can be added for each tagfile. The format of a tag file without 1541# this location is as follows: 1542# 1543# TAGFILES = file1 file2 ... 1544# Adding location for the tag files is done as follows: 1545# 1546# TAGFILES = file1=loc1 "file2 = loc2" ... 1547# where "loc1" and "loc2" can be relative or absolute paths or 1548# URLs. If a location is present for each tag, the installdox tool 1549# does not have to be run to correct the links. 1550# Note that each tag file must have a unique name 1551# (where the name does NOT include the path) 1552# If a tag file is not located in the directory in which doxygen 1553# is run, you must also specify the path to the tagfile here. 1554 1555TAGFILES = 1556 1557# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1558# a tag file that is based on the input files it reads. 1559 1560GENERATE_TAGFILE = 1561 1562# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1563# in the class index. If set to NO only the inherited external classes 1564# will be listed. 1565 1566ALLEXTERNALS = NO 1567 1568# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1569# in the modules index. If set to NO, only the current project's groups will 1570# be listed. 1571 1572EXTERNAL_GROUPS = YES 1573 1574# The PERL_PATH should be the absolute path and name of the perl script 1575# interpreter (i.e. the result of `which perl'). 1576 1577PERL_PATH = /boot/home/config/bin/perl 1578 1579#--------------------------------------------------------------------------- 1580# Configuration options related to the dot tool 1581#--------------------------------------------------------------------------- 1582 1583# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1584# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1585# or super classes. Setting the tag to NO turns the diagrams off. Note that 1586# this option also works with HAVE_DOT disabled, but it is recommended to 1587# install and use dot, since it yields more powerful graphs. 1588 1589CLASS_DIAGRAMS = YES 1590 1591# You can define message sequence charts within doxygen comments using the \msc 1592# command. Doxygen will then run the mscgen tool (see 1593# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1594# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1595# the mscgen tool resides. If left empty the tool is assumed to be found in the 1596# default search path. 1597 1598MSCGEN_PATH = 1599 1600# If set to YES, the inheritance and collaboration graphs will hide 1601# inheritance and usage relations if the target is undocumented 1602# or is not a class. 1603 1604HIDE_UNDOC_RELATIONS = YES 1605 1606# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1607# available from the path. This tool is part of Graphviz, a graph visualization 1608# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1609# have no effect if this option is set to NO (the default) 1610 1611HAVE_DOT = NO 1612 1613# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1614# allowed to run in parallel. When set to 0 (the default) doxygen will 1615# base this on the number of processors available in the system. You can set it 1616# explicitly to a value larger than 0 to get control over the balance 1617# between CPU load and processing speed. 1618 1619DOT_NUM_THREADS = 0 1620 1621# By default doxygen will use the Helvetica font for all dot files that 1622# doxygen generates. When you want a differently looking font you can specify 1623# the font name using DOT_FONTNAME. You need to make sure dot is able to find 1624# the font, which can be done by putting it in a standard location or by setting 1625# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1626# directory containing the font. 1627 1628DOT_FONTNAME = Helvetica 1629 1630# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1631# The default size is 10pt. 1632 1633DOT_FONTSIZE = 10 1634 1635# By default doxygen will tell dot to use the Helvetica font. 1636# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1637# set the path where dot can find it. 1638 1639DOT_FONTPATH = 1640 1641# If the CLASS_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 inheritance relations. Setting this tag to YES will force the 1644# the CLASS_DIAGRAMS tag to NO. 1645 1646CLASS_GRAPH = YES 1647 1648# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1649# will generate a graph for each documented class showing the direct and 1650# indirect implementation dependencies (inheritance, containment, and 1651# class references variables) of the class with other documented classes. 1652 1653COLLABORATION_GRAPH = YES 1654 1655# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1656# will generate a graph for groups, showing the direct groups dependencies 1657 1658GROUP_GRAPHS = YES 1659 1660# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1661# collaboration diagrams in a style similar to the OMG's Unified Modeling 1662# Language. 1663 1664UML_LOOK = NO 1665 1666# If set to YES, the inheritance and collaboration graphs will show the 1667# relations between templates and their instances. 1668 1669TEMPLATE_RELATIONS = YES 1670 1671# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1672# tags are set to YES then doxygen will generate a graph for each documented 1673# file showing the direct and indirect include dependencies of the file with 1674# other documented files. 1675 1676INCLUDE_GRAPH = NO 1677 1678# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1679# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1680# documented header file showing the documented files that directly or 1681# indirectly include this file. 1682 1683INCLUDED_BY_GRAPH = NO 1684 1685# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1686# doxygen will generate a call dependency graph for every global function 1687# or class method. Note that enabling this option will significantly increase 1688# the time of a run. So in most cases it will be better to enable call graphs 1689# for selected functions only using the \callgraph command. 1690 1691CALL_GRAPH = NO 1692 1693# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1694# doxygen will generate a caller dependency graph for every global function 1695# or class method. Note that enabling this option will significantly increase 1696# the time of a run. So in most cases it will be better to enable caller 1697# graphs for selected functions only using the \callergraph command. 1698 1699CALLER_GRAPH = NO 1700 1701# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1702# will generate a graphical hierarchy of all classes instead of a textual one. 1703 1704GRAPHICAL_HIERARCHY = YES 1705 1706# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1707# then doxygen will show the dependencies a directory has on other directories 1708# in a graphical way. The dependency relations are determined by the #include 1709# relations between the files in the directories. 1710 1711DIRECTORY_GRAPH = YES 1712 1713# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1714# generated by dot. Possible values are svg, png, jpg, or gif. 1715# If left blank png will be used. If you choose svg you need to set 1716# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1717# visible in IE 9+ (other browsers do not have this requirement). 1718 1719DOT_IMAGE_FORMAT = png 1720 1721# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1722# enable generation of interactive SVG images that allow zooming and panning. 1723# Note that this requires a modern browser other than Internet Explorer. 1724# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1725# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1726# visible. Older versions of IE do not have SVG support. 1727 1728INTERACTIVE_SVG = NO 1729 1730# The tag DOT_PATH can be used to specify the path where the dot tool can be 1731# found. If left blank, it is assumed the dot tool can be found in the path. 1732 1733DOT_PATH = 1734 1735# The DOTFILE_DIRS tag can be used to specify one or more directories that 1736# contain dot files that are included in the documentation (see the 1737# \dotfile command). 1738 1739DOTFILE_DIRS = 1740 1741# The MSCFILE_DIRS tag can be used to specify one or more directories that 1742# contain msc files that are included in the documentation (see the 1743# \mscfile command). 1744 1745MSCFILE_DIRS = 1746 1747# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1748# nodes that will be shown in the graph. If the number of nodes in a graph 1749# becomes larger than this value, doxygen will truncate the graph, which is 1750# visualized by representing a node as a red box. Note that doxygen if the 1751# number of direct children of the root node in a graph is already larger than 1752# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1753# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1754 1755DOT_GRAPH_MAX_NODES = 50 1756 1757# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1758# graphs generated by dot. A depth value of 3 means that only nodes reachable 1759# from the root by following a path via at most 3 edges will be shown. Nodes 1760# that lay further from the root node will be omitted. Note that setting this 1761# option to 1 or 2 may greatly reduce the computation time needed for large 1762# code bases. Also note that the size of a graph can be further restricted by 1763# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1764 1765MAX_DOT_GRAPH_DEPTH = 0 1766 1767# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1768# background. This is disabled by default, because dot on Windows does not 1769# seem to support this out of the box. Warning: Depending on the platform used, 1770# enabling this option may lead to badly anti-aliased labels on the edges of 1771# a graph (i.e. they become hard to read). 1772 1773DOT_TRANSPARENT = NO 1774 1775# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1776# files in one run (i.e. multiple -o and -T options on the command line). This 1777# makes dot run faster, but since only newer versions of dot (>1.8.10) 1778# support this, this feature is disabled by default. 1779 1780DOT_MULTI_TARGETS = NO 1781 1782# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1783# generate a legend page explaining the meaning of the various boxes and 1784# arrows in the dot generated graphs. 1785 1786GENERATE_LEGEND = YES 1787 1788# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1789# remove the intermediate dot files that are used to generate 1790# the various graphs. 1791 1792DOT_CLEANUP = YES 1793