Doxyfile 78.7 KB
Newer Older
Daniel Salzman's avatar
Daniel Salzman committed
1
# Doxyfile 1.8.3.1
2 3

# This file describes the settings to be used by the documentation system
Daniel Salzman's avatar
Daniel Salzman committed
4
# doxygen (www.doxygen.org) for a project.
5
#
Daniel Salzman's avatar
Daniel Salzman committed
6
# All text after a hash (#) is considered a comment and will be ignored.
7 8 9 10
# The format is:
#       TAG = value [value, ...]
# For lists items can also be appended using:
#       TAG += value [value, ...]
Daniel Salzman's avatar
Daniel Salzman committed
11
# Values that contain spaces should be placed between quotes (" ").
12 13 14 15 16

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

Jan Včelák's avatar
Jan Včelák committed
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

Daniel Salzman's avatar
Daniel Salzman committed
25 26 27
# The PROJECT_NAME tag is a single word (or sequence of words) that should
# identify the project. Note that if you do not use Doxywizard you need
# to put quotes around the project name if it contains spaces.
28

Lubos Slovak's avatar
Lubos Slovak committed
29
PROJECT_NAME           = Knot
30

Jan Včelák's avatar
Jan Včelák committed
31 32
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
33 34
# if some version control system is used.

Daniel Salzman's avatar
Daniel Salzman committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48
PROJECT_NUMBER         = 1.4

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer
# a quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF          =

# With the PROJECT_LOGO tag one can specify an logo or icon that is
# included in the documentation. The maximum height of the logo should not
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
# Doxygen will copy the logo to the output directory.

PROJECT_LOGO           =
49

Jan Včelák's avatar
Jan Včelák committed
50 51 52
# 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
53 54 55 56
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = doc

Jan Včelák's avatar
Jan Včelák committed
57 58 59 60 61
# 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
62 63 64 65
# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

Jan Včelák's avatar
Jan Včelák committed
66 67 68 69 70 71 72 73
# 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, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
Daniel Salzman's avatar
Daniel Salzman committed
74
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
Lubos Slovak's avatar
Lubos Slovak committed
75
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76 77 78

OUTPUT_LANGUAGE        = English

Jan Včelák's avatar
Jan Včelák committed
79 80 81
# 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).
82 83 84 85
# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

Jan Včelák's avatar
Jan Včelák committed
86 87 88
# 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
89 90 91 92
# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

Jan Včelák's avatar
Jan Včelák committed
93 94 95 96 97 98 99 100
# 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"
101 102 103 104 105 106 107 108 109 110 111 112 113 114
# "represents" "a" "an" "the"

ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the

Jan Včelák's avatar
Jan Včelák committed
115 116
# 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
117 118
# description.

Lubos Slovak's avatar
Lubos Slovak committed
119
ALWAYS_DETAILED_SEC    = YES
120

Jan Včelák's avatar
Jan Včelák committed
121 122 123
# 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
124 125 126 127
# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

Jan Včelák's avatar
Jan Včelák committed
128 129
# 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
130 131
# to NO the shortest path that makes the file name unique will be used.

Lubos Slovak's avatar
Lubos Slovak committed
132
FULL_PATH_NAMES        = YES
133

Jan Včelák's avatar
Jan Včelák committed
134 135 136 137 138
# 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
Daniel Salzman's avatar
Daniel Salzman committed
139 140 141
# path to strip. Note that you specify absolute paths here, but also
# relative paths, which will be relative from the directory where doxygen is
# started.
142

Daniel Salzman's avatar
Daniel Salzman committed
143
STRIP_FROM_PATH        = src/
144

Jan Včelák's avatar
Jan Včelák committed
145 146 147 148 149
# 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
150 151
# are normally passed to the compiler using the -I flag.

Jan Včelák's avatar
Jan Včelák committed
152
STRIP_FROM_INC_PATH    =
153

Jan Včelák's avatar
Jan Včelák committed
154
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
Daniel Salzman's avatar
Daniel Salzman committed
155
# (but less readable) file names. This can be useful if your file system
156 157 158 159
# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

Jan Včelák's avatar
Jan Včelák committed
160 161 162 163
# 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
164 165 166 167
# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = NO

Jan Včelák's avatar
Jan Včelák committed
168 169 170 171
# 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
172 173 174 175
# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

Jan Včelák's avatar
Jan Včelák committed
176 177 178 179
# 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
180 181 182 183
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

Jan Včelák's avatar
Jan Včelák committed
184 185
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
186 187 188 189
# re-implements.

INHERIT_DOCS           = YES

Jan Včelák's avatar
Jan Včelák committed
190 191
# 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
192 193 194 195
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

Jan Včelák's avatar
Jan Včelák committed
196
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
197 198 199 200
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

Jan Včelák's avatar
Jan Včelák committed
201 202 203 204 205
# 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:".
206 207
# You can put \n's in the value part of an alias to insert newlines.

Jan Včelák's avatar
Jan Včelák committed
208
ALIASES                =
209

Daniel Salzman's avatar
Daniel Salzman committed
210 211 212 213 214 215 216
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding
# "class=itcl::class" will allow you to use the command class in the
# itcl::class meaning.

TCL_SUBST              =

Jan Včelák's avatar
Jan Včelák committed
217 218 219
# 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
220 221 222 223
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = YES

Jan Včelák's avatar
Jan Včelák committed
224 225 226
# 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
227 228 229 230
# scopes will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

Jan Včelák's avatar
Jan Včelák committed
231 232
# 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
233 234 235 236
# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

Jan Včelák's avatar
Jan Včelák committed
237 238
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
239 240 241 242
# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

Jan Včelák's avatar
Jan Včelák committed
243
# Doxygen selects the parser to use depending on the extension of the files it
Daniel Salzman's avatar
Daniel Salzman committed
244 245 246 247 248 249 250 251 252
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension,
# and language is one of the parsers supported by doxygen: IDL, Java,
# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
# C++. For instance to make doxygen treat .inc files as Fortran files (default
# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
# that for custom extensions you also need to set FILE_PATTERNS otherwise the
# files are not read by doxygen.
253

Jan Včelák's avatar
Jan Včelák committed
254
EXTENSION_MAPPING      =
255

Daniel Salzman's avatar
Daniel Salzman committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
# comments according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you
# can mix doxygen, HTML, and XML commands with Markdown formatting.
# Disable only in case of backward compatibilities issues.

