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