doxygen.cfg.in 54.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
# Doxyfile 1.5.6

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
#       TAG = value [value, ...]
# For lists items can also be appended using:
#       TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

17 18 19 20
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
21 22 23 24
# http://www.gnu.org/software/libiconv for the list of possible encodings.

DOXYFILE_ENCODING      = UTF-8

25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 27 28 29
# by quotes) that should identify the project.

PROJECT_NAME           = @PACKAGE_NAME

30 31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
32 33 34 35
# if some version control system is used.

PROJECT_NUMBER         = @PACKAGE_VERSION@

36 37 38
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
39 40 41 42
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = @top_builddir@/doc

43 44 45 46 47
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
# format and will distribute the generated files over these directories.
# Enabling this option can be useful when feeding doxygen a huge amount of
# source files, where putting all generated files in the same directory would
48 49 50 51
# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

52 53 54 55 56 57 58 59 60
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61 62 63 64
# and Ukrainian.

OUTPUT_LANGUAGE        = English

65 66 67
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
68 69 70 71
# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

72 73 74
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 76 77 78
# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

79 80 81 82 83 84 85 86
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
# in this list, if found as the leading text of the brief description, will be
# stripped from the text and the result after processing the whole list, is
# used as the annotated text. Otherwise, the brief description is used as-is.
# If left blank, the following values are used ("$name" is automatically
# replaced with the name of the entity): "The $name class" "The $name widget"
# "The $name file" "is" "provides" "specifies" "contains"
87 88
# "represents" "a" "an" "the"

89
ABBREVIATE_BRIEF       =
90

91 92
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
93 94 95 96
# description.

ALWAYS_DETAILED_SEC    = NO

97 98 99
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
100 101 102 103
# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

104 105
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
106 107 108 109
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = NO

110 111 112 113 114
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the
115 116
# path to strip.

117
STRIP_FROM_PATH        =
118

119 120 121 122 123
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
# the reader which header file to include in order to use a class.
# If left blank only the name of the header file containing the class
# definition is used. Otherwise one should specify the include paths that
124 125
# are normally passed to the compiler using the -I flag.

126
STRIP_FROM_INC_PATH    =
127

128 129
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful is your file systems
130 131 132 133
# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

134 135 136 137
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like regular Qt-style comments
138 139 140 141
# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = NO

142 143 144 145
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
146 147 148 149
# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

150 151 152 153
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
154 155 156 157
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

158 159
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
160 161 162 163
# re-implements.

INHERIT_DOCS           = YES

164 165
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
# a new page for each member. If set to NO, the documentation of a member will
166 167 168 169
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

170
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171 172 173 174
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

175 176 177 178 179
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user-defined paragraph with heading "Side Effects:".
180 181
# You can put \n's in the value part of an alias to insert newlines.

182
ALIASES                =
183

184 185 186
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
# For instance, some of the names that are used will be different. The list
187 188 189 190
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = YES

191 192 193
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for
# Java. For instance, namespaces will be presented as packages, qualified
194 195 196 197
# scopes will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

198 199
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
200 201 202 203
# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

204 205
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
206 207 208 209
# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

210 211 212 213 214
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
215 216 217 218 219 220 221 222 223
# diagrams that involve STL classes more complete and accurate.

BUILTIN_STL_SUPPORT    = NO

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.

CPP_CLI_SUPPORT        = NO

224 225
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
226 227 228 229
# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

230 231 232 233 234
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
235 236 237 238
# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

239 240 241
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
242 243 244 245
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

246 247 248 249
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a
# subgroup of that type (e.g. under the Public Functions section). Set it to
# NO to prevent subgrouping. Alternatively, this can be done per class using
250 251 252 253
# the \nosubgrouping command.

SUBGROUPING            = YES

254 255 256 257 258 259
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically
# be useful for C code in case the coding convention dictates that all compound
260 261 262 263 264 265 266 267
# types are typedef'ed and only the typedef is referenced, never the tag name.

TYPEDEF_HIDES_STRUCT   = NO

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

268 269 270
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
271 272 273 274
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = NO

275
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
276 277 278 279
# will be included in the documentation.