MARKDOWN_SUPPORT       = YES

# When enabled doxygen tries to link words that correspond to documented classes,
# or namespaces to their corresponding documentation. Such a link can be
# prevented in individual cases by by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.

AUTOLINK_SUPPORT       = YES

Jan Včelák's avatar
Jan Včelák committed
272 273 274 275
# 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.
Daniel Salzman's avatar
Daniel Salzman committed
276
# func(std::string) {}). This also makes the inheritance and collaboration
277 278 279 280
# diagrams that involve STL classes more complete and accurate.

BUILTIN_STL_SUPPORT    = NO

Jan Včelák's avatar
Jan Včelák committed
281
# If you use Microsoft's C++/CLI language, you should set this option to YES to
282 283 284 285
# enable parsing support.

CPP_CLI_SUPPORT        = NO

Jan Včelák's avatar
Jan Včelák committed
286 287
# 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
288 289 290 291
# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

Daniel Salzman's avatar
Daniel Salzman committed
292 293 294 295
# 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 replace the get and set methods by a property in
# the documentation. This will only work if the methods are indeed getting or
Jan Včelák's avatar
Jan Včelák committed
296
# setting a simple type. If this is not the case, or you want to show the
297 298 299 300
# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

Jan Včelák's avatar
Jan Včelák committed
301 302 303
# 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
304 305 306 307
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

Jan Včelák's avatar
Jan Včelák committed
308 309 310 311
# 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
312 313 314 315
# the \nosubgrouping command.

SUBGROUPING            = YES

Daniel Salzman's avatar
Daniel Salzman committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
# unions are shown inside the group in which they are included (e.g. using
# @ingroup) instead of on a separate page (for HTML and Man pages) or
# section (for LaTeX and RTF).

INLINE_GROUPED_CLASSES = NO

# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
# unions with only public data fields will be shown inline in the documentation
# of the scope in which they are defined (i.e. file, namespace, or group
# documentation), provided this scope is documented. If set to NO (the default),
# structs, classes, and unions are shown on a separate page (for HTML and Man
# pages) or section (for LaTeX and RTF).

INLINE_SIMPLE_STRUCTS  = NO

Jan Včelák's avatar
Jan Včelák committed
332 333 334 335 336 337
# 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
338 339
# types are typedef'ed and only the typedef is referenced, never the tag name.

Lubos Slovak's avatar
Lubos Slovak committed
340
TYPEDEF_HIDES_STRUCT   = YES
341

Jan Včelák's avatar
Jan Včelák committed
342 343 344 345 346 347
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
Daniel Salzman's avatar
Daniel Salzman committed
348
# causing a significant performance penalty.
Jan Včelák's avatar
Jan Včelák committed
349 350
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
Daniel Salzman's avatar
Daniel Salzman committed
351
# a logarithmic scale so increasing the size by one will roughly double the
Jan Včelák's avatar
Jan Včelák committed
352 353
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
Daniel Salzman's avatar
Daniel Salzman committed
354
# corresponding to a cache size of 2^16 = 65536 symbols.
355 356 357

SYMBOL_CACHE_SIZE      = 0

Daniel Salzman's avatar
Daniel Salzman committed
358 359 360 361 362 363 364 365 366 367 368
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
# their name and scope. Since this can be an expensive process and often the
# same symbol appear multiple times in the code, doxygen keeps a cache of
# pre-resolved symbols. If the cache is too small doxygen will become slower.
# If the cache is too large, memory is wasted. The cache size is given by this
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols.

LOOKUP_CACHE_SIZE      = 0

369 370 371 372
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

Jan Včelák's avatar
Jan Včelák committed
373 374 375
# 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
376 377 378 379
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = YES

Jan Včelák's avatar
Jan Včelák committed
380
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
381 382
# will be included in the documentation.

383
EXTRACT_PRIVATE        = NO
384

Daniel Salzman's avatar
Daniel Salzman committed
385 386 387 388 389
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
# scope will be included in the documentation.

EXTRACT_PACKAGE        = NO

Jan Včelák's avatar
Jan Včelák committed
390
# If the EXTRACT_STATIC tag is set to YES all static members of a file
391 392
# will be included in the documentation.

393
EXTRACT_STATIC         = NO
394

Jan Včelák's avatar
Jan Včelák committed
395 396
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
397 398
# If set to NO only classes defined in header files are included.

Lubos Slovak's avatar
Lubos Slovak committed
399
EXTRACT_LOCAL_CLASSES  = YES
400

Jan Včelák's avatar
Jan Včelák committed
401 402 403
# 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.
404 405
# If set to NO (the default) only methods in the interface are included.

406
EXTRACT_LOCAL_METHODS  = NO
407

Jan Včelák's avatar
Jan Včelák committed
408 409 410 411
# 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
Daniel Salzman's avatar
Daniel Salzman committed
412
# anonymous namespaces are hidden.
413 414 415

EXTRACT_ANON_NSPACES   = NO

Jan Včelák's avatar
Jan Včelák committed
416 417 418 419
# 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.
420 421 422 423
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

Jan Včelák's avatar
Jan Včelák committed
424 425 426
# 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
427 428 429 430
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

Jan Včelák's avatar
Jan Včelák committed
431 432 433
# 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
434 435 436 437
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

Jan Včelák's avatar
Jan Včelák committed
438 439 440
# 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
441 442 443 444
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

Jan Včelák's avatar
Jan Včelák committed
445 446 447
# 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.
448 449 450 451
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

Jan Včelák's avatar
Jan Včelák committed
452 453 454 455
# 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
456 457 458 459
# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = NO

Jan Včelák's avatar
Jan Včelák committed
460 461
# 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
462 463 464 465
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = YES

Jan Včelák's avatar
Jan Včelák committed
466 467
# 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
468 469 470 471
# of that file.

SHOW_INCLUDE_FILES     = YES

Jan Včelák's avatar
Jan Včelák committed
472 473
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
# will list include files with double quotes in the documentation
Lubos Slovak's avatar
Lubos Slovak committed
474 475 476 477
# rather than with sharp brackets.

FORCE_LOCAL_INCLUDES   = NO

Jan Včelák's avatar
Jan Včelák committed
478
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
479 480 481 482
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

