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