EXTRACT_PRIVATE        = NO

280
# If the EXTRACT_STATIC tag is set to YES all static members of a file
281 282 283 284
# will be included in the documentation.

EXTRACT_STATIC         = NO

285 286
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
287 288 289 290
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

291 292 293
# This flag is only useful for Objective-C code. When set to YES local
# methods, which are defined in the implementation section but not in
# the interface are included in the documentation.
294 295 296 297
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

298 299 300 301
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
302 303 304 305
# anonymous namespace are hidden.

EXTRACT_ANON_NSPACES   = NO

306 307 308 309
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
310 311 312 313
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

314 315 316
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
317 318 319 320
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

321 322 323
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
324 325 326 327
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

328 329 330
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
# documentation blocks found inside the body of a function.
# If set to NO (the default) these blocks will be appended to the
331 332 333 334
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

335 336 337
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
338 339 340 341
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

342 343 344 345
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
346 347 348 349
# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = NO

350 351
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
352 353 354 355
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

356 357
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation
358 359 360 361
# of that file.

SHOW_INCLUDE_FILES     = NO

362
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
363 364 365 366
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

367 368 369
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
370 371 372 373
# declaration order.

SORT_MEMBER_DOCS       = YES

374 375 376
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
377 378 379 380
# declaration order.

SORT_BRIEF_DOCS        = NO

381 382
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
383 384 385 386
# the group names will appear in their defined order.

SORT_GROUP_NAMES       = NO

387 388 389 390
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
# NO (the default), the class list will be sorted only by class name,
# not including the namespace part.
391
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
392
# Note: This option applies only to the class list, not to the
393 394 395 396
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

397 398
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
399 400 401 402
# commands in the documentation.

GENERATE_TODOLIST      = YES

403 404
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
405 406 407 408
# commands in the documentation.

GENERATE_TESTLIST      = YES

409 410
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
411 412 413 414
# commands in the documentation.

GENERATE_BUGLIST       = YES

415 416
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
417 418 419 420
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

421
# The ENABLED_SECTIONS tag can be used to enable conditional
422 423
# documentation sections, marked by \if sectionname ... \endif.

424
ENABLED_SECTIONS       =
425

426 427 428 429 430 431
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
432 433 434 435
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

436 437
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
438 439 440 441 442
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
443
# This will remove the Files entry from the Quick Index and from the
444 445 446 447
# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

448
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
449 450 451 452 453
# Namespaces page.  This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

454 455 456 457 458 459
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command <command> <input-file>, where <command> is the value of
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
# provided by doxygen. Whatever the program writes to standard output
460 461
# is used as the file version. See the manual for examples.

462
FILE_VERSION_FILTER    =
463 464 465 466 467

#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

468
# The QUIET tag can be used to turn on/off the messages that are generated
469 470 471 472
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = YES

473 474
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
475 476 477 478
# NO is used.

WARNINGS               = YES

479 480
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
481 482 483 484
# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

485 486 487
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
# parameters in a documented function, or documenting parameters that
488 489 490 491
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

492 493 494 495
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
# or return value. If set to NO (the default) doxygen will only warn about
# wrong or incomplete parameter documentation, but not about the absence of
496 497 498 499
# documentation.

WARN_NO_PARAMDOC       = NO

500 501 502 503 504
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text. Optionally the format may contain
# $version, which will be replaced by the version of the file (if it could
505 506 507 508
# be obtained via FILE_VERSION_FILTER)

WARN_FORMAT            = "$file:$line: $text"

509 510
# The WARN_LOGFILE tag can be used to specify a file to which warning
# and error messages should be written. If left blank the output is written
511 512
# to stderr.

513
WARN_LOGFILE           =
514 515 516 517 518

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

519 520 521
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
522 523 524 525
# with spaces.

INPUT                  = @top_srcdir@/src

526 527 528 529
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
530 531 532 533
# the list of possible encodings.

INPUT_ENCODING         = UTF-8

534 535 536 537 538
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
539 540 541 542 543
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90

FILE_PATTERNS          = *.c \
                         *.h

544 545
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
546 547 548 549
# If left blank NO is used.