Jan Včelák's avatar
Jan Včelák committed
483 484 485
# 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
486 487 488 489
# declaration order.

SORT_MEMBER_DOCS       = YES

Jan Včelák's avatar
Jan Včelák committed
490 491 492
# 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
493 494 495 496
# declaration order.

SORT_BRIEF_DOCS        = NO

Jan Včelák's avatar
Jan Včelák committed
497 498 499 500 501 502
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
# will sort the (brief and detailed) documentation of class members so that
# constructors and destructors are listed first. If set to NO (the default)
# the constructors will appear in the respective orders defined by
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
Lubos Slovak's avatar
Lubos Slovak committed
503 504 505 506
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.

SORT_MEMBERS_CTORS_1ST = NO

Jan Včelák's avatar
Jan Včelák committed
507 508
# 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)
509 510 511 512
# the group names will appear in their defined order.

SORT_GROUP_NAMES       = NO

Jan Včelák's avatar
Jan Včelák committed
513 514 515 516 517 518
# 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.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the
519 520 521 522
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

Daniel Salzman's avatar
Daniel Salzman committed
523 524 525 526 527 528 529 530 531
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
# do proper type resolution of all parameters of a function it will reject a
# match between the prototype and the implementation of a member function even
# if there is only one candidate or it is obvious which candidate to choose
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
# will still accept a match between prototype and implementation in such cases.

STRICT_PROTO_MATCHING  = NO

Jan Včelák's avatar
Jan Včelák committed
532 533
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
534 535 536 537
# commands in the documentation.

GENERATE_TODOLIST      = YES

Jan Včelák's avatar
Jan Včelák committed
538 539
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
540 541 542 543
# commands in the documentation.

GENERATE_TESTLIST      = YES

Jan Včelák's avatar
Jan Včelák committed
544 545
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
546 547 548 549
# commands in the documentation.

GENERATE_BUGLIST       = YES

Jan Včelák's avatar
Jan Včelák committed
550 551
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
552 553 554 555
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

Jan Včelák's avatar
Jan Včelák committed
556
# The ENABLED_SECTIONS tag can be used to enable conditional
Daniel Salzman's avatar
Daniel Salzman committed
557 558
# documentation sections, marked by \if section-label ... \endif
# and \cond section-label ... \endcond blocks.
559

Jan Včelák's avatar
Jan Včelák committed
560
ENABLED_SECTIONS       =
561

Jan Včelák's avatar
Jan Včelák committed
562
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
Daniel Salzman's avatar
Daniel Salzman committed
563
# the initial value of a variable or macro consists of for it to appear in
Jan Včelák's avatar
Jan Včelák committed
564 565
# 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.
Daniel Salzman's avatar
Daniel Salzman committed
566
# The appearance of the initializer of individual variables and macros in the
Jan Včelák's avatar
Jan Včelák committed
567
# documentation can be controlled using \showinitializer or \hideinitializer
568 569
# command in the documentation regardless of this setting.

Lubos Slovak's avatar
Lubos Slovak committed
570
MAX_INITIALIZER_LINES  = 50
571

Jan Včelák's avatar
Jan Včelák committed
572 573
# 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
574 575 576 577
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

Jan Včelák's avatar
Jan Včelák committed
578 579
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
580 581 582 583
# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

Jan Včelák's avatar
Jan Včelák committed
584
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
Daniel Salzman's avatar
Daniel Salzman committed
585 586
# Namespaces page.
# This will remove the Namespaces entry from the Quick Index
587 588 589 590
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

Jan Včelák's avatar
Jan Včelák committed
591 592 593 594 595 596
# 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
597 598
# is used as the file version. See the manual for examples.

Jan Včelák's avatar
Jan Včelák committed
599
FILE_VERSION_FILTER    =
600

Jan Včelák's avatar
Jan Včelák committed
601 602
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
Daniel Salzman's avatar
Daniel Salzman committed
603
# output files in an output format independent way. To create the layout file
Jan Včelák's avatar
Jan Včelák committed
604 605
# that represents doxygen's defaults, run doxygen with the -l option.
# You can optionally specify a file name after the option, if omitted
Lubos Slovak's avatar
Lubos Slovak committed
606
# DoxygenLayout.xml will be used as the name of the layout file.
607

Jan Včelák's avatar
Jan Včelák committed
608
LAYOUT_FILE            =
609

Daniel Salzman's avatar
Daniel Salzman committed
610 611 612 613 614 615 616 617 618 619 620
# The CITE_BIB_FILES tag can be used to specify one or more bib files
# containing the references data. This must be a list of .bib files. The
# .bib extension is automatically appended if omitted. Using this command
# requires the bibtex tool to be installed. See also
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
# feature you need bibtex and perl available in the search path. Do not use
# file names with spaces, bibtex cannot handle them.

CITE_BIB_FILES         =

621 622 623 624
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

Jan Včelák's avatar
Jan Včelák committed
625
# The QUIET tag can be used to turn on/off the messages that are generated
626 627
# by doxygen. Possible values are YES and NO. If left blank NO is used.

Lubos Slovak's avatar
Lubos Slovak committed
628
QUIET                  = NO
629

Jan Včelák's avatar
Jan Včelák committed
630 631
# 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
632 633 634 635
# NO is used.

WARNINGS               = YES

Jan Včelák's avatar
Jan Včelák committed
636 637
# 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
638 639 640 641
# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

Jan Včelák's avatar
Jan Včelák committed
642 643 644
# 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
645 646 647 648
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

Daniel Salzman's avatar
Daniel Salzman committed
649
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
Jan Včelák's avatar
Jan Včelák committed
650 651 652
# 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
653 654
# documentation.

Lubos Slovak's avatar
Lubos Slovak committed
655
WARN_NO_PARAMDOC       = NO
656

Jan Včelák's avatar
Jan Včelák committed
657 658 659 660 661
# 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
662 663 664 665
# be obtained via FILE_VERSION_FILTER)

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

Jan Včelák's avatar
Jan Včelák committed
666 667
# 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
668 669
# to stderr.

Jan Včelák's avatar
Jan Včelák committed
670
WARN_LOGFILE           =
671 672 673 674 675

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

Jan Včelák's avatar
Jan Včelák committed
676 677 678
# 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
679 680
# with spaces.

681 682 683 684
INPUT                  = src/common \
                         src/libknot \
                         src/common \
                         src/knot \
