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