RECURSIVE              = YES

550 551
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
552 553 554 555
# subdirectory from a directory tree whose root is specified with the INPUT tag.

EXCLUDE                = ../src/config.h

556 557
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
558 559 560 561
# from the input.

EXCLUDE_SYMLINKS       = NO

562 563 564 565
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
566 567 568 569
# for example use the pattern */test/*

EXCLUDE_PATTERNS       = *_private.h

570 571 572 573
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
574 575
# AClass::ANamespace, ANamespace::*Test

576
EXCLUDE_SYMBOLS        =
577

578 579
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
580 581
# the \include command).

582
EXAMPLE_PATH           =
583

584 585 586
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
587 588
# blank all files are included.

589
EXAMPLE_PATTERNS       =
590

591 592 593
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
594 595 596 597
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

598 599
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
600 601
# the \image command).

602
IMAGE_PATH             =
603

604 605 606 607 608 609
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command <filter> <input-file>, where <filter>
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output.  If FILTER_PATTERNS is specified, this tag will be
610 611
# ignored.

612
INPUT_FILTER           =
613

614 615 616 617 618
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis.  Doxygen will compare the file name with each pattern and apply the
# filter if there is a match.  The filters are a list of the form:
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
619 620
# is applied to all files.

621
FILTER_PATTERNS        =
622

623 624
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
625 626 627 628 629 630 631 632
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

633 634 635
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
# Note: To get rid of all source code in the generated output, make sure also
636 637 638 639
# VERBATIM_HEADERS is set to NO.

SOURCE_BROWSER         = NO

640
# Setting the INLINE_SOURCES tag to YES will include the body
641 642 643 644
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

645 646
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
647 648 649 650
# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = YES

651 652
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
653 654 655 656
# functions referencing it will be listed.

REFERENCED_BY_RELATION = YES

657 658
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
659 660 661 662 663 664 665 666 667 668 669
# called/used by that function will be listed.

REFERENCES_RELATION    = YES

# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
# link to the source code.  Otherwise they will link to the documentstion.

REFERENCES_LINK_SOURCE = YES

670 671 672 673
# If the USE_HTAGS tag is set to YES then the references to source code
# will point to the HTML generated by the htags(1) tool instead of doxygen
# built-in source browser. The htags tool is part of GNU's global source
# tagging system (see http://www.gnu.org/software/global/global.html). You
674 675 676 677
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

678 679
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
680 681 682 683 684 685 686 687
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

688 689
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
690 691 692 693
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = NO

694 695
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
696 697 698 699
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

700 701 702
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
703 704
# should be ignored while generating the index headers.

705
IGNORE_PREFIX          =
706 707 708 709 710

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------

711
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
712 713 714 715
# generate HTML output.

GENERATE_HTML          = YES

716 717
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
718 719 720 721
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

722 723
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
724 725 726 727
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

728 729
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
730 731 732 733
# standard header.

HTML_HEADER            = @top_srcdir@/doc/header.html

734 735
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
736 737 738 739
# standard footer.

HTML_FOOTER            = @top_srcdir@/doc/footer.html

740 741 742 743 744
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
745 746
# stylesheet in the HTML output directory as well, or it will be erased!

747
HTML_STYLESHEET        =
748

749 750 751
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
752 753 754 755
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

756 757 758 759 760 761 762
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
763 764 765 766
# it at startup.

GENERATE_DOCSET        = NO

767 768 769
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
770 771 772 773
# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

774 775 776
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
777 778 779 780
# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

781 782 783 784
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
785 786 787 788
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).

HTML_DYNAMIC_SECTIONS  = NO

789 790 791
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
792 793
# written to the html output directory.

794
CHM_FILE               =
795

796 797 798
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
799 800
# the HTML help compiler on the generated index.hhp.

801
HHC_LOCATION           =
802

803 804
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
805 806 807 808 809 810 811 812
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.

813
CHM_INDEX_ENCODING     =
814

815 816
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
817 818 819 820
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

821
# The TOC_EXPAND flag can be set to YES to add extra items for group members
822 823 824 825
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             = NO

826 827
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
828 829 830 831
# the value YES disables it.