685 686
                         src/zscanner \
                         src/utils \
Lubos Slovak's avatar
Lubos Slovak committed
687
                         Doxy.page.h
688

Jan Včelák's avatar
Jan Včelák committed
689 690 691 692
# 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
693 694 695 696
# the list of possible encodings.

INPUT_ENCODING         = UTF-8

Jan Včelák's avatar
Jan Včelák committed
697 698 699 700
# 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:
Daniel Salzman's avatar
Daniel Salzman committed
701 702 703
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
# *.f90 *.f *.for *.vhd *.vhdl
704 705

FILE_PATTERNS          = *.c \
Lubos Slovak's avatar
Lubos Slovak committed
706
                         *.h
707

Jan Včelák's avatar
Jan Včelák committed
708 709
# 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.
710 711 712 713
# If left blank NO is used.

RECURSIVE              = YES

Daniel Salzman's avatar
Daniel Salzman committed
714
# The EXCLUDE tag can be used to specify files and/or directories that should be
Jan Včelák's avatar
Jan Včelák committed
715
# excluded from the INPUT source files. This way you can easily exclude a
716
# subdirectory from a directory tree whose root is specified with the INPUT tag.
Daniel Salzman's avatar
Daniel Salzman committed
717 718
# Note that relative paths are relative to the directory from which doxygen is
# run.
719

720
EXCLUDE                =
721

Daniel Salzman's avatar
Daniel Salzman committed
722 723
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
724 725 726 727
# from the input.

EXCLUDE_SYMLINKS       = NO

Jan Včelák's avatar
Jan Včelák committed
728 729 730 731
# 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
732 733
# for example use the pattern */test/*

Jan Včelák's avatar
Jan Včelák committed
734
EXCLUDE_PATTERNS       =
735

Jan Včelák's avatar
Jan Včelák committed
736 737 738 739
# 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,
740 741
# AClass::ANamespace, ANamespace::*Test

Jan Včelák's avatar
Jan Včelák committed
742
EXCLUDE_SYMBOLS        =
743

Jan Včelák's avatar
Jan Včelák committed
744 745
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
746 747
# the \include command).

Jan Včelák's avatar
Jan Včelák committed
748
EXAMPLE_PATH           =
749

Jan Včelák's avatar
Jan Včelák committed
750 751 752
# 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
753 754 755 756
# blank all files are included.

EXAMPLE_PATTERNS       = *

Jan Včelák's avatar
Jan Včelák committed
757 758 759
# 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.
760 761 762 763
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

Jan Včelák's avatar
Jan Včelák committed
764 765
# 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
766 767
# the \image command).

Jan Včelák's avatar
Jan Včelák committed
768
IMAGE_PATH             =
769

Jan Včelák's avatar
Jan Včelák committed
770 771 772 773 774
# 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
Daniel Salzman's avatar
Daniel Salzman committed
775 776
# to standard output.
# If FILTER_PATTERNS is specified, this tag will be
777 778
# ignored.

Jan Včelák's avatar
Jan Včelák committed
779
INPUT_FILTER           =
780

Jan Včelák's avatar
Jan Včelák committed
781
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
Daniel Salzman's avatar
Daniel Salzman committed
782 783 784 785
# 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:
Jan Včelák's avatar
Jan Včelák committed
786
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
Daniel Salzman's avatar
Daniel Salzman committed
787 788
# info on how filters are used. If FILTER_PATTERNS is empty or if
# non of the patterns match the file name, INPUT_FILTER is applied.
789

Jan Včelák's avatar
Jan Včelák committed
790
FILTER_PATTERNS        =
791

Jan Včelák's avatar
Jan Včelák committed
792 793
# 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
794 795 796 797
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

Daniel Salzman's avatar
Daniel Salzman committed
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
# and it is also possible to disable source filtering for a specific pattern
# using *.ext= (so without naming a filter). This option only has effect when
# FILTER_SOURCE_FILES is enabled.

FILTER_SOURCE_PATTERNS =

# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page (index.html).
# This can be useful if you have a project on for instance GitHub and want reuse
# the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =

813 814 815 816
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

Jan Včelák's avatar
Jan Včelák committed
817 818 819
# 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
820 821 822 823
# VERBATIM_HEADERS is set to NO.

SOURCE_BROWSER         = YES

Jan Včelák's avatar
Jan Včelák committed
824
# Setting the INLINE_SOURCES tag to YES will include the body
825 826 827 828
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

Jan Včelák's avatar
Jan Včelák committed
829 830
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
Daniel Salzman's avatar
Daniel Salzman committed
831
# fragments. Normal C, C++ and Fortran comments will always remain visible.
832 833 834

STRIP_CODE_COMMENTS    = YES

Jan Včelák's avatar
Jan Včelák committed
835 836
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
837 838 839 840
# functions referencing it will be listed.

REFERENCED_BY_RELATION = NO

Jan Včelák's avatar
Jan Včelák committed
841 842
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
843 844 845 846
# called/used by that function will be listed.

REFERENCES_RELATION    = NO

Jan Včelák's avatar
Jan Včelák committed
847 848 849
# 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
Daniel Salzman's avatar
Daniel Salzman committed
850 851
# link to the source code.
# Otherwise they will link to the documentation.
852 853 854

REFERENCES_LINK_SOURCE = YES

Jan Včelák's avatar
Jan Včelák committed
855 856 857 858
# 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
859 860 861 862
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

Jan Včelák's avatar
Jan Včelák committed
863 864
# 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
865 866 867 868 869 870 871 872
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

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

Jan Včelák's avatar
Jan Včelák committed
873 874
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
875 876 877 878
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = YES

Jan Včelák's avatar
Jan Včelák committed
879 880
# 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
881 882 883 884
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

Jan Včelák's avatar
Jan Včelák committed
885 886 887
# 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
888 889
# should be ignored while generating the index headers.

Jan Včelák's avatar
Jan Včelák committed
890
IGNORE_PREFIX          =
891 892 893 894 895

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

Jan Včelák's avatar
Jan Včelák committed
896
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
897 898 899 900
# generate HTML output.

GENERATE_HTML          = YES

Jan Včelák's avatar
Jan Včelák committed
901 902
# 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
903 904 905 906
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

Jan Včelák's avatar
Jan Včelák committed
907 908
# 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
909 910 911 912
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

