1246854Sdes# Doxyfile 1.7.6.1 2238104Sdes 3238104Sdes# This file describes the settings to be used by the documentation system 4238104Sdes# doxygen (www.doxygen.org) for a project. 5238104Sdes# 6238104Sdes# All text after a hash (#) is considered a comment and will be ignored. 7238104Sdes# The format is: 8238104Sdes# TAG = value [value, ...] 9238104Sdes# For lists items can also be appended using: 10238104Sdes# TAG += value [value, ...] 11238104Sdes# Values that contain spaces should be placed between quotes (" "). 12238104Sdes 13238104Sdes#--------------------------------------------------------------------------- 14238104Sdes# Project related configuration options 15238104Sdes#--------------------------------------------------------------------------- 16238104Sdes 17238104Sdes# This tag specifies the encoding used for all characters in the config file 18238104Sdes# that follow. The default is UTF-8 which is also the encoding used for all 19238104Sdes# text before the first occurrence of this tag. Doxygen uses libiconv (or the 20238104Sdes# iconv built into libc) for the transcoding. See 21238104Sdes# http://www.gnu.org/software/libiconv for the list of possible encodings. 22238104Sdes 23238104SdesDOXYFILE_ENCODING = UTF-8 24238104Sdes 25246854Sdes# The PROJECT_NAME tag is a single word (or sequence of words) that should 26246854Sdes# identify the project. Note that if you do not use Doxywizard you need 27246854Sdes# to put quotes around the project name if it contains spaces. 28238104Sdes 29238104SdesPROJECT_NAME = ldns 30238104Sdes 31238104Sdes# The PROJECT_NUMBER tag can be used to enter a project or revision number. 32238104Sdes# This could be handy for archiving the generated documentation or 33238104Sdes# if some version control system is used. 34238104Sdes 35238104SdesPROJECT_NUMBER = 1.6.7 36238104Sdes 37246854Sdes# Using the PROJECT_BRIEF tag one can provide an optional one line description 38246854Sdes# for a project that appears at the top of each page and should give viewer 39246854Sdes# a quick idea about the purpose of the project. Keep the description short. 40238104Sdes 41238104SdesPROJECT_BRIEF = 42238104Sdes 43238104Sdes# With the PROJECT_LOGO tag one can specify an logo or icon that is 44238104Sdes# included in the documentation. The maximum height of the logo should not 45238104Sdes# exceed 55 pixels and the maximum width should not exceed 200 pixels. 46238104Sdes# Doxygen will copy the logo to the output directory. 47238104Sdes 48238104SdesPROJECT_LOGO = 49238104Sdes 50238104Sdes# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 51238104Sdes# base path where the generated documentation will be put. 52238104Sdes# If a relative path is entered, it will be relative to the location 53238104Sdes# where doxygen was started. If left blank the current directory will be used. 54238104Sdes 55238104SdesOUTPUT_DIRECTORY = doc/ 56238104Sdes 57238104Sdes# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 58238104Sdes# 4096 sub-directories (in 2 levels) under the output directory of each output 59238104Sdes# format and will distribute the generated files over these directories. 60238104Sdes# Enabling this option can be useful when feeding doxygen a huge amount of 61238104Sdes# source files, where putting all generated files in the same directory would 62238104Sdes# otherwise cause performance problems for the file system. 63238104Sdes 64238104SdesCREATE_SUBDIRS = NO 65238104Sdes 66238104Sdes# The OUTPUT_LANGUAGE tag is used to specify the language in which all 67238104Sdes# documentation generated by doxygen is written. Doxygen will use this 68238104Sdes# information to generate all constant output in the proper language. 69238104Sdes# The default language is English, other supported languages are: 70238104Sdes# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 71238104Sdes# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 72238104Sdes# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 73238104Sdes# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 74238104Sdes# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 75238104Sdes# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 76238104Sdes 77238104SdesOUTPUT_LANGUAGE = English 78238104Sdes 79238104Sdes# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 80238104Sdes# include brief member descriptions after the members that are listed in 81238104Sdes# the file and class documentation (similar to JavaDoc). 82238104Sdes# Set to NO to disable this. 83238104Sdes 84238104SdesBRIEF_MEMBER_DESC = YES 85238104Sdes 86238104Sdes# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 87238104Sdes# the brief description of a member or function before the detailed description. 88238104Sdes# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 89238104Sdes# brief descriptions will be completely suppressed. 90238104Sdes 91238104SdesREPEAT_BRIEF = YES 92238104Sdes 93238104Sdes# This tag implements a quasi-intelligent brief description abbreviator 94238104Sdes# that is used to form the text in various listings. Each string 95238104Sdes# in this list, if found as the leading text of the brief description, will be 96238104Sdes# stripped from the text and the result after processing the whole list, is 97238104Sdes# used as the annotated text. Otherwise, the brief description is used as-is. 98238104Sdes# If left blank, the following values are used ("$name" is automatically 99238104Sdes# replaced with the name of the entity): "The $name class" "The $name widget" 100238104Sdes# "The $name file" "is" "provides" "specifies" "contains" 101238104Sdes# "represents" "a" "an" "the" 102238104Sdes 103238104SdesABBREVIATE_BRIEF = 104238104Sdes 105238104Sdes# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 106238104Sdes# Doxygen will generate a detailed section even if there is only a brief 107238104Sdes# description. 108238104Sdes 109238104SdesALWAYS_DETAILED_SEC = NO 110238104Sdes 111238104Sdes# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 112238104Sdes# inherited members of a class in the documentation of that class as if those 113238104Sdes# members were ordinary class members. Constructors, destructors and assignment 114238104Sdes# operators of the base classes will not be shown. 115238104Sdes 116238104SdesINLINE_INHERITED_MEMB = NO 117238104Sdes 118238104Sdes# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 119238104Sdes# path before files name in the file list and in the header files. If set 120238104Sdes# to NO the shortest path that makes the file name unique will be used. 121238104Sdes 122238104SdesFULL_PATH_NAMES = YES 123238104Sdes 124238104Sdes# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 125238104Sdes# can be used to strip a user-defined part of the path. Stripping is 126238104Sdes# only done if one of the specified strings matches the left-hand part of 127238104Sdes# the path. The tag can be used to show relative paths in the file list. 128238104Sdes# If left blank the directory from which doxygen is run is used as the 129238104Sdes# path to strip. 130238104Sdes 131238104SdesSTRIP_FROM_PATH = 132238104Sdes 133238104Sdes# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 134238104Sdes# the path mentioned in the documentation of a class, which tells 135238104Sdes# the reader which header file to include in order to use a class. 136238104Sdes# If left blank only the name of the header file containing the class 137238104Sdes# definition is used. Otherwise one should specify the include paths that 138238104Sdes# are normally passed to the compiler using the -I flag. 139238104Sdes 140238104SdesSTRIP_FROM_INC_PATH = 141238104Sdes 142238104Sdes# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 143238104Sdes# (but less readable) file names. This can be useful if your file system 144238104Sdes# doesn't support long names like on DOS, Mac, or CD-ROM. 145238104Sdes 146238104SdesSHORT_NAMES = NO 147238104Sdes 148238104Sdes# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 149238104Sdes# will interpret the first line (until the first dot) of a JavaDoc-style 150238104Sdes# comment as the brief description. If set to NO, the JavaDoc 151238104Sdes# comments will behave just like regular Qt-style comments 152238104Sdes# (thus requiring an explicit @brief command for a brief description.) 153238104Sdes 154238104SdesJAVADOC_AUTOBRIEF = YES 155238104Sdes 156238104Sdes# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 157238104Sdes# interpret the first line (until the first dot) of a Qt-style 158238104Sdes# comment as the brief description. If set to NO, the comments 159238104Sdes# will behave just like regular Qt-style comments (thus requiring 160238104Sdes# an explicit \brief command for a brief description.) 161238104Sdes 162238104SdesQT_AUTOBRIEF = NO 163238104Sdes 164238104Sdes# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 165238104Sdes# treat a multi-line C++ special comment block (i.e. a block of //! or /// 166238104Sdes# comments) as a brief description. This used to be the default behaviour. 167238104Sdes# The new default is to treat a multi-line C++ comment block as a detailed 168238104Sdes# description. Set this tag to YES if you prefer the old behaviour instead. 169238104Sdes 170238104SdesMULTILINE_CPP_IS_BRIEF = NO 171238104Sdes 172238104Sdes# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 173238104Sdes# member inherits the documentation from any documented member that it 174238104Sdes# re-implements. 175238104Sdes 176238104SdesINHERIT_DOCS = YES 177238104Sdes 178238104Sdes# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 179238104Sdes# a new page for each member. If set to NO, the documentation of a member will 180238104Sdes# be part of the file/class/namespace that contains it. 181238104Sdes 182238104SdesSEPARATE_MEMBER_PAGES = NO 183238104Sdes 184238104Sdes# The TAB_SIZE tag can be used to set the number of spaces in a tab. 185238104Sdes# Doxygen uses this value to replace tabs by spaces in code fragments. 186238104Sdes 187238104SdesTAB_SIZE = 8 188238104Sdes 189238104Sdes# This tag can be used to specify a number of aliases that acts 190238104Sdes# as commands in the documentation. An alias has the form "name=value". 191238104Sdes# For example adding "sideeffect=\par Side Effects:\n" will allow you to 192238104Sdes# put the command \sideeffect (or @sideeffect) in the documentation, which 193238104Sdes# will result in a user-defined paragraph with heading "Side Effects:". 194238104Sdes# You can put \n's in the value part of an alias to insert newlines. 195238104Sdes 196238104SdesALIASES = 197238104Sdes 198246854Sdes# This tag can be used to specify a number of word-keyword mappings (TCL only). 199246854Sdes# A mapping has the form "name=value". For example adding 200246854Sdes# "class=itcl::class" will allow you to use the command class in the 201246854Sdes# itcl::class meaning. 202246854Sdes 203246854SdesTCL_SUBST = 204246854Sdes 205238104Sdes# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 206238104Sdes# sources only. Doxygen will then generate output that is more tailored for C. 207238104Sdes# For instance, some of the names that are used will be different. The list 208238104Sdes# of all members will be omitted, etc. 209238104Sdes 210238104SdesOPTIMIZE_OUTPUT_FOR_C = YES 211238104Sdes 212238104Sdes# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 213238104Sdes# sources only. Doxygen will then generate output that is more tailored for 214238104Sdes# Java. For instance, namespaces will be presented as packages, qualified 215238104Sdes# scopes will look different, etc. 216238104Sdes 217238104SdesOPTIMIZE_OUTPUT_JAVA = NO 218238104Sdes 219238104Sdes# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 220238104Sdes# sources only. Doxygen will then generate output that is more tailored for 221238104Sdes# Fortran. 222238104Sdes 223238104SdesOPTIMIZE_FOR_FORTRAN = NO 224238104Sdes 225238104Sdes# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 226238104Sdes# sources. Doxygen will then generate output that is tailored for 227238104Sdes# VHDL. 228238104Sdes 229238104SdesOPTIMIZE_OUTPUT_VHDL = NO 230238104Sdes 231238104Sdes# Doxygen selects the parser to use depending on the extension of the files it 232238104Sdes# parses. With this tag you can assign which parser to use for a given extension. 233238104Sdes# Doxygen has a built-in mapping, but you can override or extend it using this 234238104Sdes# tag. The format is ext=language, where ext is a file extension, and language 235238104Sdes# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 236238104Sdes# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 237238104Sdes# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 238238104Sdes# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 239238104Sdes# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 240238104Sdes 241238104SdesEXTENSION_MAPPING = 242238104Sdes 243238104Sdes# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 244238104Sdes# to include (a tag file for) the STL sources as input, then you should 245238104Sdes# set this tag to YES in order to let doxygen match functions declarations and 246238104Sdes# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 247238104Sdes# func(std::string) {}). This also makes the inheritance and collaboration 248238104Sdes# diagrams that involve STL classes more complete and accurate. 249238104Sdes 250238104SdesBUILTIN_STL_SUPPORT = NO 251238104Sdes 252238104Sdes# If you use Microsoft's C++/CLI language, you should set this option to YES to 253238104Sdes# enable parsing support. 254238104Sdes 255238104SdesCPP_CLI_SUPPORT = NO 256238104Sdes 257238104Sdes# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 258238104Sdes# Doxygen will parse them like normal C++ but will assume all classes use public 259238104Sdes# instead of private inheritance when no explicit protection keyword is present. 260238104Sdes 261238104SdesSIP_SUPPORT = NO 262238104Sdes 263238104Sdes# For Microsoft's IDL there are propget and propput attributes to indicate getter 264238104Sdes# and setter methods for a property. Setting this option to YES (the default) 265238104Sdes# will make doxygen replace the get and set methods by a property in the 266238104Sdes# documentation. This will only work if the methods are indeed getting or 267238104Sdes# setting a simple type. If this is not the case, or you want to show the 268238104Sdes# methods anyway, you should set this option to NO. 269238104Sdes 270238104SdesIDL_PROPERTY_SUPPORT = YES 271238104Sdes 272238104Sdes# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 273238104Sdes# tag is set to YES, then doxygen will reuse the documentation of the first 274238104Sdes# member in the group (if any) for the other members of the group. By default 275238104Sdes# all members of a group must be documented explicitly. 276238104Sdes 277238104SdesDISTRIBUTE_GROUP_DOC = NO 278238104Sdes 279238104Sdes# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 280238104Sdes# the same type (for instance a group of public functions) to be put as a 281238104Sdes# subgroup of that type (e.g. under the Public Functions section). Set it to 282238104Sdes# NO to prevent subgrouping. Alternatively, this can be done per class using 283238104Sdes# the \nosubgrouping command. 284238104Sdes 285238104SdesSUBGROUPING = YES 286238104Sdes 287246854Sdes# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 288246854Sdes# unions are shown inside the group in which they are included (e.g. using 289246854Sdes# @ingroup) instead of on a separate page (for HTML and Man pages) or 290246854Sdes# section (for LaTeX and RTF). 291246854Sdes 292246854SdesINLINE_GROUPED_CLASSES = NO 293246854Sdes 294246854Sdes# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 295246854Sdes# unions with only public data fields will be shown inline in the documentation 296246854Sdes# of the scope in which they are defined (i.e. file, namespace, or group 297246854Sdes# documentation), provided this scope is documented. If set to NO (the default), 298246854Sdes# structs, classes, and unions are shown on a separate page (for HTML and Man 299246854Sdes# pages) or section (for LaTeX and RTF). 300246854Sdes 301246854SdesINLINE_SIMPLE_STRUCTS = NO 302246854Sdes 303238104Sdes# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 304238104Sdes# is documented as struct, union, or enum with the name of the typedef. So 305238104Sdes# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 306238104Sdes# with name TypeT. When disabled the typedef will appear as a member of a file, 307238104Sdes# namespace, or class. And the struct will be named TypeS. This can typically 308238104Sdes# be useful for C code in case the coding convention dictates that all compound 309238104Sdes# types are typedef'ed and only the typedef is referenced, never the tag name. 310238104Sdes 311238104SdesTYPEDEF_HIDES_STRUCT = NO 312238104Sdes 313238104Sdes# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 314238104Sdes# determine which symbols to keep in memory and which to flush to disk. 315238104Sdes# When the cache is full, less often used symbols will be written to disk. 316238104Sdes# For small to medium size projects (<1000 input files) the default value is 317238104Sdes# probably good enough. For larger projects a too small cache size can cause 318238104Sdes# doxygen to be busy swapping symbols to and from disk most of the time 319238104Sdes# causing a significant performance penalty. 320238104Sdes# If the system has enough physical memory increasing the cache will improve the 321238104Sdes# performance by keeping more symbols in memory. Note that the value works on 322238104Sdes# a logarithmic scale so increasing the size by one will roughly double the 323238104Sdes# memory usage. The cache size is given by this formula: 324238104Sdes# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 325246854Sdes# corresponding to a cache size of 2^16 = 65536 symbols. 326238104Sdes 327238104SdesSYMBOL_CACHE_SIZE = 0 328238104Sdes 329246854Sdes# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 330246854Sdes# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 331246854Sdes# their name and scope. Since this can be an expensive process and often the 332246854Sdes# same symbol appear multiple times in the code, doxygen keeps a cache of 333246854Sdes# pre-resolved symbols. If the cache is too small doxygen will become slower. 334246854Sdes# If the cache is too large, memory is wasted. The cache size is given by this 335246854Sdes# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 336246854Sdes# corresponding to a cache size of 2^16 = 65536 symbols. 337246854Sdes 338246854SdesLOOKUP_CACHE_SIZE = 0 339246854Sdes 340238104Sdes#--------------------------------------------------------------------------- 341238104Sdes# Build related configuration options 342238104Sdes#--------------------------------------------------------------------------- 343238104Sdes 344238104Sdes# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 345238104Sdes# documentation are documented, even if no documentation was available. 346238104Sdes# Private class members and static file members will be hidden unless 347238104Sdes# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 348238104Sdes 349238104SdesEXTRACT_ALL = YES 350238104Sdes 351238104Sdes# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 352238104Sdes# will be included in the documentation. 353238104Sdes 354238104SdesEXTRACT_PRIVATE = NO 355238104Sdes 356238104Sdes# If the EXTRACT_STATIC tag is set to YES all static members of a file 357238104Sdes# will be included in the documentation. 358238104Sdes 359238104SdesEXTRACT_STATIC = NO 360238104Sdes 361238104Sdes# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 362238104Sdes# defined locally in source files will be included in the documentation. 363238104Sdes# If set to NO only classes defined in header files are included. 364238104Sdes 365238104SdesEXTRACT_LOCAL_CLASSES = YES 366238104Sdes 367238104Sdes# This flag is only useful for Objective-C code. When set to YES local 368238104Sdes# methods, which are defined in the implementation section but not in 369238104Sdes# the interface are included in the documentation. 370238104Sdes# If set to NO (the default) only methods in the interface are included. 371238104Sdes 372238104SdesEXTRACT_LOCAL_METHODS = NO 373238104Sdes 374238104Sdes# If this flag is set to YES, the members of anonymous namespaces will be 375238104Sdes# extracted and appear in the documentation as a namespace called 376238104Sdes# 'anonymous_namespace{file}', where file will be replaced with the base 377238104Sdes# name of the file that contains the anonymous namespace. By default 378238104Sdes# anonymous namespaces are hidden. 379238104Sdes 380238104SdesEXTRACT_ANON_NSPACES = NO 381238104Sdes 382238104Sdes# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 383238104Sdes# undocumented members of documented classes, files or namespaces. 384238104Sdes# If set to NO (the default) these members will be included in the 385238104Sdes# various overviews, but no documentation section is generated. 386238104Sdes# This option has no effect if EXTRACT_ALL is enabled. 387238104Sdes 388238104SdesHIDE_UNDOC_MEMBERS = NO 389238104Sdes 390238104Sdes# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 391238104Sdes# undocumented classes that are normally visible in the class hierarchy. 392238104Sdes# If set to NO (the default) these classes will be included in the various 393238104Sdes# overviews. This option has no effect if EXTRACT_ALL is enabled. 394238104Sdes 395238104SdesHIDE_UNDOC_CLASSES = NO 396238104Sdes 397238104Sdes# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 398238104Sdes# friend (class|struct|union) declarations. 399238104Sdes# If set to NO (the default) these declarations will be included in the 400238104Sdes# documentation. 401238104Sdes 402238104SdesHIDE_FRIEND_COMPOUNDS = NO 403238104Sdes 404238104Sdes# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 405238104Sdes# documentation blocks found inside the body of a function. 406238104Sdes# If set to NO (the default) these blocks will be appended to the 407238104Sdes# function's detailed documentation block. 408238104Sdes 409238104SdesHIDE_IN_BODY_DOCS = NO 410238104Sdes 411238104Sdes# The INTERNAL_DOCS tag determines if documentation 412238104Sdes# that is typed after a \internal command is included. If the tag is set 413238104Sdes# to NO (the default) then the documentation will be excluded. 414238104Sdes# Set it to YES to include the internal documentation. 415238104Sdes 416238104SdesINTERNAL_DOCS = NO 417238104Sdes 418238104Sdes# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 419238104Sdes# file names in lower-case letters. If set to YES upper-case letters are also 420238104Sdes# allowed. This is useful if you have classes or files whose names only differ 421238104Sdes# in case and if your file system supports case sensitive file names. Windows 422238104Sdes# and Mac users are advised to set this option to NO. 423238104Sdes 424238104SdesCASE_SENSE_NAMES = YES 425238104Sdes 426238104Sdes# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 427238104Sdes# will show members with their full class and namespace scopes in the 428238104Sdes# documentation. If set to YES the scope will be hidden. 429238104Sdes 430238104SdesHIDE_SCOPE_NAMES = NO 431238104Sdes 432238104Sdes# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 433238104Sdes# will put a list of the files that are included by a file in the documentation 434238104Sdes# of that file. 435238104Sdes 436238104SdesSHOW_INCLUDE_FILES = NO 437238104Sdes 438238104Sdes# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 439238104Sdes# will list include files with double quotes in the documentation 440238104Sdes# rather than with sharp brackets. 441238104Sdes 442238104SdesFORCE_LOCAL_INCLUDES = NO 443238104Sdes 444238104Sdes# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 445238104Sdes# is inserted in the documentation for inline members. 446238104Sdes 447238104SdesINLINE_INFO = YES 448238104Sdes 449238104Sdes# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 450238104Sdes# will sort the (detailed) documentation of file and class members 451238104Sdes# alphabetically by member name. If set to NO the members will appear in 452238104Sdes# declaration order. 453238104Sdes 454238104SdesSORT_MEMBER_DOCS = NO 455238104Sdes 456238104Sdes# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 457238104Sdes# brief documentation of file, namespace and class members alphabetically 458238104Sdes# by member name. If set to NO (the default) the members will appear in 459238104Sdes# declaration order. 460238104Sdes 461238104SdesSORT_BRIEF_DOCS = NO 462238104Sdes 463238104Sdes# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 464238104Sdes# will sort the (brief and detailed) documentation of class members so that 465238104Sdes# constructors and destructors are listed first. If set to NO (the default) 466238104Sdes# the constructors will appear in the respective orders defined by 467238104Sdes# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 468238104Sdes# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 469238104Sdes# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 470238104Sdes 471238104SdesSORT_MEMBERS_CTORS_1ST = NO 472238104Sdes 473238104Sdes# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 474238104Sdes# hierarchy of group names into alphabetical order. If set to NO (the default) 475238104Sdes# the group names will appear in their defined order. 476238104Sdes 477238104SdesSORT_GROUP_NAMES = NO 478238104Sdes 479238104Sdes# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 480238104Sdes# sorted by fully-qualified names, including namespaces. If set to 481238104Sdes# NO (the default), the class list will be sorted only by class name, 482238104Sdes# not including the namespace part. 483238104Sdes# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 484238104Sdes# Note: This option applies only to the class list, not to the 485238104Sdes# alphabetical list. 486238104Sdes 487238104SdesSORT_BY_SCOPE_NAME = NO 488238104Sdes 489246854Sdes# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 490246854Sdes# do proper type resolution of all parameters of a function it will reject a 491246854Sdes# match between the prototype and the implementation of a member function even 492246854Sdes# if there is only one candidate or it is obvious which candidate to choose 493246854Sdes# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 494238104Sdes# will still accept a match between prototype and implementation in such cases. 495238104Sdes 496238104SdesSTRICT_PROTO_MATCHING = NO 497238104Sdes 498238104Sdes# The GENERATE_TODOLIST tag can be used to enable (YES) or 499238104Sdes# disable (NO) the todo list. This list is created by putting \todo 500238104Sdes# commands in the documentation. 501238104Sdes 502238104SdesGENERATE_TODOLIST = YES 503238104Sdes 504238104Sdes# The GENERATE_TESTLIST tag can be used to enable (YES) or 505238104Sdes# disable (NO) the test list. This list is created by putting \test 506238104Sdes# commands in the documentation. 507238104Sdes 508238104SdesGENERATE_TESTLIST = YES 509238104Sdes 510238104Sdes# The GENERATE_BUGLIST tag can be used to enable (YES) or 511238104Sdes# disable (NO) the bug list. This list is created by putting \bug 512238104Sdes# commands in the documentation. 513238104Sdes 514238104SdesGENERATE_BUGLIST = YES 515238104Sdes 516238104Sdes# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 517238104Sdes# disable (NO) the deprecated list. This list is created by putting 518238104Sdes# \deprecated commands in the documentation. 519238104Sdes 520238104SdesGENERATE_DEPRECATEDLIST= YES 521238104Sdes 522238104Sdes# The ENABLED_SECTIONS tag can be used to enable conditional 523238104Sdes# documentation sections, marked by \if sectionname ... \endif. 524238104Sdes 525238104SdesENABLED_SECTIONS = 526238104Sdes 527238104Sdes# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 528238104Sdes# the initial value of a variable or macro consists of for it to appear in 529238104Sdes# the documentation. If the initializer consists of more lines than specified 530238104Sdes# here it will be hidden. Use a value of 0 to hide initializers completely. 531238104Sdes# The appearance of the initializer of individual variables and macros in the 532238104Sdes# documentation can be controlled using \showinitializer or \hideinitializer 533238104Sdes# command in the documentation regardless of this setting. 534238104Sdes 535238104SdesMAX_INITIALIZER_LINES = 30 536238104Sdes 537238104Sdes# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 538238104Sdes# at the bottom of the documentation of classes and structs. If set to YES the 539238104Sdes# list will mention the files that were used to generate the documentation. 540238104Sdes 541238104SdesSHOW_USED_FILES = NO 542238104Sdes 543238104Sdes# If the sources in your project are distributed over multiple directories 544238104Sdes# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 545238104Sdes# in the documentation. The default is NO. 546238104Sdes 547238104SdesSHOW_DIRECTORIES = YES 548238104Sdes 549238104Sdes# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 550238104Sdes# This will remove the Files entry from the Quick Index and from the 551238104Sdes# Folder Tree View (if specified). The default is YES. 552238104Sdes 553238104SdesSHOW_FILES = YES 554238104Sdes 555238104Sdes# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 556238104Sdes# Namespaces page. 557238104Sdes# This will remove the Namespaces entry from the Quick Index 558238104Sdes# and from the Folder Tree View (if specified). The default is YES. 559238104Sdes 560238104SdesSHOW_NAMESPACES = YES 561238104Sdes 562238104Sdes# The FILE_VERSION_FILTER tag can be used to specify a program or script that 563238104Sdes# doxygen should invoke to get the current version for each file (typically from 564238104Sdes# the version control system). Doxygen will invoke the program by executing (via 565238104Sdes# popen()) the command <command> <input-file>, where <command> is the value of 566238104Sdes# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 567238104Sdes# provided by doxygen. Whatever the program writes to standard output 568238104Sdes# is used as the file version. See the manual for examples. 569238104Sdes 570238104SdesFILE_VERSION_FILTER = 571238104Sdes 572238104Sdes# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 573238104Sdes# by doxygen. The layout file controls the global structure of the generated 574238104Sdes# output files in an output format independent way. The create the layout file 575238104Sdes# that represents doxygen's defaults, run doxygen with the -l option. 576238104Sdes# You can optionally specify a file name after the option, if omitted 577238104Sdes# DoxygenLayout.xml will be used as the name of the layout file. 578238104Sdes 579238104SdesLAYOUT_FILE = 580238104Sdes 581246854Sdes# The CITE_BIB_FILES tag can be used to specify one or more bib files 582246854Sdes# containing the references data. This must be a list of .bib files. The 583246854Sdes# .bib extension is automatically appended if omitted. Using this command 584246854Sdes# requires the bibtex tool to be installed. See also 585246854Sdes# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 586246854Sdes# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 587246854Sdes# feature you need bibtex and perl available in the search path. 588246854Sdes 589246854SdesCITE_BIB_FILES = 590246854Sdes 591238104Sdes#--------------------------------------------------------------------------- 592238104Sdes# configuration options related to warning and progress messages 593238104Sdes#--------------------------------------------------------------------------- 594238104Sdes 595238104Sdes# The QUIET tag can be used to turn on/off the messages that are generated 596238104Sdes# by doxygen. Possible values are YES and NO. If left blank NO is used. 597238104Sdes 598238104SdesQUIET = YES 599238104Sdes 600238104Sdes# The WARNINGS tag can be used to turn on/off the warning messages that are 601238104Sdes# generated by doxygen. Possible values are YES and NO. If left blank 602238104Sdes# NO is used. 603238104Sdes 604238104SdesWARNINGS = YES 605238104Sdes 606238104Sdes# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 607238104Sdes# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 608238104Sdes# automatically be disabled. 609238104Sdes 610238104SdesWARN_IF_UNDOCUMENTED = YES 611238104Sdes 612238104Sdes# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 613238104Sdes# potential errors in the documentation, such as not documenting some 614238104Sdes# parameters in a documented function, or documenting parameters that 615238104Sdes# don't exist or using markup commands wrongly. 616238104Sdes 617238104SdesWARN_IF_DOC_ERROR = YES 618238104Sdes 619238104Sdes# The WARN_NO_PARAMDOC option can be enabled to get warnings for 620238104Sdes# functions that are documented, but have no documentation for their parameters 621238104Sdes# or return value. If set to NO (the default) doxygen will only warn about 622238104Sdes# wrong or incomplete parameter documentation, but not about the absence of 623238104Sdes# documentation. 624238104Sdes 625238104SdesWARN_NO_PARAMDOC = NO 626238104Sdes 627238104Sdes# The WARN_FORMAT tag determines the format of the warning messages that 628238104Sdes# doxygen can produce. The string should contain the $file, $line, and $text 629238104Sdes# tags, which will be replaced by the file and line number from which the 630238104Sdes# warning originated and the warning text. Optionally the format may contain 631238104Sdes# $version, which will be replaced by the version of the file (if it could 632238104Sdes# be obtained via FILE_VERSION_FILTER) 633238104Sdes 634238104SdesWARN_FORMAT = "doxygen: $file:$line: $text" 635238104Sdes 636238104Sdes# The WARN_LOGFILE tag can be used to specify a file to which warning 637238104Sdes# and error messages should be written. If left blank the output is written 638238104Sdes# to stderr. 639238104Sdes 640238104SdesWARN_LOGFILE = 641238104Sdes 642238104Sdes#--------------------------------------------------------------------------- 643238104Sdes# configuration options related to the input files 644238104Sdes#--------------------------------------------------------------------------- 645238104Sdes 646238104Sdes# The INPUT tag can be used to specify the files and/or directories that contain 647238104Sdes# documented source files. You may enter file names like "myfile.cpp" or 648238104Sdes# directories like "/usr/src/myproject". Separate the files or directories 649238104Sdes# with spaces. 650238104Sdes 651238104SdesINPUT = . \ 652238104Sdes ldns/ \ 653238104Sdes doc/ \ 654238104Sdes examples/ldns-mx.c \ 655238104Sdes examples/ldns-read-zone.c \ 656238104Sdes examples/ldns-signzone.c 657238104Sdes 658238104Sdes# This tag can be used to specify the character encoding of the source files 659238104Sdes# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 660238104Sdes# also the default input encoding. Doxygen uses libiconv (or the iconv built 661238104Sdes# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 662238104Sdes# the list of possible encodings. 663238104Sdes 664238104SdesINPUT_ENCODING = UTF-8 665238104Sdes 666238104Sdes# If the value of the INPUT tag contains directories, you can use the 667238104Sdes# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 668238104Sdes# and *.h) to filter out the source-files in the directories. If left 669238104Sdes# blank the following patterns are tested: 670238104Sdes# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 671238104Sdes# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 672238104Sdes# *.f90 *.f *.for *.vhd *.vhdl 673238104Sdes 674238104SdesFILE_PATTERNS = 675238104Sdes 676238104Sdes# The RECURSIVE tag can be used to turn specify whether or not subdirectories 677238104Sdes# should be searched for input files as well. Possible values are YES and NO. 678238104Sdes# If left blank NO is used. 679238104Sdes 680238104SdesRECURSIVE = NO 681238104Sdes 682246854Sdes# The EXCLUDE tag can be used to specify files and/or directories that should be 683238104Sdes# excluded from the INPUT source files. This way you can easily exclude a 684238104Sdes# subdirectory from a directory tree whose root is specified with the INPUT tag. 685246854Sdes# Note that relative paths are relative to the directory from which doxygen is 686246854Sdes# run. 687238104Sdes 688238104SdesEXCLUDE = 689238104Sdes 690246854Sdes# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 691238104Sdes# directories that are symbolic links (a Unix file system feature) are excluded 692238104Sdes# from the input. 693238104Sdes 694238104SdesEXCLUDE_SYMLINKS = NO 695238104Sdes 696238104Sdes# If the value of the INPUT tag contains directories, you can use the 697238104Sdes# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 698238104Sdes# certain files from those directories. Note that the wildcards are matched 699238104Sdes# against the file with absolute path, so to exclude all test directories 700238104Sdes# for example use the pattern */test/* 701238104Sdes 702238104SdesEXCLUDE_PATTERNS = 703238104Sdes 704238104Sdes# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 705238104Sdes# (namespaces, classes, functions, etc.) that should be excluded from the 706238104Sdes# output. The symbol name can be a fully qualified name, a word, or if the 707238104Sdes# wildcard * is used, a substring. Examples: ANamespace, AClass, 708238104Sdes# AClass::ANamespace, ANamespace::*Test 709238104Sdes 710238104SdesEXCLUDE_SYMBOLS = 711238104Sdes 712238104Sdes# The EXAMPLE_PATH tag can be used to specify one or more files or 713238104Sdes# directories that contain example code fragments that are included (see 714238104Sdes# the \include command). 715238104Sdes 716238104SdesEXAMPLE_PATH = examples 717238104Sdes 718238104Sdes# If the value of the EXAMPLE_PATH tag contains directories, you can use the 719238104Sdes# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 720238104Sdes# and *.h) to filter out the source-files in the directories. If left 721238104Sdes# blank all files are included. 722238104Sdes 723238104SdesEXAMPLE_PATTERNS = 724238104Sdes 725238104Sdes# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 726238104Sdes# searched for input files to be used with the \include or \dontinclude 727238104Sdes# commands irrespective of the value of the RECURSIVE tag. 728238104Sdes# Possible values are YES and NO. If left blank NO is used. 729238104Sdes 730238104SdesEXAMPLE_RECURSIVE = NO 731238104Sdes 732238104Sdes# The IMAGE_PATH tag can be used to specify one or more files or 733238104Sdes# directories that contain image that are included in the documentation (see 734238104Sdes# the \image command). 735238104Sdes 736238104SdesIMAGE_PATH = doc/images 737238104Sdes 738238104Sdes# The INPUT_FILTER tag can be used to specify a program that doxygen should 739238104Sdes# invoke to filter for each input file. Doxygen will invoke the filter program 740238104Sdes# by executing (via popen()) the command <filter> <input-file>, where <filter> 741238104Sdes# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 742238104Sdes# input file. Doxygen will then use the output that the filter program writes 743238104Sdes# to standard output. 744238104Sdes# If FILTER_PATTERNS is specified, this tag will be 745238104Sdes# ignored. 746238104Sdes 747238104SdesINPUT_FILTER = 748238104Sdes 749238104Sdes# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 750238104Sdes# basis. 751238104Sdes# Doxygen will compare the file name with each pattern and apply the 752238104Sdes# filter if there is a match. 753238104Sdes# The filters are a list of the form: 754238104Sdes# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 755238104Sdes# info on how filters are used. If FILTER_PATTERNS is empty or if 756238104Sdes# non of the patterns match the file name, INPUT_FILTER is applied. 757238104Sdes 758238104SdesFILTER_PATTERNS = 759238104Sdes 760238104Sdes# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 761238104Sdes# INPUT_FILTER) will be used to filter the input files when producing source 762238104Sdes# files to browse (i.e. when SOURCE_BROWSER is set to YES). 763238104Sdes 764238104SdesFILTER_SOURCE_FILES = NO 765238104Sdes 766238104Sdes# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 767238104Sdes# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 768238104Sdes# and it is also possible to disable source filtering for a specific pattern 769238104Sdes# using *.ext= (so without naming a filter). This option only has effect when 770238104Sdes# FILTER_SOURCE_FILES is enabled. 771238104Sdes 772238104SdesFILTER_SOURCE_PATTERNS = 773238104Sdes 774238104Sdes#--------------------------------------------------------------------------- 775238104Sdes# configuration options related to source browsing 776238104Sdes#--------------------------------------------------------------------------- 777238104Sdes 778238104Sdes# If the SOURCE_BROWSER tag is set to YES then a list of source files will 779238104Sdes# be generated. Documented entities will be cross-referenced with these sources. 780238104Sdes# Note: To get rid of all source code in the generated output, make sure also 781238104Sdes# VERBATIM_HEADERS is set to NO. 782238104Sdes 783238104SdesSOURCE_BROWSER = YES 784238104Sdes 785238104Sdes# Setting the INLINE_SOURCES tag to YES will include the body 786238104Sdes# of functions and classes directly in the documentation. 787238104Sdes 788238104SdesINLINE_SOURCES = NO 789238104Sdes 790238104Sdes# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 791238104Sdes# doxygen to hide any special comment blocks from generated source code 792238104Sdes# fragments. Normal C and C++ comments will always remain visible. 793238104Sdes 794238104SdesSTRIP_CODE_COMMENTS = YES 795238104Sdes 796238104Sdes# If the REFERENCED_BY_RELATION tag is set to YES 797238104Sdes# then for each documented function all documented 798238104Sdes# functions referencing it will be listed. 799238104Sdes 800238104SdesREFERENCED_BY_RELATION = NO 801238104Sdes 802238104Sdes# If the REFERENCES_RELATION tag is set to YES 803238104Sdes# then for each documented function all documented entities 804238104Sdes# called/used by that function will be listed. 805238104Sdes 806238104SdesREFERENCES_RELATION = YES 807238104Sdes 808238104Sdes# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 809238104Sdes# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 810238104Sdes# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 811238104Sdes# link to the source code. 812238104Sdes# Otherwise they will link to the documentation. 813238104Sdes 814238104SdesREFERENCES_LINK_SOURCE = YES 815238104Sdes 816238104Sdes# If the USE_HTAGS tag is set to YES then the references to source code 817238104Sdes# will point to the HTML generated by the htags(1) tool instead of doxygen 818238104Sdes# built-in source browser. The htags tool is part of GNU's global source 819238104Sdes# tagging system (see http://www.gnu.org/software/global/global.html). You 820238104Sdes# will need version 4.8.6 or higher. 821238104Sdes 822238104SdesUSE_HTAGS = NO 823238104Sdes 824238104Sdes# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 825238104Sdes# will generate a verbatim copy of the header file for each class for 826238104Sdes# which an include is specified. Set to NO to disable this. 827238104Sdes 828238104SdesVERBATIM_HEADERS = YES 829238104Sdes 830238104Sdes#--------------------------------------------------------------------------- 831238104Sdes# configuration options related to the alphabetical class index 832238104Sdes#--------------------------------------------------------------------------- 833238104Sdes 834238104Sdes# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 835238104Sdes# of all compounds will be generated. Enable this if the project 836238104Sdes# contains a lot of classes, structs, unions or interfaces. 837238104Sdes 838238104SdesALPHABETICAL_INDEX = YES 839238104Sdes 840238104Sdes# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 841238104Sdes# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 842238104Sdes# in which this list will be split (can be a number in the range [1..20]) 843238104Sdes 844238104SdesCOLS_IN_ALPHA_INDEX = 3 845238104Sdes 846238104Sdes# In case all classes in a project start with a common prefix, all 847238104Sdes# classes will be put under the same header in the alphabetical index. 848238104Sdes# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 849238104Sdes# should be ignored while generating the index headers. 850238104Sdes 851238104SdesIGNORE_PREFIX = ldns_ 852238104Sdes 853238104Sdes#--------------------------------------------------------------------------- 854238104Sdes# configuration options related to the HTML output 855238104Sdes#--------------------------------------------------------------------------- 856238104Sdes 857238104Sdes# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 858238104Sdes# generate HTML output. 859238104Sdes 860238104SdesGENERATE_HTML = YES 861238104Sdes 862238104Sdes# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 863238104Sdes# If a relative path is entered the value of OUTPUT_DIRECTORY will be 864238104Sdes# put in front of it. If left blank `html' will be used as the default path. 865238104Sdes 866238104SdesHTML_OUTPUT = html 867238104Sdes 868238104Sdes# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 869238104Sdes# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 870238104Sdes# doxygen will generate files with .html extension. 871238104Sdes 872238104SdesHTML_FILE_EXTENSION = .html 873238104Sdes 874238104Sdes# The HTML_HEADER tag can be used to specify a personal HTML header for 875238104Sdes# each generated HTML page. If it is left blank doxygen will generate a 876246854Sdes# standard header. Note that when using a custom header you are responsible 877246854Sdes# for the proper inclusion of any scripts and style sheets that doxygen 878246854Sdes# needs, which is dependent on the configuration options used. 879246854Sdes# It is advised to generate a default header using "doxygen -w html 880246854Sdes# header.html footer.html stylesheet.css YourConfigFile" and then modify 881246854Sdes# that header. Note that the header is subject to change so you typically 882246854Sdes# have to redo this when upgrading to a newer version of doxygen or when 883246854Sdes# changing the value of configuration settings such as GENERATE_TREEVIEW! 884238104Sdes 885238104SdesHTML_HEADER = doc/header.html 886238104Sdes 887238104Sdes# The HTML_FOOTER tag can be used to specify a personal HTML footer for 888238104Sdes# each generated HTML page. If it is left blank doxygen will generate a 889238104Sdes# standard footer. 890238104Sdes 891238104SdesHTML_FOOTER = 892238104Sdes 893238104Sdes# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 894238104Sdes# style sheet that is used by each HTML page. It can be used to 895238104Sdes# fine-tune the look of the HTML output. If the tag is left blank doxygen 896238104Sdes# will generate a default style sheet. Note that doxygen will try to copy 897238104Sdes# the style sheet file to the HTML output directory, so don't put your own 898246854Sdes# style sheet in the HTML output directory as well, or it will be erased! 899238104Sdes 900238104SdesHTML_STYLESHEET = 901238104Sdes 902246854Sdes# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 903246854Sdes# other source files which should be copied to the HTML output directory. Note 904246854Sdes# that these files will be copied to the base HTML output directory. Use the 905246854Sdes# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 906246854Sdes# files. In the HTML_STYLESHEET file, use the file name only. Also note that 907246854Sdes# the files will be copied as-is; there are no commands or markers available. 908246854Sdes 909246854SdesHTML_EXTRA_FILES = 910246854Sdes 911238104Sdes# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 912246854Sdes# Doxygen will adjust the colors in the style sheet and background images 913238104Sdes# according to this color. Hue is specified as an angle on a colorwheel, 914238104Sdes# see http://en.wikipedia.org/wiki/Hue for more information. 915238104Sdes# For instance the value 0 represents red, 60 is yellow, 120 is green, 916238104Sdes# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 917238104Sdes# The allowed range is 0 to 359. 918238104Sdes 919238104SdesHTML_COLORSTYLE_HUE = 220 920238104Sdes 921238104Sdes# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 922238104Sdes# the colors in the HTML output. For a value of 0 the output will use 923238104Sdes# grayscales only. A value of 255 will produce the most vivid colors. 924238104Sdes 925238104SdesHTML_COLORSTYLE_SAT = 100 926238104Sdes 927238104Sdes# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 928238104Sdes# the luminance component of the colors in the HTML output. Values below 929238104Sdes# 100 gradually make the output lighter, whereas values above 100 make 930238104Sdes# the output darker. The value divided by 100 is the actual gamma applied, 931238104Sdes# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 932238104Sdes# and 100 does not change the gamma. 933238104Sdes 934238104SdesHTML_COLORSTYLE_GAMMA = 80 935238104Sdes 936238104Sdes# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 937238104Sdes# page will contain the date and time when the page was generated. Setting 938238104Sdes# this to NO can help when comparing the output of multiple runs. 939238104Sdes 940238104SdesHTML_TIMESTAMP = YES 941238104Sdes 942238104Sdes# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 943238104Sdes# documentation will contain sections that can be hidden and shown after the 944238104Sdes# page has loaded. For this to work a browser that supports 945238104Sdes# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 946238104Sdes# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 947238104Sdes 948238104SdesHTML_DYNAMIC_SECTIONS = NO 949238104Sdes 950238104Sdes# If the GENERATE_DOCSET tag is set to YES, additional index files 951238104Sdes# will be generated that can be used as input for Apple's Xcode 3 952238104Sdes# integrated development environment, introduced with OSX 10.5 (Leopard). 953238104Sdes# To create a documentation set, doxygen will generate a Makefile in the 954238104Sdes# HTML output directory. Running make will produce the docset in that 955238104Sdes# directory and running "make install" will install the docset in 956238104Sdes# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 957238104Sdes# it at startup. 958238104Sdes# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 959238104Sdes# for more information. 960238104Sdes 961238104SdesGENERATE_DOCSET = NO 962238104Sdes 963238104Sdes# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 964238104Sdes# feed. A documentation feed provides an umbrella under which multiple 965238104Sdes# documentation sets from a single provider (such as a company or product suite) 966238104Sdes# can be grouped. 967238104Sdes 968238104SdesDOCSET_FEEDNAME = "Doxygen generated docs" 969238104Sdes 970238104Sdes# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 971238104Sdes# should uniquely identify the documentation set bundle. This should be a 972238104Sdes# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 973238104Sdes# will append .docset to the name. 974238104Sdes 975238104SdesDOCSET_BUNDLE_ID = org.doxygen.Project 976238104Sdes 977238104Sdes# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 978238104Sdes# the documentation publisher. This should be a reverse domain-name style 979238104Sdes# string, e.g. com.mycompany.MyDocSet.documentation. 980238104Sdes 981238104SdesDOCSET_PUBLISHER_ID = org.doxygen.Publisher 982238104Sdes 983238104Sdes# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 984238104Sdes 985238104SdesDOCSET_PUBLISHER_NAME = Publisher 986238104Sdes 987238104Sdes# If the GENERATE_HTMLHELP tag is set to YES, additional index files 988238104Sdes# will be generated that can be used as input for tools like the 989238104Sdes# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 990238104Sdes# of the generated HTML documentation. 991238104Sdes 992238104SdesGENERATE_HTMLHELP = NO 993238104Sdes 994238104Sdes# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 995238104Sdes# be used to specify the file name of the resulting .chm file. You 996238104Sdes# can add a path in front of the file if the result should not be 997238104Sdes# written to the html output directory. 998238104Sdes 999238104SdesCHM_FILE = 1000238104Sdes 1001238104Sdes# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1002238104Sdes# be used to specify the location (absolute path including file name) of 1003238104Sdes# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1004238104Sdes# the HTML help compiler on the generated index.hhp. 1005238104Sdes 1006238104SdesHHC_LOCATION = 1007238104Sdes 1008238104Sdes# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1009238104Sdes# controls if a separate .chi index file is generated (YES) or that 1010238104Sdes# it should be included in the master .chm file (NO). 1011238104Sdes 1012238104SdesGENERATE_CHI = NO 1013238104Sdes 1014238104Sdes# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1015238104Sdes# is used to encode HtmlHelp index (hhk), content (hhc) and project file 1016238104Sdes# content. 1017238104Sdes 1018238104SdesCHM_INDEX_ENCODING = 1019238104Sdes 1020238104Sdes# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1021238104Sdes# controls whether a binary table of contents is generated (YES) or a 1022238104Sdes# normal table of contents (NO) in the .chm file. 1023238104Sdes 1024238104SdesBINARY_TOC = NO 1025238104Sdes 1026238104Sdes# The TOC_EXPAND flag can be set to YES to add extra items for group members 1027238104Sdes# to the contents of the HTML help documentation and to the tree view. 1028238104Sdes 1029238104SdesTOC_EXPAND = NO 1030238104Sdes 1031238104Sdes# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1032238104Sdes# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1033238104Sdes# that can be used as input for Qt's qhelpgenerator to generate a 1034238104Sdes# Qt Compressed Help (.qch) of the generated HTML documentation. 1035238104Sdes 1036238104SdesGENERATE_QHP = NO 1037238104Sdes 1038238104Sdes# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1039238104Sdes# be used to specify the file name of the resulting .qch file. 1040238104Sdes# The path specified is relative to the HTML output folder. 1041238104Sdes 1042238104SdesQCH_FILE = 1043238104Sdes 1044238104Sdes# The QHP_NAMESPACE tag specifies the namespace to use when generating 1045238104Sdes# Qt Help Project output. For more information please see 1046238104Sdes# http://doc.trolltech.com/qthelpproject.html#namespace 1047238104Sdes 1048238104SdesQHP_NAMESPACE = org.doxygen.Project 1049238104Sdes 1050238104Sdes# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1051238104Sdes# Qt Help Project output. For more information please see 1052238104Sdes# http://doc.trolltech.com/qthelpproject.html#virtual-folders 1053238104Sdes 1054238104SdesQHP_VIRTUAL_FOLDER = doc 1055238104Sdes 1056238104Sdes# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1057238104Sdes# add. For more information please see 1058238104Sdes# http://doc.trolltech.com/qthelpproject.html#custom-filters 1059238104Sdes 1060238104SdesQHP_CUST_FILTER_NAME = 1061238104Sdes 1062238104Sdes# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1063238104Sdes# custom filter to add. For more information please see 1064238104Sdes# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1065238104Sdes# Qt Help Project / Custom Filters</a>. 1066238104Sdes 1067238104SdesQHP_CUST_FILTER_ATTRS = 1068238104Sdes 1069238104Sdes# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1070238104Sdes# project's 1071238104Sdes# filter section matches. 1072238104Sdes# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1073238104Sdes# Qt Help Project / Filter Attributes</a>. 1074238104Sdes 1075238104SdesQHP_SECT_FILTER_ATTRS = 1076238104Sdes 1077238104Sdes# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1078238104Sdes# be used to specify the location of Qt's qhelpgenerator. 1079238104Sdes# If non-empty doxygen will try to run qhelpgenerator on the generated 1080238104Sdes# .qhp file. 1081238104Sdes 1082238104SdesQHG_LOCATION = 1083238104Sdes 1084238104Sdes# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1085238104Sdes# will be generated, which together with the HTML files, form an Eclipse help 1086238104Sdes# plugin. To install this plugin and make it available under the help contents 1087238104Sdes# menu in Eclipse, the contents of the directory containing the HTML and XML 1088238104Sdes# files needs to be copied into the plugins directory of eclipse. The name of 1089238104Sdes# the directory within the plugins directory should be the same as 1090238104Sdes# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1091238104Sdes# the help appears. 1092238104Sdes 1093238104SdesGENERATE_ECLIPSEHELP = NO 1094238104Sdes 1095238104Sdes# A unique identifier for the eclipse help plugin. When installing the plugin 1096238104Sdes# the directory name containing the HTML and XML files should also have 1097238104Sdes# this name. 1098238104Sdes 1099238104SdesECLIPSE_DOC_ID = org.doxygen.Project 1100238104Sdes 1101246854Sdes# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1102246854Sdes# at top of each HTML page. The value NO (the default) enables the index and 1103246854Sdes# the value YES disables it. Since the tabs have the same information as the 1104246854Sdes# navigation tree you can set this option to NO if you already set 1105246854Sdes# GENERATE_TREEVIEW to YES. 1106238104Sdes 1107238104SdesDISABLE_INDEX = NO 1108238104Sdes 1109238104Sdes# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1110238104Sdes# structure should be generated to display hierarchical information. 1111238104Sdes# If the tag value is set to YES, a side panel will be generated 1112238104Sdes# containing a tree-like index structure (just like the one that 1113238104Sdes# is generated for HTML Help). For this to work a browser that supports 1114238104Sdes# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1115238104Sdes# Windows users are probably better off using the HTML help feature. 1116246854Sdes# Since the tree basically has the same information as the tab index you 1117246854Sdes# could consider to set DISABLE_INDEX to NO when enabling this option. 1118238104Sdes 1119238104SdesGENERATE_TREEVIEW = NO 1120238104Sdes 1121246854Sdes# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1122246854Sdes# (range [0,1..20]) that doxygen will group on one line in the generated HTML 1123246854Sdes# documentation. Note that a value of 0 will completely suppress the enum 1124246854Sdes# values from appearing in the overview section. 1125238104Sdes 1126246854SdesENUM_VALUES_PER_LINE = 4 1127238104Sdes 1128238104Sdes# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1129238104Sdes# used to set the initial width (in pixels) of the frame in which the tree 1130238104Sdes# is shown. 1131238104Sdes 1132238104SdesTREEVIEW_WIDTH = 250 1133238104Sdes 1134238104Sdes# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1135238104Sdes# links to external symbols imported via tag files in a separate window. 1136238104Sdes 1137238104SdesEXT_LINKS_IN_WINDOW = NO 1138238104Sdes 1139238104Sdes# Use this tag to change the font size of Latex formulas included 1140238104Sdes# as images in the HTML documentation. The default is 10. Note that 1141238104Sdes# when you change the font size after a successful doxygen run you need 1142238104Sdes# to manually remove any form_*.png images from the HTML output directory 1143238104Sdes# to force them to be regenerated. 1144238104Sdes 1145238104SdesFORMULA_FONTSIZE = 10 1146238104Sdes 1147238104Sdes# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1148238104Sdes# generated for formulas are transparent PNGs. Transparent PNGs are 1149238104Sdes# not supported properly for IE 6.0, but are supported on all modern browsers. 1150238104Sdes# Note that when changing this option you need to delete any form_*.png files 1151238104Sdes# in the HTML output before the changes have effect. 1152238104Sdes 1153238104SdesFORMULA_TRANSPARENT = YES 1154238104Sdes 1155238104Sdes# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1156238104Sdes# (see http://www.mathjax.org) which uses client side Javascript for the 1157238104Sdes# rendering instead of using prerendered bitmaps. Use this if you do not 1158238104Sdes# have LaTeX installed or if you want to formulas look prettier in the HTML 1159238104Sdes# output. When enabled you also need to install MathJax separately and 1160238104Sdes# configure the path to it using the MATHJAX_RELPATH option. 1161238104Sdes 1162238104SdesUSE_MATHJAX = NO 1163238104Sdes 1164238104Sdes# When MathJax is enabled you need to specify the location relative to the 1165238104Sdes# HTML output directory using the MATHJAX_RELPATH option. The destination 1166238104Sdes# directory should contain the MathJax.js script. For instance, if the mathjax 1167238104Sdes# directory is located at the same level as the HTML output directory, then 1168246854Sdes# MATHJAX_RELPATH should be ../mathjax. The default value points to the 1169246854Sdes# mathjax.org site, so you can quickly see the result without installing 1170238104Sdes# MathJax, but it is strongly recommended to install a local copy of MathJax 1171238104Sdes# before deployment. 1172238104Sdes 1173238104SdesMATHJAX_RELPATH = http://www.mathjax.org/mathjax 1174238104Sdes 1175246854Sdes# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1176246854Sdes# names that should be enabled during MathJax rendering. 1177246854Sdes 1178246854SdesMATHJAX_EXTENSIONS = 1179246854Sdes 1180238104Sdes# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1181238104Sdes# for the HTML output. The underlying search engine uses javascript 1182238104Sdes# and DHTML and should work on any modern browser. Note that when using 1183238104Sdes# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1184238104Sdes# (GENERATE_DOCSET) there is already a search function so this one should 1185238104Sdes# typically be disabled. For large projects the javascript based search engine 1186238104Sdes# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1187238104Sdes 1188238104SdesSEARCHENGINE = NO 1189238104Sdes 1190238104Sdes# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1191238104Sdes# implemented using a PHP enabled web server instead of at the web client 1192238104Sdes# using Javascript. Doxygen will generate the search PHP script and index 1193238104Sdes# file to put on the web server. The advantage of the server 1194238104Sdes# based approach is that it scales better to large projects and allows 1195238104Sdes# full text search. The disadvantages are that it is more difficult to setup 1196238104Sdes# and does not have live searching capabilities. 1197238104Sdes 1198238104SdesSERVER_BASED_SEARCH = NO 1199238104Sdes 1200238104Sdes#--------------------------------------------------------------------------- 1201238104Sdes# configuration options related to the LaTeX output 1202238104Sdes#--------------------------------------------------------------------------- 1203238104Sdes 1204238104Sdes# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1205238104Sdes# generate Latex output. 1206238104Sdes 1207238104SdesGENERATE_LATEX = NO 1208238104Sdes 1209238104Sdes# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1210238104Sdes# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1211238104Sdes# put in front of it. If left blank `latex' will be used as the default path. 1212238104Sdes 1213238104SdesLATEX_OUTPUT = latex 1214238104Sdes 1215238104Sdes# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1216238104Sdes# invoked. If left blank `latex' will be used as the default command name. 1217238104Sdes# Note that when enabling USE_PDFLATEX this option is only used for 1218238104Sdes# generating bitmaps for formulas in the HTML output, but not in the 1219238104Sdes# Makefile that is written to the output directory. 1220238104Sdes 1221238104SdesLATEX_CMD_NAME = latex 1222238104Sdes 1223238104Sdes# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1224238104Sdes# generate index for LaTeX. If left blank `makeindex' will be used as the 1225238104Sdes# default command name. 1226238104Sdes 1227238104SdesMAKEINDEX_CMD_NAME = makeindex 1228238104Sdes 1229238104Sdes# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1230238104Sdes# LaTeX documents. This may be useful for small projects and may help to 1231238104Sdes# save some trees in general. 1232238104Sdes 1233238104SdesCOMPACT_LATEX = NO 1234238104Sdes 1235238104Sdes# The PAPER_TYPE tag can be used to set the paper type that is used 1236238104Sdes# by the printer. Possible values are: a4, letter, legal and 1237238104Sdes# executive. If left blank a4wide will be used. 1238238104Sdes 1239238104SdesPAPER_TYPE = a4wide 1240238104Sdes 1241238104Sdes# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1242238104Sdes# packages that should be included in the LaTeX output. 1243238104Sdes 1244238104SdesEXTRA_PACKAGES = 1245238104Sdes 1246238104Sdes# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1247238104Sdes# the generated latex document. The header should contain everything until 1248238104Sdes# the first chapter. If it is left blank doxygen will generate a 1249238104Sdes# standard header. Notice: only use this tag if you know what you are doing! 1250238104Sdes 1251238104SdesLATEX_HEADER = 1252238104Sdes 1253246854Sdes# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1254246854Sdes# the generated latex document. The footer should contain everything after 1255246854Sdes# the last chapter. If it is left blank doxygen will generate a 1256246854Sdes# standard footer. Notice: only use this tag if you know what you are doing! 1257246854Sdes 1258246854SdesLATEX_FOOTER = 1259246854Sdes 1260238104Sdes# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1261238104Sdes# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1262238104Sdes# contain links (just like the HTML output) instead of page references 1263238104Sdes# This makes the output suitable for online browsing using a pdf viewer. 1264238104Sdes 1265238104SdesPDF_HYPERLINKS = YES 1266238104Sdes 1267238104Sdes# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1268238104Sdes# plain latex in the generated Makefile. Set this option to YES to get a 1269238104Sdes# higher quality PDF documentation. 1270238104Sdes 1271238104SdesUSE_PDFLATEX = YES 1272238104Sdes 1273238104Sdes# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1274238104Sdes# command to the generated LaTeX files. This will instruct LaTeX to keep 1275238104Sdes# running if errors occur, instead of asking the user for help. 1276238104Sdes# This option is also used when generating formulas in HTML. 1277238104Sdes 1278238104SdesLATEX_BATCHMODE = YES 1279238104Sdes 1280238104Sdes# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1281238104Sdes# include the index chapters (such as File Index, Compound Index, etc.) 1282238104Sdes# in the output. 1283238104Sdes 1284238104SdesLATEX_HIDE_INDICES = NO 1285238104Sdes 1286238104Sdes# If LATEX_SOURCE_CODE is set to YES then doxygen will include 1287238104Sdes# source code with syntax highlighting in the LaTeX output. 1288238104Sdes# Note that which sources are shown also depends on other settings 1289238104Sdes# such as SOURCE_BROWSER. 1290238104Sdes 1291238104SdesLATEX_SOURCE_CODE = NO 1292238104Sdes 1293246854Sdes# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1294246854Sdes# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1295246854Sdes# http://en.wikipedia.org/wiki/BibTeX for more info. 1296246854Sdes 1297246854SdesLATEX_BIB_STYLE = plain 1298246854Sdes 1299238104Sdes#--------------------------------------------------------------------------- 1300238104Sdes# configuration options related to the RTF output 1301238104Sdes#--------------------------------------------------------------------------- 1302238104Sdes 1303238104Sdes# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1304238104Sdes# The RTF output is optimized for Word 97 and may not look very pretty with 1305238104Sdes# other RTF readers or editors. 1306238104Sdes 1307238104SdesGENERATE_RTF = NO 1308238104Sdes 1309238104Sdes# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1310238104Sdes# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1311238104Sdes# put in front of it. If left blank `rtf' will be used as the default path. 1312238104Sdes 1313238104SdesRTF_OUTPUT = rtf 1314238104Sdes 1315238104Sdes# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1316238104Sdes# RTF documents. This may be useful for small projects and may help to 1317238104Sdes# save some trees in general. 1318238104Sdes 1319238104SdesCOMPACT_RTF = NO 1320238104Sdes 1321238104Sdes# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1322238104Sdes# will contain hyperlink fields. The RTF file will 1323238104Sdes# contain links (just like the HTML output) instead of page references. 1324238104Sdes# This makes the output suitable for online browsing using WORD or other 1325238104Sdes# programs which support those fields. 1326238104Sdes# Note: wordpad (write) and others do not support links. 1327238104Sdes 1328238104SdesRTF_HYPERLINKS = NO 1329238104Sdes 1330246854Sdes# Load style sheet definitions from file. Syntax is similar to doxygen's 1331238104Sdes# config file, i.e. a series of assignments. You only have to provide 1332238104Sdes# replacements, missing definitions are set to their default value. 1333238104Sdes 1334238104SdesRTF_STYLESHEET_FILE = 1335238104Sdes 1336238104Sdes# Set optional variables used in the generation of an rtf document. 1337238104Sdes# Syntax is similar to doxygen's config file. 1338238104Sdes 1339238104SdesRTF_EXTENSIONS_FILE = 1340238104Sdes 1341238104Sdes#--------------------------------------------------------------------------- 1342238104Sdes# configuration options related to the man page output 1343238104Sdes#--------------------------------------------------------------------------- 1344238104Sdes 1345238104Sdes# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1346238104Sdes# generate man pages 1347238104Sdes 1348238104SdesGENERATE_MAN = NO 1349238104Sdes 1350238104Sdes# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1351238104Sdes# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1352238104Sdes# put in front of it. If left blank `man' will be used as the default path. 1353238104Sdes 1354238104SdesMAN_OUTPUT = man 1355238104Sdes 1356238104Sdes# The MAN_EXTENSION tag determines the extension that is added to 1357238104Sdes# the generated man pages (default is the subroutine's section .3) 1358238104Sdes 1359238104SdesMAN_EXTENSION = .3 1360238104Sdes 1361238104Sdes# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1362238104Sdes# then it will generate one additional man file for each entity 1363238104Sdes# documented in the real man page(s). These additional files 1364238104Sdes# only source the real man page, but without them the man command 1365238104Sdes# would be unable to find the correct page. The default is NO. 1366238104Sdes 1367238104SdesMAN_LINKS = NO 1368238104Sdes 1369238104Sdes#--------------------------------------------------------------------------- 1370238104Sdes# configuration options related to the XML output 1371238104Sdes#--------------------------------------------------------------------------- 1372238104Sdes 1373238104Sdes# If the GENERATE_XML tag is set to YES Doxygen will 1374238104Sdes# generate an XML file that captures the structure of 1375238104Sdes# the code including all documentation. 1376238104Sdes 1377238104SdesGENERATE_XML = NO 1378238104Sdes 1379238104Sdes# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1380238104Sdes# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1381238104Sdes# put in front of it. If left blank `xml' will be used as the default path. 1382238104Sdes 1383238104SdesXML_OUTPUT = xml 1384238104Sdes 1385238104Sdes# The XML_SCHEMA tag can be used to specify an XML schema, 1386238104Sdes# which can be used by a validating XML parser to check the 1387238104Sdes# syntax of the XML files. 1388238104Sdes 1389238104SdesXML_SCHEMA = 1390238104Sdes 1391238104Sdes# The XML_DTD tag can be used to specify an XML DTD, 1392238104Sdes# which can be used by a validating XML parser to check the 1393238104Sdes# syntax of the XML files. 1394238104Sdes 1395238104SdesXML_DTD = 1396238104Sdes 1397238104Sdes# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1398238104Sdes# dump the program listings (including syntax highlighting 1399238104Sdes# and cross-referencing information) to the XML output. Note that 1400238104Sdes# enabling this will significantly increase the size of the XML output. 1401238104Sdes 1402238104SdesXML_PROGRAMLISTING = YES 1403238104Sdes 1404238104Sdes#--------------------------------------------------------------------------- 1405238104Sdes# configuration options for the AutoGen Definitions output 1406238104Sdes#--------------------------------------------------------------------------- 1407238104Sdes 1408238104Sdes# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1409238104Sdes# generate an AutoGen Definitions (see autogen.sf.net) file 1410238104Sdes# that captures the structure of the code including all 1411238104Sdes# documentation. Note that this feature is still experimental 1412238104Sdes# and incomplete at the moment. 1413238104Sdes 1414238104SdesGENERATE_AUTOGEN_DEF = NO 1415238104Sdes 1416238104Sdes#--------------------------------------------------------------------------- 1417238104Sdes# configuration options related to the Perl module output 1418238104Sdes#--------------------------------------------------------------------------- 1419238104Sdes 1420238104Sdes# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1421238104Sdes# generate a Perl module file that captures the structure of 1422238104Sdes# the code including all documentation. Note that this 1423238104Sdes# feature is still experimental and incomplete at the 1424238104Sdes# moment. 1425238104Sdes 1426238104SdesGENERATE_PERLMOD = NO 1427238104Sdes 1428238104Sdes# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1429238104Sdes# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1430238104Sdes# to generate PDF and DVI output from the Perl module output. 1431238104Sdes 1432238104SdesPERLMOD_LATEX = NO 1433238104Sdes 1434238104Sdes# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1435238104Sdes# nicely formatted so it can be parsed by a human reader. 1436238104Sdes# This is useful 1437238104Sdes# if you want to understand what is going on. 1438238104Sdes# On the other hand, if this 1439238104Sdes# tag is set to NO the size of the Perl module output will be much smaller 1440238104Sdes# and Perl will parse it just the same. 1441238104Sdes 1442238104SdesPERLMOD_PRETTY = YES 1443238104Sdes 1444238104Sdes# The names of the make variables in the generated doxyrules.make file 1445238104Sdes# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1446238104Sdes# This is useful so different doxyrules.make files included by the same 1447238104Sdes# Makefile don't overwrite each other's variables. 1448238104Sdes 1449238104SdesPERLMOD_MAKEVAR_PREFIX = 1450238104Sdes 1451238104Sdes#--------------------------------------------------------------------------- 1452238104Sdes# Configuration options related to the preprocessor 1453238104Sdes#--------------------------------------------------------------------------- 1454238104Sdes 1455238104Sdes# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1456238104Sdes# evaluate all C-preprocessor directives found in the sources and include 1457238104Sdes# files. 1458238104Sdes 1459238104SdesENABLE_PREPROCESSING = YES 1460238104Sdes 1461238104Sdes# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1462238104Sdes# names in the source code. If set to NO (the default) only conditional 1463238104Sdes# compilation will be performed. Macro expansion can be done in a controlled 1464238104Sdes# way by setting EXPAND_ONLY_PREDEF to YES. 1465238104Sdes 1466238104SdesMACRO_EXPANSION = YES 1467238104Sdes 1468238104Sdes# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1469238104Sdes# then the macro expansion is limited to the macros specified with the 1470238104Sdes# PREDEFINED and EXPAND_AS_DEFINED tags. 1471238104Sdes 1472238104SdesEXPAND_ONLY_PREDEF = NO 1473238104Sdes 1474238104Sdes# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1475246854Sdes# pointed to by INCLUDE_PATH will be searched when a #include is found. 1476238104Sdes 1477238104SdesSEARCH_INCLUDES = YES 1478238104Sdes 1479238104Sdes# The INCLUDE_PATH tag can be used to specify one or more directories that 1480238104Sdes# contain include files that are not input files but should be processed by 1481238104Sdes# the preprocessor. 1482238104Sdes 1483246854SdesINCLUDE_PATH = . 1484238104Sdes 1485238104Sdes# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1486238104Sdes# patterns (like *.h and *.hpp) to filter out the header-files in the 1487238104Sdes# directories. If left blank, the patterns specified with FILE_PATTERNS will 1488238104Sdes# be used. 1489238104Sdes 1490238104SdesINCLUDE_FILE_PATTERNS = 1491238104Sdes 1492238104Sdes# The PREDEFINED tag can be used to specify one or more macro names that 1493238104Sdes# are defined before the preprocessor is started (similar to the -D option of 1494238104Sdes# gcc). The argument of the tag is a list of macros of the form: name 1495238104Sdes# or name=definition (no spaces). If the definition and the = are 1496238104Sdes# omitted =1 is assumed. To prevent a macro definition from being 1497238104Sdes# undefined via #undef or recursively expanded use the := operator 1498238104Sdes# instead of the = operator. 1499238104Sdes 1500238104SdesPREDEFINED = HAVE_SSL 1501238104Sdes 1502238104Sdes# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1503238104Sdes# this tag can be used to specify a list of macro names that should be expanded. 1504238104Sdes# The macro definition that is found in the sources will be used. 1505246854Sdes# Use the PREDEFINED tag if you want to use a different macro definition that 1506246854Sdes# overrules the definition found in the source code. 1507238104Sdes 1508238104SdesEXPAND_AS_DEFINED = 1509238104Sdes 1510238104Sdes# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1511238104Sdes# doxygen's preprocessor will remove all references to function-like macros 1512238104Sdes# that are alone on a line, have an all uppercase name, and do not end with a 1513238104Sdes# semicolon, because these will confuse the parser if not removed. 1514238104Sdes 1515238104SdesSKIP_FUNCTION_MACROS = YES 1516238104Sdes 1517238104Sdes#--------------------------------------------------------------------------- 1518238104Sdes# Configuration::additions related to external references 1519238104Sdes#--------------------------------------------------------------------------- 1520238104Sdes 1521238104Sdes# The TAGFILES option can be used to specify one or more tagfiles. 1522238104Sdes# Optionally an initial location of the external documentation 1523238104Sdes# can be added for each tagfile. The format of a tag file without 1524238104Sdes# this location is as follows: 1525238104Sdes# 1526238104Sdes# TAGFILES = file1 file2 ... 1527238104Sdes# Adding location for the tag files is done as follows: 1528238104Sdes# 1529238104Sdes# TAGFILES = file1=loc1 "file2 = loc2" ... 1530238104Sdes# where "loc1" and "loc2" can be relative or absolute paths or 1531238104Sdes# URLs. If a location is present for each tag, the installdox tool 1532238104Sdes# does not have to be run to correct the links. 1533238104Sdes# Note that each tag file must have a unique name 1534238104Sdes# (where the name does NOT include the path) 1535238104Sdes# If a tag file is not located in the directory in which doxygen 1536238104Sdes# is run, you must also specify the path to the tagfile here. 1537238104Sdes 1538238104SdesTAGFILES = 1539238104Sdes 1540238104Sdes# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1541238104Sdes# a tag file that is based on the input files it reads. 1542238104Sdes 1543238104SdesGENERATE_TAGFILE = 1544238104Sdes 1545238104Sdes# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1546238104Sdes# in the class index. If set to NO only the inherited external classes 1547238104Sdes# will be listed. 1548238104Sdes 1549238104SdesALLEXTERNALS = NO 1550238104Sdes 1551238104Sdes# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1552238104Sdes# in the modules index. If set to NO, only the current project's groups will 1553238104Sdes# be listed. 1554238104Sdes 1555238104SdesEXTERNAL_GROUPS = YES 1556238104Sdes 1557238104Sdes# The PERL_PATH should be the absolute path and name of the perl script 1558238104Sdes# interpreter (i.e. the result of `which perl'). 1559238104Sdes 1560238104SdesPERL_PATH = /usr/bin/perl 1561238104Sdes 1562238104Sdes#--------------------------------------------------------------------------- 1563238104Sdes# Configuration options related to the dot tool 1564238104Sdes#--------------------------------------------------------------------------- 1565238104Sdes 1566238104Sdes# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1567238104Sdes# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1568238104Sdes# or super classes. Setting the tag to NO turns the diagrams off. Note that 1569238104Sdes# this option also works with HAVE_DOT disabled, but it is recommended to 1570238104Sdes# install and use dot, since it yields more powerful graphs. 1571238104Sdes 1572238104SdesCLASS_DIAGRAMS = YES 1573238104Sdes 1574238104Sdes# You can define message sequence charts within doxygen comments using the \msc 1575238104Sdes# command. Doxygen will then run the mscgen tool (see 1576238104Sdes# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1577238104Sdes# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1578238104Sdes# the mscgen tool resides. If left empty the tool is assumed to be found in the 1579238104Sdes# default search path. 1580238104Sdes 1581238104SdesMSCGEN_PATH = 1582238104Sdes 1583238104Sdes# If set to YES, the inheritance and collaboration graphs will hide 1584238104Sdes# inheritance and usage relations if the target is undocumented 1585238104Sdes# or is not a class. 1586238104Sdes 1587238104SdesHIDE_UNDOC_RELATIONS = YES 1588238104Sdes 1589238104Sdes# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1590238104Sdes# available from the path. This tool is part of Graphviz, a graph visualization 1591238104Sdes# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1592238104Sdes# have no effect if this option is set to NO (the default) 1593238104Sdes 1594238104SdesHAVE_DOT = NO 1595238104Sdes 1596238104Sdes# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1597238104Sdes# allowed to run in parallel. When set to 0 (the default) doxygen will 1598238104Sdes# base this on the number of processors available in the system. You can set it 1599238104Sdes# explicitly to a value larger than 0 to get control over the balance 1600238104Sdes# between CPU load and processing speed. 1601238104Sdes 1602238104SdesDOT_NUM_THREADS = 0 1603238104Sdes 1604246854Sdes# By default doxygen will use the Helvetica font for all dot files that 1605246854Sdes# doxygen generates. When you want a differently looking font you can specify 1606246854Sdes# the font name using DOT_FONTNAME. You need to make sure dot is able to find 1607246854Sdes# the font, which can be done by putting it in a standard location or by setting 1608246854Sdes# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1609246854Sdes# directory containing the font. 1610238104Sdes 1611238104SdesDOT_FONTNAME = Helvetica 1612238104Sdes 1613238104Sdes# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1614238104Sdes# The default size is 10pt. 1615238104Sdes 1616238104SdesDOT_FONTSIZE = 10 1617238104Sdes 1618246854Sdes# By default doxygen will tell dot to use the Helvetica font. 1619246854Sdes# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1620246854Sdes# set the path where dot can find it. 1621238104Sdes 1622238104SdesDOT_FONTPATH = 1623238104Sdes 1624238104Sdes# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1625238104Sdes# will generate a graph for each documented class showing the direct and 1626238104Sdes# indirect inheritance relations. Setting this tag to YES will force the 1627246854Sdes# CLASS_DIAGRAMS tag to NO. 1628238104Sdes 1629238104SdesCLASS_GRAPH = YES 1630238104Sdes 1631238104Sdes# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1632238104Sdes# will generate a graph for each documented class showing the direct and 1633238104Sdes# indirect implementation dependencies (inheritance, containment, and 1634238104Sdes# class references variables) of the class with other documented classes. 1635238104Sdes 1636238104SdesCOLLABORATION_GRAPH = YES 1637238104Sdes 1638238104Sdes# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1639238104Sdes# will generate a graph for groups, showing the direct groups dependencies 1640238104Sdes 1641238104SdesGROUP_GRAPHS = YES 1642238104Sdes 1643238104Sdes# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1644238104Sdes# collaboration diagrams in a style similar to the OMG's Unified Modeling 1645238104Sdes# Language. 1646238104Sdes 1647238104SdesUML_LOOK = NO 1648238104Sdes 1649238104Sdes# If set to YES, the inheritance and collaboration graphs will show the 1650238104Sdes# relations between templates and their instances. 1651238104Sdes 1652238104SdesTEMPLATE_RELATIONS = NO 1653238104Sdes 1654238104Sdes# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1655238104Sdes# tags are set to YES then doxygen will generate a graph for each documented 1656238104Sdes# file showing the direct and indirect include dependencies of the file with 1657238104Sdes# other documented files. 1658238104Sdes 1659238104SdesINCLUDE_GRAPH = YES 1660238104Sdes 1661238104Sdes# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1662238104Sdes# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1663238104Sdes# documented header file showing the documented files that directly or 1664238104Sdes# indirectly include this file. 1665238104Sdes 1666238104SdesINCLUDED_BY_GRAPH = YES 1667238104Sdes 1668238104Sdes# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1669238104Sdes# doxygen will generate a call dependency graph for every global function 1670238104Sdes# or class method. Note that enabling this option will significantly increase 1671238104Sdes# the time of a run. So in most cases it will be better to enable call graphs 1672238104Sdes# for selected functions only using the \callgraph command. 1673238104Sdes 1674238104SdesCALL_GRAPH = YES 1675238104Sdes 1676238104Sdes# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1677238104Sdes# doxygen will generate a caller dependency graph for every global function 1678238104Sdes# or class method. Note that enabling this option will significantly increase 1679238104Sdes# the time of a run. So in most cases it will be better to enable caller 1680238104Sdes# graphs for selected functions only using the \callergraph command. 1681238104Sdes 1682238104SdesCALLER_GRAPH = NO 1683238104Sdes 1684238104Sdes# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1685238104Sdes# will generate a graphical hierarchy of all classes instead of a textual one. 1686238104Sdes 1687238104SdesGRAPHICAL_HIERARCHY = YES 1688238104Sdes 1689238104Sdes# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1690238104Sdes# then doxygen will show the dependencies a directory has on other directories 1691238104Sdes# in a graphical way. The dependency relations are determined by the #include 1692238104Sdes# relations between the files in the directories. 1693238104Sdes 1694238104SdesDIRECTORY_GRAPH = YES 1695238104Sdes 1696238104Sdes# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1697246854Sdes# generated by dot. Possible values are svg, png, jpg, or gif. 1698246854Sdes# If left blank png will be used. If you choose svg you need to set 1699246854Sdes# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1700246854Sdes# visible in IE 9+ (other browsers do not have this requirement). 1701238104Sdes 1702238104SdesDOT_IMAGE_FORMAT = png 1703238104Sdes 1704246854Sdes# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1705246854Sdes# enable generation of interactive SVG images that allow zooming and panning. 1706246854Sdes# Note that this requires a modern browser other than Internet Explorer. 1707246854Sdes# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1708246854Sdes# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1709246854Sdes# visible. Older versions of IE do not have SVG support. 1710246854Sdes 1711246854SdesINTERACTIVE_SVG = NO 1712246854Sdes 1713238104Sdes# The tag DOT_PATH can be used to specify the path where the dot tool can be 1714238104Sdes# found. If left blank, it is assumed the dot tool can be found in the path. 1715238104Sdes 1716238104SdesDOT_PATH = 1717238104Sdes 1718238104Sdes# The DOTFILE_DIRS tag can be used to specify one or more directories that 1719238104Sdes# contain dot files that are included in the documentation (see the 1720238104Sdes# \dotfile command). 1721238104Sdes 1722238104SdesDOTFILE_DIRS = 1723238104Sdes 1724238104Sdes# The MSCFILE_DIRS tag can be used to specify one or more directories that 1725238104Sdes# contain msc files that are included in the documentation (see the 1726238104Sdes# \mscfile command). 1727238104Sdes 1728238104SdesMSCFILE_DIRS = 1729238104Sdes 1730238104Sdes# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1731238104Sdes# nodes that will be shown in the graph. If the number of nodes in a graph 1732238104Sdes# becomes larger than this value, doxygen will truncate the graph, which is 1733238104Sdes# visualized by representing a node as a red box. Note that doxygen if the 1734238104Sdes# number of direct children of the root node in a graph is already larger than 1735238104Sdes# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1736238104Sdes# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1737238104Sdes 1738238104SdesDOT_GRAPH_MAX_NODES = 50 1739238104Sdes 1740238104Sdes# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1741238104Sdes# graphs generated by dot. A depth value of 3 means that only nodes reachable 1742238104Sdes# from the root by following a path via at most 3 edges will be shown. Nodes 1743238104Sdes# that lay further from the root node will be omitted. Note that setting this 1744238104Sdes# option to 1 or 2 may greatly reduce the computation time needed for large 1745238104Sdes# code bases. Also note that the size of a graph can be further restricted by 1746238104Sdes# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1747238104Sdes 1748238104SdesMAX_DOT_GRAPH_DEPTH = 0 1749238104Sdes 1750238104Sdes# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1751238104Sdes# background. This is disabled by default, because dot on Windows does not 1752238104Sdes# seem to support this out of the box. Warning: Depending on the platform used, 1753238104Sdes# enabling this option may lead to badly anti-aliased labels on the edges of 1754238104Sdes# a graph (i.e. they become hard to read). 1755238104Sdes 1756238104SdesDOT_TRANSPARENT = NO 1757238104Sdes 1758238104Sdes# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1759238104Sdes# files in one run (i.e. multiple -o and -T options on the command line). This 1760238104Sdes# makes dot run faster, but since only newer versions of dot (>1.8.10) 1761238104Sdes# support this, this feature is disabled by default. 1762238104Sdes 1763238104SdesDOT_MULTI_TARGETS = YES 1764238104Sdes 1765238104Sdes# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1766238104Sdes# generate a legend page explaining the meaning of the various boxes and 1767238104Sdes# arrows in the dot generated graphs. 1768238104Sdes 1769238104SdesGENERATE_LEGEND = YES 1770238104Sdes 1771238104Sdes# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1772238104Sdes# remove the intermediate dot files that are used to generate 1773238104Sdes# the various graphs. 1774238104Sdes 1775238104SdesDOT_CLEANUP = YES 1776