1848b8605Smrg# Doxyfile 1.5.3 2848b8605Smrg 3848b8605Smrg# This file describes the settings to be used by the documentation system 4848b8605Smrg# doxygen (www.doxygen.org) for a project 5848b8605Smrg# 6848b8605Smrg# All text after a hash (#) is considered a comment and will be ignored 7848b8605Smrg# The format is: 8848b8605Smrg# TAG = value [value, ...] 9848b8605Smrg# For lists items can also be appended using: 10848b8605Smrg# TAG += value [value, ...] 11848b8605Smrg# Values that contain spaces should be placed between quotes (" ") 12848b8605Smrg 13848b8605Smrg#--------------------------------------------------------------------------- 14848b8605Smrg# Project related configuration options 15848b8605Smrg#--------------------------------------------------------------------------- 16848b8605Smrg 17848b8605Smrg# This tag specifies the encoding used for all characters in the config file that 18848b8605Smrg# follow. The default is UTF-8 which is also the encoding used for all text before 19848b8605Smrg# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 20848b8605Smrg# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 21848b8605Smrg# possible encodings. 22848b8605Smrg 23848b8605SmrgDOXYFILE_ENCODING = UTF-8 24848b8605Smrg 25848b8605Smrg# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 26848b8605Smrg# by quotes) that should identify the project. 27848b8605Smrg 28848b8605SmrgPROJECT_NAME = Gallium3D 29848b8605Smrg 30848b8605Smrg# The PROJECT_NUMBER tag can be used to enter a project or revision number. 31848b8605Smrg# This could be handy for archiving the generated documentation or 32848b8605Smrg# if some version control system is used. 33848b8605Smrg 34848b8605SmrgPROJECT_NUMBER = 0.1 35848b8605Smrg 36848b8605Smrg# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 37848b8605Smrg# base path where the generated documentation will be put. 38848b8605Smrg# If a relative path is entered, it will be relative to the location 39848b8605Smrg# where doxygen was started. If left blank the current directory will be used. 40848b8605Smrg 41848b8605SmrgOUTPUT_DIRECTORY = gallium 42848b8605Smrg 43848b8605Smrg# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 44848b8605Smrg# 4096 sub-directories (in 2 levels) under the output directory of each output 45848b8605Smrg# format and will distribute the generated files over these directories. 46848b8605Smrg# Enabling this option can be useful when feeding doxygen a huge amount of 47848b8605Smrg# source files, where putting all generated files in the same directory would 48848b8605Smrg# otherwise cause performance problems for the file system. 49848b8605Smrg 50848b8605SmrgCREATE_SUBDIRS = NO 51848b8605Smrg 52848b8605Smrg# The OUTPUT_LANGUAGE tag is used to specify the language in which all 53848b8605Smrg# documentation generated by doxygen is written. Doxygen will use this 54848b8605Smrg# information to generate all constant output in the proper language. 55848b8605Smrg# The default language is English, other supported languages are: 56848b8605Smrg# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 57848b8605Smrg# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 58848b8605Smrg# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 59848b8605Smrg# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 60848b8605Smrg# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 61848b8605Smrg 62848b8605SmrgOUTPUT_LANGUAGE = English 63848b8605Smrg 64848b8605Smrg# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 65848b8605Smrg# include brief member descriptions after the members that are listed in 66848b8605Smrg# the file and class documentation (similar to JavaDoc). 67848b8605Smrg# Set to NO to disable this. 68848b8605Smrg 69848b8605SmrgBRIEF_MEMBER_DESC = YES 70848b8605Smrg 71848b8605Smrg# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 72848b8605Smrg# the brief description of a member or function before the detailed description. 73848b8605Smrg# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 74848b8605Smrg# brief descriptions will be completely suppressed. 75848b8605Smrg 76848b8605SmrgREPEAT_BRIEF = YES 77848b8605Smrg 78848b8605Smrg# This tag implements a quasi-intelligent brief description abbreviator 79848b8605Smrg# that is used to form the text in various listings. Each string 80848b8605Smrg# in this list, if found as the leading text of the brief description, will be 81848b8605Smrg# stripped from the text and the result after processing the whole list, is 82848b8605Smrg# used as the annotated text. Otherwise, the brief description is used as-is. 83848b8605Smrg# If left blank, the following values are used ("$name" is automatically 84848b8605Smrg# replaced with the name of the entity): "The $name class" "The $name widget" 85848b8605Smrg# "The $name file" "is" "provides" "specifies" "contains" 86848b8605Smrg# "represents" "a" "an" "the" 87848b8605Smrg 88848b8605SmrgABBREVIATE_BRIEF = 89848b8605Smrg 90848b8605Smrg# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 91848b8605Smrg# Doxygen will generate a detailed section even if there is only a brief 92848b8605Smrg# description. 93848b8605Smrg 94848b8605SmrgALWAYS_DETAILED_SEC = NO 95848b8605Smrg 96848b8605Smrg# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 97848b8605Smrg# inherited members of a class in the documentation of that class as if those 98848b8605Smrg# members were ordinary class members. Constructors, destructors and assignment 99848b8605Smrg# operators of the base classes will not be shown. 100848b8605Smrg 101848b8605SmrgINLINE_INHERITED_MEMB = NO 102848b8605Smrg 103848b8605Smrg# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 104848b8605Smrg# path before files name in the file list and in the header files. If set 105848b8605Smrg# to NO the shortest path that makes the file name unique will be used. 106848b8605Smrg 107848b8605SmrgFULL_PATH_NAMES = YES 108848b8605Smrg 109848b8605Smrg# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 110848b8605Smrg# can be used to strip a user-defined part of the path. Stripping is 111848b8605Smrg# only done if one of the specified strings matches the left-hand part of 112848b8605Smrg# the path. The tag can be used to show relative paths in the file list. 113848b8605Smrg# If left blank the directory from which doxygen is run is used as the 114848b8605Smrg# path to strip. 115848b8605Smrg 116848b8605SmrgSTRIP_FROM_PATH = ../src 117848b8605Smrg 118848b8605Smrg# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 119848b8605Smrg# the path mentioned in the documentation of a class, which tells 120848b8605Smrg# the reader which header file to include in order to use a class. 121848b8605Smrg# If left blank only the name of the header file containing the class 122848b8605Smrg# definition is used. Otherwise one should specify the include paths that 123848b8605Smrg# are normally passed to the compiler using the -I flag. 124848b8605Smrg 125848b8605SmrgSTRIP_FROM_INC_PATH = 126848b8605Smrg 127848b8605Smrg# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 128848b8605Smrg# (but less readable) file names. This can be useful is your file systems 129848b8605Smrg# doesn't support long names like on DOS, Mac, or CD-ROM. 130848b8605Smrg 131848b8605SmrgSHORT_NAMES = NO 132848b8605Smrg 133848b8605Smrg# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 134848b8605Smrg# will interpret the first line (until the first dot) of a JavaDoc-style 135848b8605Smrg# comment as the brief description. If set to NO, the JavaDoc 136848b8605Smrg# comments will behave just like regular Qt-style comments 137848b8605Smrg# (thus requiring an explicit @brief command for a brief description.) 138848b8605Smrg 139848b8605SmrgJAVADOC_AUTOBRIEF = YES 140848b8605Smrg 141848b8605Smrg# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 142848b8605Smrg# interpret the first line (until the first dot) of a Qt-style 143848b8605Smrg# comment as the brief description. If set to NO, the comments 144848b8605Smrg# will behave just like regular Qt-style comments (thus requiring 145848b8605Smrg# an explicit \brief command for a brief description.) 146848b8605Smrg 147848b8605SmrgQT_AUTOBRIEF = YES 148848b8605Smrg 149848b8605Smrg# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 150848b8605Smrg# treat a multi-line C++ special comment block (i.e. a block of //! or /// 151848b8605Smrg# comments) as a brief description. This used to be the default behaviour. 152848b8605Smrg# The new default is to treat a multi-line C++ comment block as a detailed 153848b8605Smrg# description. Set this tag to YES if you prefer the old behaviour instead. 154848b8605Smrg 155848b8605SmrgMULTILINE_CPP_IS_BRIEF = NO 156848b8605Smrg 157848b8605Smrg# If the DETAILS_AT_TOP tag is set to YES then Doxygen 158848b8605Smrg# will output the detailed description near the top, like JavaDoc. 159848b8605Smrg# If set to NO, the detailed description appears after the member 160848b8605Smrg# documentation. 161848b8605Smrg 162848b8605SmrgDETAILS_AT_TOP = NO 163848b8605Smrg 164848b8605Smrg# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 165848b8605Smrg# member inherits the documentation from any documented member that it 166848b8605Smrg# re-implements. 167848b8605Smrg 168848b8605SmrgINHERIT_DOCS = YES 169848b8605Smrg 170848b8605Smrg# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 171848b8605Smrg# a new page for each member. If set to NO, the documentation of a member will 172848b8605Smrg# be part of the file/class/namespace that contains it. 173848b8605Smrg 174848b8605SmrgSEPARATE_MEMBER_PAGES = NO 175848b8605Smrg 176848b8605Smrg# The TAB_SIZE tag can be used to set the number of spaces in a tab. 177848b8605Smrg# Doxygen uses this value to replace tabs by spaces in code fragments. 178848b8605Smrg 179848b8605SmrgTAB_SIZE = 8 180848b8605Smrg 181848b8605Smrg# This tag can be used to specify a number of aliases that acts 182848b8605Smrg# as commands in the documentation. An alias has the form "name=value". 183848b8605Smrg# For example adding "sideeffect=\par Side Effects:\n" will allow you to 184848b8605Smrg# put the command \sideeffect (or @sideeffect) in the documentation, which 185848b8605Smrg# will result in a user-defined paragraph with heading "Side Effects:". 186848b8605Smrg# You can put \n's in the value part of an alias to insert newlines. 187848b8605Smrg 188848b8605SmrgALIASES = 189848b8605Smrg 190848b8605Smrg# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 191848b8605Smrg# sources only. Doxygen will then generate output that is more tailored for C. 192848b8605Smrg# For instance, some of the names that are used will be different. The list 193848b8605Smrg# of all members will be omitted, etc. 194848b8605Smrg 195848b8605SmrgOPTIMIZE_OUTPUT_FOR_C = YES 196848b8605Smrg 197848b8605Smrg# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 198848b8605Smrg# sources only. Doxygen will then generate output that is more tailored for Java. 199848b8605Smrg# For instance, namespaces will be presented as packages, qualified scopes 200848b8605Smrg# will look different, etc. 201848b8605Smrg 202848b8605SmrgOPTIMIZE_OUTPUT_JAVA = NO 203848b8605Smrg 204848b8605Smrg# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 205848b8605Smrg# include (a tag file for) the STL sources as input, then you should 206848b8605Smrg# set this tag to YES in order to let doxygen match functions declarations and 207848b8605Smrg# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 208848b8605Smrg# func(std::string) {}). This also make the inheritance and collaboration 209848b8605Smrg# diagrams that involve STL classes more complete and accurate. 210848b8605Smrg 211848b8605SmrgBUILTIN_STL_SUPPORT = NO 212848b8605Smrg 213848b8605Smrg# If you use Microsoft's C++/CLI language, you should set this option to YES to 214848b8605Smrg# enable parsing support. 215848b8605Smrg 216848b8605SmrgCPP_CLI_SUPPORT = NO 217848b8605Smrg 218848b8605Smrg# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 219848b8605Smrg# tag is set to YES, then doxygen will reuse the documentation of the first 220848b8605Smrg# member in the group (if any) for the other members of the group. By default 221848b8605Smrg# all members of a group must be documented explicitly. 222848b8605Smrg 223848b8605SmrgDISTRIBUTE_GROUP_DOC = NO 224848b8605Smrg 225848b8605Smrg# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 226848b8605Smrg# the same type (for instance a group of public functions) to be put as a 227848b8605Smrg# subgroup of that type (e.g. under the Public Functions section). Set it to 228848b8605Smrg# NO to prevent subgrouping. Alternatively, this can be done per class using 229848b8605Smrg# the \nosubgrouping command. 230848b8605Smrg 231848b8605SmrgSUBGROUPING = YES 232848b8605Smrg 233848b8605Smrg#--------------------------------------------------------------------------- 234848b8605Smrg# Build related configuration options 235848b8605Smrg#--------------------------------------------------------------------------- 236848b8605Smrg 237848b8605Smrg# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 238848b8605Smrg# documentation are documented, even if no documentation was available. 239848b8605Smrg# Private class members and static file members will be hidden unless 240848b8605Smrg# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 241848b8605Smrg 242848b8605SmrgEXTRACT_ALL = YES 243848b8605Smrg 244848b8605Smrg# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 245848b8605Smrg# will be included in the documentation. 246848b8605Smrg 247848b8605SmrgEXTRACT_PRIVATE = YES 248848b8605Smrg 249848b8605Smrg# If the EXTRACT_STATIC tag is set to YES all static members of a file 250848b8605Smrg# will be included in the documentation. 251848b8605Smrg 252848b8605SmrgEXTRACT_STATIC = YES 253848b8605Smrg 254848b8605Smrg# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 255848b8605Smrg# defined locally in source files will be included in the documentation. 256848b8605Smrg# If set to NO only classes defined in header files are included. 257848b8605Smrg 258848b8605SmrgEXTRACT_LOCAL_CLASSES = YES 259848b8605Smrg 260848b8605Smrg# This flag is only useful for Objective-C code. When set to YES local 261848b8605Smrg# methods, which are defined in the implementation section but not in 262848b8605Smrg# the interface are included in the documentation. 263848b8605Smrg# If set to NO (the default) only methods in the interface are included. 264848b8605Smrg 265848b8605SmrgEXTRACT_LOCAL_METHODS = NO 266848b8605Smrg 267848b8605Smrg# If this flag is set to YES, the members of anonymous namespaces will be extracted 268848b8605Smrg# and appear in the documentation as a namespace called 'anonymous_namespace{file}', 269848b8605Smrg# where file will be replaced with the base name of the file that contains the anonymous 270848b8605Smrg# namespace. By default anonymous namespace are hidden. 271848b8605Smrg 272848b8605SmrgEXTRACT_ANON_NSPACES = NO 273848b8605Smrg 274848b8605Smrg# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 275848b8605Smrg# undocumented members of documented classes, files or namespaces. 276848b8605Smrg# If set to NO (the default) these members will be included in the 277848b8605Smrg# various overviews, but no documentation section is generated. 278848b8605Smrg# This option has no effect if EXTRACT_ALL is enabled. 279848b8605Smrg 280848b8605SmrgHIDE_UNDOC_MEMBERS = NO 281848b8605Smrg 282848b8605Smrg# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 283848b8605Smrg# undocumented classes that are normally visible in the class hierarchy. 284848b8605Smrg# If set to NO (the default) these classes will be included in the various 285848b8605Smrg# overviews. This option has no effect if EXTRACT_ALL is enabled. 286848b8605Smrg 287848b8605SmrgHIDE_UNDOC_CLASSES = NO 288848b8605Smrg 289848b8605Smrg# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 290848b8605Smrg# friend (class|struct|union) declarations. 291848b8605Smrg# If set to NO (the default) these declarations will be included in the 292848b8605Smrg# documentation. 293848b8605Smrg 294848b8605SmrgHIDE_FRIEND_COMPOUNDS = NO 295848b8605Smrg 296848b8605Smrg# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 297848b8605Smrg# documentation blocks found inside the body of a function. 298848b8605Smrg# If set to NO (the default) these blocks will be appended to the 299848b8605Smrg# function's detailed documentation block. 300848b8605Smrg 301848b8605SmrgHIDE_IN_BODY_DOCS = NO 302848b8605Smrg 303848b8605Smrg# The INTERNAL_DOCS tag determines if documentation 304848b8605Smrg# that is typed after a \internal command is included. If the tag is set 305848b8605Smrg# to NO (the default) then the documentation will be excluded. 306848b8605Smrg# Set it to YES to include the internal documentation. 307848b8605Smrg 308848b8605SmrgINTERNAL_DOCS = NO 309848b8605Smrg 310848b8605Smrg# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 311848b8605Smrg# file names in lower-case letters. If set to YES upper-case letters are also 312848b8605Smrg# allowed. This is useful if you have classes or files whose names only differ 313848b8605Smrg# in case and if your file system supports case sensitive file names. Windows 314848b8605Smrg# and Mac users are advised to set this option to NO. 315848b8605Smrg 316848b8605SmrgCASE_SENSE_NAMES = YES 317848b8605Smrg 318848b8605Smrg# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 319848b8605Smrg# will show members with their full class and namespace scopes in the 320848b8605Smrg# documentation. If set to YES the scope will be hidden. 321848b8605Smrg 322848b8605SmrgHIDE_SCOPE_NAMES = NO 323848b8605Smrg 324848b8605Smrg# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 325848b8605Smrg# will put a list of the files that are included by a file in the documentation 326848b8605Smrg# of that file. 327848b8605Smrg 328848b8605SmrgSHOW_INCLUDE_FILES = NO 329848b8605Smrg 330848b8605Smrg# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 331848b8605Smrg# is inserted in the documentation for inline members. 332848b8605Smrg 333848b8605SmrgINLINE_INFO = NO 334848b8605Smrg 335848b8605Smrg# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 336848b8605Smrg# will sort the (detailed) documentation of file and class members 337848b8605Smrg# alphabetically by member name. If set to NO the members will appear in 338848b8605Smrg# declaration order. 339848b8605Smrg 340848b8605SmrgSORT_MEMBER_DOCS = YES 341848b8605Smrg 342848b8605Smrg# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 343848b8605Smrg# brief documentation of file, namespace and class members alphabetically 344848b8605Smrg# by member name. If set to NO (the default) the members will appear in 345848b8605Smrg# declaration order. 346848b8605Smrg 347848b8605SmrgSORT_BRIEF_DOCS = NO 348848b8605Smrg 349848b8605Smrg# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 350848b8605Smrg# sorted by fully-qualified names, including namespaces. If set to 351848b8605Smrg# NO (the default), the class list will be sorted only by class name, 352848b8605Smrg# not including the namespace part. 353848b8605Smrg# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 354848b8605Smrg# Note: This option applies only to the class list, not to the 355848b8605Smrg# alphabetical list. 356848b8605Smrg 357848b8605SmrgSORT_BY_SCOPE_NAME = NO 358848b8605Smrg 359848b8605Smrg# The GENERATE_TODOLIST tag can be used to enable (YES) or 360848b8605Smrg# disable (NO) the todo list. This list is created by putting \todo 361848b8605Smrg# commands in the documentation. 362848b8605Smrg 363848b8605SmrgGENERATE_TODOLIST = NO 364848b8605Smrg 365848b8605Smrg# The GENERATE_TESTLIST tag can be used to enable (YES) or 366848b8605Smrg# disable (NO) the test list. This list is created by putting \test 367848b8605Smrg# commands in the documentation. 368848b8605Smrg 369848b8605SmrgGENERATE_TESTLIST = NO 370848b8605Smrg 371848b8605Smrg# The GENERATE_BUGLIST tag can be used to enable (YES) or 372848b8605Smrg# disable (NO) the bug list. This list is created by putting \bug 373848b8605Smrg# commands in the documentation. 374848b8605Smrg 375848b8605SmrgGENERATE_BUGLIST = NO 376848b8605Smrg 377848b8605Smrg# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 378848b8605Smrg# disable (NO) the deprecated list. This list is created by putting 379848b8605Smrg# \deprecated commands in the documentation. 380848b8605Smrg 381848b8605SmrgGENERATE_DEPRECATEDLIST= YES 382848b8605Smrg 383848b8605Smrg# The ENABLED_SECTIONS tag can be used to enable conditional 384848b8605Smrg# documentation sections, marked by \if sectionname ... \endif. 385848b8605Smrg 386848b8605SmrgENABLED_SECTIONS = 387848b8605Smrg 388848b8605Smrg# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 389848b8605Smrg# the initial value of a variable or define consists of for it to appear in 390848b8605Smrg# the documentation. If the initializer consists of more lines than specified 391848b8605Smrg# here it will be hidden. Use a value of 0 to hide initializers completely. 392848b8605Smrg# The appearance of the initializer of individual variables and defines in the 393848b8605Smrg# documentation can be controlled using \showinitializer or \hideinitializer 394848b8605Smrg# command in the documentation regardless of this setting. 395848b8605Smrg 396848b8605SmrgMAX_INITIALIZER_LINES = 30 397848b8605Smrg 398848b8605Smrg# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 399848b8605Smrg# at the bottom of the documentation of classes and structs. If set to YES the 400848b8605Smrg# list will mention the files that were used to generate the documentation. 401848b8605Smrg 402848b8605SmrgSHOW_USED_FILES = YES 403848b8605Smrg 404848b8605Smrg# If the sources in your project are distributed over multiple directories 405848b8605Smrg# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 406848b8605Smrg# in the documentation. The default is NO. 407848b8605Smrg 408848b8605SmrgSHOW_DIRECTORIES = YES 409848b8605Smrg 410848b8605Smrg# The FILE_VERSION_FILTER tag can be used to specify a program or script that 411848b8605Smrg# doxygen should invoke to get the current version for each file (typically from the 412848b8605Smrg# version control system). Doxygen will invoke the program by executing (via 413848b8605Smrg# popen()) the command <command> <input-file>, where <command> is the value of 414848b8605Smrg# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 415848b8605Smrg# provided by doxygen. Whatever the program writes to standard output 416848b8605Smrg# is used as the file version. See the manual for examples. 417848b8605Smrg 418848b8605SmrgFILE_VERSION_FILTER = 419848b8605Smrg 420848b8605Smrg#--------------------------------------------------------------------------- 421848b8605Smrg# configuration options related to warning and progress messages 422848b8605Smrg#--------------------------------------------------------------------------- 423848b8605Smrg 424848b8605Smrg# The QUIET tag can be used to turn on/off the messages that are generated 425848b8605Smrg# by doxygen. Possible values are YES and NO. If left blank NO is used. 426848b8605Smrg 427848b8605SmrgQUIET = NO 428848b8605Smrg 429848b8605Smrg# The WARNINGS tag can be used to turn on/off the warning messages that are 430848b8605Smrg# generated by doxygen. Possible values are YES and NO. If left blank 431848b8605Smrg# NO is used. 432848b8605Smrg 433848b8605SmrgWARNINGS = YES 434848b8605Smrg 435848b8605Smrg# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 436848b8605Smrg# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 437848b8605Smrg# automatically be disabled. 438848b8605Smrg 439848b8605SmrgWARN_IF_UNDOCUMENTED = YES 440848b8605Smrg 441848b8605Smrg# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 442848b8605Smrg# potential errors in the documentation, such as not documenting some 443848b8605Smrg# parameters in a documented function, or documenting parameters that 444848b8605Smrg# don't exist or using markup commands wrongly. 445848b8605Smrg 446848b8605SmrgWARN_IF_DOC_ERROR = YES 447848b8605Smrg 448848b8605Smrg# This WARN_NO_PARAMDOC option can be abled to get warnings for 449848b8605Smrg# functions that are documented, but have no documentation for their parameters 450848b8605Smrg# or return value. If set to NO (the default) doxygen will only warn about 451848b8605Smrg# wrong or incomplete parameter documentation, but not about the absence of 452848b8605Smrg# documentation. 453848b8605Smrg 454848b8605SmrgWARN_NO_PARAMDOC = NO 455848b8605Smrg 456848b8605Smrg# The WARN_FORMAT tag determines the format of the warning messages that 457848b8605Smrg# doxygen can produce. The string should contain the $file, $line, and $text 458848b8605Smrg# tags, which will be replaced by the file and line number from which the 459848b8605Smrg# warning originated and the warning text. Optionally the format may contain 460848b8605Smrg# $version, which will be replaced by the version of the file (if it could 461848b8605Smrg# be obtained via FILE_VERSION_FILTER) 462848b8605Smrg 463848b8605SmrgWARN_FORMAT = "$file:$line: $text" 464848b8605Smrg 465848b8605Smrg# The WARN_LOGFILE tag can be used to specify a file to which warning 466848b8605Smrg# and error messages should be written. If left blank the output is written 467848b8605Smrg# to stderr. 468848b8605Smrg 469848b8605SmrgWARN_LOGFILE = 470848b8605Smrg 471848b8605Smrg#--------------------------------------------------------------------------- 472848b8605Smrg# configuration options related to the input files 473848b8605Smrg#--------------------------------------------------------------------------- 474848b8605Smrg 475848b8605Smrg# The INPUT tag can be used to specify the files and/or directories that contain 476848b8605Smrg# documented source files. You may enter file names like "myfile.cpp" or 477848b8605Smrg# directories like "/usr/src/myproject". Separate the files or directories 478848b8605Smrg# with spaces. 479848b8605Smrg 480848b8605SmrgINPUT = gallium.doc \ 481848b8605Smrg ../src/gallium \ 482848b8605Smrg ../src/mesa/state_tracker 483848b8605Smrg 484848b8605Smrg# This tag can be used to specify the character encoding of the source files that 485848b8605Smrg# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 486848b8605Smrg# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 487848b8605Smrg# See http://www.gnu.org/software/libiconv for the list of possible encodings. 488848b8605Smrg 489848b8605SmrgINPUT_ENCODING = UTF-8 490848b8605Smrg 491848b8605Smrg# If the value of the INPUT tag contains directories, you can use the 492848b8605Smrg# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 493848b8605Smrg# and *.h) to filter out the source-files in the directories. If left 494848b8605Smrg# blank the following patterns are tested: 495848b8605Smrg# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 496848b8605Smrg# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py 497848b8605Smrg 498848b8605SmrgFILE_PATTERNS = *.c *.h *.cpp *.hpp 499848b8605Smrg 500848b8605Smrg# The RECURSIVE tag can be used to turn specify whether or not subdirectories 501848b8605Smrg# should be searched for input files as well. Possible values are YES and NO. 502848b8605Smrg# If left blank NO is used. 503848b8605Smrg 504848b8605SmrgRECURSIVE = YES 505848b8605Smrg 506848b8605Smrg# The EXCLUDE tag can be used to specify files and/or directories that should 507848b8605Smrg# excluded from the INPUT source files. This way you can easily exclude a 508848b8605Smrg# subdirectory from a directory tree whose root is specified with the INPUT tag. 509848b8605Smrg 510848b8605SmrgEXCLUDE = 511848b8605Smrg 512848b8605Smrg# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 513848b8605Smrg# directories that are symbolic links (a Unix filesystem feature) are excluded 514848b8605Smrg# from the input. 515848b8605Smrg 516848b8605SmrgEXCLUDE_SYMLINKS = NO 517848b8605Smrg 518848b8605Smrg# If the value of the INPUT tag contains directories, you can use the 519848b8605Smrg# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 520848b8605Smrg# certain files from those directories. Note that the wildcards are matched 521848b8605Smrg# against the file with absolute path, so to exclude all test directories 522848b8605Smrg# for example use the pattern */test/* 523848b8605Smrg 524848b8605SmrgEXCLUDE_PATTERNS = 525848b8605Smrg 526848b8605Smrg# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 527848b8605Smrg# (namespaces, classes, functions, etc.) that should be excluded from the output. 528848b8605Smrg# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 529848b8605Smrg# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test 530848b8605Smrg 531848b8605SmrgEXCLUDE_SYMBOLS = 532848b8605Smrg 533848b8605Smrg# The EXAMPLE_PATH tag can be used to specify one or more files or 534848b8605Smrg# directories that contain example code fragments that are included (see 535848b8605Smrg# the \include command). 536848b8605Smrg 537848b8605SmrgEXAMPLE_PATH = 538848b8605Smrg 539848b8605Smrg# If the value of the EXAMPLE_PATH tag contains directories, you can use the 540848b8605Smrg# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 541848b8605Smrg# and *.h) to filter out the source-files in the directories. If left 542848b8605Smrg# blank all files are included. 543848b8605Smrg 544848b8605SmrgEXAMPLE_PATTERNS = 545848b8605Smrg 546848b8605Smrg# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 547848b8605Smrg# searched for input files to be used with the \include or \dontinclude 548848b8605Smrg# commands irrespective of the value of the RECURSIVE tag. 549848b8605Smrg# Possible values are YES and NO. If left blank NO is used. 550848b8605Smrg 551848b8605SmrgEXAMPLE_RECURSIVE = NO 552848b8605Smrg 553848b8605Smrg# The IMAGE_PATH tag can be used to specify one or more files or 554848b8605Smrg# directories that contain image that are included in the documentation (see 555848b8605Smrg# the \image command). 556848b8605Smrg 557848b8605SmrgIMAGE_PATH = 558848b8605Smrg 559848b8605Smrg# The INPUT_FILTER tag can be used to specify a program that doxygen should 560848b8605Smrg# invoke to filter for each input file. Doxygen will invoke the filter program 561848b8605Smrg# by executing (via popen()) the command <filter> <input-file>, where <filter> 562848b8605Smrg# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 563848b8605Smrg# input file. Doxygen will then use the output that the filter program writes 564848b8605Smrg# to standard output. If FILTER_PATTERNS is specified, this tag will be 565848b8605Smrg# ignored. 566848b8605Smrg 567848b8605SmrgINPUT_FILTER = 568848b8605Smrg 569848b8605Smrg# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 570848b8605Smrg# basis. Doxygen will compare the file name with each pattern and apply the 571848b8605Smrg# filter if there is a match. The filters are a list of the form: 572848b8605Smrg# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 573848b8605Smrg# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 574848b8605Smrg# is applied to all files. 575848b8605Smrg 576848b8605SmrgFILTER_PATTERNS = 577848b8605Smrg 578848b8605Smrg# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 579848b8605Smrg# INPUT_FILTER) will be used to filter the input files when producing source 580848b8605Smrg# files to browse (i.e. when SOURCE_BROWSER is set to YES). 581848b8605Smrg 582848b8605SmrgFILTER_SOURCE_FILES = NO 583848b8605Smrg 584848b8605Smrg#--------------------------------------------------------------------------- 585848b8605Smrg# configuration options related to source browsing 586848b8605Smrg#--------------------------------------------------------------------------- 587848b8605Smrg 588848b8605Smrg# If the SOURCE_BROWSER tag is set to YES then a list of source files will 589848b8605Smrg# be generated. Documented entities will be cross-referenced with these sources. 590848b8605Smrg# Note: To get rid of all source code in the generated output, make sure also 591848b8605Smrg# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH 592848b8605Smrg# then you must also enable this option. If you don't then doxygen will produce 593848b8605Smrg# a warning and turn it on anyway 594848b8605Smrg 595848b8605SmrgSOURCE_BROWSER = YES 596848b8605Smrg 597848b8605Smrg# Setting the INLINE_SOURCES tag to YES will include the body 598848b8605Smrg# of functions and classes directly in the documentation. 599848b8605Smrg 600848b8605SmrgINLINE_SOURCES = YES 601848b8605Smrg 602848b8605Smrg# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 603848b8605Smrg# doxygen to hide any special comment blocks from generated source code 604848b8605Smrg# fragments. Normal C and C++ comments will always remain visible. 605848b8605Smrg 606848b8605SmrgSTRIP_CODE_COMMENTS = YES 607848b8605Smrg 608848b8605Smrg# If the REFERENCED_BY_RELATION tag is set to YES (the default) 609848b8605Smrg# then for each documented function all documented 610848b8605Smrg# functions referencing it will be listed. 611848b8605Smrg 612848b8605SmrgREFERENCED_BY_RELATION = NO 613848b8605Smrg 614848b8605Smrg# If the REFERENCES_RELATION tag is set to YES (the default) 615848b8605Smrg# then for each documented function all documented entities 616848b8605Smrg# called/used by that function will be listed. 617848b8605Smrg 618848b8605SmrgREFERENCES_RELATION = YES 619848b8605Smrg 620848b8605Smrg# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 621848b8605Smrg# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 622848b8605Smrg# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 623848b8605Smrg# link to the source code. Otherwise they will link to the documentstion. 624848b8605Smrg 625848b8605SmrgREFERENCES_LINK_SOURCE = YES 626848b8605Smrg 627848b8605Smrg# If the USE_HTAGS tag is set to YES then the references to source code 628848b8605Smrg# will point to the HTML generated by the htags(1) tool instead of doxygen 629848b8605Smrg# built-in source browser. The htags tool is part of GNU's global source 630848b8605Smrg# tagging system (see http://www.gnu.org/software/global/global.html). You 631848b8605Smrg# will need version 4.8.6 or higher. 632848b8605Smrg 633848b8605SmrgUSE_HTAGS = NO 634848b8605Smrg 635848b8605Smrg# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 636848b8605Smrg# will generate a verbatim copy of the header file for each class for 637848b8605Smrg# which an include is specified. Set to NO to disable this. 638848b8605Smrg 639848b8605SmrgVERBATIM_HEADERS = NO 640848b8605Smrg 641848b8605Smrg#--------------------------------------------------------------------------- 642848b8605Smrg# configuration options related to the alphabetical class index 643848b8605Smrg#--------------------------------------------------------------------------- 644848b8605Smrg 645848b8605Smrg# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 646848b8605Smrg# of all compounds will be generated. Enable this if the project 647848b8605Smrg# contains a lot of classes, structs, unions or interfaces. 648848b8605Smrg 649848b8605SmrgALPHABETICAL_INDEX = NO 650848b8605Smrg 651848b8605Smrg# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 652848b8605Smrg# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 653848b8605Smrg# in which this list will be split (can be a number in the range [1..20]) 654848b8605Smrg 655848b8605SmrgCOLS_IN_ALPHA_INDEX = 5 656848b8605Smrg 657848b8605Smrg# In case all classes in a project start with a common prefix, all 658848b8605Smrg# classes will be put under the same header in the alphabetical index. 659848b8605Smrg# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 660848b8605Smrg# should be ignored while generating the index headers. 661848b8605Smrg 662848b8605SmrgIGNORE_PREFIX = 663848b8605Smrg 664848b8605Smrg#--------------------------------------------------------------------------- 665848b8605Smrg# configuration options related to the HTML output 666848b8605Smrg#--------------------------------------------------------------------------- 667848b8605Smrg 668848b8605Smrg# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 669848b8605Smrg# generate HTML output. 670848b8605Smrg 671848b8605SmrgGENERATE_HTML = YES 672848b8605Smrg 673848b8605Smrg# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 674848b8605Smrg# If a relative path is entered the value of OUTPUT_DIRECTORY will be 675848b8605Smrg# put in front of it. If left blank `html' will be used as the default path. 676848b8605Smrg 677848b8605SmrgHTML_OUTPUT = . 678848b8605Smrg 679848b8605Smrg# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 680848b8605Smrg# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 681848b8605Smrg# doxygen will generate files with .html extension. 682848b8605Smrg 683848b8605SmrgHTML_FILE_EXTENSION = .html 684848b8605Smrg 685848b8605Smrg# The HTML_HEADER tag can be used to specify a personal HTML header for 686848b8605Smrg# each generated HTML page. If it is left blank doxygen will generate a 687848b8605Smrg# standard header. 688848b8605Smrg 689848b8605SmrgHTML_HEADER = 690848b8605Smrg 691848b8605Smrg# The HTML_FOOTER tag can be used to specify a personal HTML footer for 692848b8605Smrg# each generated HTML page. If it is left blank doxygen will generate a 693848b8605Smrg# standard footer. 694848b8605Smrg 695848b8605SmrgHTML_FOOTER = 696848b8605Smrg 697848b8605Smrg# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 698848b8605Smrg# style sheet that is used by each HTML page. It can be used to 699848b8605Smrg# fine-tune the look of the HTML output. If the tag is left blank doxygen 700848b8605Smrg# will generate a default style sheet. Note that doxygen will try to copy 701848b8605Smrg# the style sheet file to the HTML output directory, so don't put your own 702848b8605Smrg# stylesheet in the HTML output directory as well, or it will be erased! 703848b8605Smrg 704848b8605SmrgHTML_STYLESHEET = 705848b8605Smrg 706848b8605Smrg# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 707848b8605Smrg# files or namespaces will be aligned in HTML using tables. If set to 708848b8605Smrg# NO a bullet list will be used. 709848b8605Smrg 710848b8605SmrgHTML_ALIGN_MEMBERS = YES 711848b8605Smrg 712848b8605Smrg# If the GENERATE_HTMLHELP tag is set to YES, additional index files 713848b8605Smrg# will be generated that can be used as input for tools like the 714848b8605Smrg# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 715848b8605Smrg# of the generated HTML documentation. 716848b8605Smrg 717848b8605SmrgGENERATE_HTMLHELP = NO 718848b8605Smrg 719848b8605Smrg# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 720848b8605Smrg# documentation will contain sections that can be hidden and shown after the 721848b8605Smrg# page has loaded. For this to work a browser that supports 722848b8605Smrg# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 723848b8605Smrg# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 724848b8605Smrg 725848b8605SmrgHTML_DYNAMIC_SECTIONS = NO 726848b8605Smrg 727848b8605Smrg# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 728848b8605Smrg# be used to specify the file name of the resulting .chm file. You 729848b8605Smrg# can add a path in front of the file if the result should not be 730848b8605Smrg# written to the html output directory. 731848b8605Smrg 732848b8605SmrgCHM_FILE = 733848b8605Smrg 734848b8605Smrg# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 735848b8605Smrg# be used to specify the location (absolute path including file name) of 736848b8605Smrg# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 737848b8605Smrg# the HTML help compiler on the generated index.hhp. 738848b8605Smrg 739848b8605SmrgHHC_LOCATION = 740848b8605Smrg 741848b8605Smrg# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 742848b8605Smrg# controls if a separate .chi index file is generated (YES) or that 743848b8605Smrg# it should be included in the master .chm file (NO). 744848b8605Smrg 745848b8605SmrgGENERATE_CHI = NO 746848b8605Smrg 747848b8605Smrg# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 748848b8605Smrg# controls whether a binary table of contents is generated (YES) or a 749848b8605Smrg# normal table of contents (NO) in the .chm file. 750848b8605Smrg 751848b8605SmrgBINARY_TOC = NO 752848b8605Smrg 753848b8605Smrg# The TOC_EXPAND flag can be set to YES to add extra items for group members 754848b8605Smrg# to the contents of the HTML help documentation and to the tree view. 755848b8605Smrg 756848b8605SmrgTOC_EXPAND = NO 757848b8605Smrg 758848b8605Smrg# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 759848b8605Smrg# top of each HTML page. The value NO (the default) enables the index and 760848b8605Smrg# the value YES disables it. 761848b8605Smrg 762848b8605SmrgDISABLE_INDEX = NO 763848b8605Smrg 764848b8605Smrg# This tag can be used to set the number of enum values (range [1..20]) 765848b8605Smrg# that doxygen will group on one line in the generated HTML documentation. 766848b8605Smrg 767848b8605SmrgENUM_VALUES_PER_LINE = 4 768848b8605Smrg 769848b8605Smrg# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 770848b8605Smrg# generated containing a tree-like index structure (just like the one that 771848b8605Smrg# is generated for HTML Help). For this to work a browser that supports 772848b8605Smrg# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 773848b8605Smrg# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 774848b8605Smrg# probably better off using the HTML help feature. 775848b8605Smrg 776848b8605SmrgGENERATE_TREEVIEW = NO 777848b8605Smrg 778848b8605Smrg# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 779848b8605Smrg# used to set the initial width (in pixels) of the frame in which the tree 780848b8605Smrg# is shown. 781848b8605Smrg 782848b8605SmrgTREEVIEW_WIDTH = 250 783848b8605Smrg 784848b8605Smrg#--------------------------------------------------------------------------- 785848b8605Smrg# configuration options related to the LaTeX output 786848b8605Smrg#--------------------------------------------------------------------------- 787848b8605Smrg 788848b8605Smrg# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 789848b8605Smrg# generate Latex output. 790848b8605Smrg 791848b8605SmrgGENERATE_LATEX = NO 792848b8605Smrg 793848b8605Smrg# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 794848b8605Smrg# If a relative path is entered the value of OUTPUT_DIRECTORY will be 795848b8605Smrg# put in front of it. If left blank `latex' will be used as the default path. 796848b8605Smrg 797848b8605SmrgLATEX_OUTPUT = latex 798848b8605Smrg 799848b8605Smrg# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 800848b8605Smrg# invoked. If left blank `latex' will be used as the default command name. 801848b8605Smrg 802848b8605SmrgLATEX_CMD_NAME = latex 803848b8605Smrg 804848b8605Smrg# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 805848b8605Smrg# generate index for LaTeX. If left blank `makeindex' will be used as the 806848b8605Smrg# default command name. 807848b8605Smrg 808848b8605SmrgMAKEINDEX_CMD_NAME = makeindex 809848b8605Smrg 810848b8605Smrg# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 811848b8605Smrg# LaTeX documents. This may be useful for small projects and may help to 812848b8605Smrg# save some trees in general. 813848b8605Smrg 814848b8605SmrgCOMPACT_LATEX = NO 815848b8605Smrg 816848b8605Smrg# The PAPER_TYPE tag can be used to set the paper type that is used 817848b8605Smrg# by the printer. Possible values are: a4, a4wide, letter, legal and 818848b8605Smrg# executive. If left blank a4wide will be used. 819848b8605Smrg 820848b8605SmrgPAPER_TYPE = a4wide 821848b8605Smrg 822848b8605Smrg# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 823848b8605Smrg# packages that should be included in the LaTeX output. 824848b8605Smrg 825848b8605SmrgEXTRA_PACKAGES = 826848b8605Smrg 827848b8605Smrg# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 828848b8605Smrg# the generated latex document. The header should contain everything until 829848b8605Smrg# the first chapter. If it is left blank doxygen will generate a 830848b8605Smrg# standard header. Notice: only use this tag if you know what you are doing! 831848b8605Smrg 832848b8605SmrgLATEX_HEADER = 833848b8605Smrg 834848b8605Smrg# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 835848b8605Smrg# is prepared for conversion to pdf (using ps2pdf). The pdf file will 836848b8605Smrg# contain links (just like the HTML output) instead of page references 837848b8605Smrg# This makes the output suitable for online browsing using a pdf viewer. 838848b8605Smrg 839848b8605SmrgPDF_HYPERLINKS = NO 840848b8605Smrg 841848b8605Smrg# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 842848b8605Smrg# plain latex in the generated Makefile. Set this option to YES to get a 843848b8605Smrg# higher quality PDF documentation. 844848b8605Smrg 845848b8605SmrgUSE_PDFLATEX = NO 846848b8605Smrg 847848b8605Smrg# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 848848b8605Smrg# command to the generated LaTeX files. This will instruct LaTeX to keep 849848b8605Smrg# running if errors occur, instead of asking the user for help. 850848b8605Smrg# This option is also used when generating formulas in HTML. 851848b8605Smrg 852848b8605SmrgLATEX_BATCHMODE = NO 853848b8605Smrg 854848b8605Smrg# If LATEX_HIDE_INDICES is set to YES then doxygen will not 855848b8605Smrg# include the index chapters (such as File Index, Compound Index, etc.) 856848b8605Smrg# in the output. 857848b8605Smrg 858848b8605SmrgLATEX_HIDE_INDICES = NO 859848b8605Smrg 860848b8605Smrg#--------------------------------------------------------------------------- 861848b8605Smrg# configuration options related to the RTF output 862848b8605Smrg#--------------------------------------------------------------------------- 863848b8605Smrg 864848b8605Smrg# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 865848b8605Smrg# The RTF output is optimized for Word 97 and may not look very pretty with 866848b8605Smrg# other RTF readers or editors. 867848b8605Smrg 868848b8605SmrgGENERATE_RTF = NO 869848b8605Smrg 870848b8605Smrg# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 871848b8605Smrg# If a relative path is entered the value of OUTPUT_DIRECTORY will be 872848b8605Smrg# put in front of it. If left blank `rtf' will be used as the default path. 873848b8605Smrg 874848b8605SmrgRTF_OUTPUT = rtf 875848b8605Smrg 876848b8605Smrg# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 877848b8605Smrg# RTF documents. This may be useful for small projects and may help to 878848b8605Smrg# save some trees in general. 879848b8605Smrg 880848b8605SmrgCOMPACT_RTF = NO 881848b8605Smrg 882848b8605Smrg# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 883848b8605Smrg# will contain hyperlink fields. The RTF file will 884848b8605Smrg# contain links (just like the HTML output) instead of page references. 885848b8605Smrg# This makes the output suitable for online browsing using WORD or other 886848b8605Smrg# programs which support those fields. 887848b8605Smrg# Note: wordpad (write) and others do not support links. 888848b8605Smrg 889848b8605SmrgRTF_HYPERLINKS = NO 890848b8605Smrg 891848b8605Smrg# Load stylesheet definitions from file. Syntax is similar to doxygen's 892848b8605Smrg# config file, i.e. a series of assignments. You only have to provide 893848b8605Smrg# replacements, missing definitions are set to their default value. 894848b8605Smrg 895848b8605SmrgRTF_STYLESHEET_FILE = 896848b8605Smrg 897848b8605Smrg# Set optional variables used in the generation of an rtf document. 898848b8605Smrg# Syntax is similar to doxygen's config file. 899848b8605Smrg 900848b8605SmrgRTF_EXTENSIONS_FILE = 901848b8605Smrg 902848b8605Smrg#--------------------------------------------------------------------------- 903848b8605Smrg# configuration options related to the man page output 904848b8605Smrg#--------------------------------------------------------------------------- 905848b8605Smrg 906848b8605Smrg# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 907848b8605Smrg# generate man pages 908848b8605Smrg 909848b8605SmrgGENERATE_MAN = NO 910848b8605Smrg 911848b8605Smrg# The MAN_OUTPUT tag is used to specify where the man pages will be put. 912848b8605Smrg# If a relative path is entered the value of OUTPUT_DIRECTORY will be 913848b8605Smrg# put in front of it. If left blank `man' will be used as the default path. 914848b8605Smrg 915848b8605SmrgMAN_OUTPUT = man 916848b8605Smrg 917848b8605Smrg# The MAN_EXTENSION tag determines the extension that is added to 918848b8605Smrg# the generated man pages (default is the subroutine's section .3) 919848b8605Smrg 920848b8605SmrgMAN_EXTENSION = .3 921848b8605Smrg 922848b8605Smrg# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 923848b8605Smrg# then it will generate one additional man file for each entity 924848b8605Smrg# documented in the real man page(s). These additional files 925848b8605Smrg# only source the real man page, but without them the man command 926848b8605Smrg# would be unable to find the correct page. The default is NO. 927848b8605Smrg 928848b8605SmrgMAN_LINKS = NO 929848b8605Smrg 930848b8605Smrg#--------------------------------------------------------------------------- 931848b8605Smrg# configuration options related to the XML output 932848b8605Smrg#--------------------------------------------------------------------------- 933848b8605Smrg 934848b8605Smrg# If the GENERATE_XML tag is set to YES Doxygen will 935848b8605Smrg# generate an XML file that captures the structure of 936848b8605Smrg# the code including all documentation. 937848b8605Smrg 938848b8605SmrgGENERATE_XML = NO 939848b8605Smrg 940848b8605Smrg# The XML_OUTPUT tag is used to specify where the XML pages will be put. 941848b8605Smrg# If a relative path is entered the value of OUTPUT_DIRECTORY will be 942848b8605Smrg# put in front of it. If left blank `xml' will be used as the default path. 943848b8605Smrg 944848b8605SmrgXML_OUTPUT = xml 945848b8605Smrg 946848b8605Smrg# The XML_SCHEMA tag can be used to specify an XML schema, 947848b8605Smrg# which can be used by a validating XML parser to check the 948848b8605Smrg# syntax of the XML files. 949848b8605Smrg 950848b8605SmrgXML_SCHEMA = 951848b8605Smrg 952848b8605Smrg# The XML_DTD tag can be used to specify an XML DTD, 953848b8605Smrg# which can be used by a validating XML parser to check the 954848b8605Smrg# syntax of the XML files. 955848b8605Smrg 956848b8605SmrgXML_DTD = 957848b8605Smrg 958848b8605Smrg# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 959848b8605Smrg# dump the program listings (including syntax highlighting 960848b8605Smrg# and cross-referencing information) to the XML output. Note that 961848b8605Smrg# enabling this will significantly increase the size of the XML output. 962848b8605Smrg 963848b8605SmrgXML_PROGRAMLISTING = YES 964848b8605Smrg 965848b8605Smrg#--------------------------------------------------------------------------- 966848b8605Smrg# configuration options for the AutoGen Definitions output 967848b8605Smrg#--------------------------------------------------------------------------- 968848b8605Smrg 969848b8605Smrg# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 970848b8605Smrg# generate an AutoGen Definitions (see autogen.sf.net) file 971848b8605Smrg# that captures the structure of the code including all 972848b8605Smrg# documentation. Note that this feature is still experimental 973848b8605Smrg# and incomplete at the moment. 974848b8605Smrg 975848b8605SmrgGENERATE_AUTOGEN_DEF = NO 976848b8605Smrg 977848b8605Smrg#--------------------------------------------------------------------------- 978848b8605Smrg# configuration options related to the Perl module output 979848b8605Smrg#--------------------------------------------------------------------------- 980848b8605Smrg 981848b8605Smrg# If the GENERATE_PERLMOD tag is set to YES Doxygen will 982848b8605Smrg# generate a Perl module file that captures the structure of 983848b8605Smrg# the code including all documentation. Note that this 984848b8605Smrg# feature is still experimental and incomplete at the 985848b8605Smrg# moment. 986848b8605Smrg 987848b8605SmrgGENERATE_PERLMOD = NO 988848b8605Smrg 989848b8605Smrg# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 990848b8605Smrg# the necessary Makefile rules, Perl scripts and LaTeX code to be able 991848b8605Smrg# to generate PDF and DVI output from the Perl module output. 992848b8605Smrg 993848b8605SmrgPERLMOD_LATEX = NO 994848b8605Smrg 995848b8605Smrg# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 996848b8605Smrg# nicely formatted so it can be parsed by a human reader. This is useful 997848b8605Smrg# if you want to understand what is going on. On the other hand, if this 998848b8605Smrg# tag is set to NO the size of the Perl module output will be much smaller 999848b8605Smrg# and Perl will parse it just the same. 1000848b8605Smrg 1001848b8605SmrgPERLMOD_PRETTY = YES 1002848b8605Smrg 1003848b8605Smrg# The names of the make variables in the generated doxyrules.make file 1004848b8605Smrg# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1005848b8605Smrg# This is useful so different doxyrules.make files included by the same 1006848b8605Smrg# Makefile don't overwrite each other's variables. 1007848b8605Smrg 1008848b8605SmrgPERLMOD_MAKEVAR_PREFIX = 1009848b8605Smrg 1010848b8605Smrg#--------------------------------------------------------------------------- 1011848b8605Smrg# Configuration options related to the preprocessor 1012848b8605Smrg#--------------------------------------------------------------------------- 1013848b8605Smrg 1014848b8605Smrg# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1015848b8605Smrg# evaluate all C-preprocessor directives found in the sources and include 1016848b8605Smrg# files. 1017848b8605Smrg 1018848b8605SmrgENABLE_PREPROCESSING = YES 1019848b8605Smrg 1020848b8605Smrg# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1021848b8605Smrg# names in the source code. If set to NO (the default) only conditional 1022848b8605Smrg# compilation will be performed. Macro expansion can be done in a controlled 1023848b8605Smrg# way by setting EXPAND_ONLY_PREDEF to YES. 1024848b8605Smrg 1025848b8605SmrgMACRO_EXPANSION = YES 1026848b8605Smrg 1027848b8605Smrg# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1028848b8605Smrg# then the macro expansion is limited to the macros specified with the 1029848b8605Smrg# PREDEFINED and EXPAND_AS_DEFINED tags. 1030848b8605Smrg 1031848b8605SmrgEXPAND_ONLY_PREDEF = NO 1032848b8605Smrg 1033848b8605Smrg# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1034848b8605Smrg# in the INCLUDE_PATH (see below) will be search if a #include is found. 1035848b8605Smrg 1036848b8605SmrgSEARCH_INCLUDES = YES 1037848b8605Smrg 1038848b8605Smrg# The INCLUDE_PATH tag can be used to specify one or more directories that 1039848b8605Smrg# contain include files that are not input files but should be processed by 1040848b8605Smrg# the preprocessor. 1041848b8605Smrg 1042848b8605SmrgINCLUDE_PATH = 1043848b8605Smrg 1044848b8605Smrg# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1045848b8605Smrg# patterns (like *.h and *.hpp) to filter out the header-files in the 1046848b8605Smrg# directories. If left blank, the patterns specified with FILE_PATTERNS will 1047848b8605Smrg# be used. 1048848b8605Smrg 1049848b8605SmrgINCLUDE_FILE_PATTERNS = 1050848b8605Smrg 1051848b8605Smrg# The PREDEFINED tag can be used to specify one or more macro names that 1052848b8605Smrg# are defined before the preprocessor is started (similar to the -D option of 1053848b8605Smrg# gcc). The argument of the tag is a list of macros of the form: name 1054848b8605Smrg# or name=definition (no spaces). If the definition and the = are 1055848b8605Smrg# omitted =1 is assumed. To prevent a macro definition from being 1056848b8605Smrg# undefined via #undef or recursively expanded use the := operator 1057848b8605Smrg# instead of the = operator. 1058848b8605Smrg 1059848b8605SmrgPREDEFINED = INLINE=inline MESA_LLVM=1 1060848b8605Smrg 1061848b8605Smrg# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1062848b8605Smrg# this tag can be used to specify a list of macro names that should be expanded. 1063848b8605Smrg# The macro definition that is found in the sources will be used. 1064848b8605Smrg# Use the PREDEFINED tag if you want to use a different macro definition. 1065848b8605Smrg 1066848b8605SmrgEXPAND_AS_DEFINED = 1067848b8605Smrg 1068848b8605Smrg# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1069848b8605Smrg# doxygen's preprocessor will remove all function-like macros that are alone 1070848b8605Smrg# on a line, have an all uppercase name, and do not end with a semicolon. Such 1071848b8605Smrg# function macros are typically used for boiler-plate code, and will confuse 1072848b8605Smrg# the parser if not removed. 1073848b8605Smrg 1074848b8605SmrgSKIP_FUNCTION_MACROS = YES 1075848b8605Smrg 1076848b8605Smrg#--------------------------------------------------------------------------- 1077848b8605Smrg# Configuration::additions related to external references 1078848b8605Smrg#--------------------------------------------------------------------------- 1079848b8605Smrg 1080848b8605Smrg# The TAGFILES option can be used to specify one or more tagfiles. 1081848b8605Smrg# Optionally an initial location of the external documentation 1082848b8605Smrg# can be added for each tagfile. The format of a tag file without 1083848b8605Smrg# this location is as follows: 1084848b8605Smrg# TAGFILES = file1 file2 ... 1085848b8605Smrg# Adding location for the tag files is done as follows: 1086848b8605Smrg# TAGFILES = file1=loc1 "file2 = loc2" ... 1087848b8605Smrg# where "loc1" and "loc2" can be relative or absolute paths or 1088848b8605Smrg# URLs. If a location is present for each tag, the installdox tool 1089848b8605Smrg# does not have to be run to correct the links. 1090848b8605Smrg# Note that each tag file must have a unique name 1091848b8605Smrg# (where the name does NOT include the path) 1092848b8605Smrg# If a tag file is not located in the directory in which doxygen 1093848b8605Smrg# is run, you must also specify the path to the tagfile here. 1094848b8605Smrg 1095848b8605SmrgTAGFILES = \ 1096848b8605Smrg main.tag=../main \ 1097848b8605Smrg math.tag=../math \ 1098848b8605Smrg swrast_setup.tag=../swrast_setup \ 1099848b8605Smrg swrast.tag=../swrast \ 1100848b8605Smrg tnl_dd.tag=../tnl_dd \ 1101848b8605Smrg tnl.tag=../tnl \ 1102848b8605Smrg vbo.tag=../vbo 1103848b8605Smrg 1104848b8605Smrg# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1105848b8605Smrg# a tag file that is based on the input files it reads. 1106848b8605Smrg 1107848b8605SmrgGENERATE_TAGFILE = 1108848b8605Smrg 1109848b8605Smrg# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1110848b8605Smrg# in the class index. If set to NO only the inherited external classes 1111848b8605Smrg# will be listed. 1112848b8605Smrg 1113848b8605SmrgALLEXTERNALS = NO 1114848b8605Smrg 1115848b8605Smrg# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1116848b8605Smrg# in the modules index. If set to NO, only the current project's groups will 1117848b8605Smrg# be listed. 1118848b8605Smrg 1119848b8605SmrgEXTERNAL_GROUPS = YES 1120848b8605Smrg 1121848b8605Smrg# The PERL_PATH should be the absolute path and name of the perl script 1122848b8605Smrg# interpreter (i.e. the result of `which perl'). 1123848b8605Smrg 1124848b8605SmrgPERL_PATH = /usr/bin/perl 1125848b8605Smrg 1126848b8605Smrg#--------------------------------------------------------------------------- 1127848b8605Smrg# Configuration options related to the dot tool 1128848b8605Smrg#--------------------------------------------------------------------------- 1129848b8605Smrg 1130848b8605Smrg# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1131848b8605Smrg# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1132848b8605Smrg# or super classes. Setting the tag to NO turns the diagrams off. Note that 1133848b8605Smrg# this option is superseded by the HAVE_DOT option below. This is only a 1134848b8605Smrg# fallback. It is recommended to install and use dot, since it yields more 1135848b8605Smrg# powerful graphs. 1136848b8605Smrg 1137848b8605SmrgCLASS_DIAGRAMS = YES 1138848b8605Smrg 1139848b8605Smrg# You can define message sequence charts within doxygen comments using the \msc 1140848b8605Smrg# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 1141848b8605Smrg# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 1142848b8605Smrg# specify the directory where the mscgen tool resides. If left empty the tool is assumed to 1143848b8605Smrg# be found in the default search path. 1144848b8605Smrg 1145848b8605SmrgMSCGEN_PATH = 1146848b8605Smrg 1147848b8605Smrg# If set to YES, the inheritance and collaboration graphs will hide 1148848b8605Smrg# inheritance and usage relations if the target is undocumented 1149848b8605Smrg# or is not a class. 1150848b8605Smrg 1151848b8605SmrgHIDE_UNDOC_RELATIONS = YES 1152848b8605Smrg 1153848b8605Smrg# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1154848b8605Smrg# available from the path. This tool is part of Graphviz, a graph visualization 1155848b8605Smrg# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1156848b8605Smrg# have no effect if this option is set to NO (the default) 1157848b8605Smrg 1158848b8605SmrgHAVE_DOT = YES 1159848b8605Smrg 1160848b8605Smrg# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1161848b8605Smrg# will generate a graph for each documented class showing the direct and 1162848b8605Smrg# indirect inheritance relations. Setting this tag to YES will force the 1163848b8605Smrg# the CLASS_DIAGRAMS tag to NO. 1164848b8605Smrg 1165848b8605SmrgCLASS_GRAPH = YES 1166848b8605Smrg 1167848b8605Smrg# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1168848b8605Smrg# will generate a graph for each documented class showing the direct and 1169848b8605Smrg# indirect implementation dependencies (inheritance, containment, and 1170848b8605Smrg# class references variables) of the class with other documented classes. 1171848b8605Smrg 1172848b8605SmrgCOLLABORATION_GRAPH = YES 1173848b8605Smrg 1174848b8605Smrg# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1175848b8605Smrg# will generate a graph for groups, showing the direct groups dependencies 1176848b8605Smrg 1177848b8605SmrgGROUP_GRAPHS = YES 1178848b8605Smrg 1179848b8605Smrg# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1180848b8605Smrg# collaboration diagrams in a style similar to the OMG's Unified Modeling 1181848b8605Smrg# Language. 1182848b8605Smrg 1183848b8605SmrgUML_LOOK = NO 1184848b8605Smrg 1185848b8605Smrg# If set to YES, the inheritance and collaboration graphs will show the 1186848b8605Smrg# relations between templates and their instances. 1187848b8605Smrg 1188848b8605SmrgTEMPLATE_RELATIONS = NO 1189848b8605Smrg 1190848b8605Smrg# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1191848b8605Smrg# tags are set to YES then doxygen will generate a graph for each documented 1192848b8605Smrg# file showing the direct and indirect include dependencies of the file with 1193848b8605Smrg# other documented files. 1194848b8605Smrg 1195848b8605SmrgINCLUDE_GRAPH = YES 1196848b8605Smrg 1197848b8605Smrg# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1198848b8605Smrg# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1199848b8605Smrg# documented header file showing the documented files that directly or 1200848b8605Smrg# indirectly include this file. 1201848b8605Smrg 1202848b8605SmrgINCLUDED_BY_GRAPH = YES 1203848b8605Smrg 1204848b8605Smrg# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 1205848b8605Smrg# generate a call dependency graph for every global function or class method. 1206848b8605Smrg# Note that enabling this option will significantly increase the time of a run. 1207848b8605Smrg# So in most cases it will be better to enable call graphs for selected 1208848b8605Smrg# functions only using the \callgraph command. 1209848b8605Smrg 1210848b8605SmrgCALL_GRAPH = NO 1211848b8605Smrg 1212848b8605Smrg# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 1213848b8605Smrg# generate a caller dependency graph for every global function or class method. 1214848b8605Smrg# Note that enabling this option will significantly increase the time of a run. 1215848b8605Smrg# So in most cases it will be better to enable caller graphs for selected 1216848b8605Smrg# functions only using the \callergraph command. 1217848b8605Smrg 1218848b8605SmrgCALLER_GRAPH = NO 1219848b8605Smrg 1220848b8605Smrg# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1221848b8605Smrg# will graphical hierarchy of all classes instead of a textual one. 1222848b8605Smrg 1223848b8605SmrgGRAPHICAL_HIERARCHY = YES 1224848b8605Smrg 1225848b8605Smrg# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1226848b8605Smrg# then doxygen will show the dependencies a directory has on other directories 1227848b8605Smrg# in a graphical way. The dependency relations are determined by the #include 1228848b8605Smrg# relations between the files in the directories. 1229848b8605Smrg 1230848b8605SmrgDIRECTORY_GRAPH = YES 1231848b8605Smrg 1232848b8605Smrg# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1233848b8605Smrg# generated by dot. Possible values are png, jpg, or gif 1234848b8605Smrg# If left blank png will be used. 1235848b8605Smrg 1236848b8605SmrgDOT_IMAGE_FORMAT = png 1237848b8605Smrg 1238848b8605Smrg# The tag DOT_PATH can be used to specify the path where the dot tool can be 1239848b8605Smrg# found. If left blank, it is assumed the dot tool can be found in the path. 1240848b8605Smrg 1241848b8605SmrgDOT_PATH = 1242848b8605Smrg 1243848b8605Smrg# The DOTFILE_DIRS tag can be used to specify one or more directories that 1244848b8605Smrg# contain dot files that are included in the documentation (see the 1245848b8605Smrg# \dotfile command). 1246848b8605Smrg 1247848b8605SmrgDOTFILE_DIRS = 1248848b8605Smrg 1249848b8605Smrg# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1250848b8605Smrg# nodes that will be shown in the graph. If the number of nodes in a graph 1251848b8605Smrg# becomes larger than this value, doxygen will truncate the graph, which is 1252848b8605Smrg# visualized by representing a node as a red box. Note that doxygen if the number 1253848b8605Smrg# of direct children of the root node in a graph is already larger than 1254848b8605Smrg# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note 1255848b8605Smrg# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1256848b8605Smrg 1257848b8605SmrgDOT_GRAPH_MAX_NODES = 50 1258848b8605Smrg 1259848b8605Smrg# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1260848b8605Smrg# graphs generated by dot. A depth value of 3 means that only nodes reachable 1261848b8605Smrg# from the root by following a path via at most 3 edges will be shown. Nodes 1262848b8605Smrg# that lay further from the root node will be omitted. Note that setting this 1263848b8605Smrg# option to 1 or 2 may greatly reduce the computation time needed for large 1264848b8605Smrg# code bases. Also note that the size of a graph can be further restricted by 1265848b8605Smrg# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1266848b8605Smrg 1267848b8605SmrgMAX_DOT_GRAPH_DEPTH = 0 1268848b8605Smrg 1269848b8605Smrg# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1270848b8605Smrg# background. This is disabled by default, which results in a white background. 1271848b8605Smrg# Warning: Depending on the platform used, enabling this option may lead to 1272848b8605Smrg# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1273848b8605Smrg# read). 1274848b8605Smrg 1275848b8605SmrgDOT_TRANSPARENT = NO 1276848b8605Smrg 1277848b8605Smrg# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1278848b8605Smrg# files in one run (i.e. multiple -o and -T options on the command line). This 1279848b8605Smrg# makes dot run faster, but since only newer versions of dot (>1.8.10) 1280848b8605Smrg# support this, this feature is disabled by default. 1281848b8605Smrg 1282848b8605SmrgDOT_MULTI_TARGETS = NO 1283848b8605Smrg 1284848b8605Smrg# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1285848b8605Smrg# generate a legend page explaining the meaning of the various boxes and 1286848b8605Smrg# arrows in the dot generated graphs. 1287848b8605Smrg 1288848b8605SmrgGENERATE_LEGEND = YES 1289848b8605Smrg 1290848b8605Smrg# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1291848b8605Smrg# remove the intermediate dot files that are used to generate 1292848b8605Smrg# the various graphs. 1293848b8605Smrg 1294848b8605SmrgDOT_CLEANUP = YES 1295848b8605Smrg 1296848b8605Smrg#--------------------------------------------------------------------------- 1297848b8605Smrg# Configuration::additions related to the search engine 1298848b8605Smrg#--------------------------------------------------------------------------- 1299848b8605Smrg 1300848b8605Smrg# The SEARCHENGINE tag specifies whether or not a search engine should be 1301848b8605Smrg# used. If set to NO the values of all tags below this one will be ignored. 1302848b8605Smrg 1303848b8605SmrgSEARCHENGINE = NO 1304