Jan Včelák's avatar
Jan Včelák committed
913 914
# 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
Daniel Salzman's avatar
Daniel Salzman committed
915 916 917 918 919 920 921 922
# standard header. Note that when using a custom header you are responsible
#  for the proper inclusion of any scripts and style sheets that doxygen
# needs, which is dependent on the configuration options used.
# It is advised to generate a default header using "doxygen -w html
# header.html footer.html stylesheet.css YourConfigFile" and then modify
# that header. Note that the header is subject to change so you typically
# have to redo this when upgrading to a newer version of doxygen or when
# changing the value of configuration settings such as GENERATE_TREEVIEW!
923

Jan Včelák's avatar
Jan Včelák committed
924
HTML_HEADER            =
925

Jan Včelák's avatar
Jan Včelák committed
926 927
# 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
928 929
# standard footer.

Jan Včelák's avatar
Jan Včelák committed
930
HTML_FOOTER            =
931

Jan Včelák's avatar
Jan Včelák committed
932 933
# 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
Daniel Salzman's avatar
Daniel Salzman committed
934 935 936 937
# fine-tune the look of the HTML output. If left blank doxygen will
# generate a default style sheet. Note that it is recommended to use
# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
# tag will in the future become obsolete.
938

Jan Včelák's avatar
Jan Včelák committed
939
HTML_STYLESHEET        =
940

Daniel Salzman's avatar
Daniel Salzman committed
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
# user-defined cascading style sheet that is included after the standard
# style sheets created by doxygen. Using this option one can overrule
# certain style aspects. This is preferred over using HTML_STYLESHEET
# since it does not replace the standard style sheet and is therefor more
# robust against future updates. Doxygen will copy the style sheet file to
# the output directory.

HTML_EXTRA_STYLESHEET  =

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
# the files will be copied as-is; there are no commands or markers available.

HTML_EXTRA_FILES       =

Jan Včelák's avatar
Jan Včelák committed
960
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
Daniel Salzman's avatar
Daniel Salzman committed
961
# Doxygen will adjust the colors in the style sheet and background images
Jan Včelák's avatar
Jan Včelák committed
962 963 964 965
# according to this color. Hue is specified as an angle on a colorwheel,
# see http://en.wikipedia.org/wiki/Hue for more information.
# For instance the value 0 represents red, 60 is yellow, 120 is green,
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
Lubos Slovak's avatar
Lubos Slovak committed
966 967 968 969
# The allowed range is 0 to 359.

HTML_COLORSTYLE_HUE    = 220

Jan Včelák's avatar
Jan Včelák committed
970 971
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
# the colors in the HTML output. For a value of 0 the output will use
Lubos Slovak's avatar
Lubos Slovak committed
972 973 974 975
# grayscales only. A value of 255 will produce the most vivid colors.

HTML_COLORSTYLE_SAT    = 100

Jan Včelák's avatar
Jan Včelák committed
976 977 978 979 980
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
# the luminance component of the colors in the HTML output. Values below
# 100 gradually make the output lighter, whereas values above 100 make
# the output darker. The value divided by 100 is the actual gamma applied,
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
Lubos Slovak's avatar
Lubos Slovak committed
981 982 983 984
# and 100 does not change the gamma.

HTML_COLORSTYLE_GAMMA  = 80

Jan Včelák's avatar
Jan Včelák committed
985 986
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
Lubos Slovak's avatar
Lubos Slovak committed
987 988 989 990
# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP         = YES

Jan Včelák's avatar
Jan Včelák committed
991 992
# 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
Daniel Salzman's avatar
Daniel Salzman committed
993
# page has loaded.
994 995 996

HTML_DYNAMIC_SECTIONS  = NO

Daniel Salzman's avatar
Daniel Salzman committed
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
# entries shown in the various tree structured indices initially; the user
# can expand and collapse entries dynamically later on. Doxygen will expand
# the tree to such a level that at most the specified number of entries are
# visible (unless a fully collapsed tree already exceeds this amount).
# So setting the number of entries 1 will produce a full collapsed tree by
# default. 0 is a special value representing an infinite number of entries
# and will result in a full expanded tree by default.

HTML_INDEX_NUM_ENTRIES = 100

Jan Včelák's avatar
Jan Včelák committed
1008 1009 1010 1011 1012 1013 1014 1015 1016
# 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
# it at startup.
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
Lubos Slovak's avatar
Lubos Slovak committed
1017
# for more information.
1018 1019 1020

GENERATE_DOCSET        = NO

Jan Včelák's avatar
Jan Včelák committed
1021 1022 1023
# 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)
1024 1025 1026 1027
# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

Jan Včelák's avatar
Jan Včelák committed
1028 1029 1030
# 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
1031 1032 1033 1034
# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

Daniel Salzman's avatar
Daniel Salzman committed
1035 1036 1037
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
# identify the documentation publisher. This should be a reverse domain-name
# style string, e.g. com.mycompany.MyDocSet.documentation.
Lubos Slovak's avatar
Lubos Slovak committed
1038 1039 1040 1041 1042 1043 1044

DOCSET_PUBLISHER_ID    = org.doxygen.Publisher

# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.

DOCSET_PUBLISHER_NAME  = Publisher

Jan Včelák's avatar
Jan Včelák committed
1045 1046 1047
# 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)
1048 1049 1050 1051
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

Jan Včelák's avatar
Jan Včelák committed
1052 1053 1054
# 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
1055 1056
# written to the html output directory.

Jan Včelák's avatar
Jan Včelák committed
1057
CHM_FILE               =
1058

Jan Včelák's avatar
Jan Včelák committed
1059 1060 1061
# 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
1062 1063
# the HTML help compiler on the generated index.hhp.

Jan Včelák's avatar
Jan Včelák committed
1064
HHC_LOCATION           =
1065

Jan Včelák's avatar
Jan Včelák committed
1066 1067
# 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
1068 1069 1070 1071
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

Jan Včelák's avatar
Jan Včelák committed
1072 1073
# 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
1074 1075
# content.

Jan Včelák's avatar
Jan Včelák committed
1076
CHM_INDEX_ENCODING     =
1077

Jan Včelák's avatar
Jan Včelák committed
1078 1079
# 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
1080 1081 1082 1083
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

Jan Včelák's avatar
Jan Včelák committed
1084
# The TOC_EXPAND flag can be set to YES to add extra items for group members
1085 1086 1087 1088
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             = NO