DISABLE_INDEX          = YES

832
# This tag can be used to set the number of enum values (range [1..20])
833 834 835 836 837 838 839
# that doxygen will group on one line in the generated HTML documentation.

ENUM_VALUES_PER_LINE   = 4

# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
# If the tag value is set to FRAME, a side panel will be generated
840 841 842 843 844
# containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
# probably better off using the HTML help feature. Other possible values
845 846 847 848 849 850 851 852 853
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
# and Class Hiererachy pages using a tree view instead of an ordered list;
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
# disables this behavior completely. For backwards compatibility with previous
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
# respectively.

GENERATE_TREEVIEW      = NO

854 855
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
856 857 858 859
# is shown.

TREEVIEW_WIDTH         = 250

860 861 862 863
# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
864 865 866 867 868 869 870 871
# to force them to be regenerated.

FORMULA_FONTSIZE       = 10

#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

872
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
873 874 875 876 877 878 879 880
# generate Latex output.

GENERATE_LATEX         = NO

#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

881 882
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# The RTF output is optimized for Word 97 and may not look very pretty with
883 884 885 886
# other RTF readers or editors.

GENERATE_RTF           = NO

887 888
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
889 890 891 892
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

893 894
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
895 896 897 898
# save some trees in general.

COMPACT_RTF            = NO

899 900 901 902 903
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using WORD or other
# programs which support those fields.
904 905 906 907
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

908 909
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assignments. You only have to provide
910 911
# replacements, missing definitions are set to their default value.

912
RTF_STYLESHEET_FILE    =
913

914
# Set optional variables used in the generation of an rtf document.
915 916
# Syntax is similar to doxygen's config file.

917
RTF_EXTENSIONS_FILE    =
918 919 920 921 922

#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------

923
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
924 925 926 927
# generate man pages

GENERATE_MAN           = NO

928 929
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
930 931 932 933
# put in front of it. If left blank `man' will be used as the default path.

MAN_OUTPUT             = man

934
# The MAN_EXTENSION tag determines the extension that is added to
935 936 937 938
# the generated man pages (default is the subroutine's section .3)

MAN_EXTENSION          = .3

939 940 941 942
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
# documented in the real man page(s). These additional files
# only source the real man page, but without them the man command
943 944 945 946 947 948 949 950
# would be unable to find the correct page. The default is NO.

MAN_LINKS              = NO

#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------

951 952
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
953 954 955 956
# the code including all documentation.

GENERATE_XML           = NO

957 958
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
959 960 961 962
# put in front of it. If left blank `xml' will be used as the default path.

XML_OUTPUT             = xml

963 964
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
965 966
# syntax of the XML files.

967
XML_SCHEMA             =
968

969 970
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
971 972
# syntax of the XML files.

973
XML_DTD                =
974

975 976 977
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting
# and cross-referencing information) to the XML output. Note that
978 979 980 981 982 983 984 985
# enabling this will significantly increase the size of the XML output.

XML_PROGRAMLISTING     = YES

#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

986 987 988 989
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
# generate an AutoGen Definitions (see autogen.sf.net) file
# that captures the structure of the code including all
# documentation. Note that this feature is still experimental
990 991 992 993 994 995 996 997
# and incomplete at the moment.

GENERATE_AUTOGEN_DEF   = NO

#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------

998 999 1000 1001
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
# generate a Perl module file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
1002 1003 1004 1005
# moment.

GENERATE_PERLMOD       = NO

1006 1007
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1008 1009 1010 1011
# to generate PDF and DVI output from the Perl module output.

PERLMOD_LATEX          = NO

1012 1013 1014 1015
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
# nicely formatted so it can be parsed by a human reader.  This is useful
# if you want to understand what is going on.  On the other hand, if this
# tag is set to NO the size of the Perl module output will be much smaller
1016 1017 1018 1019
# and Perl will parse it just the same.

PERLMOD_PRETTY         = YES

1020 1021 1022
# The names of the make variables in the generated doxyrules.make file
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
# This is useful so different doxyrules.make files included by the same
1023 1024
# Makefile don't overwrite each other's variables.

