4
# This file describes the settings to be used by the documentation system
5
# doxygen (www.doxygen.org) for a project
7
# All text after a hash (#) is considered a comment and will be ignored
9
# TAG = value [value, ...]
10
# For lists items can also be appended using:
11
# TAG += value [value, ...]
12
# Values that contain spaces should be placed between quotes (" ")
14
#---------------------------------------------------------------------------
15
# Project related configuration options
16
#---------------------------------------------------------------------------
18
# This tag specifies the encoding used for all characters in the config file that
19
# follow. The default is UTF-8 which is also the encoding used for all text before
20
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
21
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
24
DOXYFILE_ENCODING = UTF-8
26
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
27
# by quotes) that should identify the project.
29
PROJECT_NAME = @PACKAGE_NAME@
31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32
# This could be handy for archiving the generated documentation or
33
# if some version control system is used.
35
PROJECT_NUMBER = @PACKAGE_VERSION@
37
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
38
# base path where the generated documentation will be put.
39
# If a relative path is entered, it will be relative to the location
40
# where doxygen was started. If left blank the current directory will be used.
42
OUTPUT_DIRECTORY = @abs_top_builddir@/doc
44
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
45
# 4096 sub-directories (in 2 levels) under the output directory of each output
46
# format and will distribute the generated files over these directories.
47
# Enabling this option can be useful when feeding doxygen a huge amount of
48
# source files, where putting all generated files in the same directory would
49
# otherwise cause performance problems for the file system.
53
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
54
# documentation generated by doxygen is written. Doxygen will use this
55
# information to generate all constant output in the proper language.
56
# The default language is English, other supported languages are:
57
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
58
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
59
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
60
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
61
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
63
OUTPUT_LANGUAGE = English
65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66
# include brief member descriptions after the members that are listed in
67
# the file and class documentation (similar to JavaDoc).
68
# Set to NO to disable this.
70
BRIEF_MEMBER_DESC = YES
72
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73
# the brief description of a member or function before the detailed description.
74
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75
# brief descriptions will be completely suppressed.
79
# This tag implements a quasi-intelligent brief description abbreviator
80
# that is used to form the text in various listings. Each string
81
# in this list, if found as the leading text of the brief description, will be
82
# stripped from the text and the result after processing the whole list, is
83
# used as the annotated text. Otherwise, the brief description is used as-is.
84
# If left blank, the following values are used ("$name" is automatically
85
# replaced with the name of the entity): "The $name class" "The $name widget"
86
# "The $name file" "is" "provides" "specifies" "contains"
87
# "represents" "a" "an" "the"
89
ABBREVIATE_BRIEF = "The $name class" \
101
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102
# Doxygen will generate a detailed section even if there is only a brief
105
ALWAYS_DETAILED_SEC = NO
107
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108
# inherited members of a class in the documentation of that class as if those
109
# members were ordinary class members. Constructors, destructors and assignment
110
# operators of the base classes will not be shown.
112
INLINE_INHERITED_MEMB = NO
114
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115
# path before files name in the file list and in the header files. If set
116
# to NO the shortest path that makes the file name unique will be used.
120
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121
# can be used to strip a user-defined part of the path. Stripping is
122
# only done if one of the specified strings matches the left-hand part of
123
# the path. The tag can be used to show relative paths in the file list.
124
# If left blank the directory from which doxygen is run is used as the
129
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130
# the path mentioned in the documentation of a class, which tells
131
# the reader which header file to include in order to use a class.
132
# If left blank only the name of the header file containing the class
133
# definition is used. Otherwise one should specify the include paths that
134
# are normally passed to the compiler using the -I flag.
136
STRIP_FROM_INC_PATH =
138
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139
# (but less readable) file names. This can be useful is your file systems
140
# doesn't support long names like on DOS, Mac, or CD-ROM.
144
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145
# will interpret the first line (until the first dot) of a JavaDoc-style
146
# comment as the brief description. If set to NO, the JavaDoc
147
# comments will behave just like the Qt-style comments (thus requiring an
148
# explicit @brief command for a brief description.
150
JAVADOC_AUTOBRIEF = YES
152
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
153
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
154
# comments) as a brief description. This used to be the default behaviour.
155
# The new default is to treat a multi-line C++ comment block as a detailed
156
# description. Set this tag to YES if you prefer the old behaviour instead.
158
MULTILINE_CPP_IS_BRIEF = NO
160
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
161
# will output the detailed description near the top, like JavaDoc.
162
# If set to NO, the detailed description appears after the member
167
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
168
# member inherits the documentation from any documented member that it
173
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
174
# a new page for each member. If set to NO, the documentation of a member will
175
# be part of the file/class/namespace that contains it.
177
SEPARATE_MEMBER_PAGES = NO
179
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
180
# Doxygen uses this value to replace tabs by spaces in code fragments.
184
# This tag can be used to specify a number of aliases that acts
185
# as commands in the documentation. An alias has the form "name=value".
186
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
187
# put the command \sideeffect (or @sideeffect) in the documentation, which
188
# will result in a user-defined paragraph with heading "Side Effects:".
189
# You can put \n's in the value part of an alias to insert newlines.
193
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
194
# sources only. Doxygen will then generate output that is more tailored for C.
195
# For instance, some of the names that are used will be different. The list
196
# of all members will be omitted, etc.
198
OPTIMIZE_OUTPUT_FOR_C = YES
200
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
201
# sources only. Doxygen will then generate output that is more tailored for Java.
202
# For instance, namespaces will be presented as packages, qualified scopes
203
# will look different, etc.
205
OPTIMIZE_OUTPUT_JAVA = NO
207
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
208
# include (a tag file for) the STL sources as input, then you should
209
# set this tag to YES in order to let doxygen match functions declarations and
210
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
211
# func(std::string) {}). This also make the inheritance and collaboration
212
# diagrams that involve STL classes more complete and accurate.
214
BUILTIN_STL_SUPPORT = NO
216
# If you use Microsoft's C++/CLI language, you should set this option to YES to
217
# enable parsing support.
221
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
222
# tag is set to YES, then doxygen will reuse the documentation of the first
223
# member in the group (if any) for the other members of the group. By default
224
# all members of a group must be documented explicitly.
226
DISTRIBUTE_GROUP_DOC = NO
228
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
229
# the same type (for instance a group of public functions) to be put as a
230
# subgroup of that type (e.g. under the Public Functions section). Set it to
231
# NO to prevent subgrouping. Alternatively, this can be done per class using
232
# the \nosubgrouping command.
236
#---------------------------------------------------------------------------
237
# Build related configuration options
238
#---------------------------------------------------------------------------
240
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
241
# documentation are documented, even if no documentation was available.
242
# Private class members and static file members will be hidden unless
243
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
247
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
248
# will be included in the documentation.
252
# If the EXTRACT_STATIC tag is set to YES all static members of a file
253
# will be included in the documentation.
257
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
258
# defined locally in source files will be included in the documentation.
259
# If set to NO only classes defined in header files are included.
261
EXTRACT_LOCAL_CLASSES = YES
263
# This flag is only useful for Objective-C code. When set to YES local
264
# methods, which are defined in the implementation section but not in
265
# the interface are included in the documentation.
266
# If set to NO (the default) only methods in the interface are included.
268
EXTRACT_LOCAL_METHODS = NO
270
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
271
# undocumented members of documented classes, files or namespaces.
272
# If set to NO (the default) these members will be included in the
273
# various overviews, but no documentation section is generated.
274
# This option has no effect if EXTRACT_ALL is enabled.
276
HIDE_UNDOC_MEMBERS = NO
278
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
279
# undocumented classes that are normally visible in the class hierarchy.
280
# If set to NO (the default) these classes will be included in the various
281
# overviews. This option has no effect if EXTRACT_ALL is enabled.
283
HIDE_UNDOC_CLASSES = NO
285
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
286
# friend (class|struct|union) declarations.
287
# If set to NO (the default) these declarations will be included in the
290
HIDE_FRIEND_COMPOUNDS = NO
292
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
293
# documentation blocks found inside the body of a function.
294
# If set to NO (the default) these blocks will be appended to the
295
# function's detailed documentation block.
297
HIDE_IN_BODY_DOCS = NO
299
# The INTERNAL_DOCS tag determines if documentation
300
# that is typed after a \internal command is included. If the tag is set
301
# to NO (the default) then the documentation will be excluded.
302
# Set it to YES to include the internal documentation.
306
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
307
# file names in lower-case letters. If set to YES upper-case letters are also
308
# allowed. This is useful if you have classes or files whose names only differ
309
# in case and if your file system supports case sensitive file names. Windows
310
# and Mac users are advised to set this option to NO.
312
CASE_SENSE_NAMES = YES
314
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
315
# will show members with their full class and namespace scopes in the
316
# documentation. If set to YES the scope will be hidden.
318
HIDE_SCOPE_NAMES = NO
320
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
321
# will put a list of the files that are included by a file in the documentation
324
SHOW_INCLUDE_FILES = YES
326
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
327
# is inserted in the documentation for inline members.
331
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
332
# will sort the (detailed) documentation of file and class members
333
# alphabetically by member name. If set to NO the members will appear in
336
SORT_MEMBER_DOCS = YES
338
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
339
# brief documentation of file, namespace and class members alphabetically
340
# by member name. If set to NO (the default) the members will appear in
345
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
346
# sorted by fully-qualified names, including namespaces. If set to
347
# NO (the default), the class list will be sorted only by class name,
348
# not including the namespace part.
349
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
350
# Note: This option applies only to the class list, not to the
353
SORT_BY_SCOPE_NAME = NO
355
# The GENERATE_TODOLIST tag can be used to enable (YES) or
356
# disable (NO) the todo list. This list is created by putting \todo
357
# commands in the documentation.
359
GENERATE_TODOLIST = YES
361
# The GENERATE_TESTLIST tag can be used to enable (YES) or
362
# disable (NO) the test list. This list is created by putting \test
363
# commands in the documentation.
365
GENERATE_TESTLIST = YES
367
# The GENERATE_BUGLIST tag can be used to enable (YES) or
368
# disable (NO) the bug list. This list is created by putting \bug
369
# commands in the documentation.
371
GENERATE_BUGLIST = YES
373
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
374
# disable (NO) the deprecated list. This list is created by putting
375
# \deprecated commands in the documentation.
377
GENERATE_DEPRECATEDLIST= YES
379
# The ENABLED_SECTIONS tag can be used to enable conditional
380
# documentation sections, marked by \if sectionname ... \endif.
384
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
385
# the initial value of a variable or define consists of for it to appear in
386
# the documentation. If the initializer consists of more lines than specified
387
# here it will be hidden. Use a value of 0 to hide initializers completely.
388
# The appearance of the initializer of individual variables and defines in the
389
# documentation can be controlled using \showinitializer or \hideinitializer
390
# command in the documentation regardless of this setting.
392
MAX_INITIALIZER_LINES = 30
394
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
395
# at the bottom of the documentation of classes and structs. If set to YES the
396
# list will mention the files that were used to generate the documentation.
398
SHOW_USED_FILES = YES
400
# If the sources in your project are distributed over multiple directories
401
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
402
# in the documentation. The default is NO.
404
SHOW_DIRECTORIES = NO
406
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
407
# doxygen should invoke to get the current version for each file (typically from the
408
# version control system). Doxygen will invoke the program by executing (via
409
# popen()) the command <command> <input-file>, where <command> is the value of
410
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
411
# provided by doxygen. Whatever the program writes to standard output
412
# is used as the file version. See the manual for examples.
414
FILE_VERSION_FILTER =
416
#---------------------------------------------------------------------------
417
# configuration options related to warning and progress messages
418
#---------------------------------------------------------------------------
420
# The QUIET tag can be used to turn on/off the messages that are generated
421
# by doxygen. Possible values are YES and NO. If left blank NO is used.
425
# The WARNINGS tag can be used to turn on/off the warning messages that are
426
# generated by doxygen. Possible values are YES and NO. If left blank
431
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
432
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
433
# automatically be disabled.
435
WARN_IF_UNDOCUMENTED = YES
437
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
438
# potential errors in the documentation, such as not documenting some
439
# parameters in a documented function, or documenting parameters that
440
# don't exist or using markup commands wrongly.
442
WARN_IF_DOC_ERROR = YES
444
# This WARN_NO_PARAMDOC option can be abled to get warnings for
445
# functions that are documented, but have no documentation for their parameters
446
# or return value. If set to NO (the default) doxygen will only warn about
447
# wrong or incomplete parameter documentation, but not about the absence of
450
WARN_NO_PARAMDOC = NO
452
# The WARN_FORMAT tag determines the format of the warning messages that
453
# doxygen can produce. The string should contain the $file, $line, and $text
454
# tags, which will be replaced by the file and line number from which the
455
# warning originated and the warning text. Optionally the format may contain
456
# $version, which will be replaced by the version of the file (if it could
457
# be obtained via FILE_VERSION_FILTER)
459
WARN_FORMAT = "$file:$line: $text"
461
# The WARN_LOGFILE tag can be used to specify a file to which warning
462
# and error messages should be written. If left blank the output is written
465
WARN_LOGFILE = warn.log
467
#---------------------------------------------------------------------------
468
# configuration options related to the input files
469
#---------------------------------------------------------------------------
471
# The INPUT tag can be used to specify the files and/or directories that contain
472
# documented source files. You may enter file names like "myfile.cpp" or
473
# directories like "/usr/src/myproject". Separate the files or directories
476
INPUT = @abs_top_srcdir@/doc/mainpage.doc \
477
@abs_top_srcdir@/iocore \
478
@abs_top_srcdir@/lib/ts \
479
@abs_top_srcdir@/lib/tsconfig \
480
@abs_top_srcdir@/lib/records \
481
@abs_top_srcdir@/proxy \
482
@abs_top_srcdir@/test
484
# This tag can be used to specify the character encoding of the source files that
485
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
486
# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
487
# See http://www.gnu.org/software/libiconv for the list of possible encodings.
489
INPUT_ENCODING = UTF-8
491
# If the value of the INPUT tag contains directories, you can use the
492
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
493
# and *.h) to filter out the source-files in the directories. If left
494
# blank the following patterns are tested:
495
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
496
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
498
FILE_PATTERNS = *.c *.cc *.h *.i
500
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
501
# should be searched for input files as well. Possible values are YES and NO.
502
# If left blank NO is used.
506
# The EXCLUDE tag can be used to specify files and/or directories that should
507
# excluded from the INPUT source files. This way you can easily exclude a
508
# subdirectory from a directory tree whose root is specified with the INPUT tag.
512
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
513
# directories that are symbolic links (a Unix filesystem feature) are excluded
516
EXCLUDE_SYMLINKS = NO
518
# If the value of the INPUT tag contains directories, you can use the
519
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
520
# certain files from those directories. Note that the wildcards are matched
521
# against the file with absolute path, so to exclude all test directories
522
# for example use the pattern */test/*
526
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
527
# (namespaces, classes, functions, etc.) that should be excluded from the output.
528
# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
529
# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
533
# The EXAMPLE_PATH tag can be used to specify one or more files or
534
# directories that contain example code fragments that are included (see
535
# the \include command).
539
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
540
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
541
# and *.h) to filter out the source-files in the directories. If left
542
# blank all files are included.
546
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
547
# searched for input files to be used with the \include or \dontinclude
548
# commands irrespective of the value of the RECURSIVE tag.
549
# Possible values are YES and NO. If left blank NO is used.
551
EXAMPLE_RECURSIVE = NO
553
# The IMAGE_PATH tag can be used to specify one or more files or
554
# directories that contain image that are included in the documentation (see
555
# the \image command).
559
# The INPUT_FILTER tag can be used to specify a program that doxygen should
560
# invoke to filter for each input file. Doxygen will invoke the filter program
561
# by executing (via popen()) the command <filter> <input-file>, where <filter>
562
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
563
# input file. Doxygen will then use the output that the filter program writes
564
# to standard output. If FILTER_PATTERNS is specified, this tag will be
569
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
570
# basis. Doxygen will compare the file name with each pattern and apply the
571
# filter if there is a match. The filters are a list of the form:
572
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
573
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
574
# is applied to all files.
578
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
579
# INPUT_FILTER) will be used to filter the input files when producing source
580
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
582
FILTER_SOURCE_FILES = NO
584
#---------------------------------------------------------------------------
585
# configuration options related to source browsing
586
#---------------------------------------------------------------------------
588
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
589
# be generated. Documented entities will be cross-referenced with these sources.
590
# Note: To get rid of all source code in the generated output, make sure also
591
# VERBATIM_HEADERS is set to NO.
595
# Setting the INLINE_SOURCES tag to YES will include the body
596
# of functions and classes directly in the documentation.
600
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
601
# doxygen to hide any special comment blocks from generated source code
602
# fragments. Normal C and C++ comments will always remain visible.
604
STRIP_CODE_COMMENTS = YES
606
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
607
# then for each documented function all documented
608
# functions referencing it will be listed.
610
REFERENCED_BY_RELATION = YES
612
# If the REFERENCES_RELATION tag is set to YES (the default)
613
# then for each documented function all documented entities
614
# called/used by that function will be listed.
616
REFERENCES_RELATION = YES
618
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
619
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
620
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
621
# link to the source code. Otherwise they will link to the documentstion.
623
REFERENCES_LINK_SOURCE = YES
625
# If the USE_HTAGS tag is set to YES then the references to source code
626
# will point to the HTML generated by the htags(1) tool instead of doxygen
627
# built-in source browser. The htags tool is part of GNU's global source
628
# tagging system (see http://www.gnu.org/software/global/global.html). You
629
# will need version 4.8.6 or higher.
633
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
634
# will generate a verbatim copy of the header file for each class for
635
# which an include is specified. Set to NO to disable this.
637
VERBATIM_HEADERS = YES
639
#---------------------------------------------------------------------------
640
# configuration options related to the alphabetical class index
641
#---------------------------------------------------------------------------
643
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
644
# of all compounds will be generated. Enable this if the project
645
# contains a lot of classes, structs, unions or interfaces.
647
ALPHABETICAL_INDEX = YES
649
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
650
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
651
# in which this list will be split (can be a number in the range [1..20])
653
COLS_IN_ALPHA_INDEX = 5
655
# In case all classes in a project start with a common prefix, all
656
# classes will be put under the same header in the alphabetical index.
657
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
658
# should be ignored while generating the index headers.
662
#---------------------------------------------------------------------------
663
# configuration options related to the HTML output
664
#---------------------------------------------------------------------------
666
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
667
# generate HTML output.
671
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
672
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
673
# put in front of it. If left blank `html' will be used as the default path.
677
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
678
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
679
# doxygen will generate files with .html extension.
681
HTML_FILE_EXTENSION = .html
683
# The HTML_HEADER tag can be used to specify a personal HTML header for
684
# each generated HTML page. If it is left blank doxygen will generate a
689
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
690
# each generated HTML page. If it is left blank doxygen will generate a
695
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
696
# style sheet that is used by each HTML page. It can be used to
697
# fine-tune the look of the HTML output. If the tag is left blank doxygen
698
# will generate a default style sheet. Note that doxygen will try to copy
699
# the style sheet file to the HTML output directory, so don't put your own
700
# stylesheet in the HTML output directory as well, or it will be erased!
704
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
705
# files or namespaces will be aligned in HTML using tables. If set to
706
# NO a bullet list will be used.
708
HTML_ALIGN_MEMBERS = YES
710
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
711
# will be generated that can be used as input for tools like the
712
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
713
# of the generated HTML documentation.
715
GENERATE_HTMLHELP = NO
717
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
718
# be used to specify the file name of the resulting .chm file. You
719
# can add a path in front of the file if the result should not be
720
# written to the html output directory.
724
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
725
# be used to specify the location (absolute path including file name) of
726
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
727
# the HTML help compiler on the generated index.hhp.
731
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
732
# controls if a separate .chi index file is generated (YES) or that
733
# it should be included in the master .chm file (NO).
737
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
738
# controls whether a binary table of contents is generated (YES) or a
739
# normal table of contents (NO) in the .chm file.
743
# The TOC_EXPAND flag can be set to YES to add extra items for group members
744
# to the contents of the HTML help documentation and to the tree view.
748
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
749
# top of each HTML page. The value NO (the default) enables the index and
750
# the value YES disables it.
754
# This tag can be used to set the number of enum values (range [1..20])
755
# that doxygen will group on one line in the generated HTML documentation.
757
ENUM_VALUES_PER_LINE = 4
759
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
760
# generated containing a tree-like index structure (just like the one that
761
# is generated for HTML Help). For this to work a browser that supports
762
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
763
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
764
# probably better off using the HTML help feature.
766
GENERATE_TREEVIEW = NO
768
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
769
# used to set the initial width (in pixels) of the frame in which the tree
774
#---------------------------------------------------------------------------
775
# configuration options related to the LaTeX output
776
#---------------------------------------------------------------------------
778
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
779
# generate Latex output.
783
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
784
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
785
# put in front of it. If left blank `latex' will be used as the default path.
789
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
790
# invoked. If left blank `latex' will be used as the default command name.
792
LATEX_CMD_NAME = latex
794
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
795
# generate index for LaTeX. If left blank `makeindex' will be used as the
796
# default command name.
798
MAKEINDEX_CMD_NAME = makeindex
800
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
801
# LaTeX documents. This may be useful for small projects and may help to
802
# save some trees in general.
806
# The PAPER_TYPE tag can be used to set the paper type that is used
807
# by the printer. Possible values are: a4, a4wide, letter, legal and
808
# executive. If left blank a4wide will be used.
812
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
813
# packages that should be included in the LaTeX output.
817
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
818
# the generated latex document. The header should contain everything until
819
# the first chapter. If it is left blank doxygen will generate a
820
# standard header. Notice: only use this tag if you know what you are doing!
824
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
825
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
826
# contain links (just like the HTML output) instead of page references
827
# This makes the output suitable for online browsing using a pdf viewer.
831
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
832
# plain latex in the generated Makefile. Set this option to YES to get a
833
# higher quality PDF documentation.
837
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
838
# command to the generated LaTeX files. This will instruct LaTeX to keep
839
# running if errors occur, instead of asking the user for help.
840
# This option is also used when generating formulas in HTML.
844
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
845
# include the index chapters (such as File Index, Compound Index, etc.)
848
LATEX_HIDE_INDICES = NO
850
#---------------------------------------------------------------------------
851
# configuration options related to the RTF output
852
#---------------------------------------------------------------------------
854
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
855
# The RTF output is optimized for Word 97 and may not look very pretty with
856
# other RTF readers or editors.
860
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
861
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
862
# put in front of it. If left blank `rtf' will be used as the default path.
866
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
867
# RTF documents. This may be useful for small projects and may help to
868
# save some trees in general.
872
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
873
# will contain hyperlink fields. The RTF file will
874
# contain links (just like the HTML output) instead of page references.
875
# This makes the output suitable for online browsing using WORD or other
876
# programs which support those fields.
877
# Note: wordpad (write) and others do not support links.
881
# Load stylesheet definitions from file. Syntax is similar to doxygen's
882
# config file, i.e. a series of assignments. You only have to provide
883
# replacements, missing definitions are set to their default value.
885
RTF_STYLESHEET_FILE =
887
# Set optional variables used in the generation of an rtf document.
888
# Syntax is similar to doxygen's config file.
890
RTF_EXTENSIONS_FILE =
892
#---------------------------------------------------------------------------
893
# configuration options related to the man page output
894
#---------------------------------------------------------------------------
896
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
901
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
902
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
903
# put in front of it. If left blank `man' will be used as the default path.
907
# The MAN_EXTENSION tag determines the extension that is added to
908
# the generated man pages (default is the subroutine's section .3)
912
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
913
# then it will generate one additional man file for each entity
914
# documented in the real man page(s). These additional files
915
# only source the real man page, but without them the man command
916
# would be unable to find the correct page. The default is NO.
920
#---------------------------------------------------------------------------
921
# configuration options related to the XML output
922
#---------------------------------------------------------------------------
924
# If the GENERATE_XML tag is set to YES Doxygen will
925
# generate an XML file that captures the structure of
926
# the code including all documentation.
930
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
931
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
932
# put in front of it. If left blank `xml' will be used as the default path.
936
# The XML_SCHEMA tag can be used to specify an XML schema,
937
# which can be used by a validating XML parser to check the
938
# syntax of the XML files.
942
# The XML_DTD tag can be used to specify an XML DTD,
943
# which can be used by a validating XML parser to check the
944
# syntax of the XML files.
948
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
949
# dump the program listings (including syntax highlighting
950
# and cross-referencing information) to the XML output. Note that
951
# enabling this will significantly increase the size of the XML output.
953
XML_PROGRAMLISTING = YES
955
#---------------------------------------------------------------------------
956
# configuration options for the AutoGen Definitions output
957
#---------------------------------------------------------------------------
959
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
960
# generate an AutoGen Definitions (see autogen.sf.net) file
961
# that captures the structure of the code including all
962
# documentation. Note that this feature is still experimental
963
# and incomplete at the moment.
965
GENERATE_AUTOGEN_DEF = NO
967
#---------------------------------------------------------------------------
968
# configuration options related to the Perl module output
969
#---------------------------------------------------------------------------
971
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
972
# generate a Perl module file that captures the structure of
973
# the code including all documentation. Note that this
974
# feature is still experimental and incomplete at the
977
GENERATE_PERLMOD = NO
979
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
980
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
981
# to generate PDF and DVI output from the Perl module output.
985
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
986
# nicely formatted so it can be parsed by a human reader. This is useful
987
# if you want to understand what is going on. On the other hand, if this
988
# tag is set to NO the size of the Perl module output will be much smaller
989
# and Perl will parse it just the same.
993
# The names of the make variables in the generated doxyrules.make file
994
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
995
# This is useful so different doxyrules.make files included by the same
996
# Makefile don't overwrite each other's variables.
998
PERLMOD_MAKEVAR_PREFIX =
1000
#---------------------------------------------------------------------------
1001
# Configuration options related to the preprocessor
1002
#---------------------------------------------------------------------------
1004
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1005
# evaluate all C-preprocessor directives found in the sources and include
1008
ENABLE_PREPROCESSING = YES
1010
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1011
# names in the source code. If set to NO (the default) only conditional
1012
# compilation will be performed. Macro expansion can be done in a controlled
1013
# way by setting EXPAND_ONLY_PREDEF to YES.
1015
MACRO_EXPANSION = NO
1017
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1018
# then the macro expansion is limited to the macros specified with the
1019
# PREDEFINED and EXPAND_AS_DEFINED tags.
1021
EXPAND_ONLY_PREDEF = NO
1023
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1024
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1026
SEARCH_INCLUDES = YES
1028
# The INCLUDE_PATH tag can be used to specify one or more directories that
1029
# contain include files that are not input files but should be processed by
1034
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1035
# patterns (like *.h and *.hpp) to filter out the header-files in the
1036
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1039
INCLUDE_FILE_PATTERNS =
1041
# The PREDEFINED tag can be used to specify one or more macro names that
1042
# are defined before the preprocessor is started (similar to the -D option of
1043
# gcc). The argument of the tag is a list of macros of the form: name
1044
# or name=definition (no spaces). If the definition and the = are
1045
# omitted =1 is assumed. To prevent a macro definition from being
1046
# undefined via #undef or recursively expanded use the := operator
1047
# instead of the = operator.
1051
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1052
# this tag can be used to specify a list of macro names that should be expanded.
1053
# The macro definition that is found in the sources will be used.
1054
# Use the PREDEFINED tag if you want to use a different macro definition.
1058
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1059
# doxygen's preprocessor will remove all function-like macros that are alone
1060
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1061
# function macros are typically used for boiler-plate code, and will confuse
1062
# the parser if not removed.
1064
SKIP_FUNCTION_MACROS = YES
1066
#---------------------------------------------------------------------------
1067
# Configuration::additions related to external references
1068
#---------------------------------------------------------------------------
1070
# The TAGFILES option can be used to specify one or more tagfiles.
1071
# Optionally an initial location of the external documentation
1072
# can be added for each tagfile. The format of a tag file without
1073
# this location is as follows:
1074
# TAGFILES = file1 file2 ...
1075
# Adding location for the tag files is done as follows:
1076
# TAGFILES = file1=loc1 "file2 = loc2" ...
1077
# where "loc1" and "loc2" can be relative or absolute paths or
1078
# URLs. If a location is present for each tag, the installdox tool
1079
# does not have to be run to correct the links.
1080
# Note that each tag file must have a unique name
1081
# (where the name does NOT include the path)
1082
# If a tag file is not located in the directory in which doxygen
1083
# is run, you must also specify the path to the tagfile here.
1087
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1088
# a tag file that is based on the input files it reads.
1092
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1093
# in the class index. If set to NO only the inherited external classes
1098
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1099
# in the modules index. If set to NO, only the current project's groups will
1102
EXTERNAL_GROUPS = YES
1104
# The PERL_PATH should be the absolute path and name of the perl script
1105
# interpreter (i.e. the result of `which perl').
1109
#---------------------------------------------------------------------------
1110
# Configuration options related to the dot tool
1111
#---------------------------------------------------------------------------
1113
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1114
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1115
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1116
# this option is superseded by the HAVE_DOT option below. This is only a
1117
# fallback. It is recommended to install and use dot, since it yields more
1122
# You can define message sequence charts within doxygen comments using the \msc
1123
# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1124
# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1125
# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1126
# be found in the default search path.
1130
# If set to YES, the inheritance and collaboration graphs will hide
1131
# inheritance and usage relations if the target is undocumented
1132
# or is not a class.
1134
HIDE_UNDOC_RELATIONS = YES
1136
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1137
# available from the path. This tool is part of Graphviz, a graph visualization
1138
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1139
# have no effect if this option is set to NO (the default)
1143
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1144
# will generate a graph for each documented class showing the direct and
1145
# indirect inheritance relations. Setting this tag to YES will force the
1146
# the CLASS_DIAGRAMS tag to NO.
1150
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1151
# will generate a graph for each documented class showing the direct and
1152
# indirect implementation dependencies (inheritance, containment, and
1153
# class references variables) of the class with other documented classes.
1155
COLLABORATION_GRAPH = YES
1157
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1158
# will generate a graph for groups, showing the direct groups dependencies
1162
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1163
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1168
# If set to YES, the inheritance and collaboration graphs will show the
1169
# relations between templates and their instances.
1171
TEMPLATE_RELATIONS = YES
1173
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1174
# tags are set to YES then doxygen will generate a graph for each documented
1175
# file showing the direct and indirect include dependencies of the file with
1176
# other documented files.
1180
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1181
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1182
# documented header file showing the documented files that directly or
1183
# indirectly include this file.
1185
INCLUDED_BY_GRAPH = YES
1187
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1188
# generate a call dependency graph for every global function or class method.
1189
# Note that enabling this option will significantly increase the time of a run.
1190
# So in most cases it will be better to enable call graphs for selected
1191
# functions only using the \callgraph command.
1195
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1196
# generate a caller dependency graph for every global function or class method.
1197
# Note that enabling this option will significantly increase the time of a run.
1198
# So in most cases it will be better to enable caller graphs for selected
1199
# functions only using the \callergraph command.
1203
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1204
# will graphical hierarchy of all classes instead of a textual one.
1206
GRAPHICAL_HIERARCHY = YES
1208
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1209
# then doxygen will show the dependencies a directory has on other directories
1210
# in a graphical way. The dependency relations are determined by the #include
1211
# relations between the files in the directories.
1213
DIRECTORY_GRAPH = YES
1215
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1216
# generated by dot. Possible values are png, jpg, or gif
1217
# If left blank png will be used.
1219
DOT_IMAGE_FORMAT = png
1221
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1222
# found. If left blank, it is assumed the dot tool can be found in the path.
1226
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1227
# contain dot files that are included in the documentation (see the
1228
# \dotfile command).
1230
DOTFILE_DIRS = @abs_top_srcdir@/doc/dot
1232
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1233
# nodes that will be shown in the graph. If the number of nodes in a graph
1234
# becomes larger than this value, doxygen will truncate the graph, which is
1235
# visualized by representing a node as a red box. Note that doxygen will always
1236
# show the root nodes and its direct children regardless of this setting.
1238
DOT_GRAPH_MAX_NODES = 100
1240
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1241
# background. This is disabled by default, which results in a white background.
1242
# Warning: Depending on the platform used, enabling this option may lead to
1243
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1246
DOT_TRANSPARENT = NO
1248
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1249
# files in one run (i.e. multiple -o and -T options on the command line). This
1250
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1251
# support this, this feature is disabled by default.
1253
DOT_MULTI_TARGETS = YES
1255
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1256
# generate a legend page explaining the meaning of the various boxes and
1257
# arrows in the dot generated graphs.
1259
GENERATE_LEGEND = YES
1261
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1262
# remove the intermediate dot files that are used to generate
1263
# the various graphs.
1267
#---------------------------------------------------------------------------
1268
# Configuration::additions related to the search engine
1269
#---------------------------------------------------------------------------
1271
# The SEARCHENGINE tag specifies whether or not a search engine should be
1272
# used. If set to NO the values of all tags below this one will be ignored.
added
removed
doc/Doxyfile.in
