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