1025
PERLMOD_MAKEVAR_PREFIX =
1026 1027

#---------------------------------------------------------------------------
1028
# Configuration options related to the preprocessor
1029 1030
#---------------------------------------------------------------------------

1031 1032
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
1033 1034 1035 1036
# files.

ENABLE_PREPROCESSING   = YES

1037 1038 1039
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed. Macro expansion can be done in a controlled
1040 1041 1042 1043
# way by setting EXPAND_ONLY_PREDEF to YES.

MACRO_EXPANSION        = NO

1044 1045
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
1046 1047 1048 1049
# PREDEFINED and EXPAND_AS_DEFINED tags.

EXPAND_ONLY_PREDEF     = NO

1050
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1051 1052 1053 1054
# in the INCLUDE_PATH (see below) will be search if a #include is found.

SEARCH_INCLUDES        = YES

1055 1056
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
1057 1058
# the preprocessor.

1059
INCLUDE_PATH           =
1060

1061 1062 1063
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1064 1065
# be used.

1066
INCLUDE_FILE_PATTERNS  =
1067

1068 1069 1070 1071 1072 1073
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
1074 1075 1076 1077
# instead of the = operator.

PREDEFINED             = _DOXYGEN_SKIP_ME

1078 1079 1080
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
1081 1082
# Use the PREDEFINED tag if you want to use a different macro definition.

1083
EXPAND_AS_DEFINED      =
1084

1085 1086 1087 1088
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
# on a line, have an all uppercase name, and do not end with a semicolon. Such
# function macros are typically used for boiler-plate code, and will confuse
1089 1090 1091 1092 1093
# the parser if not removed.

SKIP_FUNCTION_MACROS   = YES

#---------------------------------------------------------------------------
1094
# Configuration::additions related to external references
1095 1096
#---------------------------------------------------------------------------

1097 1098 1099 1100 1101 1102 1103 1104 1105
# The TAGFILES option can be used to specify one or more tagfiles.
# Optionally an initial location of the external documentation
# can be added for each tagfile. The format of a tag file without
# this location is as follows:
#   TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
#   TAGFILES = file1=loc1 "file2 = loc2" ...
# where "loc1" and "loc2" can be relative or absolute paths or
# URLs. If a location is present for each tag, the installdox tool
1106 1107 1108
# does not have to be run to correct the links.
# Note that each tag file must have a unique name
# (where the name does NOT include the path)
1109
# If a tag file is not located in the directory in which doxygen
1110 1111
# is run, you must also specify the path to the tagfile here.

1112
TAGFILES               =
1113

1114
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1115 1116
# a tag file that is based on the input files it reads.

1117
GENERATE_TAGFILE       =
1118

1119 1120
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
1121 1122 1123 1124
# will be listed.

ALLEXTERNALS           = NO

1125 1126
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will
1127 1128 1129 1130
# be listed.

EXTERNAL_GROUPS        = YES

1131
# The PERL_PATH should be the absolute path and name of the perl script
1132 1133 1134 1135 1136
# interpreter (i.e. the result of `which perl').

PERL_PATH              = /usr/bin/perl

#---------------------------------------------------------------------------
1137
# Configuration options related to the dot tool
1138 1139
#---------------------------------------------------------------------------

1140 1141 1142 1143 1144
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
# or super classes. Setting the tag to NO turns the diagrams off. Note that
# this option is superseded by the HAVE_DOT option below. This is only a
# fallback. It is recommended to install and use dot, since it yields more
1145 1146 1147 1148
# powerful graphs.

CLASS_DIAGRAMS         = YES

1149 1150 1151 1152 1153
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1154 1155
# default search path.

1156
MSCGEN_PATH            =
1157

1158 1159
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
1160 1161 1162 1163
# or is not a class.

HIDE_UNDOC_RELATIONS   = YES

1164 1165 1166
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1167 1168 1169 1170
# have no effect if this option is set to NO (the default)

HAVE_DOT               = NO

1171 1172 1173 1174 1175 1176 1177
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
# font does not include all possible unicode characters however, so when you need
# these (or just want a differently looking font) you can specify the font name
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
# which can be done by putting it in a standard location or by setting the
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1178 1179 1180 1181
# containing the font.

