1*06f32e7eSjoerg# Doxyfile 1.8.6 2*06f32e7eSjoerg 3*06f32e7eSjoerg# This file describes the settings to be used by the documentation system 4*06f32e7eSjoerg# doxygen (www.doxygen.org) for a project. 5*06f32e7eSjoerg# 6*06f32e7eSjoerg# All text after a double hash (##) is considered a comment and is placed in 7*06f32e7eSjoerg# front of the TAG it is preceding. 8*06f32e7eSjoerg# 9*06f32e7eSjoerg# All text after a single hash (#) is considered a comment and will be ignored. 10*06f32e7eSjoerg# The format is: 11*06f32e7eSjoerg# TAG = value [value, ...] 12*06f32e7eSjoerg# For lists, items can also be appended using: 13*06f32e7eSjoerg# TAG += value [value, ...] 14*06f32e7eSjoerg# Values that contain spaces should be placed between quotes (\" \"). 15*06f32e7eSjoerg 16*06f32e7eSjoerg#--------------------------------------------------------------------------- 17*06f32e7eSjoerg# Project related configuration options 18*06f32e7eSjoerg#--------------------------------------------------------------------------- 19*06f32e7eSjoerg 20*06f32e7eSjoerg# This tag specifies the encoding used for all characters in the config file 21*06f32e7eSjoerg# that follow. The default is UTF-8 which is also the encoding used for all text 22*06f32e7eSjoerg# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23*06f32e7eSjoerg# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24*06f32e7eSjoerg# for the list of possible encodings. 25*06f32e7eSjoerg# The default value is: UTF-8. 26*06f32e7eSjoerg 27*06f32e7eSjoergDOXYFILE_ENCODING = UTF-8 28*06f32e7eSjoerg 29*06f32e7eSjoerg# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30*06f32e7eSjoerg# double-quotes, unless you are using Doxywizard) that should identify the 31*06f32e7eSjoerg# project for which the documentation is generated. This name is used in the 32*06f32e7eSjoerg# title of most generated pages and in a few other places. 33*06f32e7eSjoerg# The default value is: My Project. 34*06f32e7eSjoerg 35*06f32e7eSjoergPROJECT_NAME = LLVM 36*06f32e7eSjoerg 37*06f32e7eSjoerg# The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38*06f32e7eSjoerg# could be handy for archiving the generated documentation or if some version 39*06f32e7eSjoerg# control system is used. 40*06f32e7eSjoerg 41*06f32e7eSjoergPROJECT_NUMBER = @PACKAGE_VERSION@ 42*06f32e7eSjoerg 43*06f32e7eSjoerg# Using the PROJECT_BRIEF tag one can provide an optional one line description 44*06f32e7eSjoerg# for a project that appears at the top of each page and should give viewer a 45*06f32e7eSjoerg# quick idea about the purpose of the project. Keep the description short. 46*06f32e7eSjoerg 47*06f32e7eSjoergPROJECT_BRIEF = 48*06f32e7eSjoerg 49*06f32e7eSjoerg# With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50*06f32e7eSjoerg# the documentation. The maximum height of the logo should not exceed 55 pixels 51*06f32e7eSjoerg# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52*06f32e7eSjoerg# to the output directory. 53*06f32e7eSjoerg 54*06f32e7eSjoergPROJECT_LOGO = 55*06f32e7eSjoerg 56*06f32e7eSjoerg# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57*06f32e7eSjoerg# into which the generated documentation will be written. If a relative path is 58*06f32e7eSjoerg# entered, it will be relative to the location where doxygen was started. If 59*06f32e7eSjoerg# left blank the current directory will be used. 60*06f32e7eSjoerg 61*06f32e7eSjoergOUTPUT_DIRECTORY = @abs_top_builddir@/doxygen 62*06f32e7eSjoerg 63*06f32e7eSjoerg# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 64*06f32e7eSjoerg# directories (in 2 levels) under the output directory of each output format and 65*06f32e7eSjoerg# will distribute the generated files over these directories. Enabling this 66*06f32e7eSjoerg# option can be useful when feeding doxygen a huge amount of source files, where 67*06f32e7eSjoerg# putting all generated files in the same directory would otherwise causes 68*06f32e7eSjoerg# performance problems for the file system. 69*06f32e7eSjoerg# The default value is: NO. 70*06f32e7eSjoerg 71*06f32e7eSjoergCREATE_SUBDIRS = NO 72*06f32e7eSjoerg 73*06f32e7eSjoerg# The OUTPUT_LANGUAGE tag is used to specify the language in which all 74*06f32e7eSjoerg# documentation generated by doxygen is written. Doxygen will use this 75*06f32e7eSjoerg# information to generate all constant output in the proper language. 76*06f32e7eSjoerg# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 77*06f32e7eSjoerg# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 78*06f32e7eSjoerg# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 79*06f32e7eSjoerg# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 80*06f32e7eSjoerg# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 81*06f32e7eSjoerg# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 82*06f32e7eSjoerg# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 83*06f32e7eSjoerg# Ukrainian and Vietnamese. 84*06f32e7eSjoerg# The default value is: English. 85*06f32e7eSjoerg 86*06f32e7eSjoergOUTPUT_LANGUAGE = English 87*06f32e7eSjoerg 88*06f32e7eSjoerg# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 89*06f32e7eSjoerg# descriptions after the members that are listed in the file and class 90*06f32e7eSjoerg# documentation (similar to Javadoc). Set to NO to disable this. 91*06f32e7eSjoerg# The default value is: YES. 92*06f32e7eSjoerg 93*06f32e7eSjoergBRIEF_MEMBER_DESC = YES 94*06f32e7eSjoerg 95*06f32e7eSjoerg# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 96*06f32e7eSjoerg# description of a member or function before the detailed description 97*06f32e7eSjoerg# 98*06f32e7eSjoerg# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 99*06f32e7eSjoerg# brief descriptions will be completely suppressed. 100*06f32e7eSjoerg# The default value is: YES. 101*06f32e7eSjoerg 102*06f32e7eSjoergREPEAT_BRIEF = YES 103*06f32e7eSjoerg 104*06f32e7eSjoerg# This tag implements a quasi-intelligent brief description abbreviator that is 105*06f32e7eSjoerg# used to form the text in various listings. Each string in this list, if found 106*06f32e7eSjoerg# as the leading text of the brief description, will be stripped from the text 107*06f32e7eSjoerg# and the result, after processing the whole list, is used as the annotated 108*06f32e7eSjoerg# text. Otherwise, the brief description is used as-is. If left blank, the 109*06f32e7eSjoerg# following values are used ($name is automatically replaced with the name of 110*06f32e7eSjoerg# the entity):The $name class, The $name widget, The $name file, is, provides, 111*06f32e7eSjoerg# specifies, contains, represents, a, an and the. 112*06f32e7eSjoerg 113*06f32e7eSjoergABBREVIATE_BRIEF = 114*06f32e7eSjoerg 115*06f32e7eSjoerg# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 116*06f32e7eSjoerg# doxygen will generate a detailed section even if there is only a brief 117*06f32e7eSjoerg# description. 118*06f32e7eSjoerg# The default value is: NO. 119*06f32e7eSjoerg 120*06f32e7eSjoergALWAYS_DETAILED_SEC = NO 121*06f32e7eSjoerg 122*06f32e7eSjoerg# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 123*06f32e7eSjoerg# inherited members of a class in the documentation of that class as if those 124*06f32e7eSjoerg# members were ordinary class members. Constructors, destructors and assignment 125*06f32e7eSjoerg# operators of the base classes will not be shown. 126*06f32e7eSjoerg# The default value is: NO. 127*06f32e7eSjoerg 128*06f32e7eSjoergINLINE_INHERITED_MEMB = NO 129*06f32e7eSjoerg 130*06f32e7eSjoerg# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 131*06f32e7eSjoerg# before files name in the file list and in the header files. If set to NO the 132*06f32e7eSjoerg# shortest path that makes the file name unique will be used 133*06f32e7eSjoerg# The default value is: YES. 134*06f32e7eSjoerg 135*06f32e7eSjoergFULL_PATH_NAMES = YES 136*06f32e7eSjoerg 137*06f32e7eSjoerg# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 138*06f32e7eSjoerg# Stripping is only done if one of the specified strings matches the left-hand 139*06f32e7eSjoerg# part of the path. The tag can be used to show relative paths in the file list. 140*06f32e7eSjoerg# If left blank the directory from which doxygen is run is used as the path to 141*06f32e7eSjoerg# strip. 142*06f32e7eSjoerg# 143*06f32e7eSjoerg# Note that you can specify absolute paths here, but also relative paths, which 144*06f32e7eSjoerg# will be relative from the directory where doxygen is started. 145*06f32e7eSjoerg# This tag requires that the tag FULL_PATH_NAMES is set to YES. 146*06f32e7eSjoerg 147*06f32e7eSjoergSTRIP_FROM_PATH = @abs_top_srcdir@/.. 148*06f32e7eSjoerg 149*06f32e7eSjoerg# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 150*06f32e7eSjoerg# path mentioned in the documentation of a class, which tells the reader which 151*06f32e7eSjoerg# header file to include in order to use a class. If left blank only the name of 152*06f32e7eSjoerg# the header file containing the class definition is used. Otherwise one should 153*06f32e7eSjoerg# specify the list of include paths that are normally passed to the compiler 154*06f32e7eSjoerg# using the -I flag. 155*06f32e7eSjoerg 156*06f32e7eSjoergSTRIP_FROM_INC_PATH = @abs_top_srcdir@/../include 157*06f32e7eSjoergSTRIP_FROM_INC_PATH += @abs_top_srcdir@/../lib 158*06f32e7eSjoerg 159*06f32e7eSjoerg# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 160*06f32e7eSjoerg# less readable) file names. This can be useful is your file systems doesn't 161*06f32e7eSjoerg# support long names like on DOS, Mac, or CD-ROM. 162*06f32e7eSjoerg# The default value is: NO. 163*06f32e7eSjoerg 164*06f32e7eSjoergSHORT_NAMES = NO 165*06f32e7eSjoerg 166*06f32e7eSjoerg# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 167*06f32e7eSjoerg# first line (until the first dot) of a Javadoc-style comment as the brief 168*06f32e7eSjoerg# description. If set to NO, the Javadoc-style will behave just like regular Qt- 169*06f32e7eSjoerg# style comments (thus requiring an explicit @brief command for a brief 170*06f32e7eSjoerg# description.) 171*06f32e7eSjoerg# The default value is: NO. 172*06f32e7eSjoerg 173*06f32e7eSjoergJAVADOC_AUTOBRIEF = YES 174*06f32e7eSjoerg 175*06f32e7eSjoerg# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 176*06f32e7eSjoerg# line (until the first dot) of a Qt-style comment as the brief description. If 177*06f32e7eSjoerg# set to NO, the Qt-style will behave just like regular Qt-style comments (thus 178*06f32e7eSjoerg# requiring an explicit \brief command for a brief description.) 179*06f32e7eSjoerg# The default value is: NO. 180*06f32e7eSjoerg 181*06f32e7eSjoergQT_AUTOBRIEF = YES 182*06f32e7eSjoerg 183*06f32e7eSjoerg# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 184*06f32e7eSjoerg# multi-line C++ special comment block (i.e. a block of //! or /// comments) as 185*06f32e7eSjoerg# a brief description. This used to be the default behavior. The new default is 186*06f32e7eSjoerg# to treat a multi-line C++ comment block as a detailed description. Set this 187*06f32e7eSjoerg# tag to YES if you prefer the old behavior instead. 188*06f32e7eSjoerg# 189*06f32e7eSjoerg# Note that setting this tag to YES also means that rational rose comments are 190*06f32e7eSjoerg# not recognized any more. 191*06f32e7eSjoerg# The default value is: NO. 192*06f32e7eSjoerg 193*06f32e7eSjoergMULTILINE_CPP_IS_BRIEF = NO 194*06f32e7eSjoerg 195*06f32e7eSjoerg# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 196*06f32e7eSjoerg# documentation from any documented member that it re-implements. 197*06f32e7eSjoerg# The default value is: YES. 198*06f32e7eSjoerg 199*06f32e7eSjoergINHERIT_DOCS = YES 200*06f32e7eSjoerg 201*06f32e7eSjoerg# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 202*06f32e7eSjoerg# new page for each member. If set to NO, the documentation of a member will be 203*06f32e7eSjoerg# part of the file/class/namespace that contains it. 204*06f32e7eSjoerg# The default value is: NO. 205*06f32e7eSjoerg 206*06f32e7eSjoergSEPARATE_MEMBER_PAGES = NO 207*06f32e7eSjoerg 208*06f32e7eSjoerg# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 209*06f32e7eSjoerg# uses this value to replace tabs by spaces in code fragments. 210*06f32e7eSjoerg# Minimum value: 1, maximum value: 16, default value: 4. 211*06f32e7eSjoerg 212*06f32e7eSjoergTAB_SIZE = 2 213*06f32e7eSjoerg 214*06f32e7eSjoerg# This tag can be used to specify a number of aliases that act as commands in 215*06f32e7eSjoerg# the documentation. An alias has the form: 216*06f32e7eSjoerg# name=value 217*06f32e7eSjoerg# For example adding 218*06f32e7eSjoerg# "sideeffect=@par Side Effects:\n" 219*06f32e7eSjoerg# will allow you to put the command \sideeffect (or @sideeffect) in the 220*06f32e7eSjoerg# documentation, which will result in a user-defined paragraph with heading 221*06f32e7eSjoerg# "Side Effects:". You can put \n's in the value part of an alias to insert 222*06f32e7eSjoerg# newlines. 223*06f32e7eSjoerg 224*06f32e7eSjoergALIASES = 225*06f32e7eSjoerg 226*06f32e7eSjoerg# This tag can be used to specify a number of word-keyword mappings (TCL only). 227*06f32e7eSjoerg# A mapping has the form "name=value". For example adding "class=itcl::class" 228*06f32e7eSjoerg# will allow you to use the command class in the itcl::class meaning. 229*06f32e7eSjoerg 230*06f32e7eSjoergTCL_SUBST = 231*06f32e7eSjoerg 232*06f32e7eSjoerg# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 233*06f32e7eSjoerg# only. Doxygen will then generate output that is more tailored for C. For 234*06f32e7eSjoerg# instance, some of the names that are used will be different. The list of all 235*06f32e7eSjoerg# members will be omitted, etc. 236*06f32e7eSjoerg# The default value is: NO. 237*06f32e7eSjoerg 238*06f32e7eSjoergOPTIMIZE_OUTPUT_FOR_C = NO 239*06f32e7eSjoerg 240*06f32e7eSjoerg# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 241*06f32e7eSjoerg# Python sources only. Doxygen will then generate output that is more tailored 242*06f32e7eSjoerg# for that language. For instance, namespaces will be presented as packages, 243*06f32e7eSjoerg# qualified scopes will look different, etc. 244*06f32e7eSjoerg# The default value is: NO. 245*06f32e7eSjoerg 246*06f32e7eSjoergOPTIMIZE_OUTPUT_JAVA = NO 247*06f32e7eSjoerg 248*06f32e7eSjoerg# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 249*06f32e7eSjoerg# sources. Doxygen will then generate output that is tailored for Fortran. 250*06f32e7eSjoerg# The default value is: NO. 251*06f32e7eSjoerg 252*06f32e7eSjoergOPTIMIZE_FOR_FORTRAN = NO 253*06f32e7eSjoerg 254*06f32e7eSjoerg# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 255*06f32e7eSjoerg# sources. Doxygen will then generate output that is tailored for VHDL. 256*06f32e7eSjoerg# The default value is: NO. 257*06f32e7eSjoerg 258*06f32e7eSjoergOPTIMIZE_OUTPUT_VHDL = NO 259*06f32e7eSjoerg 260*06f32e7eSjoerg# Doxygen selects the parser to use depending on the extension of the files it 261*06f32e7eSjoerg# parses. With this tag you can assign which parser to use for a given 262*06f32e7eSjoerg# extension. Doxygen has a built-in mapping, but you can override or extend it 263*06f32e7eSjoerg# using this tag. The format is ext=language, where ext is a file extension, and 264*06f32e7eSjoerg# language is one of the parsers supported by doxygen: IDL, Java, Javascript, 265*06f32e7eSjoerg# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make 266*06f32e7eSjoerg# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 267*06f32e7eSjoerg# (default is Fortran), use: inc=Fortran f=C. 268*06f32e7eSjoerg# 269*06f32e7eSjoerg# Note For files without extension you can use no_extension as a placeholder. 270*06f32e7eSjoerg# 271*06f32e7eSjoerg# Note that for custom extensions you also need to set FILE_PATTERNS otherwise 272*06f32e7eSjoerg# the files are not read by doxygen. 273*06f32e7eSjoerg 274*06f32e7eSjoergEXTENSION_MAPPING = 275*06f32e7eSjoerg 276*06f32e7eSjoerg# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 277*06f32e7eSjoerg# according to the Markdown format, which allows for more readable 278*06f32e7eSjoerg# documentation. See http://daringfireball.net/projects/markdown/ for details. 279*06f32e7eSjoerg# The output of markdown processing is further processed by doxygen, so you can 280*06f32e7eSjoerg# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 281*06f32e7eSjoerg# case of backward compatibilities issues. 282*06f32e7eSjoerg# The default value is: YES. 283*06f32e7eSjoerg 284*06f32e7eSjoergMARKDOWN_SUPPORT = YES 285*06f32e7eSjoerg 286*06f32e7eSjoerg# When enabled doxygen tries to link words that correspond to documented 287*06f32e7eSjoerg# classes, or namespaces to their corresponding documentation. Such a link can 288*06f32e7eSjoerg# be prevented in individual cases by putting a % sign in front of the word 289*06f32e7eSjoerg# or globally by setting AUTOLINK_SUPPORT to NO. 290*06f32e7eSjoerg# The default value is: YES. 291*06f32e7eSjoerg 292*06f32e7eSjoergAUTOLINK_SUPPORT = YES 293*06f32e7eSjoerg 294*06f32e7eSjoerg# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 295*06f32e7eSjoerg# to include (a tag file for) the STL sources as input, then you should set this 296*06f32e7eSjoerg# tag to YES in order to let doxygen match functions declarations and 297*06f32e7eSjoerg# definitions whose arguments contain STL classes (e.g. func(std::string); 298*06f32e7eSjoerg# versus func(std::string) {}). This also make the inheritance and collaboration 299*06f32e7eSjoerg# diagrams that involve STL classes more complete and accurate. 300*06f32e7eSjoerg# The default value is: NO. 301*06f32e7eSjoerg 302*06f32e7eSjoergBUILTIN_STL_SUPPORT = NO 303*06f32e7eSjoerg 304*06f32e7eSjoerg# If you use Microsoft's C++/CLI language, you should set this option to YES to 305*06f32e7eSjoerg# enable parsing support. 306*06f32e7eSjoerg# The default value is: NO. 307*06f32e7eSjoerg 308*06f32e7eSjoergCPP_CLI_SUPPORT = NO 309*06f32e7eSjoerg 310*06f32e7eSjoerg# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 311*06f32e7eSjoerg# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 312*06f32e7eSjoerg# will parse them like normal C++ but will assume all classes use public instead 313*06f32e7eSjoerg# of private inheritance when no explicit protection keyword is present. 314*06f32e7eSjoerg# The default value is: NO. 315*06f32e7eSjoerg 316*06f32e7eSjoergSIP_SUPPORT = NO 317*06f32e7eSjoerg 318*06f32e7eSjoerg# For Microsoft's IDL there are propget and propput attributes to indicate 319*06f32e7eSjoerg# getter and setter methods for a property. Setting this option to YES will make 320*06f32e7eSjoerg# doxygen to replace the get and set methods by a property in the documentation. 321*06f32e7eSjoerg# This will only work if the methods are indeed getting or setting a simple 322*06f32e7eSjoerg# type. If this is not the case, or you want to show the methods anyway, you 323*06f32e7eSjoerg# should set this option to NO. 324*06f32e7eSjoerg# The default value is: YES. 325*06f32e7eSjoerg 326*06f32e7eSjoergIDL_PROPERTY_SUPPORT = YES 327*06f32e7eSjoerg 328*06f32e7eSjoerg# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 329*06f32e7eSjoerg# tag is set to YES, then doxygen will reuse the documentation of the first 330*06f32e7eSjoerg# member in the group (if any) for the other members of the group. By default 331*06f32e7eSjoerg# all members of a group must be documented explicitly. 332*06f32e7eSjoerg# The default value is: NO. 333*06f32e7eSjoerg 334*06f32e7eSjoergDISTRIBUTE_GROUP_DOC = NO 335*06f32e7eSjoerg 336*06f32e7eSjoerg# Set the SUBGROUPING tag to YES to allow class member groups of the same type 337*06f32e7eSjoerg# (for instance a group of public functions) to be put as a subgroup of that 338*06f32e7eSjoerg# type (e.g. under the Public Functions section). Set it to NO to prevent 339*06f32e7eSjoerg# subgrouping. Alternatively, this can be done per class using the 340*06f32e7eSjoerg# \nosubgrouping command. 341*06f32e7eSjoerg# The default value is: YES. 342*06f32e7eSjoerg 343*06f32e7eSjoergSUBGROUPING = YES 344*06f32e7eSjoerg 345*06f32e7eSjoerg# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 346*06f32e7eSjoerg# are shown inside the group in which they are included (e.g. using \ingroup) 347*06f32e7eSjoerg# instead of on a separate page (for HTML and Man pages) or section (for LaTeX 348*06f32e7eSjoerg# and RTF). 349*06f32e7eSjoerg# 350*06f32e7eSjoerg# Note that this feature does not work in combination with 351*06f32e7eSjoerg# SEPARATE_MEMBER_PAGES. 352*06f32e7eSjoerg# The default value is: NO. 353*06f32e7eSjoerg 354*06f32e7eSjoergINLINE_GROUPED_CLASSES = NO 355*06f32e7eSjoerg 356*06f32e7eSjoerg# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 357*06f32e7eSjoerg# with only public data fields or simple typedef fields will be shown inline in 358*06f32e7eSjoerg# the documentation of the scope in which they are defined (i.e. file, 359*06f32e7eSjoerg# namespace, or group documentation), provided this scope is documented. If set 360*06f32e7eSjoerg# to NO, structs, classes, and unions are shown on a separate page (for HTML and 361*06f32e7eSjoerg# Man pages) or section (for LaTeX and RTF). 362*06f32e7eSjoerg# The default value is: NO. 363*06f32e7eSjoerg 364*06f32e7eSjoergINLINE_SIMPLE_STRUCTS = NO 365*06f32e7eSjoerg 366*06f32e7eSjoerg# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 367*06f32e7eSjoerg# enum is documented as struct, union, or enum with the name of the typedef. So 368*06f32e7eSjoerg# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 369*06f32e7eSjoerg# with name TypeT. When disabled the typedef will appear as a member of a file, 370*06f32e7eSjoerg# namespace, or class. And the struct will be named TypeS. This can typically be 371*06f32e7eSjoerg# useful for C code in case the coding convention dictates that all compound 372*06f32e7eSjoerg# types are typedef'ed and only the typedef is referenced, never the tag name. 373*06f32e7eSjoerg# The default value is: NO. 374*06f32e7eSjoerg 375*06f32e7eSjoergTYPEDEF_HIDES_STRUCT = NO 376*06f32e7eSjoerg 377*06f32e7eSjoerg# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 378*06f32e7eSjoerg# cache is used to resolve symbols given their name and scope. Since this can be 379*06f32e7eSjoerg# an expensive process and often the same symbol appears multiple times in the 380*06f32e7eSjoerg# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 381*06f32e7eSjoerg# doxygen will become slower. If the cache is too large, memory is wasted. The 382*06f32e7eSjoerg# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 383*06f32e7eSjoerg# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 384*06f32e7eSjoerg# symbols. At the end of a run doxygen will report the cache usage and suggest 385*06f32e7eSjoerg# the optimal cache size from a speed point of view. 386*06f32e7eSjoerg# Minimum value: 0, maximum value: 9, default value: 0. 387*06f32e7eSjoerg 388*06f32e7eSjoergLOOKUP_CACHE_SIZE = 4 389*06f32e7eSjoerg 390*06f32e7eSjoerg#--------------------------------------------------------------------------- 391*06f32e7eSjoerg# Build related configuration options 392*06f32e7eSjoerg#--------------------------------------------------------------------------- 393*06f32e7eSjoerg 394*06f32e7eSjoerg# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 395*06f32e7eSjoerg# documentation are documented, even if no documentation was available. Private 396*06f32e7eSjoerg# class members and static file members will be hidden unless the 397*06f32e7eSjoerg# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 398*06f32e7eSjoerg# Note: This will also disable the warnings about undocumented members that are 399*06f32e7eSjoerg# normally produced when WARNINGS is set to YES. 400*06f32e7eSjoerg# The default value is: NO. 401*06f32e7eSjoerg 402*06f32e7eSjoergEXTRACT_ALL = YES 403*06f32e7eSjoerg 404*06f32e7eSjoerg# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 405*06f32e7eSjoerg# be included in the documentation. 406*06f32e7eSjoerg# The default value is: NO. 407*06f32e7eSjoerg 408*06f32e7eSjoergEXTRACT_PRIVATE = NO 409*06f32e7eSjoerg 410*06f32e7eSjoerg# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 411*06f32e7eSjoerg# scope will be included in the documentation. 412*06f32e7eSjoerg# The default value is: NO. 413*06f32e7eSjoerg 414*06f32e7eSjoergEXTRACT_PACKAGE = NO 415*06f32e7eSjoerg 416*06f32e7eSjoerg# If the EXTRACT_STATIC tag is set to YES all static members of a file will be 417*06f32e7eSjoerg# included in the documentation. 418*06f32e7eSjoerg# The default value is: NO. 419*06f32e7eSjoerg 420*06f32e7eSjoergEXTRACT_STATIC = YES 421*06f32e7eSjoerg 422*06f32e7eSjoerg# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 423*06f32e7eSjoerg# locally in source files will be included in the documentation. If set to NO 424*06f32e7eSjoerg# only classes defined in header files are included. Does not have any effect 425*06f32e7eSjoerg# for Java sources. 426*06f32e7eSjoerg# The default value is: YES. 427*06f32e7eSjoerg 428*06f32e7eSjoergEXTRACT_LOCAL_CLASSES = YES 429*06f32e7eSjoerg 430*06f32e7eSjoerg# This flag is only useful for Objective-C code. When set to YES local methods, 431*06f32e7eSjoerg# which are defined in the implementation section but not in the interface are 432*06f32e7eSjoerg# included in the documentation. If set to NO only methods in the interface are 433*06f32e7eSjoerg# included. 434*06f32e7eSjoerg# The default value is: NO. 435*06f32e7eSjoerg 436*06f32e7eSjoergEXTRACT_LOCAL_METHODS = NO 437*06f32e7eSjoerg 438*06f32e7eSjoerg# If this flag is set to YES, the members of anonymous namespaces will be 439*06f32e7eSjoerg# extracted and appear in the documentation as a namespace called 440*06f32e7eSjoerg# 'anonymous_namespace{file}', where file will be replaced with the base name of 441*06f32e7eSjoerg# the file that contains the anonymous namespace. By default anonymous namespace 442*06f32e7eSjoerg# are hidden. 443*06f32e7eSjoerg# The default value is: NO. 444*06f32e7eSjoerg 445*06f32e7eSjoergEXTRACT_ANON_NSPACES = NO 446*06f32e7eSjoerg 447*06f32e7eSjoerg# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 448*06f32e7eSjoerg# undocumented members inside documented classes or files. If set to NO these 449*06f32e7eSjoerg# members will be included in the various overviews, but no documentation 450*06f32e7eSjoerg# section is generated. This option has no effect if EXTRACT_ALL is enabled. 451*06f32e7eSjoerg# The default value is: NO. 452*06f32e7eSjoerg 453*06f32e7eSjoergHIDE_UNDOC_MEMBERS = NO 454*06f32e7eSjoerg 455*06f32e7eSjoerg# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 456*06f32e7eSjoerg# undocumented classes that are normally visible in the class hierarchy. If set 457*06f32e7eSjoerg# to NO these classes will be included in the various overviews. This option has 458*06f32e7eSjoerg# no effect if EXTRACT_ALL is enabled. 459*06f32e7eSjoerg# The default value is: NO. 460*06f32e7eSjoerg 461*06f32e7eSjoergHIDE_UNDOC_CLASSES = NO 462*06f32e7eSjoerg 463*06f32e7eSjoerg# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 464*06f32e7eSjoerg# (class|struct|union) declarations. If set to NO these declarations will be 465*06f32e7eSjoerg# included in the documentation. 466*06f32e7eSjoerg# The default value is: NO. 467*06f32e7eSjoerg 468*06f32e7eSjoergHIDE_FRIEND_COMPOUNDS = NO 469*06f32e7eSjoerg 470*06f32e7eSjoerg# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 471*06f32e7eSjoerg# documentation blocks found inside the body of a function. If set to NO these 472*06f32e7eSjoerg# blocks will be appended to the function's detailed documentation block. 473*06f32e7eSjoerg# The default value is: NO. 474*06f32e7eSjoerg 475*06f32e7eSjoergHIDE_IN_BODY_DOCS = NO 476*06f32e7eSjoerg 477*06f32e7eSjoerg# The INTERNAL_DOCS tag determines if documentation that is typed after a 478*06f32e7eSjoerg# \internal command is included. If the tag is set to NO then the documentation 479*06f32e7eSjoerg# will be excluded. Set it to YES to include the internal documentation. 480*06f32e7eSjoerg# The default value is: NO. 481*06f32e7eSjoerg 482*06f32e7eSjoergINTERNAL_DOCS = NO 483*06f32e7eSjoerg 484*06f32e7eSjoerg# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 485*06f32e7eSjoerg# names in lower-case letters. If set to YES upper-case letters are also 486*06f32e7eSjoerg# allowed. This is useful if you have classes or files whose names only differ 487*06f32e7eSjoerg# in case and if your file system supports case sensitive file names. Windows 488*06f32e7eSjoerg# and Mac users are advised to set this option to NO. 489*06f32e7eSjoerg# The default value is: system dependent. 490*06f32e7eSjoerg 491*06f32e7eSjoergCASE_SENSE_NAMES = YES 492*06f32e7eSjoerg 493*06f32e7eSjoerg# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 494*06f32e7eSjoerg# their full class and namespace scopes in the documentation. If set to YES the 495*06f32e7eSjoerg# scope will be hidden. 496*06f32e7eSjoerg# The default value is: NO. 497*06f32e7eSjoerg 498*06f32e7eSjoergHIDE_SCOPE_NAMES = NO 499*06f32e7eSjoerg 500*06f32e7eSjoerg# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 501*06f32e7eSjoerg# the files that are included by a file in the documentation of that file. 502*06f32e7eSjoerg# The default value is: YES. 503*06f32e7eSjoerg 504*06f32e7eSjoergSHOW_INCLUDE_FILES = YES 505*06f32e7eSjoerg 506*06f32e7eSjoerg# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 507*06f32e7eSjoerg# grouped member an include statement to the documentation, telling the reader 508*06f32e7eSjoerg# which file to include in order to use the member. 509*06f32e7eSjoerg# The default value is: NO. 510*06f32e7eSjoerg 511*06f32e7eSjoergSHOW_GROUPED_MEMB_INC = NO 512*06f32e7eSjoerg 513*06f32e7eSjoerg# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 514*06f32e7eSjoerg# files with double quotes in the documentation rather than with sharp brackets. 515*06f32e7eSjoerg# The default value is: NO. 516*06f32e7eSjoerg 517*06f32e7eSjoergFORCE_LOCAL_INCLUDES = YES 518*06f32e7eSjoerg 519*06f32e7eSjoerg# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 520*06f32e7eSjoerg# documentation for inline members. 521*06f32e7eSjoerg# The default value is: YES. 522*06f32e7eSjoerg 523*06f32e7eSjoergINLINE_INFO = YES 524*06f32e7eSjoerg 525*06f32e7eSjoerg# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 526*06f32e7eSjoerg# (detailed) documentation of file and class members alphabetically by member 527*06f32e7eSjoerg# name. If set to NO the members will appear in declaration order. 528*06f32e7eSjoerg# The default value is: YES. 529*06f32e7eSjoerg 530*06f32e7eSjoergSORT_MEMBER_DOCS = YES 531*06f32e7eSjoerg 532*06f32e7eSjoerg# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 533*06f32e7eSjoerg# descriptions of file, namespace and class members alphabetically by member 534*06f32e7eSjoerg# name. If set to NO the members will appear in declaration order. Note that 535*06f32e7eSjoerg# this will also influence the order of the classes in the class list. 536*06f32e7eSjoerg# The default value is: NO. 537*06f32e7eSjoerg 538*06f32e7eSjoergSORT_BRIEF_DOCS = NO 539*06f32e7eSjoerg 540*06f32e7eSjoerg# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 541*06f32e7eSjoerg# (brief and detailed) documentation of class members so that constructors and 542*06f32e7eSjoerg# destructors are listed first. If set to NO the constructors will appear in the 543*06f32e7eSjoerg# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 544*06f32e7eSjoerg# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 545*06f32e7eSjoerg# member documentation. 546*06f32e7eSjoerg# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 547*06f32e7eSjoerg# detailed member documentation. 548*06f32e7eSjoerg# The default value is: NO. 549*06f32e7eSjoerg 550*06f32e7eSjoergSORT_MEMBERS_CTORS_1ST = NO 551*06f32e7eSjoerg 552*06f32e7eSjoerg# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 553*06f32e7eSjoerg# of group names into alphabetical order. If set to NO the group names will 554*06f32e7eSjoerg# appear in their defined order. 555*06f32e7eSjoerg# The default value is: NO. 556*06f32e7eSjoerg 557*06f32e7eSjoergSORT_GROUP_NAMES = NO 558*06f32e7eSjoerg 559*06f32e7eSjoerg# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 560*06f32e7eSjoerg# fully-qualified names, including namespaces. If set to NO, the class list will 561*06f32e7eSjoerg# be sorted only by class name, not including the namespace part. 562*06f32e7eSjoerg# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 563*06f32e7eSjoerg# Note: This option applies only to the class list, not to the alphabetical 564*06f32e7eSjoerg# list. 565*06f32e7eSjoerg# The default value is: NO. 566*06f32e7eSjoerg 567*06f32e7eSjoergSORT_BY_SCOPE_NAME = NO 568*06f32e7eSjoerg 569*06f32e7eSjoerg# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 570*06f32e7eSjoerg# type resolution of all parameters of a function it will reject a match between 571*06f32e7eSjoerg# the prototype and the implementation of a member function even if there is 572*06f32e7eSjoerg# only one candidate or it is obvious which candidate to choose by doing a 573*06f32e7eSjoerg# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 574*06f32e7eSjoerg# accept a match between prototype and implementation in such cases. 575*06f32e7eSjoerg# The default value is: NO. 576*06f32e7eSjoerg 577*06f32e7eSjoergSTRICT_PROTO_MATCHING = NO 578*06f32e7eSjoerg 579*06f32e7eSjoerg# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 580*06f32e7eSjoerg# todo list. This list is created by putting \todo commands in the 581*06f32e7eSjoerg# documentation. 582*06f32e7eSjoerg# The default value is: YES. 583*06f32e7eSjoerg 584*06f32e7eSjoergGENERATE_TODOLIST = YES 585*06f32e7eSjoerg 586*06f32e7eSjoerg# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 587*06f32e7eSjoerg# test list. This list is created by putting \test commands in the 588*06f32e7eSjoerg# documentation. 589*06f32e7eSjoerg# The default value is: YES. 590*06f32e7eSjoerg 591*06f32e7eSjoergGENERATE_TESTLIST = YES 592*06f32e7eSjoerg 593*06f32e7eSjoerg# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 594*06f32e7eSjoerg# list. This list is created by putting \bug commands in the documentation. 595*06f32e7eSjoerg# The default value is: YES. 596*06f32e7eSjoerg 597*06f32e7eSjoergGENERATE_BUGLIST = YES 598*06f32e7eSjoerg 599*06f32e7eSjoerg# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 600*06f32e7eSjoerg# the deprecated list. This list is created by putting \deprecated commands in 601*06f32e7eSjoerg# the documentation. 602*06f32e7eSjoerg# The default value is: YES. 603*06f32e7eSjoerg 604*06f32e7eSjoergGENERATE_DEPRECATEDLIST= YES 605*06f32e7eSjoerg 606*06f32e7eSjoerg# The ENABLED_SECTIONS tag can be used to enable conditional documentation 607*06f32e7eSjoerg# sections, marked by \if <section_label> ... \endif and \cond <section_label> 608*06f32e7eSjoerg# ... \endcond blocks. 609*06f32e7eSjoerg 610*06f32e7eSjoergENABLED_SECTIONS = 611*06f32e7eSjoerg 612*06f32e7eSjoerg# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 613*06f32e7eSjoerg# initial value of a variable or macro / define can have for it to appear in the 614*06f32e7eSjoerg# documentation. If the initializer consists of more lines than specified here 615*06f32e7eSjoerg# it will be hidden. Use a value of 0 to hide initializers completely. The 616*06f32e7eSjoerg# appearance of the value of individual variables and macros / defines can be 617*06f32e7eSjoerg# controlled using \showinitializer or \hideinitializer command in the 618*06f32e7eSjoerg# documentation regardless of this setting. 619*06f32e7eSjoerg# Minimum value: 0, maximum value: 10000, default value: 30. 620*06f32e7eSjoerg 621*06f32e7eSjoergMAX_INITIALIZER_LINES = 30 622*06f32e7eSjoerg 623*06f32e7eSjoerg# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 624*06f32e7eSjoerg# the bottom of the documentation of classes and structs. If set to YES the list 625*06f32e7eSjoerg# will mention the files that were used to generate the documentation. 626*06f32e7eSjoerg# The default value is: YES. 627*06f32e7eSjoerg 628*06f32e7eSjoergSHOW_USED_FILES = YES 629*06f32e7eSjoerg 630*06f32e7eSjoerg# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 631*06f32e7eSjoerg# will remove the Files entry from the Quick Index and from the Folder Tree View 632*06f32e7eSjoerg# (if specified). 633*06f32e7eSjoerg# The default value is: YES. 634*06f32e7eSjoerg 635*06f32e7eSjoergSHOW_FILES = YES 636*06f32e7eSjoerg 637*06f32e7eSjoerg# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 638*06f32e7eSjoerg# page. This will remove the Namespaces entry from the Quick Index and from the 639*06f32e7eSjoerg# Folder Tree View (if specified). 640*06f32e7eSjoerg# The default value is: YES. 641*06f32e7eSjoerg 642*06f32e7eSjoergSHOW_NAMESPACES = YES 643*06f32e7eSjoerg 644*06f32e7eSjoerg# The FILE_VERSION_FILTER tag can be used to specify a program or script that 645*06f32e7eSjoerg# doxygen should invoke to get the current version for each file (typically from 646*06f32e7eSjoerg# the version control system). Doxygen will invoke the program by executing (via 647*06f32e7eSjoerg# popen()) the command command input-file, where command is the value of the 648*06f32e7eSjoerg# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 649*06f32e7eSjoerg# by doxygen. Whatever the program writes to standard output is used as the file 650*06f32e7eSjoerg# version. For an example see the documentation. 651*06f32e7eSjoerg 652*06f32e7eSjoergFILE_VERSION_FILTER = 653*06f32e7eSjoerg 654*06f32e7eSjoerg# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 655*06f32e7eSjoerg# by doxygen. The layout file controls the global structure of the generated 656*06f32e7eSjoerg# output files in an output format independent way. To create the layout file 657*06f32e7eSjoerg# that represents doxygen's defaults, run doxygen with the -l option. You can 658*06f32e7eSjoerg# optionally specify a file name after the option, if omitted DoxygenLayout.xml 659*06f32e7eSjoerg# will be used as the name of the layout file. 660*06f32e7eSjoerg# 661*06f32e7eSjoerg# Note that if you run doxygen from a directory containing a file called 662*06f32e7eSjoerg# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 663*06f32e7eSjoerg# tag is left empty. 664*06f32e7eSjoerg 665*06f32e7eSjoergLAYOUT_FILE = 666*06f32e7eSjoerg 667*06f32e7eSjoerg# The CITE_BIB_FILES tag can be used to specify one or more bib files containing 668*06f32e7eSjoerg# the reference definitions. This must be a list of .bib files. The .bib 669*06f32e7eSjoerg# extension is automatically appended if omitted. This requires the bibtex tool 670*06f32e7eSjoerg# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 671*06f32e7eSjoerg# For LaTeX the style of the bibliography can be controlled using 672*06f32e7eSjoerg# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 673*06f32e7eSjoerg# search path. Do not use file names with spaces, bibtex cannot handle them. See 674*06f32e7eSjoerg# also \cite for info how to create references. 675*06f32e7eSjoerg 676*06f32e7eSjoergCITE_BIB_FILES = 677*06f32e7eSjoerg 678*06f32e7eSjoerg#--------------------------------------------------------------------------- 679*06f32e7eSjoerg# Configuration options related to warning and progress messages 680*06f32e7eSjoerg#--------------------------------------------------------------------------- 681*06f32e7eSjoerg 682*06f32e7eSjoerg# The QUIET tag can be used to turn on/off the messages that are generated to 683*06f32e7eSjoerg# standard output by doxygen. If QUIET is set to YES this implies that the 684*06f32e7eSjoerg# messages are off. 685*06f32e7eSjoerg# The default value is: NO. 686*06f32e7eSjoerg 687*06f32e7eSjoergQUIET = NO 688*06f32e7eSjoerg 689*06f32e7eSjoerg# The WARNINGS tag can be used to turn on/off the warning messages that are 690*06f32e7eSjoerg# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 691*06f32e7eSjoerg# this implies that the warnings are on. 692*06f32e7eSjoerg# 693*06f32e7eSjoerg# Tip: Turn warnings on while writing the documentation. 694*06f32e7eSjoerg# The default value is: YES. 695*06f32e7eSjoerg 696*06f32e7eSjoergWARNINGS = NO 697*06f32e7eSjoerg 698*06f32e7eSjoerg# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 699*06f32e7eSjoerg# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 700*06f32e7eSjoerg# will automatically be disabled. 701*06f32e7eSjoerg# The default value is: YES. 702*06f32e7eSjoerg 703*06f32e7eSjoergWARN_IF_UNDOCUMENTED = NO 704*06f32e7eSjoerg 705*06f32e7eSjoerg# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 706*06f32e7eSjoerg# potential errors in the documentation, such as not documenting some parameters 707*06f32e7eSjoerg# in a documented function, or documenting parameters that don't exist or using 708*06f32e7eSjoerg# markup commands wrongly. 709*06f32e7eSjoerg# The default value is: YES. 710*06f32e7eSjoerg 711*06f32e7eSjoergWARN_IF_DOC_ERROR = YES 712*06f32e7eSjoerg 713*06f32e7eSjoerg# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 714*06f32e7eSjoerg# are documented, but have no documentation for their parameters or return 715*06f32e7eSjoerg# value. If set to NO doxygen will only warn about wrong or incomplete parameter 716*06f32e7eSjoerg# documentation, but not about the absence of documentation. 717*06f32e7eSjoerg# The default value is: NO. 718*06f32e7eSjoerg 719*06f32e7eSjoergWARN_NO_PARAMDOC = NO 720*06f32e7eSjoerg 721*06f32e7eSjoerg# The WARN_FORMAT tag determines the format of the warning messages that doxygen 722*06f32e7eSjoerg# can produce. The string should contain the $file, $line, and $text tags, which 723*06f32e7eSjoerg# will be replaced by the file and line number from which the warning originated 724*06f32e7eSjoerg# and the warning text. Optionally the format may contain $version, which will 725*06f32e7eSjoerg# be replaced by the version of the file (if it could be obtained via 726*06f32e7eSjoerg# FILE_VERSION_FILTER) 727*06f32e7eSjoerg# The default value is: $file:$line: $text. 728*06f32e7eSjoerg 729*06f32e7eSjoergWARN_FORMAT = "$file:$line: $text" 730*06f32e7eSjoerg 731*06f32e7eSjoerg# The WARN_LOGFILE tag can be used to specify a file to which warning and error 732*06f32e7eSjoerg# messages should be written. If left blank the output is written to standard 733*06f32e7eSjoerg# error (stderr). 734*06f32e7eSjoerg 735*06f32e7eSjoergWARN_LOGFILE = 736*06f32e7eSjoerg 737*06f32e7eSjoerg#--------------------------------------------------------------------------- 738*06f32e7eSjoerg# Configuration options related to the input files 739*06f32e7eSjoerg#--------------------------------------------------------------------------- 740*06f32e7eSjoerg 741*06f32e7eSjoerg# The INPUT tag is used to specify the files and/or directories that contain 742*06f32e7eSjoerg# documented source files. You may enter file names like myfile.cpp or 743*06f32e7eSjoerg# directories like /usr/src/myproject. Separate the files or directories with 744*06f32e7eSjoerg# spaces. 745*06f32e7eSjoerg# Note: If this tag is empty the current directory is searched. 746*06f32e7eSjoerg 747*06f32e7eSjoergINPUT = @abs_top_srcdir@/../include \ 748*06f32e7eSjoerg @abs_top_srcdir@/../lib \ 749*06f32e7eSjoerg @abs_top_srcdir@/doxygen-mainpage.dox 750*06f32e7eSjoerg 751*06f32e7eSjoerg# This tag can be used to specify the character encoding of the source files 752*06f32e7eSjoerg# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 753*06f32e7eSjoerg# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 754*06f32e7eSjoerg# documentation (see: http://www.gnu.org/software/libiconv) for the list of 755*06f32e7eSjoerg# possible encodings. 756*06f32e7eSjoerg# The default value is: UTF-8. 757*06f32e7eSjoerg 758*06f32e7eSjoergINPUT_ENCODING = UTF-8 759*06f32e7eSjoerg 760*06f32e7eSjoerg# If the value of the INPUT tag contains directories, you can use the 761*06f32e7eSjoerg# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 762*06f32e7eSjoerg# *.h) to filter out the source-files in the directories. If left blank the 763*06f32e7eSjoerg# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 764*06f32e7eSjoerg# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 765*06f32e7eSjoerg# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 766*06f32e7eSjoerg# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 767*06f32e7eSjoerg# *.qsf, *.as and *.js. 768*06f32e7eSjoerg 769*06f32e7eSjoergFILE_PATTERNS = 770*06f32e7eSjoerg 771*06f32e7eSjoerg# The RECURSIVE tag can be used to specify whether or not subdirectories should 772*06f32e7eSjoerg# be searched for input files as well. 773*06f32e7eSjoerg# The default value is: NO. 774*06f32e7eSjoerg 775*06f32e7eSjoergRECURSIVE = YES 776*06f32e7eSjoerg 777*06f32e7eSjoerg# The EXCLUDE tag can be used to specify files and/or directories that should be 778*06f32e7eSjoerg# excluded from the INPUT source files. This way you can easily exclude a 779*06f32e7eSjoerg# subdirectory from a directory tree whose root is specified with the INPUT tag. 780*06f32e7eSjoerg# 781*06f32e7eSjoerg# Note that relative paths are relative to the directory from which doxygen is 782*06f32e7eSjoerg# run. 783*06f32e7eSjoerg 784*06f32e7eSjoergEXCLUDE = 785*06f32e7eSjoerg 786*06f32e7eSjoerg# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 787*06f32e7eSjoerg# directories that are symbolic links (a Unix file system feature) are excluded 788*06f32e7eSjoerg# from the input. 789*06f32e7eSjoerg# The default value is: NO. 790*06f32e7eSjoerg 791*06f32e7eSjoergEXCLUDE_SYMLINKS = NO 792*06f32e7eSjoerg 793*06f32e7eSjoerg# If the value of the INPUT tag contains directories, you can use the 794*06f32e7eSjoerg# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 795*06f32e7eSjoerg# certain files from those directories. 796*06f32e7eSjoerg# 797*06f32e7eSjoerg# Note that the wildcards are matched against the file with absolute path, so to 798*06f32e7eSjoerg# exclude all test directories for example use the pattern */test/* 799*06f32e7eSjoerg 800*06f32e7eSjoergEXCLUDE_PATTERNS = 801*06f32e7eSjoerg 802*06f32e7eSjoerg# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 803*06f32e7eSjoerg# (namespaces, classes, functions, etc.) that should be excluded from the 804*06f32e7eSjoerg# output. The symbol name can be a fully qualified name, a word, or if the 805*06f32e7eSjoerg# wildcard * is used, a substring. Examples: ANamespace, AClass, 806*06f32e7eSjoerg# AClass::ANamespace, ANamespace::*Test 807*06f32e7eSjoerg# 808*06f32e7eSjoerg# Note that the wildcards are matched against the file with absolute path, so to 809*06f32e7eSjoerg# exclude all test directories use the pattern */test/* 810*06f32e7eSjoerg 811*06f32e7eSjoergEXCLUDE_SYMBOLS = 812*06f32e7eSjoerg 813*06f32e7eSjoerg# The EXAMPLE_PATH tag can be used to specify one or more files or directories 814*06f32e7eSjoerg# that contain example code fragments that are included (see the \include 815*06f32e7eSjoerg# command). 816*06f32e7eSjoerg 817*06f32e7eSjoergEXAMPLE_PATH = @abs_top_srcdir@/../examples 818*06f32e7eSjoerg 819*06f32e7eSjoerg# If the value of the EXAMPLE_PATH tag contains directories, you can use the 820*06f32e7eSjoerg# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 821*06f32e7eSjoerg# *.h) to filter out the source-files in the directories. If left blank all 822*06f32e7eSjoerg# files are included. 823*06f32e7eSjoerg 824*06f32e7eSjoergEXAMPLE_PATTERNS = 825*06f32e7eSjoerg 826*06f32e7eSjoerg# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 827*06f32e7eSjoerg# searched for input files to be used with the \include or \dontinclude commands 828*06f32e7eSjoerg# irrespective of the value of the RECURSIVE tag. 829*06f32e7eSjoerg# The default value is: NO. 830*06f32e7eSjoerg 831*06f32e7eSjoergEXAMPLE_RECURSIVE = YES 832*06f32e7eSjoerg 833*06f32e7eSjoerg# The IMAGE_PATH tag can be used to specify one or more files or directories 834*06f32e7eSjoerg# that contain images that are to be included in the documentation (see the 835*06f32e7eSjoerg# \image command). 836*06f32e7eSjoerg 837*06f32e7eSjoergIMAGE_PATH = @abs_top_srcdir@/img 838*06f32e7eSjoerg 839*06f32e7eSjoerg# The INPUT_FILTER tag can be used to specify a program that doxygen should 840*06f32e7eSjoerg# invoke to filter for each input file. Doxygen will invoke the filter program 841*06f32e7eSjoerg# by executing (via popen()) the command: 842*06f32e7eSjoerg# 843*06f32e7eSjoerg# <filter> <input-file> 844*06f32e7eSjoerg# 845*06f32e7eSjoerg# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 846*06f32e7eSjoerg# name of an input file. Doxygen will then use the output that the filter 847*06f32e7eSjoerg# program writes to standard output. If FILTER_PATTERNS is specified, this tag 848*06f32e7eSjoerg# will be ignored. 849*06f32e7eSjoerg# 850*06f32e7eSjoerg# Note that the filter must not add or remove lines; it is applied before the 851*06f32e7eSjoerg# code is scanned, but not when the output code is generated. If lines are added 852*06f32e7eSjoerg# or removed, the anchors will not be placed correctly. 853*06f32e7eSjoerg 854*06f32e7eSjoergINPUT_FILTER = 855*06f32e7eSjoerg 856*06f32e7eSjoerg# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 857*06f32e7eSjoerg# basis. Doxygen will compare the file name with each pattern and apply the 858*06f32e7eSjoerg# filter if there is a match. The filters are a list of the form: pattern=filter 859*06f32e7eSjoerg# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 860*06f32e7eSjoerg# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 861*06f32e7eSjoerg# patterns match the file name, INPUT_FILTER is applied. 862*06f32e7eSjoerg 863*06f32e7eSjoergFILTER_PATTERNS = 864*06f32e7eSjoerg 865*06f32e7eSjoerg# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 866*06f32e7eSjoerg# INPUT_FILTER ) will also be used to filter the input files that are used for 867*06f32e7eSjoerg# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 868*06f32e7eSjoerg# The default value is: NO. 869*06f32e7eSjoerg 870*06f32e7eSjoergFILTER_SOURCE_FILES = NO 871*06f32e7eSjoerg 872*06f32e7eSjoerg# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 873*06f32e7eSjoerg# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 874*06f32e7eSjoerg# it is also possible to disable source filtering for a specific pattern using 875*06f32e7eSjoerg# *.ext= (so without naming a filter). 876*06f32e7eSjoerg# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 877*06f32e7eSjoerg 878*06f32e7eSjoergFILTER_SOURCE_PATTERNS = 879*06f32e7eSjoerg 880*06f32e7eSjoerg# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 881*06f32e7eSjoerg# is part of the input, its contents will be placed on the main page 882*06f32e7eSjoerg# (index.html). This can be useful if you have a project on for instance GitHub 883*06f32e7eSjoerg# and want to reuse the introduction page also for the doxygen output. 884*06f32e7eSjoerg 885*06f32e7eSjoergUSE_MDFILE_AS_MAINPAGE = 886*06f32e7eSjoerg 887*06f32e7eSjoerg#--------------------------------------------------------------------------- 888*06f32e7eSjoerg# Configuration options related to source browsing 889*06f32e7eSjoerg#--------------------------------------------------------------------------- 890*06f32e7eSjoerg 891*06f32e7eSjoerg# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 892*06f32e7eSjoerg# generated. Documented entities will be cross-referenced with these sources. 893*06f32e7eSjoerg# 894*06f32e7eSjoerg# Note: To get rid of all source code in the generated output, make sure that 895*06f32e7eSjoerg# also VERBATIM_HEADERS is set to NO. 896*06f32e7eSjoerg# The default value is: NO. 897*06f32e7eSjoerg 898*06f32e7eSjoergSOURCE_BROWSER = YES 899*06f32e7eSjoerg 900*06f32e7eSjoerg# Setting the INLINE_SOURCES tag to YES will include the body of functions, 901*06f32e7eSjoerg# classes and enums directly into the documentation. 902*06f32e7eSjoerg# The default value is: NO. 903*06f32e7eSjoerg 904*06f32e7eSjoergINLINE_SOURCES = NO 905*06f32e7eSjoerg 906*06f32e7eSjoerg# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 907*06f32e7eSjoerg# special comment blocks from generated source code fragments. Normal C, C++ and 908*06f32e7eSjoerg# Fortran comments will always remain visible. 909*06f32e7eSjoerg# The default value is: YES. 910*06f32e7eSjoerg 911*06f32e7eSjoergSTRIP_CODE_COMMENTS = NO 912*06f32e7eSjoerg 913*06f32e7eSjoerg# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 914*06f32e7eSjoerg# function all documented functions referencing it will be listed. 915*06f32e7eSjoerg# The default value is: NO. 916*06f32e7eSjoerg 917*06f32e7eSjoergREFERENCED_BY_RELATION = YES 918*06f32e7eSjoerg 919*06f32e7eSjoerg# If the REFERENCES_RELATION tag is set to YES then for each documented function 920*06f32e7eSjoerg# all documented entities called/used by that function will be listed. 921*06f32e7eSjoerg# The default value is: NO. 922*06f32e7eSjoerg 923*06f32e7eSjoergREFERENCES_RELATION = YES 924*06f32e7eSjoerg 925*06f32e7eSjoerg# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 926*06f32e7eSjoerg# to YES, then the hyperlinks from functions in REFERENCES_RELATION and 927*06f32e7eSjoerg# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 928*06f32e7eSjoerg# link to the documentation. 929*06f32e7eSjoerg# The default value is: YES. 930*06f32e7eSjoerg 931*06f32e7eSjoergREFERENCES_LINK_SOURCE = YES 932*06f32e7eSjoerg 933*06f32e7eSjoerg# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 934*06f32e7eSjoerg# source code will show a tooltip with additional information such as prototype, 935*06f32e7eSjoerg# brief description and links to the definition and documentation. Since this 936*06f32e7eSjoerg# will make the HTML file larger and loading of large files a bit slower, you 937*06f32e7eSjoerg# can opt to disable this feature. 938*06f32e7eSjoerg# The default value is: YES. 939*06f32e7eSjoerg# This tag requires that the tag SOURCE_BROWSER is set to YES. 940*06f32e7eSjoerg 941*06f32e7eSjoergSOURCE_TOOLTIPS = YES 942*06f32e7eSjoerg 943*06f32e7eSjoerg# If the USE_HTAGS tag is set to YES then the references to source code will 944*06f32e7eSjoerg# point to the HTML generated by the htags(1) tool instead of doxygen built-in 945*06f32e7eSjoerg# source browser. The htags tool is part of GNU's global source tagging system 946*06f32e7eSjoerg# (see http://www.gnu.org/software/global/global.html). You will need version 947*06f32e7eSjoerg# 4.8.6 or higher. 948*06f32e7eSjoerg# 949*06f32e7eSjoerg# To use it do the following: 950*06f32e7eSjoerg# - Install the latest version of global 951*06f32e7eSjoerg# - Enable SOURCE_BROWSER and USE_HTAGS in the config file 952*06f32e7eSjoerg# - Make sure the INPUT points to the root of the source tree 953*06f32e7eSjoerg# - Run doxygen as normal 954*06f32e7eSjoerg# 955*06f32e7eSjoerg# Doxygen will invoke htags (and that will in turn invoke gtags), so these 956*06f32e7eSjoerg# tools must be available from the command line (i.e. in the search path). 957*06f32e7eSjoerg# 958*06f32e7eSjoerg# The result: instead of the source browser generated by doxygen, the links to 959*06f32e7eSjoerg# source code will now point to the output of htags. 960*06f32e7eSjoerg# The default value is: NO. 961*06f32e7eSjoerg# This tag requires that the tag SOURCE_BROWSER is set to YES. 962*06f32e7eSjoerg 963*06f32e7eSjoergUSE_HTAGS = NO 964*06f32e7eSjoerg 965*06f32e7eSjoerg# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 966*06f32e7eSjoerg# verbatim copy of the header file for each class for which an include is 967*06f32e7eSjoerg# specified. Set to NO to disable this. 968*06f32e7eSjoerg# See also: Section \class. 969*06f32e7eSjoerg# The default value is: YES. 970*06f32e7eSjoerg 971*06f32e7eSjoergVERBATIM_HEADERS = YES 972*06f32e7eSjoerg 973*06f32e7eSjoerg#--------------------------------------------------------------------------- 974*06f32e7eSjoerg# Configuration options related to the alphabetical class index 975*06f32e7eSjoerg#--------------------------------------------------------------------------- 976*06f32e7eSjoerg 977*06f32e7eSjoerg# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 978*06f32e7eSjoerg# compounds will be generated. Enable this if the project contains a lot of 979*06f32e7eSjoerg# classes, structs, unions or interfaces. 980*06f32e7eSjoerg# The default value is: YES. 981*06f32e7eSjoerg 982*06f32e7eSjoergALPHABETICAL_INDEX = YES 983*06f32e7eSjoerg 984*06f32e7eSjoerg# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 985*06f32e7eSjoerg# which the alphabetical index list will be split. 986*06f32e7eSjoerg# Minimum value: 1, maximum value: 20, default value: 5. 987*06f32e7eSjoerg# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 988*06f32e7eSjoerg 989*06f32e7eSjoergCOLS_IN_ALPHA_INDEX = 4 990*06f32e7eSjoerg 991*06f32e7eSjoerg# In case all classes in a project start with a common prefix, all classes will 992*06f32e7eSjoerg# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 993*06f32e7eSjoerg# can be used to specify a prefix (or a list of prefixes) that should be ignored 994*06f32e7eSjoerg# while generating the index headers. 995*06f32e7eSjoerg# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 996*06f32e7eSjoerg 997*06f32e7eSjoergIGNORE_PREFIX = llvm:: 998*06f32e7eSjoerg 999*06f32e7eSjoerg#--------------------------------------------------------------------------- 1000*06f32e7eSjoerg# Configuration options related to the HTML output 1001*06f32e7eSjoerg#--------------------------------------------------------------------------- 1002*06f32e7eSjoerg 1003*06f32e7eSjoerg# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 1004*06f32e7eSjoerg# The default value is: YES. 1005*06f32e7eSjoerg 1006*06f32e7eSjoergGENERATE_HTML = YES 1007*06f32e7eSjoerg 1008*06f32e7eSjoerg# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1009*06f32e7eSjoerg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1010*06f32e7eSjoerg# it. 1011*06f32e7eSjoerg# The default directory is: html. 1012*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1013*06f32e7eSjoerg 1014*06f32e7eSjoergHTML_OUTPUT = html 1015*06f32e7eSjoerg 1016*06f32e7eSjoerg# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1017*06f32e7eSjoerg# generated HTML page (for example: .htm, .php, .asp). 1018*06f32e7eSjoerg# The default value is: .html. 1019*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1020*06f32e7eSjoerg 1021*06f32e7eSjoergHTML_FILE_EXTENSION = .html 1022*06f32e7eSjoerg 1023*06f32e7eSjoerg# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1024*06f32e7eSjoerg# each generated HTML page. If the tag is left blank doxygen will generate a 1025*06f32e7eSjoerg# standard header. 1026*06f32e7eSjoerg# 1027*06f32e7eSjoerg# To get valid HTML the header file that includes any scripts and style sheets 1028*06f32e7eSjoerg# that doxygen needs, which is dependent on the configuration options used (e.g. 1029*06f32e7eSjoerg# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1030*06f32e7eSjoerg# default header using 1031*06f32e7eSjoerg# doxygen -w html new_header.html new_footer.html new_stylesheet.css 1032*06f32e7eSjoerg# YourConfigFile 1033*06f32e7eSjoerg# and then modify the file new_header.html. See also section "Doxygen usage" 1034*06f32e7eSjoerg# for information on how to generate the default header that doxygen normally 1035*06f32e7eSjoerg# uses. 1036*06f32e7eSjoerg# Note: The header is subject to change so you typically have to regenerate the 1037*06f32e7eSjoerg# default header when upgrading to a newer version of doxygen. For a description 1038*06f32e7eSjoerg# of the possible markers and block names see the documentation. 1039*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1040*06f32e7eSjoerg 1041*06f32e7eSjoergHTML_HEADER = 1042*06f32e7eSjoerg 1043*06f32e7eSjoerg# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1044*06f32e7eSjoerg# generated HTML page. If the tag is left blank doxygen will generate a standard 1045*06f32e7eSjoerg# footer. See HTML_HEADER for more information on how to generate a default 1046*06f32e7eSjoerg# footer and what special commands can be used inside the footer. See also 1047*06f32e7eSjoerg# section "Doxygen usage" for information on how to generate the default footer 1048*06f32e7eSjoerg# that doxygen normally uses. 1049*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1050*06f32e7eSjoerg 1051*06f32e7eSjoergHTML_FOOTER = 1052*06f32e7eSjoerg 1053*06f32e7eSjoerg# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1054*06f32e7eSjoerg# sheet that is used by each HTML page. It can be used to fine-tune the look of 1055*06f32e7eSjoerg# the HTML output. If left blank doxygen will generate a default style sheet. 1056*06f32e7eSjoerg# See also section "Doxygen usage" for information on how to generate the style 1057*06f32e7eSjoerg# sheet that doxygen normally uses. 1058*06f32e7eSjoerg# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1059*06f32e7eSjoerg# it is more robust and this tag (HTML_STYLESHEET) will in the future become 1060*06f32e7eSjoerg# obsolete. 1061*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1062*06f32e7eSjoerg 1063*06f32e7eSjoergHTML_STYLESHEET = 1064*06f32e7eSjoerg 1065*06f32e7eSjoerg# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- 1066*06f32e7eSjoerg# defined cascading style sheet that is included after the standard style sheets 1067*06f32e7eSjoerg# created by doxygen. Using this option one can overrule certain style aspects. 1068*06f32e7eSjoerg# This is preferred over using HTML_STYLESHEET since it does not replace the 1069*06f32e7eSjoerg# standard style sheet and is therefor more robust against future updates. 1070*06f32e7eSjoerg# Doxygen will copy the style sheet file to the output directory. For an example 1071*06f32e7eSjoerg# see the documentation. 1072*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1073*06f32e7eSjoerg 1074*06f32e7eSjoergHTML_EXTRA_STYLESHEET = 1075*06f32e7eSjoerg 1076*06f32e7eSjoerg# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1077*06f32e7eSjoerg# other source files which should be copied to the HTML output directory. Note 1078*06f32e7eSjoerg# that these files will be copied to the base HTML output directory. Use the 1079*06f32e7eSjoerg# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1080*06f32e7eSjoerg# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1081*06f32e7eSjoerg# files will be copied as-is; there are no commands or markers available. 1082*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1083*06f32e7eSjoerg 1084*06f32e7eSjoergHTML_EXTRA_FILES = 1085*06f32e7eSjoerg 1086*06f32e7eSjoerg# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1087*06f32e7eSjoerg# will adjust the colors in the stylesheet and background images according to 1088*06f32e7eSjoerg# this color. Hue is specified as an angle on a colorwheel, see 1089*06f32e7eSjoerg# http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1090*06f32e7eSjoerg# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1091*06f32e7eSjoerg# purple, and 360 is red again. 1092*06f32e7eSjoerg# Minimum value: 0, maximum value: 359, default value: 220. 1093*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1094*06f32e7eSjoerg 1095*06f32e7eSjoergHTML_COLORSTYLE_HUE = 220 1096*06f32e7eSjoerg 1097*06f32e7eSjoerg# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1098*06f32e7eSjoerg# in the HTML output. For a value of 0 the output will use grayscales only. A 1099*06f32e7eSjoerg# value of 255 will produce the most vivid colors. 1100*06f32e7eSjoerg# Minimum value: 0, maximum value: 255, default value: 100. 1101*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1102*06f32e7eSjoerg 1103*06f32e7eSjoergHTML_COLORSTYLE_SAT = 100 1104*06f32e7eSjoerg 1105*06f32e7eSjoerg# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1106*06f32e7eSjoerg# luminance component of the colors in the HTML output. Values below 100 1107*06f32e7eSjoerg# gradually make the output lighter, whereas values above 100 make the output 1108*06f32e7eSjoerg# darker. The value divided by 100 is the actual gamma applied, so 80 represents 1109*06f32e7eSjoerg# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1110*06f32e7eSjoerg# change the gamma. 1111*06f32e7eSjoerg# Minimum value: 40, maximum value: 240, default value: 80. 1112*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1113*06f32e7eSjoerg 1114*06f32e7eSjoergHTML_COLORSTYLE_GAMMA = 80 1115*06f32e7eSjoerg 1116*06f32e7eSjoerg# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1117*06f32e7eSjoerg# page will contain the date and time when the page was generated. Setting this 1118*06f32e7eSjoerg# to NO can help when comparing the output of multiple runs. 1119*06f32e7eSjoerg# The default value is: YES. 1120*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1121*06f32e7eSjoerg 1122*06f32e7eSjoergHTML_TIMESTAMP = YES 1123*06f32e7eSjoerg 1124*06f32e7eSjoerg# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1125*06f32e7eSjoerg# documentation will contain sections that can be hidden and shown after the 1126*06f32e7eSjoerg# page has loaded. 1127*06f32e7eSjoerg# The default value is: NO. 1128*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1129*06f32e7eSjoerg 1130*06f32e7eSjoergHTML_DYNAMIC_SECTIONS = NO 1131*06f32e7eSjoerg 1132*06f32e7eSjoerg# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1133*06f32e7eSjoerg# shown in the various tree structured indices initially; the user can expand 1134*06f32e7eSjoerg# and collapse entries dynamically later on. Doxygen will expand the tree to 1135*06f32e7eSjoerg# such a level that at most the specified number of entries are visible (unless 1136*06f32e7eSjoerg# a fully collapsed tree already exceeds this amount). So setting the number of 1137*06f32e7eSjoerg# entries 1 will produce a full collapsed tree by default. 0 is a special value 1138*06f32e7eSjoerg# representing an infinite number of entries and will result in a full expanded 1139*06f32e7eSjoerg# tree by default. 1140*06f32e7eSjoerg# Minimum value: 0, maximum value: 9999, default value: 100. 1141*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1142*06f32e7eSjoerg 1143*06f32e7eSjoergHTML_INDEX_NUM_ENTRIES = 100 1144*06f32e7eSjoerg 1145*06f32e7eSjoerg# If the GENERATE_DOCSET tag is set to YES, additional index files will be 1146*06f32e7eSjoerg# generated that can be used as input for Apple's Xcode 3 integrated development 1147*06f32e7eSjoerg# environment (see: http://developer.apple.com/tools/xcode/), introduced with 1148*06f32e7eSjoerg# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1149*06f32e7eSjoerg# Makefile in the HTML output directory. Running make will produce the docset in 1150*06f32e7eSjoerg# that directory and running make install will install the docset in 1151*06f32e7eSjoerg# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1152*06f32e7eSjoerg# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1153*06f32e7eSjoerg# for more information. 1154*06f32e7eSjoerg# The default value is: NO. 1155*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1156*06f32e7eSjoerg 1157*06f32e7eSjoergGENERATE_DOCSET = NO 1158*06f32e7eSjoerg 1159*06f32e7eSjoerg# This tag determines the name of the docset feed. A documentation feed provides 1160*06f32e7eSjoerg# an umbrella under which multiple documentation sets from a single provider 1161*06f32e7eSjoerg# (such as a company or product suite) can be grouped. 1162*06f32e7eSjoerg# The default value is: Doxygen generated docs. 1163*06f32e7eSjoerg# This tag requires that the tag GENERATE_DOCSET is set to YES. 1164*06f32e7eSjoerg 1165*06f32e7eSjoergDOCSET_FEEDNAME = "Doxygen generated docs" 1166*06f32e7eSjoerg 1167*06f32e7eSjoerg# This tag specifies a string that should uniquely identify the documentation 1168*06f32e7eSjoerg# set bundle. This should be a reverse domain-name style string, e.g. 1169*06f32e7eSjoerg# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1170*06f32e7eSjoerg# The default value is: org.doxygen.Project. 1171*06f32e7eSjoerg# This tag requires that the tag GENERATE_DOCSET is set to YES. 1172*06f32e7eSjoerg 1173*06f32e7eSjoergDOCSET_BUNDLE_ID = org.doxygen.Project 1174*06f32e7eSjoerg 1175*06f32e7eSjoerg# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1176*06f32e7eSjoerg# the documentation publisher. This should be a reverse domain-name style 1177*06f32e7eSjoerg# string, e.g. com.mycompany.MyDocSet.documentation. 1178*06f32e7eSjoerg# The default value is: org.doxygen.Publisher. 1179*06f32e7eSjoerg# This tag requires that the tag GENERATE_DOCSET is set to YES. 1180*06f32e7eSjoerg 1181*06f32e7eSjoergDOCSET_PUBLISHER_ID = org.doxygen.Publisher 1182*06f32e7eSjoerg 1183*06f32e7eSjoerg# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1184*06f32e7eSjoerg# The default value is: Publisher. 1185*06f32e7eSjoerg# This tag requires that the tag GENERATE_DOCSET is set to YES. 1186*06f32e7eSjoerg 1187*06f32e7eSjoergDOCSET_PUBLISHER_NAME = Publisher 1188*06f32e7eSjoerg 1189*06f32e7eSjoerg# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1190*06f32e7eSjoerg# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1191*06f32e7eSjoerg# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1192*06f32e7eSjoerg# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1193*06f32e7eSjoerg# Windows. 1194*06f32e7eSjoerg# 1195*06f32e7eSjoerg# The HTML Help Workshop contains a compiler that can convert all HTML output 1196*06f32e7eSjoerg# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1197*06f32e7eSjoerg# files are now used as the Windows 98 help format, and will replace the old 1198*06f32e7eSjoerg# Windows help format (.hlp) on all Windows platforms in the future. Compressed 1199*06f32e7eSjoerg# HTML files also contain an index, a table of contents, and you can search for 1200*06f32e7eSjoerg# words in the documentation. The HTML workshop also contains a viewer for 1201*06f32e7eSjoerg# compressed HTML files. 1202*06f32e7eSjoerg# The default value is: NO. 1203*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1204*06f32e7eSjoerg 1205*06f32e7eSjoergGENERATE_HTMLHELP = NO 1206*06f32e7eSjoerg 1207*06f32e7eSjoerg# The CHM_FILE tag can be used to specify the file name of the resulting .chm 1208*06f32e7eSjoerg# file. You can add a path in front of the file if the result should not be 1209*06f32e7eSjoerg# written to the html output directory. 1210*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1211*06f32e7eSjoerg 1212*06f32e7eSjoergCHM_FILE = 1213*06f32e7eSjoerg 1214*06f32e7eSjoerg# The HHC_LOCATION tag can be used to specify the location (absolute path 1215*06f32e7eSjoerg# including file name) of the HTML help compiler ( hhc.exe). If non-empty 1216*06f32e7eSjoerg# doxygen will try to run the HTML help compiler on the generated index.hhp. 1217*06f32e7eSjoerg# The file has to be specified with full path. 1218*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1219*06f32e7eSjoerg 1220*06f32e7eSjoergHHC_LOCATION = 1221*06f32e7eSjoerg 1222*06f32e7eSjoerg# The GENERATE_CHI flag controls if a separate .chi index file is generated ( 1223*06f32e7eSjoerg# YES) or that it should be included in the master .chm file ( NO). 1224*06f32e7eSjoerg# The default value is: NO. 1225*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1226*06f32e7eSjoerg 1227*06f32e7eSjoergGENERATE_CHI = NO 1228*06f32e7eSjoerg 1229*06f32e7eSjoerg# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) 1230*06f32e7eSjoerg# and project file content. 1231*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1232*06f32e7eSjoerg 1233*06f32e7eSjoergCHM_INDEX_ENCODING = 1234*06f32e7eSjoerg 1235*06f32e7eSjoerg# The BINARY_TOC flag controls whether a binary table of contents is generated ( 1236*06f32e7eSjoerg# YES) or a normal table of contents ( NO) in the .chm file. 1237*06f32e7eSjoerg# The default value is: NO. 1238*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1239*06f32e7eSjoerg 1240*06f32e7eSjoergBINARY_TOC = NO 1241*06f32e7eSjoerg 1242*06f32e7eSjoerg# The TOC_EXPAND flag can be set to YES to add extra items for group members to 1243*06f32e7eSjoerg# the table of contents of the HTML help documentation and to the tree view. 1244*06f32e7eSjoerg# The default value is: NO. 1245*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1246*06f32e7eSjoerg 1247*06f32e7eSjoergTOC_EXPAND = NO 1248*06f32e7eSjoerg 1249*06f32e7eSjoerg# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1250*06f32e7eSjoerg# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1251*06f32e7eSjoerg# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1252*06f32e7eSjoerg# (.qch) of the generated HTML documentation. 1253*06f32e7eSjoerg# The default value is: NO. 1254*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1255*06f32e7eSjoerg 1256*06f32e7eSjoergGENERATE_QHP = @llvm_doxygen_generate_qhp@ 1257*06f32e7eSjoerg 1258*06f32e7eSjoerg# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1259*06f32e7eSjoerg# the file name of the resulting .qch file. The path specified is relative to 1260*06f32e7eSjoerg# the HTML output folder. 1261*06f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 1262*06f32e7eSjoerg 1263*06f32e7eSjoergQCH_FILE = @llvm_doxygen_qch_filename@ 1264*06f32e7eSjoerg 1265*06f32e7eSjoerg# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1266*06f32e7eSjoerg# Project output. For more information please see Qt Help Project / Namespace 1267*06f32e7eSjoerg# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1268*06f32e7eSjoerg# The default value is: org.doxygen.Project. 1269*06f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 1270*06f32e7eSjoerg 1271*06f32e7eSjoergQHP_NAMESPACE = @llvm_doxygen_qhp_namespace@ 1272*06f32e7eSjoerg 1273*06f32e7eSjoerg# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1274*06f32e7eSjoerg# Help Project output. For more information please see Qt Help Project / Virtual 1275*06f32e7eSjoerg# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1276*06f32e7eSjoerg# folders). 1277*06f32e7eSjoerg# The default value is: doc. 1278*06f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 1279*06f32e7eSjoerg 1280*06f32e7eSjoergQHP_VIRTUAL_FOLDER = doc 1281*06f32e7eSjoerg 1282*06f32e7eSjoerg# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1283*06f32e7eSjoerg# filter to add. For more information please see Qt Help Project / Custom 1284*06f32e7eSjoerg# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1285*06f32e7eSjoerg# filters). 1286*06f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 1287*06f32e7eSjoerg 1288*06f32e7eSjoergQHP_CUST_FILTER_NAME = @llvm_doxygen_qhp_cust_filter_name@ 1289*06f32e7eSjoerg 1290*06f32e7eSjoerg# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1291*06f32e7eSjoerg# custom filter to add. For more information please see Qt Help Project / Custom 1292*06f32e7eSjoerg# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1293*06f32e7eSjoerg# filters). 1294*06f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 1295*06f32e7eSjoerg 1296*06f32e7eSjoergQHP_CUST_FILTER_ATTRS = @llvm_doxygen_qhp_cust_filter_attrs@ 1297*06f32e7eSjoerg 1298*06f32e7eSjoerg# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1299*06f32e7eSjoerg# project's filter section matches. Qt Help Project / Filter Attributes (see: 1300*06f32e7eSjoerg# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1301*06f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 1302*06f32e7eSjoerg 1303*06f32e7eSjoergQHP_SECT_FILTER_ATTRS = 1304*06f32e7eSjoerg 1305*06f32e7eSjoerg# The QHG_LOCATION tag can be used to specify the location of Qt's 1306*06f32e7eSjoerg# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1307*06f32e7eSjoerg# generated .qhp file. 1308*06f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 1309*06f32e7eSjoerg 1310*06f32e7eSjoergQHG_LOCATION = @llvm_doxygen_qhelpgenerator_path@ 1311*06f32e7eSjoerg 1312*06f32e7eSjoerg# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1313*06f32e7eSjoerg# generated, together with the HTML files, they form an Eclipse help plugin. To 1314*06f32e7eSjoerg# install this plugin and make it available under the help contents menu in 1315*06f32e7eSjoerg# Eclipse, the contents of the directory containing the HTML and XML files needs 1316*06f32e7eSjoerg# to be copied into the plugins directory of eclipse. The name of the directory 1317*06f32e7eSjoerg# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1318*06f32e7eSjoerg# After copying Eclipse needs to be restarted before the help appears. 1319*06f32e7eSjoerg# The default value is: NO. 1320*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1321*06f32e7eSjoerg 1322*06f32e7eSjoergGENERATE_ECLIPSEHELP = NO 1323*06f32e7eSjoerg 1324*06f32e7eSjoerg# A unique identifier for the Eclipse help plugin. When installing the plugin 1325*06f32e7eSjoerg# the directory name containing the HTML and XML files should also have this 1326*06f32e7eSjoerg# name. Each documentation set should have its own identifier. 1327*06f32e7eSjoerg# The default value is: org.doxygen.Project. 1328*06f32e7eSjoerg# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1329*06f32e7eSjoerg 1330*06f32e7eSjoergECLIPSE_DOC_ID = org.doxygen.Project 1331*06f32e7eSjoerg 1332*06f32e7eSjoerg# If you want full control over the layout of the generated HTML pages it might 1333*06f32e7eSjoerg# be necessary to disable the index and replace it with your own. The 1334*06f32e7eSjoerg# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1335*06f32e7eSjoerg# of each HTML page. A value of NO enables the index and the value YES disables 1336*06f32e7eSjoerg# it. Since the tabs in the index contain the same information as the navigation 1337*06f32e7eSjoerg# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1338*06f32e7eSjoerg# The default value is: NO. 1339*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1340*06f32e7eSjoerg 1341*06f32e7eSjoergDISABLE_INDEX = NO 1342*06f32e7eSjoerg 1343*06f32e7eSjoerg# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1344*06f32e7eSjoerg# structure should be generated to display hierarchical information. If the tag 1345*06f32e7eSjoerg# value is set to YES, a side panel will be generated containing a tree-like 1346*06f32e7eSjoerg# index structure (just like the one that is generated for HTML Help). For this 1347*06f32e7eSjoerg# to work a browser that supports JavaScript, DHTML, CSS and frames is required 1348*06f32e7eSjoerg# (i.e. any modern browser). Windows users are probably better off using the 1349*06f32e7eSjoerg# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can 1350*06f32e7eSjoerg# further fine-tune the look of the index. As an example, the default style 1351*06f32e7eSjoerg# sheet generated by doxygen has an example that shows how to put an image at 1352*06f32e7eSjoerg# the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1353*06f32e7eSjoerg# the same information as the tab index, you could consider setting 1354*06f32e7eSjoerg# DISABLE_INDEX to YES when enabling this option. 1355*06f32e7eSjoerg# The default value is: NO. 1356*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1357*06f32e7eSjoerg 1358*06f32e7eSjoergGENERATE_TREEVIEW = NO 1359*06f32e7eSjoerg 1360*06f32e7eSjoerg# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1361*06f32e7eSjoerg# doxygen will group on one line in the generated HTML documentation. 1362*06f32e7eSjoerg# 1363*06f32e7eSjoerg# Note that a value of 0 will completely suppress the enum values from appearing 1364*06f32e7eSjoerg# in the overview section. 1365*06f32e7eSjoerg# Minimum value: 0, maximum value: 20, default value: 4. 1366*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1367*06f32e7eSjoerg 1368*06f32e7eSjoergENUM_VALUES_PER_LINE = 4 1369*06f32e7eSjoerg 1370*06f32e7eSjoerg# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1371*06f32e7eSjoerg# to set the initial width (in pixels) of the frame in which the tree is shown. 1372*06f32e7eSjoerg# Minimum value: 0, maximum value: 1500, default value: 250. 1373*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1374*06f32e7eSjoerg 1375*06f32e7eSjoergTREEVIEW_WIDTH = 250 1376*06f32e7eSjoerg 1377*06f32e7eSjoerg# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to 1378*06f32e7eSjoerg# external symbols imported via tag files in a separate window. 1379*06f32e7eSjoerg# The default value is: NO. 1380*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1381*06f32e7eSjoerg 1382*06f32e7eSjoergEXT_LINKS_IN_WINDOW = NO 1383*06f32e7eSjoerg 1384*06f32e7eSjoerg# Use this tag to change the font size of LaTeX formulas included as images in 1385*06f32e7eSjoerg# the HTML documentation. When you change the font size after a successful 1386*06f32e7eSjoerg# doxygen run you need to manually remove any form_*.png images from the HTML 1387*06f32e7eSjoerg# output directory to force them to be regenerated. 1388*06f32e7eSjoerg# Minimum value: 8, maximum value: 50, default value: 10. 1389*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1390*06f32e7eSjoerg 1391*06f32e7eSjoergFORMULA_FONTSIZE = 10 1392*06f32e7eSjoerg 1393*06f32e7eSjoerg# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1394*06f32e7eSjoerg# generated for formulas are transparent PNGs. Transparent PNGs are not 1395*06f32e7eSjoerg# supported properly for IE 6.0, but are supported on all modern browsers. 1396*06f32e7eSjoerg# 1397*06f32e7eSjoerg# Note that when changing this option you need to delete any form_*.png files in 1398*06f32e7eSjoerg# the HTML output directory before the changes have effect. 1399*06f32e7eSjoerg# The default value is: YES. 1400*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1401*06f32e7eSjoerg 1402*06f32e7eSjoergFORMULA_TRANSPARENT = YES 1403*06f32e7eSjoerg 1404*06f32e7eSjoerg# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1405*06f32e7eSjoerg# http://www.mathjax.org) which uses client side Javascript for the rendering 1406*06f32e7eSjoerg# instead of using prerendered bitmaps. Use this if you do not have LaTeX 1407*06f32e7eSjoerg# installed or if you want to formulas look prettier in the HTML output. When 1408*06f32e7eSjoerg# enabled you may also need to install MathJax separately and configure the path 1409*06f32e7eSjoerg# to it using the MATHJAX_RELPATH option. 1410*06f32e7eSjoerg# The default value is: NO. 1411*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1412*06f32e7eSjoerg 1413*06f32e7eSjoergUSE_MATHJAX = YES 1414*06f32e7eSjoerg 1415*06f32e7eSjoerg# When MathJax is enabled you can set the default output format to be used for 1416*06f32e7eSjoerg# the MathJax output. See the MathJax site (see: 1417*06f32e7eSjoerg# http://docs.mathjax.org/en/latest/output.html) for more details. 1418*06f32e7eSjoerg# Possible values are: HTML-CSS (which is slower, but has the best 1419*06f32e7eSjoerg# compatibility), NativeMML (i.e. MathML) and SVG. 1420*06f32e7eSjoerg# The default value is: HTML-CSS. 1421*06f32e7eSjoerg# This tag requires that the tag USE_MATHJAX is set to YES. 1422*06f32e7eSjoerg 1423*06f32e7eSjoergMATHJAX_FORMAT = HTML-CSS 1424*06f32e7eSjoerg 1425*06f32e7eSjoerg# When MathJax is enabled you need to specify the location relative to the HTML 1426*06f32e7eSjoerg# output directory using the MATHJAX_RELPATH option. The destination directory 1427*06f32e7eSjoerg# should contain the MathJax.js script. For instance, if the mathjax directory 1428*06f32e7eSjoerg# is located at the same level as the HTML output directory, then 1429*06f32e7eSjoerg# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1430*06f32e7eSjoerg# Content Delivery Network so you can quickly see the result without installing 1431*06f32e7eSjoerg# MathJax. However, it is strongly recommended to install a local copy of 1432*06f32e7eSjoerg# MathJax from http://www.mathjax.org before deployment. 1433*06f32e7eSjoerg# The default value is: http://cdn.mathjax.org/mathjax/latest. 1434*06f32e7eSjoerg# This tag requires that the tag USE_MATHJAX is set to YES. 1435*06f32e7eSjoerg 1436*06f32e7eSjoergMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1437*06f32e7eSjoerg 1438*06f32e7eSjoerg# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1439*06f32e7eSjoerg# extension names that should be enabled during MathJax rendering. For example 1440*06f32e7eSjoerg# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1441*06f32e7eSjoerg# This tag requires that the tag USE_MATHJAX is set to YES. 1442*06f32e7eSjoerg 1443*06f32e7eSjoergMATHJAX_EXTENSIONS = 1444*06f32e7eSjoerg 1445*06f32e7eSjoerg# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1446*06f32e7eSjoerg# of code that will be used on startup of the MathJax code. See the MathJax site 1447*06f32e7eSjoerg# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1448*06f32e7eSjoerg# example see the documentation. 1449*06f32e7eSjoerg# This tag requires that the tag USE_MATHJAX is set to YES. 1450*06f32e7eSjoerg 1451*06f32e7eSjoergMATHJAX_CODEFILE = 1452*06f32e7eSjoerg 1453*06f32e7eSjoerg# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1454*06f32e7eSjoerg# the HTML output. The underlying search engine uses javascript and DHTML and 1455*06f32e7eSjoerg# should work on any modern browser. Note that when using HTML help 1456*06f32e7eSjoerg# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1457*06f32e7eSjoerg# there is already a search function so this one should typically be disabled. 1458*06f32e7eSjoerg# For large projects the javascript based search engine can be slow, then 1459*06f32e7eSjoerg# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1460*06f32e7eSjoerg# search using the keyboard; to jump to the search box use <access key> + S 1461*06f32e7eSjoerg# (what the <access key> is depends on the OS and browser, but it is typically 1462*06f32e7eSjoerg# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1463*06f32e7eSjoerg# key> to jump into the search results window, the results can be navigated 1464*06f32e7eSjoerg# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1465*06f32e7eSjoerg# the search. The filter options can be selected when the cursor is inside the 1466*06f32e7eSjoerg# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1467*06f32e7eSjoerg# to select a filter and <Enter> or <escape> to activate or cancel the filter 1468*06f32e7eSjoerg# option. 1469*06f32e7eSjoerg# The default value is: YES. 1470*06f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 1471*06f32e7eSjoerg 1472*06f32e7eSjoergSEARCHENGINE = @enable_searchengine@ 1473*06f32e7eSjoerg 1474*06f32e7eSjoerg# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1475*06f32e7eSjoerg# implemented using a web server instead of a web client using Javascript. There 1476*06f32e7eSjoerg# are two flavours of web server based searching depending on the 1477*06f32e7eSjoerg# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 1478*06f32e7eSjoerg# searching and an index file used by the script. When EXTERNAL_SEARCH is 1479*06f32e7eSjoerg# enabled the indexing and searching needs to be provided by external tools. See 1480*06f32e7eSjoerg# the section "External Indexing and Searching" for details. 1481*06f32e7eSjoerg# The default value is: NO. 1482*06f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 1483*06f32e7eSjoerg 1484*06f32e7eSjoergSERVER_BASED_SEARCH = @enable_server_based_search@ 1485*06f32e7eSjoerg 1486*06f32e7eSjoerg# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1487*06f32e7eSjoerg# script for searching. Instead the search results are written to an XML file 1488*06f32e7eSjoerg# which needs to be processed by an external indexer. Doxygen will invoke an 1489*06f32e7eSjoerg# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1490*06f32e7eSjoerg# search results. 1491*06f32e7eSjoerg# 1492*06f32e7eSjoerg# Doxygen ships with an example indexer ( doxyindexer) and search engine 1493*06f32e7eSjoerg# (doxysearch.cgi) which are based on the open source search engine library 1494*06f32e7eSjoerg# Xapian (see: http://xapian.org/). 1495*06f32e7eSjoerg# 1496*06f32e7eSjoerg# See the section "External Indexing and Searching" for details. 1497*06f32e7eSjoerg# The default value is: NO. 1498*06f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 1499*06f32e7eSjoerg 1500*06f32e7eSjoergEXTERNAL_SEARCH = @enable_external_search@ 1501*06f32e7eSjoerg 1502*06f32e7eSjoerg# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1503*06f32e7eSjoerg# which will return the search results when EXTERNAL_SEARCH is enabled. 1504*06f32e7eSjoerg# 1505*06f32e7eSjoerg# Doxygen ships with an example indexer ( doxyindexer) and search engine 1506*06f32e7eSjoerg# (doxysearch.cgi) which are based on the open source search engine library 1507*06f32e7eSjoerg# Xapian (see: http://xapian.org/). See the section "External Indexing and 1508*06f32e7eSjoerg# Searching" for details. 1509*06f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 1510*06f32e7eSjoerg 1511*06f32e7eSjoergSEARCHENGINE_URL = @searchengine_url@ 1512*06f32e7eSjoerg 1513*06f32e7eSjoerg# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1514*06f32e7eSjoerg# search data is written to a file for indexing by an external tool. With the 1515*06f32e7eSjoerg# SEARCHDATA_FILE tag the name of this file can be specified. 1516*06f32e7eSjoerg# The default file is: searchdata.xml. 1517*06f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 1518*06f32e7eSjoerg 1519*06f32e7eSjoergSEARCHDATA_FILE = searchdata.xml 1520*06f32e7eSjoerg 1521*06f32e7eSjoerg# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1522*06f32e7eSjoerg# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1523*06f32e7eSjoerg# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1524*06f32e7eSjoerg# projects and redirect the results back to the right project. 1525*06f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 1526*06f32e7eSjoerg 1527*06f32e7eSjoergEXTERNAL_SEARCH_ID = llvm 1528*06f32e7eSjoerg 1529*06f32e7eSjoerg# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1530*06f32e7eSjoerg# projects other than the one defined by this configuration file, but that are 1531*06f32e7eSjoerg# all added to the same external search index. Each project needs to have a 1532*06f32e7eSjoerg# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1533*06f32e7eSjoerg# to a relative location where the documentation can be found. The format is: 1534*06f32e7eSjoerg# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1535*06f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 1536*06f32e7eSjoerg 1537*06f32e7eSjoergEXTRA_SEARCH_MAPPINGS = @extra_search_mappings@ 1538*06f32e7eSjoerg 1539*06f32e7eSjoerg#--------------------------------------------------------------------------- 1540*06f32e7eSjoerg# Configuration options related to the LaTeX output 1541*06f32e7eSjoerg#--------------------------------------------------------------------------- 1542*06f32e7eSjoerg 1543*06f32e7eSjoerg# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. 1544*06f32e7eSjoerg# The default value is: YES. 1545*06f32e7eSjoerg 1546*06f32e7eSjoergGENERATE_LATEX = NO 1547*06f32e7eSjoerg 1548*06f32e7eSjoerg# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1549*06f32e7eSjoerg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1550*06f32e7eSjoerg# it. 1551*06f32e7eSjoerg# The default directory is: latex. 1552*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1553*06f32e7eSjoerg 1554*06f32e7eSjoergLATEX_OUTPUT = latex 1555*06f32e7eSjoerg 1556*06f32e7eSjoerg# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1557*06f32e7eSjoerg# invoked. 1558*06f32e7eSjoerg# 1559*06f32e7eSjoerg# Note that when enabling USE_PDFLATEX this option is only used for generating 1560*06f32e7eSjoerg# bitmaps for formulas in the HTML output, but not in the Makefile that is 1561*06f32e7eSjoerg# written to the output directory. 1562*06f32e7eSjoerg# The default file is: latex. 1563*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1564*06f32e7eSjoerg 1565*06f32e7eSjoergLATEX_CMD_NAME = latex 1566*06f32e7eSjoerg 1567*06f32e7eSjoerg# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1568*06f32e7eSjoerg# index for LaTeX. 1569*06f32e7eSjoerg# The default file is: makeindex. 1570*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1571*06f32e7eSjoerg 1572*06f32e7eSjoergMAKEINDEX_CMD_NAME = makeindex 1573*06f32e7eSjoerg 1574*06f32e7eSjoerg# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX 1575*06f32e7eSjoerg# documents. This may be useful for small projects and may help to save some 1576*06f32e7eSjoerg# trees in general. 1577*06f32e7eSjoerg# The default value is: NO. 1578*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1579*06f32e7eSjoerg 1580*06f32e7eSjoergCOMPACT_LATEX = NO 1581*06f32e7eSjoerg 1582*06f32e7eSjoerg# The PAPER_TYPE tag can be used to set the paper type that is used by the 1583*06f32e7eSjoerg# printer. 1584*06f32e7eSjoerg# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1585*06f32e7eSjoerg# 14 inches) and executive (7.25 x 10.5 inches). 1586*06f32e7eSjoerg# The default value is: a4. 1587*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1588*06f32e7eSjoerg 1589*06f32e7eSjoergPAPER_TYPE = a4 1590*06f32e7eSjoerg 1591*06f32e7eSjoerg# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1592*06f32e7eSjoerg# that should be included in the LaTeX output. To get the times font for 1593*06f32e7eSjoerg# instance you can specify 1594*06f32e7eSjoerg# EXTRA_PACKAGES=times 1595*06f32e7eSjoerg# If left blank no extra packages will be included. 1596*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1597*06f32e7eSjoerg 1598*06f32e7eSjoergEXTRA_PACKAGES = 1599*06f32e7eSjoerg 1600*06f32e7eSjoerg# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1601*06f32e7eSjoerg# generated LaTeX document. The header should contain everything until the first 1602*06f32e7eSjoerg# chapter. If it is left blank doxygen will generate a standard header. See 1603*06f32e7eSjoerg# section "Doxygen usage" for information on how to let doxygen write the 1604*06f32e7eSjoerg# default header to a separate file. 1605*06f32e7eSjoerg# 1606*06f32e7eSjoerg# Note: Only use a user-defined header if you know what you are doing! The 1607*06f32e7eSjoerg# following commands have a special meaning inside the header: $title, 1608*06f32e7eSjoerg# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will 1609*06f32e7eSjoerg# replace them by respectively the title of the page, the current date and time, 1610*06f32e7eSjoerg# only the current date, the version number of doxygen, the project name (see 1611*06f32e7eSjoerg# PROJECT_NAME), or the project number (see PROJECT_NUMBER). 1612*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1613*06f32e7eSjoerg 1614*06f32e7eSjoergLATEX_HEADER = 1615*06f32e7eSjoerg 1616*06f32e7eSjoerg# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1617*06f32e7eSjoerg# generated LaTeX document. The footer should contain everything after the last 1618*06f32e7eSjoerg# chapter. If it is left blank doxygen will generate a standard footer. 1619*06f32e7eSjoerg# 1620*06f32e7eSjoerg# Note: Only use a user-defined footer if you know what you are doing! 1621*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1622*06f32e7eSjoerg 1623*06f32e7eSjoergLATEX_FOOTER = 1624*06f32e7eSjoerg 1625*06f32e7eSjoerg# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1626*06f32e7eSjoerg# other source files which should be copied to the LATEX_OUTPUT output 1627*06f32e7eSjoerg# directory. Note that the files will be copied as-is; there are no commands or 1628*06f32e7eSjoerg# markers available. 1629*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1630*06f32e7eSjoerg 1631*06f32e7eSjoergLATEX_EXTRA_FILES = 1632*06f32e7eSjoerg 1633*06f32e7eSjoerg# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1634*06f32e7eSjoerg# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1635*06f32e7eSjoerg# contain links (just like the HTML output) instead of page references. This 1636*06f32e7eSjoerg# makes the output suitable for online browsing using a PDF viewer. 1637*06f32e7eSjoerg# The default value is: YES. 1638*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1639*06f32e7eSjoerg 1640*06f32e7eSjoergPDF_HYPERLINKS = YES 1641*06f32e7eSjoerg 1642*06f32e7eSjoerg# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1643*06f32e7eSjoerg# the PDF file directly from the LaTeX files. Set this option to YES to get a 1644*06f32e7eSjoerg# higher quality PDF documentation. 1645*06f32e7eSjoerg# The default value is: YES. 1646*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1647*06f32e7eSjoerg 1648*06f32e7eSjoergUSE_PDFLATEX = YES 1649*06f32e7eSjoerg 1650*06f32e7eSjoerg# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1651*06f32e7eSjoerg# command to the generated LaTeX files. This will instruct LaTeX to keep running 1652*06f32e7eSjoerg# if errors occur, instead of asking the user for help. This option is also used 1653*06f32e7eSjoerg# when generating formulas in HTML. 1654*06f32e7eSjoerg# The default value is: NO. 1655*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1656*06f32e7eSjoerg 1657*06f32e7eSjoergLATEX_BATCHMODE = NO 1658*06f32e7eSjoerg 1659*06f32e7eSjoerg# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1660*06f32e7eSjoerg# index chapters (such as File Index, Compound Index, etc.) in the output. 1661*06f32e7eSjoerg# The default value is: NO. 1662*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1663*06f32e7eSjoerg 1664*06f32e7eSjoergLATEX_HIDE_INDICES = NO 1665*06f32e7eSjoerg 1666*06f32e7eSjoerg# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1667*06f32e7eSjoerg# code with syntax highlighting in the LaTeX output. 1668*06f32e7eSjoerg# 1669*06f32e7eSjoerg# Note that which sources are shown also depends on other settings such as 1670*06f32e7eSjoerg# SOURCE_BROWSER. 1671*06f32e7eSjoerg# The default value is: NO. 1672*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1673*06f32e7eSjoerg 1674*06f32e7eSjoergLATEX_SOURCE_CODE = NO 1675*06f32e7eSjoerg 1676*06f32e7eSjoerg# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1677*06f32e7eSjoerg# bibliography, e.g. plainnat, or ieeetr. See 1678*06f32e7eSjoerg# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1679*06f32e7eSjoerg# The default value is: plain. 1680*06f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 1681*06f32e7eSjoerg 1682*06f32e7eSjoergLATEX_BIB_STYLE = plain 1683*06f32e7eSjoerg 1684*06f32e7eSjoerg#--------------------------------------------------------------------------- 1685*06f32e7eSjoerg# Configuration options related to the RTF output 1686*06f32e7eSjoerg#--------------------------------------------------------------------------- 1687*06f32e7eSjoerg 1688*06f32e7eSjoerg# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The 1689*06f32e7eSjoerg# RTF output is optimized for Word 97 and may not look too pretty with other RTF 1690*06f32e7eSjoerg# readers/editors. 1691*06f32e7eSjoerg# The default value is: NO. 1692*06f32e7eSjoerg 1693*06f32e7eSjoergGENERATE_RTF = NO 1694*06f32e7eSjoerg 1695*06f32e7eSjoerg# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1696*06f32e7eSjoerg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1697*06f32e7eSjoerg# it. 1698*06f32e7eSjoerg# The default directory is: rtf. 1699*06f32e7eSjoerg# This tag requires that the tag GENERATE_RTF is set to YES. 1700*06f32e7eSjoerg 1701*06f32e7eSjoergRTF_OUTPUT = rtf 1702*06f32e7eSjoerg 1703*06f32e7eSjoerg# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF 1704*06f32e7eSjoerg# documents. This may be useful for small projects and may help to save some 1705*06f32e7eSjoerg# trees in general. 1706*06f32e7eSjoerg# The default value is: NO. 1707*06f32e7eSjoerg# This tag requires that the tag GENERATE_RTF is set to YES. 1708*06f32e7eSjoerg 1709*06f32e7eSjoergCOMPACT_RTF = NO 1710*06f32e7eSjoerg 1711*06f32e7eSjoerg# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1712*06f32e7eSjoerg# contain hyperlink fields. The RTF file will contain links (just like the HTML 1713*06f32e7eSjoerg# output) instead of page references. This makes the output suitable for online 1714*06f32e7eSjoerg# browsing using Word or some other Word compatible readers that support those 1715*06f32e7eSjoerg# fields. 1716*06f32e7eSjoerg# 1717*06f32e7eSjoerg# Note: WordPad (write) and others do not support links. 1718*06f32e7eSjoerg# The default value is: NO. 1719*06f32e7eSjoerg# This tag requires that the tag GENERATE_RTF is set to YES. 1720*06f32e7eSjoerg 1721*06f32e7eSjoergRTF_HYPERLINKS = NO 1722*06f32e7eSjoerg 1723*06f32e7eSjoerg# Load stylesheet definitions from file. Syntax is similar to doxygen's config 1724*06f32e7eSjoerg# file, i.e. a series of assignments. You only have to provide replacements, 1725*06f32e7eSjoerg# missing definitions are set to their default value. 1726*06f32e7eSjoerg# 1727*06f32e7eSjoerg# See also section "Doxygen usage" for information on how to generate the 1728*06f32e7eSjoerg# default style sheet that doxygen normally uses. 1729*06f32e7eSjoerg# This tag requires that the tag GENERATE_RTF is set to YES. 1730*06f32e7eSjoerg 1731*06f32e7eSjoergRTF_STYLESHEET_FILE = 1732*06f32e7eSjoerg 1733*06f32e7eSjoerg# Set optional variables used in the generation of an RTF document. Syntax is 1734*06f32e7eSjoerg# similar to doxygen's config file. A template extensions file can be generated 1735*06f32e7eSjoerg# using doxygen -e rtf extensionFile. 1736*06f32e7eSjoerg# This tag requires that the tag GENERATE_RTF is set to YES. 1737*06f32e7eSjoerg 1738*06f32e7eSjoergRTF_EXTENSIONS_FILE = 1739*06f32e7eSjoerg 1740*06f32e7eSjoerg#--------------------------------------------------------------------------- 1741*06f32e7eSjoerg# Configuration options related to the man page output 1742*06f32e7eSjoerg#--------------------------------------------------------------------------- 1743*06f32e7eSjoerg 1744*06f32e7eSjoerg# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for 1745*06f32e7eSjoerg# classes and files. 1746*06f32e7eSjoerg# The default value is: NO. 1747*06f32e7eSjoerg 1748*06f32e7eSjoergGENERATE_MAN = NO 1749*06f32e7eSjoerg 1750*06f32e7eSjoerg# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 1751*06f32e7eSjoerg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1752*06f32e7eSjoerg# it. A directory man3 will be created inside the directory specified by 1753*06f32e7eSjoerg# MAN_OUTPUT. 1754*06f32e7eSjoerg# The default directory is: man. 1755*06f32e7eSjoerg# This tag requires that the tag GENERATE_MAN is set to YES. 1756*06f32e7eSjoerg 1757*06f32e7eSjoergMAN_OUTPUT = man 1758*06f32e7eSjoerg 1759*06f32e7eSjoerg# The MAN_EXTENSION tag determines the extension that is added to the generated 1760*06f32e7eSjoerg# man pages. In case the manual section does not start with a number, the number 1761*06f32e7eSjoerg# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 1762*06f32e7eSjoerg# optional. 1763*06f32e7eSjoerg# The default value is: .3. 1764*06f32e7eSjoerg# This tag requires that the tag GENERATE_MAN is set to YES. 1765*06f32e7eSjoerg 1766*06f32e7eSjoergMAN_EXTENSION = .3 1767*06f32e7eSjoerg 1768*06f32e7eSjoerg# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1769*06f32e7eSjoerg# will generate one additional man file for each entity documented in the real 1770*06f32e7eSjoerg# man page(s). These additional files only source the real man page, but without 1771*06f32e7eSjoerg# them the man command would be unable to find the correct page. 1772*06f32e7eSjoerg# The default value is: NO. 1773*06f32e7eSjoerg# This tag requires that the tag GENERATE_MAN is set to YES. 1774*06f32e7eSjoerg 1775*06f32e7eSjoergMAN_LINKS = NO 1776*06f32e7eSjoerg 1777*06f32e7eSjoerg#--------------------------------------------------------------------------- 1778*06f32e7eSjoerg# Configuration options related to the XML output 1779*06f32e7eSjoerg#--------------------------------------------------------------------------- 1780*06f32e7eSjoerg 1781*06f32e7eSjoerg# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that 1782*06f32e7eSjoerg# captures the structure of the code including all documentation. 1783*06f32e7eSjoerg# The default value is: NO. 1784*06f32e7eSjoerg 1785*06f32e7eSjoergGENERATE_XML = NO 1786*06f32e7eSjoerg 1787*06f32e7eSjoerg# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 1788*06f32e7eSjoerg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1789*06f32e7eSjoerg# it. 1790*06f32e7eSjoerg# The default directory is: xml. 1791*06f32e7eSjoerg# This tag requires that the tag GENERATE_XML is set to YES. 1792*06f32e7eSjoerg 1793*06f32e7eSjoergXML_OUTPUT = xml 1794*06f32e7eSjoerg 1795*06f32e7eSjoerg# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program 1796*06f32e7eSjoerg# listings (including syntax highlighting and cross-referencing information) to 1797*06f32e7eSjoerg# the XML output. Note that enabling this will significantly increase the size 1798*06f32e7eSjoerg# of the XML output. 1799*06f32e7eSjoerg# The default value is: YES. 1800*06f32e7eSjoerg# This tag requires that the tag GENERATE_XML is set to YES. 1801*06f32e7eSjoerg 1802*06f32e7eSjoergXML_PROGRAMLISTING = YES 1803*06f32e7eSjoerg 1804*06f32e7eSjoerg#--------------------------------------------------------------------------- 1805*06f32e7eSjoerg# Configuration options related to the DOCBOOK output 1806*06f32e7eSjoerg#--------------------------------------------------------------------------- 1807*06f32e7eSjoerg 1808*06f32e7eSjoerg# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files 1809*06f32e7eSjoerg# that can be used to generate PDF. 1810*06f32e7eSjoerg# The default value is: NO. 1811*06f32e7eSjoerg 1812*06f32e7eSjoergGENERATE_DOCBOOK = NO 1813*06f32e7eSjoerg 1814*06f32e7eSjoerg# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 1815*06f32e7eSjoerg# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 1816*06f32e7eSjoerg# front of it. 1817*06f32e7eSjoerg# The default directory is: docbook. 1818*06f32e7eSjoerg# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1819*06f32e7eSjoerg 1820*06f32e7eSjoergDOCBOOK_OUTPUT = docbook 1821*06f32e7eSjoerg 1822*06f32e7eSjoerg#--------------------------------------------------------------------------- 1823*06f32e7eSjoerg# Configuration options for the AutoGen Definitions output 1824*06f32e7eSjoerg#--------------------------------------------------------------------------- 1825*06f32e7eSjoerg 1826*06f32e7eSjoerg# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen 1827*06f32e7eSjoerg# Definitions (see http://autogen.sf.net) file that captures the structure of 1828*06f32e7eSjoerg# the code including all documentation. Note that this feature is still 1829*06f32e7eSjoerg# experimental and incomplete at the moment. 1830*06f32e7eSjoerg# The default value is: NO. 1831*06f32e7eSjoerg 1832*06f32e7eSjoergGENERATE_AUTOGEN_DEF = NO 1833*06f32e7eSjoerg 1834*06f32e7eSjoerg#--------------------------------------------------------------------------- 1835*06f32e7eSjoerg# Configuration options related to the Perl module output 1836*06f32e7eSjoerg#--------------------------------------------------------------------------- 1837*06f32e7eSjoerg 1838*06f32e7eSjoerg# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module 1839*06f32e7eSjoerg# file that captures the structure of the code including all documentation. 1840*06f32e7eSjoerg# 1841*06f32e7eSjoerg# Note that this feature is still experimental and incomplete at the moment. 1842*06f32e7eSjoerg# The default value is: NO. 1843*06f32e7eSjoerg 1844*06f32e7eSjoergGENERATE_PERLMOD = NO 1845*06f32e7eSjoerg 1846*06f32e7eSjoerg# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary 1847*06f32e7eSjoerg# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 1848*06f32e7eSjoerg# output from the Perl module output. 1849*06f32e7eSjoerg# The default value is: NO. 1850*06f32e7eSjoerg# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1851*06f32e7eSjoerg 1852*06f32e7eSjoergPERLMOD_LATEX = NO 1853*06f32e7eSjoerg 1854*06f32e7eSjoerg# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely 1855*06f32e7eSjoerg# formatted so it can be parsed by a human reader. This is useful if you want to 1856*06f32e7eSjoerg# understand what is going on. On the other hand, if this tag is set to NO the 1857*06f32e7eSjoerg# size of the Perl module output will be much smaller and Perl will parse it 1858*06f32e7eSjoerg# just the same. 1859*06f32e7eSjoerg# The default value is: YES. 1860*06f32e7eSjoerg# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1861*06f32e7eSjoerg 1862*06f32e7eSjoergPERLMOD_PRETTY = YES 1863*06f32e7eSjoerg 1864*06f32e7eSjoerg# The names of the make variables in the generated doxyrules.make file are 1865*06f32e7eSjoerg# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 1866*06f32e7eSjoerg# so different doxyrules.make files included by the same Makefile don't 1867*06f32e7eSjoerg# overwrite each other's variables. 1868*06f32e7eSjoerg# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1869*06f32e7eSjoerg 1870*06f32e7eSjoergPERLMOD_MAKEVAR_PREFIX = 1871*06f32e7eSjoerg 1872*06f32e7eSjoerg#--------------------------------------------------------------------------- 1873*06f32e7eSjoerg# Configuration options related to the preprocessor 1874*06f32e7eSjoerg#--------------------------------------------------------------------------- 1875*06f32e7eSjoerg 1876*06f32e7eSjoerg# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all 1877*06f32e7eSjoerg# C-preprocessor directives found in the sources and include files. 1878*06f32e7eSjoerg# The default value is: YES. 1879*06f32e7eSjoerg 1880*06f32e7eSjoergENABLE_PREPROCESSING = YES 1881*06f32e7eSjoerg 1882*06f32e7eSjoerg# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names 1883*06f32e7eSjoerg# in the source code. If set to NO only conditional compilation will be 1884*06f32e7eSjoerg# performed. Macro expansion can be done in a controlled way by setting 1885*06f32e7eSjoerg# EXPAND_ONLY_PREDEF to YES. 1886*06f32e7eSjoerg# The default value is: NO. 1887*06f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1888*06f32e7eSjoerg 1889*06f32e7eSjoergMACRO_EXPANSION = YES 1890*06f32e7eSjoerg 1891*06f32e7eSjoerg# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 1892*06f32e7eSjoerg# the macro expansion is limited to the macros specified with the PREDEFINED and 1893*06f32e7eSjoerg# EXPAND_AS_DEFINED tags. 1894*06f32e7eSjoerg# The default value is: NO. 1895*06f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1896*06f32e7eSjoerg 1897*06f32e7eSjoergEXPAND_ONLY_PREDEF = YES 1898*06f32e7eSjoerg 1899*06f32e7eSjoerg# If the SEARCH_INCLUDES tag is set to YES the includes files in the 1900*06f32e7eSjoerg# INCLUDE_PATH will be searched if a #include is found. 1901*06f32e7eSjoerg# The default value is: YES. 1902*06f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1903*06f32e7eSjoerg 1904*06f32e7eSjoergSEARCH_INCLUDES = YES 1905*06f32e7eSjoerg 1906*06f32e7eSjoerg# The INCLUDE_PATH tag can be used to specify one or more directories that 1907*06f32e7eSjoerg# contain include files that are not input files but should be processed by the 1908*06f32e7eSjoerg# preprocessor. 1909*06f32e7eSjoerg# This tag requires that the tag SEARCH_INCLUDES is set to YES. 1910*06f32e7eSjoerg 1911*06f32e7eSjoergINCLUDE_PATH = ../include 1912*06f32e7eSjoerg 1913*06f32e7eSjoerg# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1914*06f32e7eSjoerg# patterns (like *.h and *.hpp) to filter out the header-files in the 1915*06f32e7eSjoerg# directories. If left blank, the patterns specified with FILE_PATTERNS will be 1916*06f32e7eSjoerg# used. 1917*06f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1918*06f32e7eSjoerg 1919*06f32e7eSjoergINCLUDE_FILE_PATTERNS = 1920*06f32e7eSjoerg 1921*06f32e7eSjoerg# The PREDEFINED tag can be used to specify one or more macro names that are 1922*06f32e7eSjoerg# defined before the preprocessor is started (similar to the -D option of e.g. 1923*06f32e7eSjoerg# gcc). The argument of the tag is a list of macros of the form: name or 1924*06f32e7eSjoerg# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 1925*06f32e7eSjoerg# is assumed. To prevent a macro definition from being undefined via #undef or 1926*06f32e7eSjoerg# recursively expanded use the := operator instead of the = operator. 1927*06f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1928*06f32e7eSjoerg 1929*06f32e7eSjoergPREDEFINED = 1930*06f32e7eSjoerg 1931*06f32e7eSjoerg# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 1932*06f32e7eSjoerg# tag can be used to specify a list of macro names that should be expanded. The 1933*06f32e7eSjoerg# macro definition that is found in the sources will be used. Use the PREDEFINED 1934*06f32e7eSjoerg# tag if you want to use a different macro definition that overrules the 1935*06f32e7eSjoerg# definition found in the source code. 1936*06f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1937*06f32e7eSjoerg 1938*06f32e7eSjoergEXPAND_AS_DEFINED = 1939*06f32e7eSjoerg 1940*06f32e7eSjoerg# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 1941*06f32e7eSjoerg# remove all references to function-like macros that are alone on a line, have an 1942*06f32e7eSjoerg# all uppercase name, and do not end with a semicolon. Such function macros are 1943*06f32e7eSjoerg# typically used for boiler-plate code, and will confuse the parser if not 1944*06f32e7eSjoerg# removed. 1945*06f32e7eSjoerg# The default value is: YES. 1946*06f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1947*06f32e7eSjoerg 1948*06f32e7eSjoergSKIP_FUNCTION_MACROS = YES 1949*06f32e7eSjoerg 1950*06f32e7eSjoerg#--------------------------------------------------------------------------- 1951*06f32e7eSjoerg# Configuration options related to external references 1952*06f32e7eSjoerg#--------------------------------------------------------------------------- 1953*06f32e7eSjoerg 1954*06f32e7eSjoerg# The TAGFILES tag can be used to specify one or more tag files. For each tag 1955*06f32e7eSjoerg# file the location of the external documentation should be added. The format of 1956*06f32e7eSjoerg# a tag file without this location is as follows: 1957*06f32e7eSjoerg# TAGFILES = file1 file2 ... 1958*06f32e7eSjoerg# Adding location for the tag files is done as follows: 1959*06f32e7eSjoerg# TAGFILES = file1=loc1 "file2 = loc2" ... 1960*06f32e7eSjoerg# where loc1 and loc2 can be relative or absolute paths or URLs. See the 1961*06f32e7eSjoerg# section "Linking to external documentation" for more information about the use 1962*06f32e7eSjoerg# of tag files. 1963*06f32e7eSjoerg# Note: Each tag file must have an unique name (where the name does NOT include 1964*06f32e7eSjoerg# the path). If a tag file is not located in the directory in which doxygen is 1965*06f32e7eSjoerg# run, you must also specify the path to the tagfile here. 1966*06f32e7eSjoerg 1967*06f32e7eSjoergTAGFILES = 1968*06f32e7eSjoerg 1969*06f32e7eSjoerg# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 1970*06f32e7eSjoerg# tag file that is based on the input files it reads. See section "Linking to 1971*06f32e7eSjoerg# external documentation" for more information about the usage of tag files. 1972*06f32e7eSjoerg 1973*06f32e7eSjoergGENERATE_TAGFILE = 1974*06f32e7eSjoerg 1975*06f32e7eSjoerg# If the ALLEXTERNALS tag is set to YES all external class will be listed in the 1976*06f32e7eSjoerg# class index. If set to NO only the inherited external classes will be listed. 1977*06f32e7eSjoerg# The default value is: NO. 1978*06f32e7eSjoerg 1979*06f32e7eSjoergALLEXTERNALS = YES 1980*06f32e7eSjoerg 1981*06f32e7eSjoerg# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in 1982*06f32e7eSjoerg# the modules index. If set to NO, only the current project's groups will be 1983*06f32e7eSjoerg# listed. 1984*06f32e7eSjoerg# The default value is: YES. 1985*06f32e7eSjoerg 1986*06f32e7eSjoergEXTERNAL_GROUPS = YES 1987*06f32e7eSjoerg 1988*06f32e7eSjoerg# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in 1989*06f32e7eSjoerg# the related pages index. If set to NO, only the current project's pages will 1990*06f32e7eSjoerg# be listed. 1991*06f32e7eSjoerg# The default value is: YES. 1992*06f32e7eSjoerg 1993*06f32e7eSjoergEXTERNAL_PAGES = YES 1994*06f32e7eSjoerg 1995*06f32e7eSjoerg# The PERL_PATH should be the absolute path and name of the perl script 1996*06f32e7eSjoerg# interpreter (i.e. the result of 'which perl'). 1997*06f32e7eSjoerg# The default file (with absolute path) is: /usr/bin/perl. 1998*06f32e7eSjoerg 1999*06f32e7eSjoergPERL_PATH = /usr/bin/perl 2000*06f32e7eSjoerg 2001*06f32e7eSjoerg#--------------------------------------------------------------------------- 2002*06f32e7eSjoerg# Configuration options related to the dot tool 2003*06f32e7eSjoerg#--------------------------------------------------------------------------- 2004*06f32e7eSjoerg 2005*06f32e7eSjoerg# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram 2006*06f32e7eSjoerg# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2007*06f32e7eSjoerg# NO turns the diagrams off. Note that this option also works with HAVE_DOT 2008*06f32e7eSjoerg# disabled, but it is recommended to install and use dot, since it yields more 2009*06f32e7eSjoerg# powerful graphs. 2010*06f32e7eSjoerg# The default value is: YES. 2011*06f32e7eSjoerg 2012*06f32e7eSjoergCLASS_DIAGRAMS = YES 2013*06f32e7eSjoerg 2014*06f32e7eSjoerg# You can define message sequence charts within doxygen comments using the \msc 2015*06f32e7eSjoerg# command. Doxygen will then run the mscgen tool (see: 2016*06f32e7eSjoerg# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 2017*06f32e7eSjoerg# documentation. The MSCGEN_PATH tag allows you to specify the directory where 2018*06f32e7eSjoerg# the mscgen tool resides. If left empty the tool is assumed to be found in the 2019*06f32e7eSjoerg# default search path. 2020*06f32e7eSjoerg 2021*06f32e7eSjoergMSCGEN_PATH = 2022*06f32e7eSjoerg 2023*06f32e7eSjoerg# You can include diagrams made with dia in doxygen documentation. Doxygen will 2024*06f32e7eSjoerg# then run dia to produce the diagram and insert it in the documentation. The 2025*06f32e7eSjoerg# DIA_PATH tag allows you to specify the directory where the dia binary resides. 2026*06f32e7eSjoerg# If left empty dia is assumed to be found in the default search path. 2027*06f32e7eSjoerg 2028*06f32e7eSjoergDIA_PATH = 2029*06f32e7eSjoerg 2030*06f32e7eSjoerg# If set to YES, the inheritance and collaboration graphs will hide inheritance 2031*06f32e7eSjoerg# and usage relations if the target is undocumented or is not a class. 2032*06f32e7eSjoerg# The default value is: YES. 2033*06f32e7eSjoerg 2034*06f32e7eSjoergHIDE_UNDOC_RELATIONS = NO 2035*06f32e7eSjoerg 2036*06f32e7eSjoerg# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2037*06f32e7eSjoerg# available from the path. This tool is part of Graphviz (see: 2038*06f32e7eSjoerg# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2039*06f32e7eSjoerg# Bell Labs. The other options in this section have no effect if this option is 2040*06f32e7eSjoerg# set to NO 2041*06f32e7eSjoerg# The default value is: NO. 2042*06f32e7eSjoerg 2043*06f32e7eSjoergHAVE_DOT = YES 2044*06f32e7eSjoerg 2045*06f32e7eSjoerg# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2046*06f32e7eSjoerg# to run in parallel. When set to 0 doxygen will base this on the number of 2047*06f32e7eSjoerg# processors available in the system. You can set it explicitly to a value 2048*06f32e7eSjoerg# larger than 0 to get control over the balance between CPU load and processing 2049*06f32e7eSjoerg# speed. 2050*06f32e7eSjoerg# Minimum value: 0, maximum value: 32, default value: 0. 2051*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2052*06f32e7eSjoerg 2053*06f32e7eSjoergDOT_NUM_THREADS = 0 2054*06f32e7eSjoerg 2055*06f32e7eSjoerg# When you want a differently looking font n the dot files that doxygen 2056*06f32e7eSjoerg# generates you can specify the font name using DOT_FONTNAME. You need to make 2057*06f32e7eSjoerg# sure dot is able to find the font, which can be done by putting it in a 2058*06f32e7eSjoerg# standard location or by setting the DOTFONTPATH environment variable or by 2059*06f32e7eSjoerg# setting DOT_FONTPATH to the directory containing the font. 2060*06f32e7eSjoerg# The default value is: Helvetica. 2061*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2062*06f32e7eSjoerg 2063*06f32e7eSjoergDOT_FONTNAME = Helvetica 2064*06f32e7eSjoerg 2065*06f32e7eSjoerg# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2066*06f32e7eSjoerg# dot graphs. 2067*06f32e7eSjoerg# Minimum value: 4, maximum value: 24, default value: 10. 2068*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2069*06f32e7eSjoerg 2070*06f32e7eSjoergDOT_FONTSIZE = 10 2071*06f32e7eSjoerg 2072*06f32e7eSjoerg# By default doxygen will tell dot to use the default font as specified with 2073*06f32e7eSjoerg# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2074*06f32e7eSjoerg# the path where dot can find it using this tag. 2075*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2076*06f32e7eSjoerg 2077*06f32e7eSjoergDOT_FONTPATH = 2078*06f32e7eSjoerg 2079*06f32e7eSjoerg# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2080*06f32e7eSjoerg# each documented class showing the direct and indirect inheritance relations. 2081*06f32e7eSjoerg# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2082*06f32e7eSjoerg# The default value is: YES. 2083*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2084*06f32e7eSjoerg 2085*06f32e7eSjoergCLASS_GRAPH = YES 2086*06f32e7eSjoerg 2087*06f32e7eSjoerg# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2088*06f32e7eSjoerg# graph for each documented class showing the direct and indirect implementation 2089*06f32e7eSjoerg# dependencies (inheritance, containment, and class references variables) of the 2090*06f32e7eSjoerg# class with other documented classes. 2091*06f32e7eSjoerg# The default value is: YES. 2092*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2093*06f32e7eSjoerg 2094*06f32e7eSjoergCOLLABORATION_GRAPH = YES 2095*06f32e7eSjoerg 2096*06f32e7eSjoerg# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2097*06f32e7eSjoerg# groups, showing the direct groups dependencies. 2098*06f32e7eSjoerg# The default value is: YES. 2099*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2100*06f32e7eSjoerg 2101*06f32e7eSjoergGROUP_GRAPHS = YES 2102*06f32e7eSjoerg 2103*06f32e7eSjoerg# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 2104*06f32e7eSjoerg# collaboration diagrams in a style similar to the OMG's Unified Modeling 2105*06f32e7eSjoerg# Language. 2106*06f32e7eSjoerg# The default value is: NO. 2107*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2108*06f32e7eSjoerg 2109*06f32e7eSjoergUML_LOOK = NO 2110*06f32e7eSjoerg 2111*06f32e7eSjoerg# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2112*06f32e7eSjoerg# class node. If there are many fields or methods and many nodes the graph may 2113*06f32e7eSjoerg# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2114*06f32e7eSjoerg# number of items for each type to make the size more manageable. Set this to 0 2115*06f32e7eSjoerg# for no limit. Note that the threshold may be exceeded by 50% before the limit 2116*06f32e7eSjoerg# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2117*06f32e7eSjoerg# but if the number exceeds 15, the total amount of fields shown is limited to 2118*06f32e7eSjoerg# 10. 2119*06f32e7eSjoerg# Minimum value: 0, maximum value: 100, default value: 10. 2120*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2121*06f32e7eSjoerg 2122*06f32e7eSjoergUML_LIMIT_NUM_FIELDS = 10 2123*06f32e7eSjoerg 2124*06f32e7eSjoerg# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2125*06f32e7eSjoerg# collaboration graphs will show the relations between templates and their 2126*06f32e7eSjoerg# instances. 2127*06f32e7eSjoerg# The default value is: NO. 2128*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2129*06f32e7eSjoerg 2130*06f32e7eSjoergTEMPLATE_RELATIONS = YES 2131*06f32e7eSjoerg 2132*06f32e7eSjoerg# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2133*06f32e7eSjoerg# YES then doxygen will generate a graph for each documented file showing the 2134*06f32e7eSjoerg# direct and indirect include dependencies of the file with other documented 2135*06f32e7eSjoerg# files. 2136*06f32e7eSjoerg# The default value is: YES. 2137*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2138*06f32e7eSjoerg 2139*06f32e7eSjoergINCLUDE_GRAPH = YES 2140*06f32e7eSjoerg 2141*06f32e7eSjoerg# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2142*06f32e7eSjoerg# set to YES then doxygen will generate a graph for each documented file showing 2143*06f32e7eSjoerg# the direct and indirect include dependencies of the file with other documented 2144*06f32e7eSjoerg# files. 2145*06f32e7eSjoerg# The default value is: YES. 2146*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2147*06f32e7eSjoerg 2148*06f32e7eSjoergINCLUDED_BY_GRAPH = YES 2149*06f32e7eSjoerg 2150*06f32e7eSjoerg# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2151*06f32e7eSjoerg# dependency graph for every global function or class method. 2152*06f32e7eSjoerg# 2153*06f32e7eSjoerg# Note that enabling this option will significantly increase the time of a run. 2154*06f32e7eSjoerg# So in most cases it will be better to enable call graphs for selected 2155*06f32e7eSjoerg# functions only using the \callgraph command. 2156*06f32e7eSjoerg# The default value is: NO. 2157*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2158*06f32e7eSjoerg 2159*06f32e7eSjoergCALL_GRAPH = NO 2160*06f32e7eSjoerg 2161*06f32e7eSjoerg# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2162*06f32e7eSjoerg# dependency graph for every global function or class method. 2163*06f32e7eSjoerg# 2164*06f32e7eSjoerg# Note that enabling this option will significantly increase the time of a run. 2165*06f32e7eSjoerg# So in most cases it will be better to enable caller graphs for selected 2166*06f32e7eSjoerg# functions only using the \callergraph command. 2167*06f32e7eSjoerg# The default value is: NO. 2168*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2169*06f32e7eSjoerg 2170*06f32e7eSjoergCALLER_GRAPH = NO 2171*06f32e7eSjoerg 2172*06f32e7eSjoerg# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2173*06f32e7eSjoerg# hierarchy of all classes instead of a textual one. 2174*06f32e7eSjoerg# The default value is: YES. 2175*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2176*06f32e7eSjoerg 2177*06f32e7eSjoergGRAPHICAL_HIERARCHY = YES 2178*06f32e7eSjoerg 2179*06f32e7eSjoerg# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2180*06f32e7eSjoerg# dependencies a directory has on other directories in a graphical way. The 2181*06f32e7eSjoerg# dependency relations are determined by the #include relations between the 2182*06f32e7eSjoerg# files in the directories. 2183*06f32e7eSjoerg# The default value is: YES. 2184*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2185*06f32e7eSjoerg 2186*06f32e7eSjoergDIRECTORY_GRAPH = YES 2187*06f32e7eSjoerg 2188*06f32e7eSjoerg# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2189*06f32e7eSjoerg# generated by dot. 2190*06f32e7eSjoerg# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2191*06f32e7eSjoerg# to make the SVG files visible in IE 9+ (other browsers do not have this 2192*06f32e7eSjoerg# requirement). 2193*06f32e7eSjoerg# Possible values are: png, jpg, gif and svg. 2194*06f32e7eSjoerg# The default value is: png. 2195*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2196*06f32e7eSjoerg 2197*06f32e7eSjoergDOT_IMAGE_FORMAT = @DOT_IMAGE_FORMAT@ 2198*06f32e7eSjoerg 2199*06f32e7eSjoerg# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2200*06f32e7eSjoerg# enable generation of interactive SVG images that allow zooming and panning. 2201*06f32e7eSjoerg# 2202*06f32e7eSjoerg# Note that this requires a modern browser other than Internet Explorer. Tested 2203*06f32e7eSjoerg# and working are Firefox, Chrome, Safari, and Opera. 2204*06f32e7eSjoerg# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2205*06f32e7eSjoerg# the SVG files visible. Older versions of IE do not have SVG support. 2206*06f32e7eSjoerg# The default value is: NO. 2207*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2208*06f32e7eSjoerg 2209*06f32e7eSjoergINTERACTIVE_SVG = NO 2210*06f32e7eSjoerg 2211*06f32e7eSjoerg# The DOT_PATH tag can be used to specify the path where the dot tool can be 2212*06f32e7eSjoerg# found. If left blank, it is assumed the dot tool can be found in the path. 2213*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2214*06f32e7eSjoerg 2215*06f32e7eSjoergDOT_PATH = @DOT@ 2216*06f32e7eSjoerg 2217*06f32e7eSjoerg# The DOTFILE_DIRS tag can be used to specify one or more directories that 2218*06f32e7eSjoerg# contain dot files that are included in the documentation (see the \dotfile 2219*06f32e7eSjoerg# command). 2220*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2221*06f32e7eSjoerg 2222*06f32e7eSjoergDOTFILE_DIRS = 2223*06f32e7eSjoerg 2224*06f32e7eSjoerg# The MSCFILE_DIRS tag can be used to specify one or more directories that 2225*06f32e7eSjoerg# contain msc files that are included in the documentation (see the \mscfile 2226*06f32e7eSjoerg# command). 2227*06f32e7eSjoerg 2228*06f32e7eSjoergMSCFILE_DIRS = 2229*06f32e7eSjoerg 2230*06f32e7eSjoerg# The DIAFILE_DIRS tag can be used to specify one or more directories that 2231*06f32e7eSjoerg# contain dia files that are included in the documentation (see the \diafile 2232*06f32e7eSjoerg# command). 2233*06f32e7eSjoerg 2234*06f32e7eSjoergDIAFILE_DIRS = 2235*06f32e7eSjoerg 2236*06f32e7eSjoerg# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2237*06f32e7eSjoerg# that will be shown in the graph. If the number of nodes in a graph becomes 2238*06f32e7eSjoerg# larger than this value, doxygen will truncate the graph, which is visualized 2239*06f32e7eSjoerg# by representing a node as a red box. Note that doxygen if the number of direct 2240*06f32e7eSjoerg# children of the root node in a graph is already larger than 2241*06f32e7eSjoerg# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2242*06f32e7eSjoerg# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2243*06f32e7eSjoerg# Minimum value: 0, maximum value: 10000, default value: 50. 2244*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2245*06f32e7eSjoerg 2246*06f32e7eSjoergDOT_GRAPH_MAX_NODES = 50 2247*06f32e7eSjoerg 2248*06f32e7eSjoerg# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2249*06f32e7eSjoerg# generated by dot. A depth value of 3 means that only nodes reachable from the 2250*06f32e7eSjoerg# root by following a path via at most 3 edges will be shown. Nodes that lay 2251*06f32e7eSjoerg# further from the root node will be omitted. Note that setting this option to 1 2252*06f32e7eSjoerg# or 2 may greatly reduce the computation time needed for large code bases. Also 2253*06f32e7eSjoerg# note that the size of a graph can be further restricted by 2254*06f32e7eSjoerg# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2255*06f32e7eSjoerg# Minimum value: 0, maximum value: 1000, default value: 0. 2256*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2257*06f32e7eSjoerg 2258*06f32e7eSjoergMAX_DOT_GRAPH_DEPTH = 0 2259*06f32e7eSjoerg 2260*06f32e7eSjoerg# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2261*06f32e7eSjoerg# background. This is disabled by default, because dot on Windows does not seem 2262*06f32e7eSjoerg# to support this out of the box. 2263*06f32e7eSjoerg# 2264*06f32e7eSjoerg# Warning: Depending on the platform used, enabling this option may lead to 2265*06f32e7eSjoerg# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 2266*06f32e7eSjoerg# read). 2267*06f32e7eSjoerg# The default value is: NO. 2268*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2269*06f32e7eSjoerg 2270*06f32e7eSjoergDOT_TRANSPARENT = YES 2271*06f32e7eSjoerg 2272*06f32e7eSjoerg# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 2273*06f32e7eSjoerg# files in one run (i.e. multiple -o and -T options on the command line). This 2274*06f32e7eSjoerg# makes dot run faster, but since only newer versions of dot (>1.8.10) support 2275*06f32e7eSjoerg# this, this feature is disabled by default. 2276*06f32e7eSjoerg# The default value is: NO. 2277*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2278*06f32e7eSjoerg 2279*06f32e7eSjoergDOT_MULTI_TARGETS = YES 2280*06f32e7eSjoerg 2281*06f32e7eSjoerg# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2282*06f32e7eSjoerg# explaining the meaning of the various boxes and arrows in the dot generated 2283*06f32e7eSjoerg# graphs. 2284*06f32e7eSjoerg# The default value is: YES. 2285*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2286*06f32e7eSjoerg 2287*06f32e7eSjoergGENERATE_LEGEND = YES 2288*06f32e7eSjoerg 2289*06f32e7eSjoerg# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot 2290*06f32e7eSjoerg# files that are used to generate the various graphs. 2291*06f32e7eSjoerg# The default value is: YES. 2292*06f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 2293*06f32e7eSjoerg 2294*06f32e7eSjoergDOT_CLEANUP = YES 2295