Jan Včelák's avatar
Jan Včelák committed
1089 1090 1091
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
# that can be used as input for Qt's qhelpgenerator to generate a
Lubos Slovak's avatar
Lubos Slovak committed
1092
# Qt Compressed Help (.qch) of the generated HTML documentation.
1093 1094 1095

GENERATE_QHP           = NO

Jan Včelák's avatar
Jan Včelák committed
1096 1097
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
1098 1099
# The path specified is relative to the HTML output folder.

Jan Včelák's avatar
Jan Včelák committed
1100
QCH_FILE               =
1101

Jan Včelák's avatar
Jan Včelák committed
1102 1103
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
1104 1105
# http://doc.trolltech.com/qthelpproject.html#namespace

Lubos Slovak's avatar
Lubos Slovak committed
1106
QHP_NAMESPACE          = org.doxygen.Project
1107

Jan Včelák's avatar
Jan Včelák committed
1108 1109
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
1110 1111 1112 1113
# http://doc.trolltech.com/qthelpproject.html#virtual-folders

QHP_VIRTUAL_FOLDER     = doc

Jan Včelák's avatar
Jan Včelák committed
1114 1115
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
# add. For more information please see
1116 1117
# http://doc.trolltech.com/qthelpproject.html#custom-filters

Jan Včelák's avatar
Jan Včelák committed
1118
QHP_CUST_FILTER_NAME   =
1119

Jan Včelák's avatar
Jan Včelák committed
1120 1121 1122
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
Lubos Slovak's avatar
Lubos Slovak committed
1123
# Qt Help Project / Custom Filters</a>.
1124

Jan Včelák's avatar
Jan Včelák committed
1125
QHP_CUST_FILTER_ATTRS  =
1126

Jan Včelák's avatar
Jan Včelák committed
1127 1128 1129 1130
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's
# filter section matches.
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
Lubos Slovak's avatar
Lubos Slovak committed
1131
# Qt Help Project / Filter Attributes</a>.
1132

Jan Včelák's avatar
Jan Včelák committed
1133
QHP_SECT_FILTER_ATTRS  =
1134

Jan Včelák's avatar
Jan Včelák committed
1135 1136 1137
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
1138 1139
# .qhp file.

Jan Včelák's avatar
Jan Včelák committed
1140
QHG_LOCATION           =
1141

Jan Včelák's avatar
Jan Včelák committed
1142
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
Daniel Salzman's avatar
Daniel Salzman committed
1143
#  will be generated, which together with the HTML files, form an Eclipse help
Jan Včelák's avatar
Jan Včelák committed
1144 1145 1146 1147 1148
# plugin. To install this plugin and make it available under the help contents
# menu in Eclipse, the contents of the directory containing the HTML and XML
# files needs to be copied into the plugins directory of eclipse. The name of
# the directory within the plugins directory should be the same as
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
Lubos Slovak's avatar
Lubos Slovak committed
1149 1150 1151 1152
# the help appears.

GENERATE_ECLIPSEHELP   = NO

Jan Včelák's avatar
Jan Včelák committed
1153 1154
# A unique identifier for the eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have
Lubos Slovak's avatar
Lubos Slovak committed
1155 1156 1157 1158
# this name.

ECLIPSE_DOC_ID         = org.doxygen.Project

Daniel Salzman's avatar
Daniel Salzman committed
1159 1160 1161 1162 1163
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
# at top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it. Since the tabs have the same information as the
# navigation tree you can set this option to NO if you already set
# GENERATE_TREEVIEW to YES.
1164 1165 1166

DISABLE_INDEX          = NO

Jan Včelák's avatar
Jan Včelák committed
1167 1168 1169 1170 1171 1172
# 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 YES, a side panel will be generated
# 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 (i.e. any modern browser).
Lubos Slovak's avatar
Lubos Slovak committed
1173
# Windows users are probably better off using the HTML help feature.
Daniel Salzman's avatar
Daniel Salzman committed
1174 1175
# Since the tree basically has the same information as the tab index you
# could consider to set DISABLE_INDEX to NO when enabling this option.
Lubos Slovak's avatar
Lubos Slovak committed
1176 1177 1178

GENERATE_TREEVIEW      = NO

Daniel Salzman's avatar
Daniel Salzman committed
1179 1180 1181 1182
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
# documentation. Note that a value of 0 will completely suppress the enum
# values from appearing in the overview section.
Lubos Slovak's avatar
Lubos Slovak committed
1183

Daniel Salzman's avatar
Daniel Salzman committed
1184
ENUM_VALUES_PER_LINE   = 4
1185

Jan Včelák's avatar
Jan Včelák committed
1186 1187
# 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
1188 1189 1190 1191
# is shown.

TREEVIEW_WIDTH         = 250

Jan Včelák's avatar
Jan Včelák committed
1192
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
Lubos Slovak's avatar
Lubos Slovak committed
1193 1194 1195 1196
# links to external symbols imported via tag files in a separate window.

EXT_LINKS_IN_WINDOW    = NO

Jan Včelák's avatar
Jan Včelák committed
1197 1198 1199 1200
# 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
1201 1202 1203 1204
# to force them to be regenerated.

FORMULA_FONTSIZE       = 10

Jan Včelák's avatar
Jan Včelák committed
1205 1206 1207 1208
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are
# not supported properly for IE 6.0, but are supported on all modern browsers.
# Note that when changing this option you need to delete any form_*.png files
Lubos Slovak's avatar
Lubos Slovak committed
1209 1210 1211 1212
# in the HTML output before the changes have effect.

FORMULA_TRANSPARENT    = YES

Daniel Salzman's avatar
Daniel Salzman committed
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
# (see http://www.mathjax.org) which uses client side Javascript for the
# rendering instead of using prerendered bitmaps. Use this if you do not
# have LaTeX installed or if you want to formulas look prettier in the HTML
# output. When enabled you may also need to install MathJax separately and
# configure the path to it using the MATHJAX_RELPATH option.

USE_MATHJAX            = NO

# When MathJax is enabled you can set the default output format to be used for
# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
# SVG. The default value is HTML-CSS, which is slower, but has the best
# compatibility.

MATHJAX_FORMAT         = HTML-CSS