DOT_FONTNAME           = FreeSans

1182 1183 1184
# By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
# different font using DOT_FONTNAME you can set the path where dot
1185 1186
# can find it using this tag.

1187
DOT_FONTPATH           =
1188

1189 1190 1191
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
1192 1193 1194 1195
# the CLASS_DIAGRAMS tag to NO.

CLASS_GRAPH            = YES

1196 1197 1198
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
1199 1200 1201 1202
# class references variables) of the class with other documented classes.

COLLABORATION_GRAPH    = YES

1203
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1204 1205 1206 1207
# will generate a graph for groups, showing the direct groups dependencies

GROUP_GRAPHS           = YES

1208 1209
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1210 1211 1212 1213
# Language.

UML_LOOK               = NO

1214
# If set to YES, the inheritance and collaboration graphs will show the
1215 1216 1217 1218
# relations between templates and their instances.

TEMPLATE_RELATIONS     = YES

1219 1220 1221
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
# file showing the direct and indirect include dependencies of the file with
1222 1223 1224 1225
# other documented files.

INCLUDE_GRAPH          = YES

1226 1227 1228
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
1229 1230 1231 1232
# indirectly include this file.

INCLUDED_BY_GRAPH      = YES

1233 1234 1235 1236
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable call graphs
1237 1238 1239 1240
# for selected functions only using the \callgraph command.

CALL_GRAPH             = NO

1241 1242 1243 1244
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a caller dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable caller
1245 1246 1247 1248
# graphs for selected functions only using the \callergraph command.

CALLER_GRAPH           = NO

1249
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1250 1251 1252 1253
# will graphical hierarchy of all classes instead of a textual one.

GRAPHICAL_HIERARCHY    = YES

1254 1255
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
# then doxygen will show the dependencies a directory has on other directories
1256 1257 1258 1259 1260
# in a graphical way. The dependency relations are determined by the #include
# relations between the files in the directories.

DIRECTORY_GRAPH        = YES

1261
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1262 1263 1264 1265 1266
# generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.

DOT_IMAGE_FORMAT       = png

1267
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1268 1269
# found. If left blank, it is assumed the dot tool can be found in the path.

1270
DOT_PATH               =
1271

1272 1273
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the
1274 1275 1276 1277
# \dotfile command).

DOTFILE_DIRS           = .

1278 1279 1280 1281 1282 1283
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
# nodes that will be shown in the graph. If the number of nodes in a graph
# becomes larger than this value, doxygen will truncate the graph, which is
# visualized by representing a node as a red box. Note that doxygen if the
# number of direct children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1284 1285 1286 1287
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.

DOT_GRAPH_MAX_NODES    = 50

1288 1289 1290 1291 1292 1293
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# from the root by following a path via at most 3 edges will be shown. Nodes
# that lay further from the root node will be omitted. Note that setting this
# option to 1 or 2 may greatly reduce the computation time needed for large
# code bases. Also note that the size of a graph can be further restricted by
1294 1295 1296 1297
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.

MAX_DOT_GRAPH_DEPTH    = 0

1298 1299 1300 1301
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is enabled by default, which results in a transparent
# background. Warning: Depending on the platform used, enabling this option
# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1302 1303 1304 1305
# become hard to read).

DOT_TRANSPARENT        = YES

1306 1307 1308
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1309 1310 1311 1312
# support this, this feature is disabled by default.

DOT_MULTI_TARGETS      = NO

1313 1314
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes and
1315 1316 1317 1318
# arrows in the dot generated graphs.

GENERATE_LEGEND        = YES

1319 1320
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermediate dot files that are used to generate
1321 1322 1323 1324 1325
# the various graphs.

DOT_CLEANUP            = YES

#---------------------------------------------------------------------------
1326
# Configuration::additions related to the search engine
1327 1328
#---------------------------------------------------------------------------

1329
# The SEARCHENGINE tag specifies whether or not a search engine should be
1330 1331 1332
# used. If set to NO the values of all tags below this one will be ignored.

SEARCHENGINE           = NO