1 # Id: Doxyfile.in,v 1.2 2006/12/22 01:44:59 marka Exp
5 # This file describes the settings to be used by the documentation system
6 # doxygen (www.doxygen.org) for a project
8 # All text after a hash (#) is considered a comment and will be ignored
10 # TAG = value [value, ...]
11 # For lists items can also be appended using:
12 # TAG += value [value, ...]
13 # Values that contain spaces should be placed between quotes (" ")
15 #---------------------------------------------------------------------------
16 # Project related configuration options
17 #---------------------------------------------------------------------------
19 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
20 # by quotes) that should identify the project.
22 PROJECT_NAME = "BIND9 Internals"
24 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
25 # This could be handy for archiving the generated documentation or
26 # if some version control system is used.
28 PROJECT_NUMBER = $(BIND9_VERSION)
30 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
31 # base path where the generated documentation will be put.
32 # If a relative path is entered, it will be relative to the location
33 # where doxygen was started. If left blank the current directory will be used.
37 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
38 # 4096 sub-directories (in 2 levels) under the output directory of each output
39 # format and will distribute the generated files over these directories.
40 # Enabling this option can be useful when feeding doxygen a huge amount of
41 # source files, where putting all generated files in the same directory would
42 # otherwise cause performance problems for the file system.
46 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
47 # documentation generated by doxygen is written. Doxygen will use this
48 # information to generate all constant output in the proper language.
49 # The default language is English, other supported languages are:
50 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
51 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
52 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
53 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
54 # Swedish, and Ukrainian.
56 OUTPUT_LANGUAGE = English
58 # This tag can be used to specify the encoding used in the generated output.
59 # The encoding is not always determined by the language that is chosen,
60 # but also whether or not the output is meant for Windows or non-Windows users.
61 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
62 # forces the Windows encoding (this is the default for the Windows binary),
63 # whereas setting the tag to NO uses a Unix-style encoding (the default for
64 # all platforms other than Windows).
66 USE_WINDOWS_ENCODING = NO
68 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
69 # include brief member descriptions after the members that are listed in
70 # the file and class documentation (similar to JavaDoc).
71 # Set to NO to disable this.
73 BRIEF_MEMBER_DESC = YES
75 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
76 # the brief description of a member or function before the detailed description.
77 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
78 # brief descriptions will be completely suppressed.
82 # This tag implements a quasi-intelligent brief description abbreviator
83 # that is used to form the text in various listings. Each string
84 # in this list, if found as the leading text of the brief description, will be
85 # stripped from the text and the result after processing the whole list, is
86 # used as the annotated text. Otherwise, the brief description is used as-is.
87 # If left blank, the following values are used ("$name" is automatically
88 # replaced with the name of the entity): "The $name class" "The $name widget"
89 # "The $name file" "is" "provides" "specifies" "contains"
90 # "represents" "a" "an" "the"
94 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
95 # Doxygen will generate a detailed section even if there is only a brief
98 ALWAYS_DETAILED_SEC = NO
100 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
101 # inherited members of a class in the documentation of that class as if those
102 # members were ordinary class members. Constructors, destructors and assignment
103 # operators of the base classes will not be shown.
105 INLINE_INHERITED_MEMB = NO
107 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
108 # path before files name in the file list and in the header files. If set
109 # to NO the shortest path that makes the file name unique will be used.
111 FULL_PATH_NAMES = YES
113 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
114 # can be used to strip a user-defined part of the path. Stripping is
115 # only done if one of the specified strings matches the left-hand part of
116 # the path. The tag can be used to show relative paths in the file list.
117 # If left blank the directory from which doxygen is run is used as the
120 STRIP_FROM_PATH = @BIND9_TOP_BUILDDIR@/
122 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
123 # the path mentioned in the documentation of a class, which tells
124 # the reader which header file to include in order to use a class.
125 # If left blank only the name of the header file containing the class
126 # definition is used. Otherwise one should specify the include paths that
127 # are normally passed to the compiler using the -I flag.
129 STRIP_FROM_INC_PATH =
131 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
132 # (but less readable) file names. This can be useful is your file systems
133 # doesn't support long names like on DOS, Mac, or CD-ROM.
137 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
138 # will interpret the first line (until the first dot) of a JavaDoc-style
139 # comment as the brief description. If set to NO, the JavaDoc
140 # comments will behave just like the Qt-style comments (thus requiring an
141 # explicit @brief command for a brief description.
143 JAVADOC_AUTOBRIEF = NO
145 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
146 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
147 # comments) as a brief description. This used to be the default behaviour.
148 # The new default is to treat a multi-line C++ comment block as a detailed
149 # description. Set this tag to YES if you prefer the old behaviour instead.
151 MULTILINE_CPP_IS_BRIEF = NO
153 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
154 # will output the detailed description near the top, like JavaDoc.
155 # If set to NO, the detailed description appears after the member
160 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
161 # member inherits the documentation from any documented member that it
166 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
167 # a new page for each member. If set to NO, the documentation of a member will
168 # be part of the file/class/namespace that contains it.
170 SEPARATE_MEMBER_PAGES = NO
172 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
173 # Doxygen uses this value to replace tabs by spaces in code fragments.
177 # This tag can be used to specify a number of aliases that acts
178 # as commands in the documentation. An alias has the form "name=value".
179 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
180 # put the command \sideeffect (or @sideeffect) in the documentation, which
181 # will result in a user-defined paragraph with heading "Side Effects:".
182 # You can put \n's in the value part of an alias to insert newlines.
186 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
187 # sources only. Doxygen will then generate output that is more tailored for C.
188 # For instance, some of the names that are used will be different. The list
189 # of all members will be omitted, etc.
191 OPTIMIZE_OUTPUT_FOR_C = YES
193 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
194 # sources only. Doxygen will then generate output that is more tailored for Java.
195 # For instance, namespaces will be presented as packages, qualified scopes
196 # will look different, etc.
198 OPTIMIZE_OUTPUT_JAVA = NO
200 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
201 # include (a tag file for) the STL sources as input, then you should
202 # set this tag to YES in order to let doxygen match functions declarations and
203 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
204 # func(std::string) {}). This also make the inheritance and collaboration
205 # diagrams that involve STL classes more complete and accurate.
207 BUILTIN_STL_SUPPORT = NO
209 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
210 # tag is set to YES, then doxygen will reuse the documentation of the first
211 # member in the group (if any) for the other members of the group. By default
212 # all members of a group must be documented explicitly.
214 DISTRIBUTE_GROUP_DOC = YES
216 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
217 # the same type (for instance a group of public functions) to be put as a
218 # subgroup of that type (e.g. under the Public Functions section). Set it to
219 # NO to prevent subgrouping. Alternatively, this can be done per class using
220 # the \nosubgrouping command.
224 #---------------------------------------------------------------------------
225 # Build related configuration options
226 #---------------------------------------------------------------------------
228 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
229 # documentation are documented, even if no documentation was available.
230 # Private class members and static file members will be hidden unless
231 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
235 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
236 # will be included in the documentation.
238 EXTRACT_PRIVATE = YES
240 # If the EXTRACT_STATIC tag is set to YES all static members of a file
241 # will be included in the documentation.
245 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
246 # defined locally in source files will be included in the documentation.
247 # If set to NO only classes defined in header files are included.
249 EXTRACT_LOCAL_CLASSES = YES
251 # This flag is only useful for Objective-C code. When set to YES local
252 # methods, which are defined in the implementation section but not in
253 # the interface are included in the documentation.
254 # If set to NO (the default) only methods in the interface are included.
256 EXTRACT_LOCAL_METHODS = YES
258 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
259 # undocumented members of documented classes, files or namespaces.
260 # If set to NO (the default) these members will be included in the
261 # various overviews, but no documentation section is generated.
262 # This option has no effect if EXTRACT_ALL is enabled.
264 HIDE_UNDOC_MEMBERS = NO
266 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
267 # undocumented classes that are normally visible in the class hierarchy.
268 # If set to NO (the default) these classes will be included in the various
269 # overviews. This option has no effect if EXTRACT_ALL is enabled.
271 HIDE_UNDOC_CLASSES = NO
273 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
274 # friend (class|struct|union) declarations.
275 # If set to NO (the default) these declarations will be included in the
278 HIDE_FRIEND_COMPOUNDS = NO
280 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
281 # documentation blocks found inside the body of a function.
282 # If set to NO (the default) these blocks will be appended to the
283 # function's detailed documentation block.
285 HIDE_IN_BODY_DOCS = NO
287 # The INTERNAL_DOCS tag determines if documentation
288 # that is typed after a \internal command is included. If the tag is set
289 # to NO (the default) then the documentation will be excluded.
290 # Set it to YES to include the internal documentation.
294 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
295 # file names in lower-case letters. If set to YES upper-case letters are also
296 # allowed. This is useful if you have classes or files whose names only differ
297 # in case and if your file system supports case sensitive file names. Windows
298 # and Mac users are advised to set this option to NO.
300 CASE_SENSE_NAMES = YES
302 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
303 # will show members with their full class and namespace scopes in the
304 # documentation. If set to YES the scope will be hidden.
306 HIDE_SCOPE_NAMES = NO
308 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
309 # will put a list of the files that are included by a file in the documentation
312 SHOW_INCLUDE_FILES = YES
314 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
315 # is inserted in the documentation for inline members.
319 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
320 # will sort the (detailed) documentation of file and class members
321 # alphabetically by member name. If set to NO the members will appear in
324 SORT_MEMBER_DOCS = NO
326 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
327 # brief documentation of file, namespace and class members alphabetically
328 # by member name. If set to NO (the default) the members will appear in
333 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
334 # sorted by fully-qualified names, including namespaces. If set to
335 # NO (the default), the class list will be sorted only by class name,
336 # not including the namespace part.
337 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
338 # Note: This option applies only to the class list, not to the
341 SORT_BY_SCOPE_NAME = NO
343 # The GENERATE_TODOLIST tag can be used to enable (YES) or
344 # disable (NO) the todo list. This list is created by putting \todo
345 # commands in the documentation.
347 GENERATE_TODOLIST = YES
349 # The GENERATE_TESTLIST tag can be used to enable (YES) or
350 # disable (NO) the test list. This list is created by putting \test
351 # commands in the documentation.
353 GENERATE_TESTLIST = YES
355 # The GENERATE_BUGLIST tag can be used to enable (YES) or
356 # disable (NO) the bug list. This list is created by putting \bug
357 # commands in the documentation.
359 GENERATE_BUGLIST = YES
361 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
362 # disable (NO) the deprecated list. This list is created by putting
363 # \deprecated commands in the documentation.
365 GENERATE_DEPRECATEDLIST= YES
367 # The ENABLED_SECTIONS tag can be used to enable conditional
368 # documentation sections, marked by \if sectionname ... \endif.
372 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
373 # the initial value of a variable or define consists of for it to appear in
374 # the documentation. If the initializer consists of more lines than specified
375 # here it will be hidden. Use a value of 0 to hide initializers completely.
376 # The appearance of the initializer of individual variables and defines in the
377 # documentation can be controlled using \showinitializer or \hideinitializer
378 # command in the documentation regardless of this setting.
380 MAX_INITIALIZER_LINES = 30
382 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
383 # at the bottom of the documentation of classes and structs. If set to YES the
384 # list will mention the files that were used to generate the documentation.
386 SHOW_USED_FILES = YES
388 # If the sources in your project are distributed over multiple directories
389 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
390 # in the documentation. The default is NO.
392 SHOW_DIRECTORIES = YES
394 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
395 # doxygen should invoke to get the current version for each file (typically from the
396 # version control system). Doxygen will invoke the program by executing (via
397 # popen()) the command <command> <input-file>, where <command> is the value of
398 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
399 # provided by doxygen. Whatever the program writes to standard output
400 # is used as the file version. See the manual for examples.
402 FILE_VERSION_FILTER =
404 #---------------------------------------------------------------------------
405 # configuration options related to warning and progress messages
406 #---------------------------------------------------------------------------
408 # The QUIET tag can be used to turn on/off the messages that are generated
409 # by doxygen. Possible values are YES and NO. If left blank NO is used.
413 # The WARNINGS tag can be used to turn on/off the warning messages that are
414 # generated by doxygen. Possible values are YES and NO. If left blank
419 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
420 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
421 # automatically be disabled.
423 WARN_IF_UNDOCUMENTED = YES
425 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
426 # potential errors in the documentation, such as not documenting some
427 # parameters in a documented function, or documenting parameters that
428 # don't exist or using markup commands wrongly.
430 WARN_IF_DOC_ERROR = YES
432 # This WARN_NO_PARAMDOC option can be abled to get warnings for
433 # functions that are documented, but have no documentation for their parameters
434 # or return value. If set to NO (the default) doxygen will only warn about
435 # wrong or incomplete parameter documentation, but not about the absence of
438 WARN_NO_PARAMDOC = YES
440 # The WARN_FORMAT tag determines the format of the warning messages that
441 # doxygen can produce. The string should contain the $file, $line, and $text
442 # tags, which will be replaced by the file and line number from which the
443 # warning originated and the warning text. Optionally the format may contain
444 # $version, which will be replaced by the version of the file (if it could
445 # be obtained via FILE_VERSION_FILTER)
447 WARN_FORMAT = "$file:$line: $text"
449 # The WARN_LOGFILE tag can be used to specify a file to which warning
450 # and error messages should be written. If left blank the output is written
455 #---------------------------------------------------------------------------
456 # configuration options related to the input files
457 #---------------------------------------------------------------------------
459 # The INPUT tag can be used to specify the files and/or directories that contain
460 # documented source files. You may enter file names like "myfile.cpp" or
461 # directories like "/usr/src/myproject". Separate the files or directories
464 INPUT = @BIND9_TOP_BUILDDIR@/lib/isc \
465 @BIND9_TOP_BUILDDIR@/lib/dns \
466 @BIND9_TOP_BUILDDIR@/lib/isccfg \
467 @BIND9_TOP_BUILDDIR@/lib/isccc \
468 @BIND9_TOP_BUILDDIR@/lib/bind9 \
469 @BIND9_TOP_BUILDDIR@/bin/check \
470 @BIND9_TOP_BUILDDIR@/bin/dig \
471 @BIND9_TOP_BUILDDIR@/bin/dnssec \
472 @BIND9_TOP_BUILDDIR@/bin/named \
473 @BIND9_TOP_BUILDDIR@/bin/nsupdate \
474 @BIND9_TOP_BUILDDIR@/bin/rndc \
475 @BIND9_TOP_BUILDDIR@/doc/doxygen/mainpage
477 # If the value of the INPUT tag contains directories, you can use the
478 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
479 # and *.h) to filter out the source-files in the directories. If left
480 # blank the following patterns are tested:
481 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
482 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
484 FILE_PATTERNS = *.c *.h *.dox
486 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
487 # should be searched for input files as well. Possible values are YES and NO.
488 # If left blank NO is used.
492 # The EXCLUDE tag can be used to specify files and/or directories that should
493 # excluded from the INPUT source files. This way you can easily exclude a
494 # subdirectory from a directory tree whose root is specified with the INPUT tag.
498 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
499 # directories that are symbolic links (a Unix filesystem feature) are excluded
502 EXCLUDE_SYMLINKS = NO
504 # If the value of the INPUT tag contains directories, you can use the
505 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
506 # certain files from those directories. Note that the wildcards are matched
507 # against the file with absolute path, so to exclude all test directories
508 # for example use the pattern */test/*
510 EXCLUDE_PATTERNS = */win32/* */lib/dns/gen* */lib/dns/rdata/*.h
512 # The EXAMPLE_PATH tag can be used to specify one or more files or
513 # directories that contain example code fragments that are included (see
514 # the \include command).
518 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
519 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
520 # and *.h) to filter out the source-files in the directories. If left
521 # blank all files are included.
525 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
526 # searched for input files to be used with the \include or \dontinclude
527 # commands irrespective of the value of the RECURSIVE tag.
528 # Possible values are YES and NO. If left blank NO is used.
530 EXAMPLE_RECURSIVE = NO
532 # The IMAGE_PATH tag can be used to specify one or more files or
533 # directories that contain image that are included in the documentation (see
534 # the \image command).
538 # The INPUT_FILTER tag can be used to specify a program that doxygen should
539 # invoke to filter for each input file. Doxygen will invoke the filter program
540 # by executing (via popen()) the command <filter> <input-file>, where <filter>
541 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
542 # input file. Doxygen will then use the output that the filter program writes
543 # to standard output. If FILTER_PATTERNS is specified, this tag will be
546 INPUT_FILTER = ./doxygen-input-filter
548 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
549 # basis. Doxygen will compare the file name with each pattern and apply the
550 # filter if there is a match. The filters are a list of the form:
551 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
552 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
553 # is applied to all files.
557 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
558 # INPUT_FILTER) will be used to filter the input files when producing source
559 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
561 FILTER_SOURCE_FILES = NO
563 #---------------------------------------------------------------------------
564 # configuration options related to source browsing
565 #---------------------------------------------------------------------------
567 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
568 # be generated. Documented entities will be cross-referenced with these sources.
569 # Note: To get rid of all source code in the generated output, make sure also
570 # VERBATIM_HEADERS is set to NO.
574 # Setting the INLINE_SOURCES tag to YES will include the body
575 # of functions and classes directly in the documentation.
579 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
580 # doxygen to hide any special comment blocks from generated source code
581 # fragments. Normal C and C++ comments will always remain visible.
583 STRIP_CODE_COMMENTS = NO
585 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
586 # then for each documented function all documented
587 # functions referencing it will be listed.
589 REFERENCED_BY_RELATION = YES
591 # If the REFERENCES_RELATION tag is set to YES (the default)
592 # then for each documented function all documented entities
593 # called/used by that function will be listed.
595 REFERENCES_RELATION = YES
597 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
598 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
599 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
600 # link to the source code. Otherwise they will link to the documentstion.
602 REFERENCES_LINK_SOURCE = YES
604 # If the USE_HTAGS tag is set to YES then the references to source code
605 # will point to the HTML generated by the htags(1) tool instead of doxygen
606 # built-in source browser. The htags tool is part of GNU's global source
607 # tagging system (see http://www.gnu.org/software/global/global.html). You
608 # will need version 4.8.6 or higher.
612 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
613 # will generate a verbatim copy of the header file for each class for
614 # which an include is specified. Set to NO to disable this.
616 VERBATIM_HEADERS = YES
618 #---------------------------------------------------------------------------
619 # configuration options related to the alphabetical class index
620 #---------------------------------------------------------------------------
622 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
623 # of all compounds will be generated. Enable this if the project
624 # contains a lot of classes, structs, unions or interfaces.
626 ALPHABETICAL_INDEX = YES
628 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
629 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
630 # in which this list will be split (can be a number in the range [1..20])
632 COLS_IN_ALPHA_INDEX = 5
634 # In case all classes in a project start with a common prefix, all
635 # classes will be put under the same header in the alphabetical index.
636 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
637 # should be ignored while generating the index headers.
641 #---------------------------------------------------------------------------
642 # configuration options related to the HTML output
643 #---------------------------------------------------------------------------
645 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
646 # generate HTML output.
650 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
651 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
652 # put in front of it. If left blank `html' will be used as the default path.
656 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
657 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
658 # doxygen will generate files with .html extension.
660 HTML_FILE_EXTENSION = .html
662 # The HTML_HEADER tag can be used to specify a personal HTML header for
663 # each generated HTML page. If it is left blank doxygen will generate a
666 HTML_HEADER = isc-header.html
668 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
669 # each generated HTML page. If it is left blank doxygen will generate a
672 HTML_FOOTER = isc-footer.html
674 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
675 # style sheet that is used by each HTML page. It can be used to
676 # fine-tune the look of the HTML output. If the tag is left blank doxygen
677 # will generate a default style sheet. Note that doxygen will try to copy
678 # the style sheet file to the HTML output directory, so don't put your own
679 # stylesheet in the HTML output directory as well, or it will be erased!
683 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
684 # files or namespaces will be aligned in HTML using tables. If set to
685 # NO a bullet list will be used.
687 HTML_ALIGN_MEMBERS = YES
689 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
690 # will be generated that can be used as input for tools like the
691 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
692 # of the generated HTML documentation.
694 GENERATE_HTMLHELP = NO
696 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
697 # be used to specify the file name of the resulting .chm file. You
698 # can add a path in front of the file if the result should not be
699 # written to the html output directory.
703 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
704 # be used to specify the location (absolute path including file name) of
705 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
706 # the HTML help compiler on the generated index.hhp.
710 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
711 # controls if a separate .chi index file is generated (YES) or that
712 # it should be included in the master .chm file (NO).
716 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
717 # controls whether a binary table of contents is generated (YES) or a
718 # normal table of contents (NO) in the .chm file.
722 # The TOC_EXPAND flag can be set to YES to add extra items for group members
723 # to the contents of the HTML help documentation and to the tree view.
727 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
728 # top of each HTML page. The value NO (the default) enables the index and
729 # the value YES disables it.
733 # This tag can be used to set the number of enum values (range [1..20])
734 # that doxygen will group on one line in the generated HTML documentation.
736 ENUM_VALUES_PER_LINE = 4
738 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
739 # generated containing a tree-like index structure (just like the one that
740 # is generated for HTML Help). For this to work a browser that supports
741 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
742 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
743 # probably better off using the HTML help feature.
745 GENERATE_TREEVIEW = NO
747 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
748 # used to set the initial width (in pixels) of the frame in which the tree
753 #---------------------------------------------------------------------------
754 # configuration options related to the LaTeX output
755 #---------------------------------------------------------------------------
757 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
758 # generate Latex output.
762 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
763 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
764 # put in front of it. If left blank `latex' will be used as the default path.
768 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
769 # invoked. If left blank `latex' will be used as the default command name.
771 LATEX_CMD_NAME = latex
773 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
774 # generate index for LaTeX. If left blank `makeindex' will be used as the
775 # default command name.
777 MAKEINDEX_CMD_NAME = makeindex
779 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
780 # LaTeX documents. This may be useful for small projects and may help to
781 # save some trees in general.
785 # The PAPER_TYPE tag can be used to set the paper type that is used
786 # by the printer. Possible values are: a4, a4wide, letter, legal and
787 # executive. If left blank a4wide will be used.
791 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
792 # packages that should be included in the LaTeX output.
796 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
797 # the generated latex document. The header should contain everything until
798 # the first chapter. If it is left blank doxygen will generate a
799 # standard header. Notice: only use this tag if you know what you are doing!
803 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
804 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
805 # contain links (just like the HTML output) instead of page references
806 # This makes the output suitable for online browsing using a pdf viewer.
810 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
811 # plain latex in the generated Makefile. Set this option to YES to get a
812 # higher quality PDF documentation.
816 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
817 # command to the generated LaTeX files. This will instruct LaTeX to keep
818 # running if errors occur, instead of asking the user for help.
819 # This option is also used when generating formulas in HTML.
821 LATEX_BATCHMODE = YES
823 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
824 # include the index chapters (such as File Index, Compound Index, etc.)
827 LATEX_HIDE_INDICES = YES
829 #---------------------------------------------------------------------------
830 # configuration options related to the RTF output
831 #---------------------------------------------------------------------------
833 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
834 # The RTF output is optimized for Word 97 and may not look very pretty with
835 # other RTF readers or editors.
839 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
840 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
841 # put in front of it. If left blank `rtf' will be used as the default path.
845 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
846 # RTF documents. This may be useful for small projects and may help to
847 # save some trees in general.
851 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
852 # will contain hyperlink fields. The RTF file will
853 # contain links (just like the HTML output) instead of page references.
854 # This makes the output suitable for online browsing using WORD or other
855 # programs which support those fields.
856 # Note: wordpad (write) and others do not support links.
860 # Load stylesheet definitions from file. Syntax is similar to doxygen's
861 # config file, i.e. a series of assignments. You only have to provide
862 # replacements, missing definitions are set to their default value.
864 RTF_STYLESHEET_FILE =
866 # Set optional variables used in the generation of an rtf document.
867 # Syntax is similar to doxygen's config file.
869 RTF_EXTENSIONS_FILE =
871 #---------------------------------------------------------------------------
872 # configuration options related to the man page output
873 #---------------------------------------------------------------------------
875 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
880 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
881 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
882 # put in front of it. If left blank `man' will be used as the default path.
886 # The MAN_EXTENSION tag determines the extension that is added to
887 # the generated man pages (default is the subroutine's section .3)
891 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
892 # then it will generate one additional man file for each entity
893 # documented in the real man page(s). These additional files
894 # only source the real man page, but without them the man command
895 # would be unable to find the correct page. The default is NO.
899 #---------------------------------------------------------------------------
900 # configuration options related to the XML output
901 #---------------------------------------------------------------------------
903 # If the GENERATE_XML tag is set to YES Doxygen will
904 # generate an XML file that captures the structure of
905 # the code including all documentation.
909 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
910 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
911 # put in front of it. If left blank `xml' will be used as the default path.
915 # The XML_SCHEMA tag can be used to specify an XML schema,
916 # which can be used by a validating XML parser to check the
917 # syntax of the XML files.
921 # The XML_DTD tag can be used to specify an XML DTD,
922 # which can be used by a validating XML parser to check the
923 # syntax of the XML files.
927 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
928 # dump the program listings (including syntax highlighting
929 # and cross-referencing information) to the XML output. Note that
930 # enabling this will significantly increase the size of the XML output.
932 XML_PROGRAMLISTING = YES
934 #---------------------------------------------------------------------------
935 # configuration options for the AutoGen Definitions output
936 #---------------------------------------------------------------------------
938 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
939 # generate an AutoGen Definitions (see autogen.sf.net) file
940 # that captures the structure of the code including all
941 # documentation. Note that this feature is still experimental
942 # and incomplete at the moment.
944 GENERATE_AUTOGEN_DEF = NO
946 #---------------------------------------------------------------------------
947 # configuration options related to the Perl module output
948 #---------------------------------------------------------------------------
950 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
951 # generate a Perl module file that captures the structure of
952 # the code including all documentation. Note that this
953 # feature is still experimental and incomplete at the
956 GENERATE_PERLMOD = NO
958 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
959 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
960 # to generate PDF and DVI output from the Perl module output.
964 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
965 # nicely formatted so it can be parsed by a human reader. This is useful
966 # if you want to understand what is going on. On the other hand, if this
967 # tag is set to NO the size of the Perl module output will be much smaller
968 # and Perl will parse it just the same.
972 # The names of the make variables in the generated doxyrules.make file
973 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
974 # This is useful so different doxyrules.make files included by the same
975 # Makefile don't overwrite each other's variables.
977 PERLMOD_MAKEVAR_PREFIX =
979 #---------------------------------------------------------------------------
980 # Configuration options related to the preprocessor
981 #---------------------------------------------------------------------------
983 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
984 # evaluate all C-preprocessor directives found in the sources and include
987 ENABLE_PREPROCESSING = YES
989 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
990 # names in the source code. If set to NO (the default) only conditional
991 # compilation will be performed. Macro expansion can be done in a controlled
992 # way by setting EXPAND_ONLY_PREDEF to YES.
996 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
997 # then the macro expansion is limited to the macros specified with the
998 # PREDEFINED and EXPAND_AS_DEFINED tags.
1000 EXPAND_ONLY_PREDEF = NO
1002 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1003 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1005 SEARCH_INCLUDES = YES
1007 # The INCLUDE_PATH tag can be used to specify one or more directories that
1008 # contain include files that are not input files but should be processed by
1013 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1014 # patterns (like *.h and *.hpp) to filter out the header-files in the
1015 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1018 INCLUDE_FILE_PATTERNS =
1020 # The PREDEFINED tag can be used to specify one or more macro names that
1021 # are defined before the preprocessor is started (similar to the -D option of
1022 # gcc). The argument of the tag is a list of macros of the form: name
1023 # or name=definition (no spaces). If the definition and the = are
1024 # omitted =1 is assumed. To prevent a macro definition from being
1025 # undefined via #undef or recursively expanded use the := operator
1026 # instead of the = operator.
1030 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1031 # this tag can be used to specify a list of macro names that should be expanded.
1032 # The macro definition that is found in the sources will be used.
1033 # Use the PREDEFINED tag if you want to use a different macro definition.
1037 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1038 # doxygen's preprocessor will remove all function-like macros that are alone
1039 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1040 # function macros are typically used for boiler-plate code, and will confuse
1041 # the parser if not removed.
1043 SKIP_FUNCTION_MACROS = YES
1045 #---------------------------------------------------------------------------
1046 # Configuration::additions related to external references
1047 #---------------------------------------------------------------------------
1049 # The TAGFILES option can be used to specify one or more tagfiles.
1050 # Optionally an initial location of the external documentation
1051 # can be added for each tagfile. The format of a tag file without
1052 # this location is as follows:
1053 # TAGFILES = file1 file2 ...
1054 # Adding location for the tag files is done as follows:
1055 # TAGFILES = file1=loc1 "file2 = loc2" ...
1056 # where "loc1" and "loc2" can be relative or absolute paths or
1057 # URLs. If a location is present for each tag, the installdox tool
1058 # does not have to be run to correct the links.
1059 # Note that each tag file must have a unique name
1060 # (where the name does NOT include the path)
1061 # If a tag file is not located in the directory in which doxygen
1062 # is run, you must also specify the path to the tagfile here.
1066 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1067 # a tag file that is based on the input files it reads.
1071 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1072 # in the class index. If set to NO only the inherited external classes
1077 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1078 # in the modules index. If set to NO, only the current project's groups will
1081 EXTERNAL_GROUPS = YES
1083 # The PERL_PATH should be the absolute path and name of the perl script
1084 # interpreter (i.e. the result of `which perl').
1088 #---------------------------------------------------------------------------
1089 # Configuration options related to the dot tool
1090 #---------------------------------------------------------------------------
1092 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1093 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1094 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1095 # this option is superseded by the HAVE_DOT option below. This is only a
1096 # fallback. It is recommended to install and use dot, since it yields more
1099 CLASS_DIAGRAMS = YES
1101 # If set to YES, the inheritance and collaboration graphs will hide
1102 # inheritance and usage relations if the target is undocumented
1103 # or is not a class.
1105 HIDE_UNDOC_RELATIONS = YES
1107 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1108 # available from the path. This tool is part of Graphviz, a graph visualization
1109 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1110 # have no effect if this option is set to NO (the default)
1114 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1115 # will generate a graph for each documented class showing the direct and
1116 # indirect inheritance relations. Setting this tag to YES will force the
1117 # the CLASS_DIAGRAMS tag to NO.
1121 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1122 # will generate a graph for each documented class showing the direct and
1123 # indirect implementation dependencies (inheritance, containment, and
1124 # class references variables) of the class with other documented classes.
1126 COLLABORATION_GRAPH = YES
1128 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1129 # will generate a graph for groups, showing the direct groups dependencies
1133 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1134 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1139 # If set to YES, the inheritance and collaboration graphs will show the
1140 # relations between templates and their instances.
1142 TEMPLATE_RELATIONS = NO
1144 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1145 # tags are set to YES then doxygen will generate a graph for each documented
1146 # file showing the direct and indirect include dependencies of the file with
1147 # other documented files.
1151 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1152 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1153 # documented header file showing the documented files that directly or
1154 # indirectly include this file.
1156 INCLUDED_BY_GRAPH = YES
1158 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1159 # generate a call dependency graph for every global function or class method.
1160 # Note that enabling this option will significantly increase the time of a run.
1161 # So in most cases it will be better to enable call graphs for selected
1162 # functions only using the \callgraph command.
1166 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1167 # generate a caller dependency graph for every global function or class method.
1168 # Note that enabling this option will significantly increase the time of a run.
1169 # So in most cases it will be better to enable caller graphs for selected
1170 # functions only using the \callergraph command.
1174 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1175 # will graphical hierarchy of all classes instead of a textual one.
1177 GRAPHICAL_HIERARCHY = YES
1179 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1180 # then doxygen will show the dependencies a directory has on other directories
1181 # in a graphical way. The dependency relations are determined by the #include
1182 # relations between the files in the directories.
1184 DIRECTORY_GRAPH = YES
1186 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1187 # generated by dot. Possible values are png, jpg, or gif
1188 # If left blank png will be used.
1190 DOT_IMAGE_FORMAT = png
1192 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1193 # found. If left blank, it is assumed the dot tool can be found in the path.
1197 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1198 # contain dot files that are included in the documentation (see the
1199 # \dotfile command).
1203 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1204 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1205 # this value, doxygen will try to truncate the graph, so that it fits within
1206 # the specified constraint. Beware that most browsers cannot cope with very
1209 MAX_DOT_GRAPH_WIDTH = 1024
1211 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1212 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1213 # this value, doxygen will try to truncate the graph, so that it fits within
1214 # the specified constraint. Beware that most browsers cannot cope with very
1217 MAX_DOT_GRAPH_HEIGHT = 1024
1219 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1220 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1221 # from the root by following a path via at most 3 edges will be shown. Nodes
1222 # that lay further from the root node will be omitted. Note that setting this
1223 # option to 1 or 2 may greatly reduce the computation time needed for large
1224 # code bases. Also note that a graph may be further truncated if the graph's
1225 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1226 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1227 # the graph is not depth-constrained.
1229 MAX_DOT_GRAPH_DEPTH = 1000
1231 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1232 # background. This is disabled by default, which results in a white background.
1233 # Warning: Depending on the platform used, enabling this option may lead to
1234 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1237 DOT_TRANSPARENT = NO
1239 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1240 # files in one run (i.e. multiple -o and -T options on the command line). This
1241 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1242 # support this, this feature is disabled by default.
1244 DOT_MULTI_TARGETS = YES
1246 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1247 # generate a legend page explaining the meaning of the various boxes and
1248 # arrows in the dot generated graphs.
1250 GENERATE_LEGEND = YES
1252 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1253 # remove the intermediate dot files that are used to generate
1254 # the various graphs.
1258 #---------------------------------------------------------------------------
1259 # Configuration::additions related to the search engine
1260 #---------------------------------------------------------------------------
1262 # The SEARCHENGINE tag specifies whether or not a search engine should be
1263 # used. If set to NO the values of all tags below this one will be ignored.
1268 # compile-command: "doxygen"