1# Doxyfile 1.5.3 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 that 18# follow. The default is UTF-8 which is also the encoding used for all text before 19# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 20# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 21# possible encodings. 22 23DOXYFILE_ENCODING = UTF-8 24 25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 26# by quotes) that should identify the project. 27 28PROJECT_NAME = Gallium3D 29 30# The PROJECT_NUMBER tag can be used to enter a project or revision number. 31# This could be handy for archiving the generated documentation or 32# if some version control system is used. 33 34PROJECT_NUMBER = 0.1 35 36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 37# base path where the generated documentation will be put. 38# If a relative path is entered, it will be relative to the location 39# where doxygen was started. If left blank the current directory will be used. 40 41OUTPUT_DIRECTORY = gallium 42 43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 44# 4096 sub-directories (in 2 levels) under the output directory of each output 45# format and will distribute the generated files over these directories. 46# Enabling this option can be useful when feeding doxygen a huge amount of 47# source files, where putting all generated files in the same directory would 48# otherwise cause performance problems for the file system. 49 50CREATE_SUBDIRS = NO 51 52# The OUTPUT_LANGUAGE tag is used to specify the language in which all 53# documentation generated by doxygen is written. Doxygen will use this 54# information to generate all constant output in the proper language. 55# The default language is English, other supported languages are: 56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 57# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 58# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 59# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 60# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 61 62OUTPUT_LANGUAGE = English 63 64# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 65# include brief member descriptions after the members that are listed in 66# the file and class documentation (similar to JavaDoc). 67# Set to NO to disable this. 68 69BRIEF_MEMBER_DESC = YES 70 71# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 72# the brief description of a member or function before the detailed description. 73# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 74# brief descriptions will be completely suppressed. 75 76REPEAT_BRIEF = YES 77 78# This tag implements a quasi-intelligent brief description abbreviator 79# that is used to form the text in various listings. Each string 80# in this list, if found as the leading text of the brief description, will be 81# stripped from the text and the result after processing the whole list, is 82# used as the annotated text. Otherwise, the brief description is used as-is. 83# If left blank, the following values are used ("$name" is automatically 84# replaced with the name of the entity): "The $name class" "The $name widget" 85# "The $name file" "is" "provides" "specifies" "contains" 86# "represents" "a" "an" "the" 87 88ABBREVIATE_BRIEF = 89 90# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 91# Doxygen will generate a detailed section even if there is only a brief 92# description. 93 94ALWAYS_DETAILED_SEC = NO 95 96# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 97# inherited members of a class in the documentation of that class as if those 98# members were ordinary class members. Constructors, destructors and assignment 99# operators of the base classes will not be shown. 100 101INLINE_INHERITED_MEMB = NO 102 103# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 104# path before files name in the file list and in the header files. If set 105# to NO the shortest path that makes the file name unique will be used. 106 107FULL_PATH_NAMES = YES 108 109# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 110# can be used to strip a user-defined part of the path. Stripping is 111# only done if one of the specified strings matches the left-hand part of 112# the path. The tag can be used to show relative paths in the file list. 113# If left blank the directory from which doxygen is run is used as the 114# path to strip. 115 116STRIP_FROM_PATH = ../src 117 118# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 119# the path mentioned in the documentation of a class, which tells 120# the reader which header file to include in order to use a class. 121# If left blank only the name of the header file containing the class 122# definition is used. Otherwise one should specify the include paths that 123# are normally passed to the compiler using the -I flag. 124 125STRIP_FROM_INC_PATH = 126 127# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 128# (but less readable) file names. This can be useful is your file systems 129# doesn't support long names like on DOS, Mac, or CD-ROM. 130 131SHORT_NAMES = NO 132 133# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 134# will interpret the first line (until the first dot) of a JavaDoc-style 135# comment as the brief description. If set to NO, the JavaDoc 136# comments will behave just like regular Qt-style comments 137# (thus requiring an explicit @brief command for a brief description.) 138 139JAVADOC_AUTOBRIEF = YES 140 141# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 142# interpret the first line (until the first dot) of a Qt-style 143# comment as the brief description. If set to NO, the comments 144# will behave just like regular Qt-style comments (thus requiring 145# an explicit \brief command for a brief description.) 146 147QT_AUTOBRIEF = YES 148 149# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 150# treat a multi-line C++ special comment block (i.e. a block of //! or /// 151# comments) as a brief description. This used to be the default behaviour. 152# The new default is to treat a multi-line C++ comment block as a detailed 153# description. Set this tag to YES if you prefer the old behaviour instead. 154 155MULTILINE_CPP_IS_BRIEF = NO 156 157# If the DETAILS_AT_TOP tag is set to YES then Doxygen 158# will output the detailed description near the top, like JavaDoc. 159# If set to NO, the detailed description appears after the member 160# documentation. 161 162DETAILS_AT_TOP = NO 163 164# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 165# member inherits the documentation from any documented member that it 166# re-implements. 167 168INHERIT_DOCS = YES 169 170# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 171# a new page for each member. If set to NO, the documentation of a member will 172# be part of the file/class/namespace that contains it. 173 174SEPARATE_MEMBER_PAGES = NO 175 176# The TAB_SIZE tag can be used to set the number of spaces in a tab. 177# Doxygen uses this value to replace tabs by spaces in code fragments. 178 179TAB_SIZE = 8 180 181# This tag can be used to specify a number of aliases that acts 182# as commands in the documentation. An alias has the form "name=value". 183# For example adding "sideeffect=\par Side Effects:\n" will allow you to 184# put the command \sideeffect (or @sideeffect) in the documentation, which 185# will result in a user-defined paragraph with heading "Side Effects:". 186# You can put \n's in the value part of an alias to insert newlines. 187 188ALIASES = 189 190# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 191# sources only. Doxygen will then generate output that is more tailored for C. 192# For instance, some of the names that are used will be different. The list 193# of all members will be omitted, etc. 194 195OPTIMIZE_OUTPUT_FOR_C = YES 196 197# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 198# sources only. Doxygen will then generate output that is more tailored for Java. 199# For instance, namespaces will be presented as packages, qualified scopes 200# will look different, etc. 201 202OPTIMIZE_OUTPUT_JAVA = NO 203 204# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 205# include (a tag file for) the STL sources as input, then you should 206# set this tag to YES in order to let doxygen match functions declarations and 207# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 208# func(std::string) {}). This also make the inheritance and collaboration 209# diagrams that involve STL classes more complete and accurate. 210 211BUILTIN_STL_SUPPORT = NO 212 213# If you use Microsoft's C++/CLI language, you should set this option to YES to 214# enable parsing support. 215 216CPP_CLI_SUPPORT = NO 217 218# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 219# tag is set to YES, then doxygen will reuse the documentation of the first 220# member in the group (if any) for the other members of the group. By default 221# all members of a group must be documented explicitly. 222 223DISTRIBUTE_GROUP_DOC = NO 224 225# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 226# the same type (for instance a group of public functions) to be put as a 227# subgroup of that type (e.g. under the Public Functions section). Set it to 228# NO to prevent subgrouping. Alternatively, this can be done per class using 229# the \nosubgrouping command. 230 231SUBGROUPING = YES 232 233#--------------------------------------------------------------------------- 234# Build related configuration options 235#--------------------------------------------------------------------------- 236 237# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 238# documentation are documented, even if no documentation was available. 239# Private class members and static file members will be hidden unless 240# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 241 242EXTRACT_ALL = YES 243 244# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 245# will be included in the documentation. 246 247EXTRACT_PRIVATE = YES 248 249# If the EXTRACT_STATIC tag is set to YES all static members of a file 250# will be included in the documentation. 251 252EXTRACT_STATIC = YES 253 254# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 255# defined locally in source files will be included in the documentation. 256# If set to NO only classes defined in header files are included. 257 258EXTRACT_LOCAL_CLASSES = YES 259 260# This flag is only useful for Objective-C code. When set to YES local 261# methods, which are defined in the implementation section but not in 262# the interface are included in the documentation. 263# If set to NO (the default) only methods in the interface are included. 264 265EXTRACT_LOCAL_METHODS = NO 266 267# If this flag is set to YES, the members of anonymous namespaces will be extracted 268# and appear in the documentation as a namespace called 'anonymous_namespace{file}', 269# where file will be replaced with the base name of the file that contains the anonymous 270# namespace. By default anonymous namespace are hidden. 271 272EXTRACT_ANON_NSPACES = NO 273 274# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 275# undocumented members of documented classes, files or namespaces. 276# If set to NO (the default) these members will be included in the 277# various overviews, but no documentation section is generated. 278# This option has no effect if EXTRACT_ALL is enabled. 279 280HIDE_UNDOC_MEMBERS = NO 281 282# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 283# undocumented classes that are normally visible in the class hierarchy. 284# If set to NO (the default) these classes will be included in the various 285# overviews. This option has no effect if EXTRACT_ALL is enabled. 286 287HIDE_UNDOC_CLASSES = NO 288 289# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 290# friend (class|struct|union) declarations. 291# If set to NO (the default) these declarations will be included in the 292# documentation. 293 294HIDE_FRIEND_COMPOUNDS = NO 295 296# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 297# documentation blocks found inside the body of a function. 298# If set to NO (the default) these blocks will be appended to the 299# function's detailed documentation block. 300 301HIDE_IN_BODY_DOCS = NO 302 303# The INTERNAL_DOCS tag determines if documentation 304# that is typed after a \internal command is included. If the tag is set 305# to NO (the default) then the documentation will be excluded. 306# Set it to YES to include the internal documentation. 307 308INTERNAL_DOCS = NO 309 310# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 311# file names in lower-case letters. If set to YES upper-case letters are also 312# allowed. This is useful if you have classes or files whose names only differ 313# in case and if your file system supports case sensitive file names. Windows 314# and Mac users are advised to set this option to NO. 315 316CASE_SENSE_NAMES = YES 317 318# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 319# will show members with their full class and namespace scopes in the 320# documentation. If set to YES the scope will be hidden. 321 322HIDE_SCOPE_NAMES = NO 323 324# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 325# will put a list of the files that are included by a file in the documentation 326# of that file. 327 328SHOW_INCLUDE_FILES = NO 329 330# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 331# is inserted in the documentation for inline members. 332 333INLINE_INFO = NO 334 335# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 336# will sort the (detailed) documentation of file and class members 337# alphabetically by member name. If set to NO the members will appear in 338# declaration order. 339 340SORT_MEMBER_DOCS = YES 341 342# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 343# brief documentation of file, namespace and class members alphabetically 344# by member name. If set to NO (the default) the members will appear in 345# declaration order. 346 347SORT_BRIEF_DOCS = NO 348 349# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 350# sorted by fully-qualified names, including namespaces. If set to 351# NO (the default), the class list will be sorted only by class name, 352# not including the namespace part. 353# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 354# Note: This option applies only to the class list, not to the 355# alphabetical list. 356 357SORT_BY_SCOPE_NAME = NO 358 359# The GENERATE_TODOLIST tag can be used to enable (YES) or 360# disable (NO) the todo list. This list is created by putting \todo 361# commands in the documentation. 362 363GENERATE_TODOLIST = NO 364 365# The GENERATE_TESTLIST tag can be used to enable (YES) or 366# disable (NO) the test list. This list is created by putting \test 367# commands in the documentation. 368 369GENERATE_TESTLIST = NO 370 371# The GENERATE_BUGLIST tag can be used to enable (YES) or 372# disable (NO) the bug list. This list is created by putting \bug 373# commands in the documentation. 374 375GENERATE_BUGLIST = NO 376 377# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 378# disable (NO) the deprecated list. This list is created by putting 379# \deprecated commands in the documentation. 380 381GENERATE_DEPRECATEDLIST= YES 382 383# The ENABLED_SECTIONS tag can be used to enable conditional 384# documentation sections, marked by \if sectionname ... \endif. 385 386ENABLED_SECTIONS = 387 388# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 389# the initial value of a variable or define consists of for it to appear in 390# the documentation. If the initializer consists of more lines than specified 391# here it will be hidden. Use a value of 0 to hide initializers completely. 392# The appearance of the initializer of individual variables and defines in the 393# documentation can be controlled using \showinitializer or \hideinitializer 394# command in the documentation regardless of this setting. 395 396MAX_INITIALIZER_LINES = 30 397 398# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 399# at the bottom of the documentation of classes and structs. If set to YES the 400# list will mention the files that were used to generate the documentation. 401 402SHOW_USED_FILES = YES 403 404# If the sources in your project are distributed over multiple directories 405# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 406# in the documentation. The default is NO. 407 408SHOW_DIRECTORIES = YES 409 410# The FILE_VERSION_FILTER tag can be used to specify a program or script that 411# doxygen should invoke to get the current version for each file (typically from the 412# version control system). Doxygen will invoke the program by executing (via 413# popen()) the command <command> <input-file>, where <command> is the value of 414# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 415# provided by doxygen. Whatever the program writes to standard output 416# is used as the file version. See the manual for examples. 417 418FILE_VERSION_FILTER = 419 420#--------------------------------------------------------------------------- 421# configuration options related to warning and progress messages 422#--------------------------------------------------------------------------- 423 424# The QUIET tag can be used to turn on/off the messages that are generated 425# by doxygen. Possible values are YES and NO. If left blank NO is used. 426 427QUIET = NO 428 429# The WARNINGS tag can be used to turn on/off the warning messages that are 430# generated by doxygen. Possible values are YES and NO. If left blank 431# NO is used. 432 433WARNINGS = YES 434 435# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 436# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 437# automatically be disabled. 438 439WARN_IF_UNDOCUMENTED = YES 440 441# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 442# potential errors in the documentation, such as not documenting some 443# parameters in a documented function, or documenting parameters that 444# don't exist or using markup commands wrongly. 445 446WARN_IF_DOC_ERROR = YES 447 448# This WARN_NO_PARAMDOC option can be abled to get warnings for 449# functions that are documented, but have no documentation for their parameters 450# or return value. If set to NO (the default) doxygen will only warn about 451# wrong or incomplete parameter documentation, but not about the absence of 452# documentation. 453 454WARN_NO_PARAMDOC = NO 455 456# The WARN_FORMAT tag determines the format of the warning messages that 457# doxygen can produce. The string should contain the $file, $line, and $text 458# tags, which will be replaced by the file and line number from which the 459# warning originated and the warning text. Optionally the format may contain 460# $version, which will be replaced by the version of the file (if it could 461# be obtained via FILE_VERSION_FILTER) 462 463WARN_FORMAT = "$file:$line: $text" 464 465# The WARN_LOGFILE tag can be used to specify a file to which warning 466# and error messages should be written. If left blank the output is written 467# to stderr. 468 469WARN_LOGFILE = 470 471#--------------------------------------------------------------------------- 472# configuration options related to the input files 473#--------------------------------------------------------------------------- 474 475# The INPUT tag can be used to specify the files and/or directories that contain 476# documented source files. You may enter file names like "myfile.cpp" or 477# directories like "/usr/src/myproject". Separate the files or directories 478# with spaces. 479 480INPUT = gallium.doc \ 481 ../src/gallium \ 482 ../src/mesa/state_tracker 483 484# This tag can be used to specify the character encoding of the source files that 485# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 486# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 487# See http://www.gnu.org/software/libiconv for the list of possible encodings. 488 489INPUT_ENCODING = UTF-8 490 491# If the value of the INPUT tag contains directories, you can use the 492# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 493# and *.h) to filter out the source-files in the directories. If left 494# blank the following patterns are tested: 495# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 496# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py 497 498FILE_PATTERNS = *.c *.h *.cpp *.hpp 499 500# The RECURSIVE tag can be used to turn specify whether or not subdirectories 501# should be searched for input files as well. Possible values are YES and NO. 502# If left blank NO is used. 503 504RECURSIVE = YES 505 506# The EXCLUDE tag can be used to specify files and/or directories that should 507# excluded from the INPUT source files. This way you can easily exclude a 508# subdirectory from a directory tree whose root is specified with the INPUT tag. 509 510EXCLUDE = 511 512# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 513# directories that are symbolic links (a Unix filesystem feature) are excluded 514# from the input. 515 516EXCLUDE_SYMLINKS = NO 517 518# If the value of the INPUT tag contains directories, you can use the 519# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 520# certain files from those directories. Note that the wildcards are matched 521# against the file with absolute path, so to exclude all test directories 522# for example use the pattern */test/* 523 524EXCLUDE_PATTERNS = 525 526# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 527# (namespaces, classes, functions, etc.) that should be excluded from the output. 528# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 529# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test 530 531EXCLUDE_SYMBOLS = 532 533# The EXAMPLE_PATH tag can be used to specify one or more files or 534# directories that contain example code fragments that are included (see 535# the \include command). 536 537EXAMPLE_PATH = 538 539# If the value of the EXAMPLE_PATH tag contains directories, you can use the 540# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 541# and *.h) to filter out the source-files in the directories. If left 542# blank all files are included. 543 544EXAMPLE_PATTERNS = 545 546# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 547# searched for input files to be used with the \include or \dontinclude 548# commands irrespective of the value of the RECURSIVE tag. 549# Possible values are YES and NO. If left blank NO is used. 550 551EXAMPLE_RECURSIVE = NO 552 553# The IMAGE_PATH tag can be used to specify one or more files or 554# directories that contain image that are included in the documentation (see 555# the \image command). 556 557IMAGE_PATH = 558 559# The INPUT_FILTER tag can be used to specify a program that doxygen should 560# invoke to filter for each input file. Doxygen will invoke the filter program 561# by executing (via popen()) the command <filter> <input-file>, where <filter> 562# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 563# input file. Doxygen will then use the output that the filter program writes 564# to standard output. If FILTER_PATTERNS is specified, this tag will be 565# ignored. 566 567INPUT_FILTER = 568 569# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 570# basis. Doxygen will compare the file name with each pattern and apply the 571# filter if there is a match. The filters are a list of the form: 572# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 573# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 574# is applied to all files. 575 576FILTER_PATTERNS = 577 578# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 579# INPUT_FILTER) will be used to filter the input files when producing source 580# files to browse (i.e. when SOURCE_BROWSER is set to YES). 581 582FILTER_SOURCE_FILES = NO 583 584#--------------------------------------------------------------------------- 585# configuration options related to source browsing 586#--------------------------------------------------------------------------- 587 588# If the SOURCE_BROWSER tag is set to YES then a list of source files will 589# be generated. Documented entities will be cross-referenced with these sources. 590# Note: To get rid of all source code in the generated output, make sure also 591# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH 592# then you must also enable this option. If you don't then doxygen will produce 593# a warning and turn it on anyway 594 595SOURCE_BROWSER = YES 596 597# Setting the INLINE_SOURCES tag to YES will include the body 598# of functions and classes directly in the documentation. 599 600INLINE_SOURCES = YES 601 602# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 603# doxygen to hide any special comment blocks from generated source code 604# fragments. Normal C and C++ comments will always remain visible. 605 606STRIP_CODE_COMMENTS = YES 607 608# If the REFERENCED_BY_RELATION tag is set to YES (the default) 609# then for each documented function all documented 610# functions referencing it will be listed. 611 612REFERENCED_BY_RELATION = NO 613 614# If the REFERENCES_RELATION tag is set to YES (the default) 615# then for each documented function all documented entities 616# called/used by that function will be listed. 617 618REFERENCES_RELATION = YES 619 620# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 621# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 622# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 623# link to the source code. Otherwise they will link to the documentstion. 624 625REFERENCES_LINK_SOURCE = YES 626 627# If the USE_HTAGS tag is set to YES then the references to source code 628# will point to the HTML generated by the htags(1) tool instead of doxygen 629# built-in source browser. The htags tool is part of GNU's global source 630# tagging system (see http://www.gnu.org/software/global/global.html). You 631# will need version 4.8.6 or higher. 632 633USE_HTAGS = NO 634 635# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 636# will generate a verbatim copy of the header file for each class for 637# which an include is specified. Set to NO to disable this. 638 639VERBATIM_HEADERS = NO 640 641#--------------------------------------------------------------------------- 642# configuration options related to the alphabetical class index 643#--------------------------------------------------------------------------- 644 645# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 646# of all compounds will be generated. Enable this if the project 647# contains a lot of classes, structs, unions or interfaces. 648 649ALPHABETICAL_INDEX = NO 650 651# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 652# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 653# in which this list will be split (can be a number in the range [1..20]) 654 655COLS_IN_ALPHA_INDEX = 5 656 657# In case all classes in a project start with a common prefix, all 658# classes will be put under the same header in the alphabetical index. 659# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 660# should be ignored while generating the index headers. 661 662IGNORE_PREFIX = 663 664#--------------------------------------------------------------------------- 665# configuration options related to the HTML output 666#--------------------------------------------------------------------------- 667 668# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 669# generate HTML output. 670 671GENERATE_HTML = YES 672 673# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 674# If a relative path is entered the value of OUTPUT_DIRECTORY will be 675# put in front of it. If left blank `html' will be used as the default path. 676 677HTML_OUTPUT = . 678 679# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 680# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 681# doxygen will generate files with .html extension. 682 683HTML_FILE_EXTENSION = .html 684 685# The HTML_HEADER tag can be used to specify a personal HTML header for 686# each generated HTML page. If it is left blank doxygen will generate a 687# standard header. 688 689HTML_HEADER = 690 691# The HTML_FOOTER tag can be used to specify a personal HTML footer for 692# each generated HTML page. If it is left blank doxygen will generate a 693# standard footer. 694 695HTML_FOOTER = 696 697# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 698# style sheet that is used by each HTML page. It can be used to 699# fine-tune the look of the HTML output. If the tag is left blank doxygen 700# will generate a default style sheet. Note that doxygen will try to copy 701# the style sheet file to the HTML output directory, so don't put your own 702# stylesheet in the HTML output directory as well, or it will be erased! 703 704HTML_STYLESHEET = 705 706# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 707# files or namespaces will be aligned in HTML using tables. If set to 708# NO a bullet list will be used. 709 710HTML_ALIGN_MEMBERS = YES 711 712# If the GENERATE_HTMLHELP tag is set to YES, additional index files 713# will be generated that can be used as input for tools like the 714# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 715# of the generated HTML documentation. 716 717GENERATE_HTMLHELP = NO 718 719# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 720# documentation will contain sections that can be hidden and shown after the 721# page has loaded. For this to work a browser that supports 722# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 723# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 724 725HTML_DYNAMIC_SECTIONS = NO 726 727# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 728# be used to specify the file name of the resulting .chm file. You 729# can add a path in front of the file if the result should not be 730# written to the html output directory. 731 732CHM_FILE = 733 734# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 735# be used to specify the location (absolute path including file name) of 736# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 737# the HTML help compiler on the generated index.hhp. 738 739HHC_LOCATION = 740 741# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 742# controls if a separate .chi index file is generated (YES) or that 743# it should be included in the master .chm file (NO). 744 745GENERATE_CHI = NO 746 747# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 748# controls whether a binary table of contents is generated (YES) or a 749# normal table of contents (NO) in the .chm file. 750 751BINARY_TOC = NO 752 753# The TOC_EXPAND flag can be set to YES to add extra items for group members 754# to the contents of the HTML help documentation and to the tree view. 755 756TOC_EXPAND = NO 757 758# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 759# top of each HTML page. The value NO (the default) enables the index and 760# the value YES disables it. 761 762DISABLE_INDEX = NO 763 764# This tag can be used to set the number of enum values (range [1..20]) 765# that doxygen will group on one line in the generated HTML documentation. 766 767ENUM_VALUES_PER_LINE = 4 768 769# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 770# generated containing a tree-like index structure (just like the one that 771# is generated for HTML Help). For this to work a browser that supports 772# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 773# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 774# probably better off using the HTML help feature. 775 776GENERATE_TREEVIEW = NO 777 778# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 779# used to set the initial width (in pixels) of the frame in which the tree 780# is shown. 781 782TREEVIEW_WIDTH = 250 783 784#--------------------------------------------------------------------------- 785# configuration options related to the LaTeX output 786#--------------------------------------------------------------------------- 787 788# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 789# generate Latex output. 790 791GENERATE_LATEX = NO 792 793# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 794# If a relative path is entered the value of OUTPUT_DIRECTORY will be 795# put in front of it. If left blank `latex' will be used as the default path. 796 797LATEX_OUTPUT = latex 798 799# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 800# invoked. If left blank `latex' will be used as the default command name. 801 802LATEX_CMD_NAME = latex 803 804# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 805# generate index for LaTeX. If left blank `makeindex' will be used as the 806# default command name. 807 808MAKEINDEX_CMD_NAME = makeindex 809 810# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 811# LaTeX documents. This may be useful for small projects and may help to 812# save some trees in general. 813 814COMPACT_LATEX = NO 815 816# The PAPER_TYPE tag can be used to set the paper type that is used 817# by the printer. Possible values are: a4, a4wide, letter, legal and 818# executive. If left blank a4wide will be used. 819 820PAPER_TYPE = a4wide 821 822# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 823# packages that should be included in the LaTeX output. 824 825EXTRA_PACKAGES = 826 827# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 828# the generated latex document. The header should contain everything until 829# the first chapter. If it is left blank doxygen will generate a 830# standard header. Notice: only use this tag if you know what you are doing! 831 832LATEX_HEADER = 833 834# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 835# is prepared for conversion to pdf (using ps2pdf). The pdf file will 836# contain links (just like the HTML output) instead of page references 837# This makes the output suitable for online browsing using a pdf viewer. 838 839PDF_HYPERLINKS = NO 840 841# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 842# plain latex in the generated Makefile. Set this option to YES to get a 843# higher quality PDF documentation. 844 845USE_PDFLATEX = NO 846 847# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 848# command to the generated LaTeX files. This will instruct LaTeX to keep 849# running if errors occur, instead of asking the user for help. 850# This option is also used when generating formulas in HTML. 851 852LATEX_BATCHMODE = NO 853 854# If LATEX_HIDE_INDICES is set to YES then doxygen will not 855# include the index chapters (such as File Index, Compound Index, etc.) 856# in the output. 857 858LATEX_HIDE_INDICES = NO 859 860#--------------------------------------------------------------------------- 861# configuration options related to the RTF output 862#--------------------------------------------------------------------------- 863 864# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 865# The RTF output is optimized for Word 97 and may not look very pretty with 866# other RTF readers or editors. 867 868GENERATE_RTF = NO 869 870# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 871# If a relative path is entered the value of OUTPUT_DIRECTORY will be 872# put in front of it. If left blank `rtf' will be used as the default path. 873 874RTF_OUTPUT = rtf 875 876# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 877# RTF documents. This may be useful for small projects and may help to 878# save some trees in general. 879 880COMPACT_RTF = NO 881 882# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 883# will contain hyperlink fields. The RTF file will 884# contain links (just like the HTML output) instead of page references. 885# This makes the output suitable for online browsing using WORD or other 886# programs which support those fields. 887# Note: wordpad (write) and others do not support links. 888 889RTF_HYPERLINKS = NO 890 891# Load stylesheet definitions from file. Syntax is similar to doxygen's 892# config file, i.e. a series of assignments. You only have to provide 893# replacements, missing definitions are set to their default value. 894 895RTF_STYLESHEET_FILE = 896 897# Set optional variables used in the generation of an rtf document. 898# Syntax is similar to doxygen's config file. 899 900RTF_EXTENSIONS_FILE = 901 902#--------------------------------------------------------------------------- 903# configuration options related to the man page output 904#--------------------------------------------------------------------------- 905 906# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 907# generate man pages 908 909GENERATE_MAN = NO 910 911# The MAN_OUTPUT tag is used to specify where the man pages will be put. 912# If a relative path is entered the value of OUTPUT_DIRECTORY will be 913# put in front of it. If left blank `man' will be used as the default path. 914 915MAN_OUTPUT = man 916 917# The MAN_EXTENSION tag determines the extension that is added to 918# the generated man pages (default is the subroutine's section .3) 919 920MAN_EXTENSION = .3 921 922# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 923# then it will generate one additional man file for each entity 924# documented in the real man page(s). These additional files 925# only source the real man page, but without them the man command 926# would be unable to find the correct page. The default is NO. 927 928MAN_LINKS = NO 929 930#--------------------------------------------------------------------------- 931# configuration options related to the XML output 932#--------------------------------------------------------------------------- 933 934# If the GENERATE_XML tag is set to YES Doxygen will 935# generate an XML file that captures the structure of 936# the code including all documentation. 937 938GENERATE_XML = NO 939 940# The XML_OUTPUT tag is used to specify where the XML pages will be put. 941# If a relative path is entered the value of OUTPUT_DIRECTORY will be 942# put in front of it. If left blank `xml' will be used as the default path. 943 944XML_OUTPUT = xml 945 946# The XML_SCHEMA tag can be used to specify an XML schema, 947# which can be used by a validating XML parser to check the 948# syntax of the XML files. 949 950XML_SCHEMA = 951 952# The XML_DTD tag can be used to specify an XML DTD, 953# which can be used by a validating XML parser to check the 954# syntax of the XML files. 955 956XML_DTD = 957 958# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 959# dump the program listings (including syntax highlighting 960# and cross-referencing information) to the XML output. Note that 961# enabling this will significantly increase the size of the XML output. 962 963XML_PROGRAMLISTING = YES 964 965#--------------------------------------------------------------------------- 966# configuration options for the AutoGen Definitions output 967#--------------------------------------------------------------------------- 968 969# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 970# generate an AutoGen Definitions (see autogen.sf.net) file 971# that captures the structure of the code including all 972# documentation. Note that this feature is still experimental 973# and incomplete at the moment. 974 975GENERATE_AUTOGEN_DEF = NO 976 977#--------------------------------------------------------------------------- 978# configuration options related to the Perl module output 979#--------------------------------------------------------------------------- 980 981# If the GENERATE_PERLMOD tag is set to YES Doxygen will 982# generate a Perl module file that captures the structure of 983# the code including all documentation. Note that this 984# feature is still experimental and incomplete at the 985# moment. 986 987GENERATE_PERLMOD = NO 988 989# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 990# the necessary Makefile rules, Perl scripts and LaTeX code to be able 991# to generate PDF and DVI output from the Perl module output. 992 993PERLMOD_LATEX = NO 994 995# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 996# nicely formatted so it can be parsed by a human reader. This is useful 997# if you want to understand what is going on. On the other hand, if this 998# tag is set to NO the size of the Perl module output will be much smaller 999# and Perl will parse it just the same. 1000 1001PERLMOD_PRETTY = YES 1002 1003# The names of the make variables in the generated doxyrules.make file 1004# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1005# This is useful so different doxyrules.make files included by the same 1006# Makefile don't overwrite each other's variables. 1007 1008PERLMOD_MAKEVAR_PREFIX = 1009 1010#--------------------------------------------------------------------------- 1011# Configuration options related to the preprocessor 1012#--------------------------------------------------------------------------- 1013 1014# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1015# evaluate all C-preprocessor directives found in the sources and include 1016# files. 1017 1018ENABLE_PREPROCESSING = YES 1019 1020# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1021# names in the source code. If set to NO (the default) only conditional 1022# compilation will be performed. Macro expansion can be done in a controlled 1023# way by setting EXPAND_ONLY_PREDEF to YES. 1024 1025MACRO_EXPANSION = YES 1026 1027# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1028# then the macro expansion is limited to the macros specified with the 1029# PREDEFINED and EXPAND_AS_DEFINED tags. 1030 1031EXPAND_ONLY_PREDEF = NO 1032 1033# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1034# in the INCLUDE_PATH (see below) will be search if a #include is found. 1035 1036SEARCH_INCLUDES = YES 1037 1038# The INCLUDE_PATH tag can be used to specify one or more directories that 1039# contain include files that are not input files but should be processed by 1040# the preprocessor. 1041 1042INCLUDE_PATH = 1043 1044# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1045# patterns (like *.h and *.hpp) to filter out the header-files in the 1046# directories. If left blank, the patterns specified with FILE_PATTERNS will 1047# be used. 1048 1049INCLUDE_FILE_PATTERNS = 1050 1051# The PREDEFINED tag can be used to specify one or more macro names that 1052# are defined before the preprocessor is started (similar to the -D option of 1053# gcc). The argument of the tag is a list of macros of the form: name 1054# or name=definition (no spaces). If the definition and the = are 1055# omitted =1 is assumed. To prevent a macro definition from being 1056# undefined via #undef or recursively expanded use the := operator 1057# instead of the = operator. 1058 1059PREDEFINED = INLINE=inline MESA_LLVM=1 1060 1061# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1062# this tag can be used to specify a list of macro names that should be expanded. 1063# The macro definition that is found in the sources will be used. 1064# Use the PREDEFINED tag if you want to use a different macro definition. 1065 1066EXPAND_AS_DEFINED = 1067 1068# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1069# doxygen's preprocessor will remove all function-like macros that are alone 1070# on a line, have an all uppercase name, and do not end with a semicolon. Such 1071# function macros are typically used for boiler-plate code, and will confuse 1072# the parser if not removed. 1073 1074SKIP_FUNCTION_MACROS = YES 1075 1076#--------------------------------------------------------------------------- 1077# Configuration::additions related to external references 1078#--------------------------------------------------------------------------- 1079 1080# The TAGFILES option can be used to specify one or more tagfiles. 1081# Optionally an initial location of the external documentation 1082# can be added for each tagfile. The format of a tag file without 1083# this location is as follows: 1084# TAGFILES = file1 file2 ... 1085# Adding location for the tag files is done as follows: 1086# TAGFILES = file1=loc1 "file2 = loc2" ... 1087# where "loc1" and "loc2" can be relative or absolute paths or 1088# URLs. If a location is present for each tag, the installdox tool 1089# does not have to be run to correct the links. 1090# Note that each tag file must have a unique name 1091# (where the name does NOT include the path) 1092# If a tag file is not located in the directory in which doxygen 1093# is run, you must also specify the path to the tagfile here. 1094 1095TAGFILES = \ 1096 main.tag=../main \ 1097 math.tag=../math \ 1098 swrast_setup.tag=../swrast_setup \ 1099 swrast.tag=../swrast \ 1100 tnl_dd.tag=../tnl_dd \ 1101 tnl.tag=../tnl \ 1102 vbo.tag=../vbo 1103 1104# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1105# a tag file that is based on the input files it reads. 1106 1107GENERATE_TAGFILE = 1108 1109# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1110# in the class index. If set to NO only the inherited external classes 1111# will be listed. 1112 1113ALLEXTERNALS = NO 1114 1115# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1116# in the modules index. If set to NO, only the current project's groups will 1117# be listed. 1118 1119EXTERNAL_GROUPS = YES 1120 1121# The PERL_PATH should be the absolute path and name of the perl script 1122# interpreter (i.e. the result of `which perl'). 1123 1124PERL_PATH = /usr/bin/perl 1125 1126#--------------------------------------------------------------------------- 1127# Configuration options related to the dot tool 1128#--------------------------------------------------------------------------- 1129 1130# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1131# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1132# or super classes. Setting the tag to NO turns the diagrams off. Note that 1133# this option is superseded by the HAVE_DOT option below. This is only a 1134# fallback. It is recommended to install and use dot, since it yields more 1135# powerful graphs. 1136 1137CLASS_DIAGRAMS = YES 1138 1139# You can define message sequence charts within doxygen comments using the \msc 1140# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 1141# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 1142# specify the directory where the mscgen tool resides. If left empty the tool is assumed to 1143# be found in the default search path. 1144 1145MSCGEN_PATH = 1146 1147# If set to YES, the inheritance and collaboration graphs will hide 1148# inheritance and usage relations if the target is undocumented 1149# or is not a class. 1150 1151HIDE_UNDOC_RELATIONS = YES 1152 1153# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1154# available from the path. This tool is part of Graphviz, a graph visualization 1155# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1156# have no effect if this option is set to NO (the default) 1157 1158HAVE_DOT = YES 1159 1160# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1161# will generate a graph for each documented class showing the direct and 1162# indirect inheritance relations. Setting this tag to YES will force the 1163# the CLASS_DIAGRAMS tag to NO. 1164 1165CLASS_GRAPH = YES 1166 1167# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1168# will generate a graph for each documented class showing the direct and 1169# indirect implementation dependencies (inheritance, containment, and 1170# class references variables) of the class with other documented classes. 1171 1172COLLABORATION_GRAPH = YES 1173 1174# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1175# will generate a graph for groups, showing the direct groups dependencies 1176 1177GROUP_GRAPHS = YES 1178 1179# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1180# collaboration diagrams in a style similar to the OMG's Unified Modeling 1181# Language. 1182 1183UML_LOOK = NO 1184 1185# If set to YES, the inheritance and collaboration graphs will show the 1186# relations between templates and their instances. 1187 1188TEMPLATE_RELATIONS = NO 1189 1190# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1191# tags are set to YES then doxygen will generate a graph for each documented 1192# file showing the direct and indirect include dependencies of the file with 1193# other documented files. 1194 1195INCLUDE_GRAPH = YES 1196 1197# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1198# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1199# documented header file showing the documented files that directly or 1200# indirectly include this file. 1201 1202INCLUDED_BY_GRAPH = YES 1203 1204# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 1205# generate a call dependency graph for every global function or class method. 1206# Note that enabling this option will significantly increase the time of a run. 1207# So in most cases it will be better to enable call graphs for selected 1208# functions only using the \callgraph command. 1209 1210CALL_GRAPH = NO 1211 1212# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 1213# generate a caller dependency graph for every global function or class method. 1214# Note that enabling this option will significantly increase the time of a run. 1215# So in most cases it will be better to enable caller graphs for selected 1216# functions only using the \callergraph command. 1217 1218CALLER_GRAPH = NO 1219 1220# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1221# will graphical hierarchy of all classes instead of a textual one. 1222 1223GRAPHICAL_HIERARCHY = YES 1224 1225# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1226# then doxygen will show the dependencies a directory has on other directories 1227# in a graphical way. The dependency relations are determined by the #include 1228# relations between the files in the directories. 1229 1230DIRECTORY_GRAPH = YES 1231 1232# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1233# generated by dot. Possible values are png, jpg, or gif 1234# If left blank png will be used. 1235 1236DOT_IMAGE_FORMAT = png 1237 1238# The tag DOT_PATH can be used to specify the path where the dot tool can be 1239# found. If left blank, it is assumed the dot tool can be found in the path. 1240 1241DOT_PATH = 1242 1243# The DOTFILE_DIRS tag can be used to specify one or more directories that 1244# contain dot files that are included in the documentation (see the 1245# \dotfile command). 1246 1247DOTFILE_DIRS = 1248 1249# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1250# nodes that will be shown in the graph. If the number of nodes in a graph 1251# becomes larger than this value, doxygen will truncate the graph, which is 1252# visualized by representing a node as a red box. Note that doxygen if the number 1253# of direct children of the root node in a graph is already larger than 1254# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note 1255# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1256 1257DOT_GRAPH_MAX_NODES = 50 1258 1259# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1260# graphs generated by dot. A depth value of 3 means that only nodes reachable 1261# from the root by following a path via at most 3 edges will be shown. Nodes 1262# that lay further from the root node will be omitted. Note that setting this 1263# option to 1 or 2 may greatly reduce the computation time needed for large 1264# code bases. Also note that the size of a graph can be further restricted by 1265# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1266 1267MAX_DOT_GRAPH_DEPTH = 0 1268 1269# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1270# background. This is disabled by default, which results in a white background. 1271# Warning: Depending on the platform used, enabling this option may lead to 1272# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1273# read). 1274 1275DOT_TRANSPARENT = NO 1276 1277# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1278# files in one run (i.e. multiple -o and -T options on the command line). This 1279# makes dot run faster, but since only newer versions of dot (>1.8.10) 1280# support this, this feature is disabled by default. 1281 1282DOT_MULTI_TARGETS = NO 1283 1284# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1285# generate a legend page explaining the meaning of the various boxes and 1286# arrows in the dot generated graphs. 1287 1288GENERATE_LEGEND = YES 1289 1290# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1291# remove the intermediate dot files that are used to generate 1292# the various graphs. 1293 1294DOT_CLEANUP = YES 1295 1296#--------------------------------------------------------------------------- 1297# Configuration::additions related to the search engine 1298#--------------------------------------------------------------------------- 1299 1300# The SEARCHENGINE tag specifies whether or not a search engine should be 1301# used. If set to NO the values of all tags below this one will be ignored. 1302 1303SEARCHENGINE = NO 1304