# When MathJax is enabled you need to specify the location relative to the
# HTML output directory using the MATHJAX_RELPATH option. The destination
# directory should contain the MathJax.js script. For instance, if the mathjax
# directory is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to
# the MathJax Content Delivery Network so you can quickly see the result without
# installing MathJax.
# However, it is strongly recommended to install a local
# copy of MathJax from http://www.mathjax.org before deployment.

MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest

# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
# names that should be enabled during MathJax rendering.

MATHJAX_EXTENSIONS     =

Jan Včelák's avatar
Jan Včelák committed
1246 1247 1248 1249 1250 1251
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
# for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
# (GENERATE_DOCSET) there is already a search function so this one should
# typically be disabled. For large projects the javascript based search engine
Lubos Slovak's avatar
Lubos Slovak committed
1252 1253 1254 1255
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.

SEARCHENGINE           = YES

Jan Včelák's avatar
Jan Včelák committed
1256
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
Daniel Salzman's avatar
Daniel Salzman committed
1257 1258 1259 1260 1261 1262
# implemented using a web server instead of a web client using Javascript.
# There are two flavours of web server based search depending on the
# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
# searching and an index file used by the script. When EXTERNAL_SEARCH is
# enabled the indexing and searching needs to be provided by external tools.
# See the manual for details.
Lubos Slovak's avatar
Lubos Slovak committed
1263 1264 1265

SERVER_BASED_SEARCH    = NO

Daniel Salzman's avatar
Daniel Salzman committed
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain
# the search results. Doxygen ships with an example indexer (doxyindexer) and
# search engine (doxysearch.cgi) which are based on the open source search engine
# library Xapian. See the manual for configuration details.

EXTERNAL_SEARCH        = NO

# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will returned the search results when EXTERNAL_SEARCH is enabled.
# Doxygen ships with an example search engine (doxysearch) which is based on
# the open source search engine library Xapian. See the manual for configuration
# details.

SEARCHENGINE_URL       =

# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.

SEARCHDATA_FILE        = searchdata.xml

# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.

EXTERNAL_SEARCH_ID     =

# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
# of to a relative location where the documentation can be found.
# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...

EXTRA_SEARCH_MAPPINGS  =

1306 1307 1308 1309
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

Jan Včelák's avatar
Jan Včelák committed
1310
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1311 1312 1313 1314
# generate Latex output.

GENERATE_LATEX         = NO

Jan Včelák's avatar
Jan Včelák committed
1315 1316
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1317 1318 1319 1320
# put in front of it. If left blank `latex' will be used as the default path.

LATEX_OUTPUT           = latex

Jan Včelák's avatar
Jan Včelák committed
1321 1322 1323 1324
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name.
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
Lubos Slovak's avatar
Lubos Slovak committed
1325
# Makefile that is written to the output directory.
1326 1327 1328

LATEX_CMD_NAME         = latex

Jan Včelák's avatar
Jan Včelák committed
1329 1330
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
1331 1332 1333 1334
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

Jan Včelák's avatar
Jan Včelák committed
1335 1336
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
1337 1338 1339 1340
# save some trees in general.

COMPACT_LATEX          = NO

Jan Včelák's avatar
Jan Včelák committed
1341
# The PAPER_TYPE tag can be used to set the paper type that is used
Daniel Salzman's avatar
Daniel Salzman committed
1342
# by the printer. Possible values are: a4, letter, legal and
1343 1344 1345 1346
# executive. If left blank a4wide will be used.

PAPER_TYPE             = a4wide

Jan Včelák's avatar
Jan Včelák committed
1347
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1348 1349
# packages that should be included in the LaTeX output.

Jan Včelák's avatar
Jan Včelák committed
1350
EXTRA_PACKAGES         =
1351

Jan Včelák's avatar
Jan Včelák committed
1352 1353 1354
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
1355 1356
# standard header. Notice: only use this tag if you know what you are doing!

Jan Včelák's avatar
Jan Včelák committed
1357
LATEX_HEADER           =
1358

Daniel Salzman's avatar
Daniel Salzman committed
1359 1360 1361 1362 1363 1364 1365
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
# the generated latex document. The footer should contain everything after
# the last chapter. If it is left blank doxygen will generate a
# standard footer. Notice: only use this tag if you know what you are doing!

LATEX_FOOTER           =

Jan Včelák's avatar
Jan Včelák committed
1366 1367 1368
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
1369 1370 1371 1372
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = YES

Jan Včelák's avatar
Jan Včelák committed
1373 1374
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
1375 1376 1377 1378
# higher quality PDF documentation.

USE_PDFLATEX           = YES

Jan Včelák's avatar
Jan Včelák committed
1379 1380 1381
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
1382 1383 1384 1385
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

Jan Včelák's avatar
Jan Včelák committed
1386 1387
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
1388 1389 1390 1391
# in the output.

LATEX_HIDE_INDICES     = NO

Jan Včelák's avatar
Jan Včelák committed
1392 1393 1394
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
# source code with syntax highlighting in the LaTeX output.
# Note that which sources are shown also depends on other settings
Lubos Slovak's avatar
Lubos Slovak committed
1395 1396 1397 1398
# such as SOURCE_BROWSER.

LATEX_SOURCE_CODE      = NO

Daniel Salzman's avatar
Daniel Salzman committed
1399 1400 1401 1402 1403 1404
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
# http://en.wikipedia.org/wiki/BibTeX for more info.

LATEX_BIB_STYLE        = plain

1405 1406 1407 1408
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

Jan Včelák's avatar
Jan Včelák committed
1409 1410
# 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
1411 1412 1413 1414
# other RTF readers or editors.

GENERATE_RTF           = NO

Jan Včelák's avatar
Jan Včelák committed
1415 1416
# 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
1417 1418 1419 1420
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

Jan Včelák's avatar
Jan Včelák committed
1421 1422
# 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
1423 1424 1425 1426
# save some trees in general.

COMPACT_RTF            = NO

Jan Včelák's avatar
Jan Včelák committed
1427 1428 1429 1430 1431
# 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.
1432 1433 1434 1435
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

Daniel Salzman's avatar
Daniel Salzman committed
1436
# Load style sheet definitions from file. Syntax is similar to doxygen's
Jan Včelák's avatar
Jan Včelák committed
1437
# config file, i.e. a series of assignments. You only have to provide
1438 1439
# replacements, missing definitions are set to their default value.

Jan Včelák's avatar
Jan Včelák committed
1440
RTF_STYLESHEET_FILE    =
1441

Jan Včelák's avatar
Jan Včelák committed
1442
# Set optional variables used in the generation of an rtf document.
1443 1444
# Syntax is similar to doxygen's config file.

Jan Včelák's avatar
Jan Včelák committed
1445
RTF_EXTENSIONS_FILE    =
1446 1447 1448 1449 1450

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

Jan Včelák's avatar
Jan Včelák committed
1451
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1452 1453 1454 1455
# generate man pages

GENERATE_MAN           = NO

Jan Včelák's avatar
Jan Včelák committed
1456 1457
# 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
1458 1459 1460 1461
# put in front of it. If left blank `man' will be used as the default path.

MAN_OUTPUT             = man

Jan Včelák's avatar
Jan Včelák committed
1462
# The MAN_EXTENSION tag determines the extension that is added to
1463 1464 1465 1466
# the generated man pages (default is the subroutine's section .3)

MAN_EXTENSION          = .3

Jan Včelák's avatar
Jan Včelák committed
1467 1468 1469 1470
# 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
1471 1472 1473 1474 1475 1476 1477 1478
# would be unable to find the correct page. The default is NO.

MAN_LINKS              = NO

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

Jan Včelák's avatar
Jan Včelák committed
1479 1480
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
1481 1482 1483 1484
# the code including all documentation.

GENERATE_XML           = NO

Jan Včelák's avatar
Jan Včelák committed
1485 1486
# 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
1487 1488 1489 1490
# put in front of it. If left blank `xml' will be used as the default path.

XML_OUTPUT             = xml

Jan Včelák's avatar
Jan Včelák committed
1491 1492
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
1493 1494
# syntax of the XML files.

Jan Včelák's avatar
Jan Včelák committed
1495
XML_SCHEMA             =
1496

Jan Včelák's avatar
Jan Včelák committed
1497 1498
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
1499 1500
# syntax of the XML files.

Jan Včelák's avatar
Jan Včelák committed
1501
XML_DTD                =
1502

Jan Včelák's avatar
Jan Včelák committed
1503 1504 1505
# 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
1506 1507 1508 1509 1510 1511 1512 1513
# enabling this will significantly increase the size of the XML output.

XML_PROGRAMLISTING     = YES

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

Jan Včelák's avatar
Jan Včelák committed
1514 1515 1516 1517
# 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
1518 1519 1520 1521 1522 1523 1524 1525
# and incomplete at the moment.

GENERATE_AUTOGEN_DEF   = NO

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

Jan Včelák's avatar
Jan Včelák committed
1526 1527 1528 1529
# 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
1530 1531 1532 1533
# moment.

GENERATE_PERLMOD       = NO

Jan Včelák's avatar
Jan Včelák committed
1534 1535
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1536 1537 1538 1539
# to generate PDF and DVI output from the Perl module output.

PERLMOD_LATEX          = NO

Jan Včelák's avatar
Jan Včelák committed
1540
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
Daniel Salzman's avatar
Daniel Salzman committed
1541 1542 1543 1544
# 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
Jan Včelák's avatar
Jan Včelák committed
1545
# tag is set to NO the size of the Perl module output will be much smaller
1546 1547 1548 1549
# and Perl will parse it just the same.

PERLMOD_PRETTY         = YES

Jan Včelák's avatar
Jan Včelák committed
1550 1551 1552
# 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
1553 1554
# Makefile don't overwrite each other's variables.

Jan Včelák's avatar
Jan Včelák committed
1555
PERLMOD_MAKEVAR_PREFIX =
1556 1557

#---------------------------------------------------------------------------
Lubos Slovak's avatar
Lubos Slovak committed
1558
# Configuration options related to the preprocessor
1559 1560
#---------------------------------------------------------------------------

Jan Včelák's avatar
Jan Včelák committed
1561 1562
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
1563 1564 1565 1566
# files.

ENABLE_PREPROCESSING   = YES

Jan Včelák's avatar
Jan Včelák committed
1567 1568 1569
# 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
1570 1571 1572 1573
# way by setting EXPAND_ONLY_PREDEF to YES.

MACRO_EXPANSION        = NO

Jan Včelák's avatar
Jan Včelák committed
1574 1575
# 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
1576 1577 1578 1579
# PREDEFINED and EXPAND_AS_DEFINED tags.

EXPAND_ONLY_PREDEF     = NO

Jan Včelák's avatar
Jan Včelák committed
1580
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
Daniel Salzman's avatar
Daniel Salzman committed
1581
# pointed to by INCLUDE_PATH will be searched when a #include is found.
1582 1583 1584

SEARCH_INCLUDES        = YES

Jan Včelák's avatar
Jan Včelák committed
1585 1586
# 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
1587 1588
# the preprocessor.

Jan Včelák's avatar
Jan Včelák committed
1589
INCLUDE_PATH           =
1590

Jan Včelák's avatar
Jan Včelák committed
1591 1592 1593
# 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
1594 1595
# be used.

Jan Včelák's avatar
Jan Včelák committed
1596
INCLUDE_FILE_PATTERNS  =
1597

Jan Včelák's avatar
Jan Včelák committed
1598 1599 1600 1601 1602 1603
# 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
1604 1605
# instead of the = operator.

Jan Včelák's avatar
Jan Včelák committed
1606
PREDEFINED             =
1607

Jan Včelák's avatar
Jan Včelák committed
1608 1609 1610
# 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.
Daniel Salzman's avatar
Daniel Salzman committed
1611 1612
# Use the PREDEFINED tag if you want to use a different macro definition that
# overrules the definition found in the source code.
1613

Jan Včelák's avatar
Jan Včelák committed
1614
EXPAND_AS_DEFINED      =
1615

Jan Včelák's avatar
Jan Včelák committed
1616
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
Daniel Salzman's avatar
Daniel Salzman committed
1617 1618 1619
# doxygen's preprocessor will remove all references to function-like macros
# that are alone on a line, have an all uppercase name, and do not end with a
# semicolon, because these will confuse the parser if not removed.
1620 1621 1622 1623

SKIP_FUNCTION_MACROS   = YES

#---------------------------------------------------------------------------
Lubos Slovak's avatar
Lubos Slovak committed
1624
# Configuration::additions related to external references