doxy.config.in 79.8 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
# Doxyfile 1.8.4
Jan Möbius's avatar
Jan Möbius committed
2 3

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

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

19 20 21 22
# 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
Jan Möbius's avatar
Jan Möbius committed
23 24 25 26
# http://www.gnu.org/software/libiconv for the list of possible encodings.

DOXYFILE_ENCODING      = UTF-8

27 28 29
# 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.
Jan Möbius's avatar
Jan Möbius committed
30 31 32

PROJECT_NAME           = OpenMesh

33 34
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
Jan Möbius's avatar
Jan Möbius committed
35 36 37 38
# if some version control system is used.

PROJECT_NUMBER         =

39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
# 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           =

# 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
Jan Möbius's avatar
Jan Möbius committed
55 56 57 58
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = @CMAKE_BINARY_DIR@/Build/@ACG_PROJECT_DATADIR@/Doc

59 60 61 62 63
# 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
Jan Möbius's avatar
Jan Möbius committed
64 65 66 67
# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

68 69 70 71 72 73 74
# 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
Jan Möbius's avatar
Jan Möbius committed
75 76 77
# messages), Korean, Korean-en, Latvian, Lithuanian, Norwegian, Macedonian,
# Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic,
# Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
Jan Möbius's avatar
Jan Möbius committed
78 79 80

OUTPUT_LANGUAGE        = English

81 82 83
# 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).
Jan Möbius's avatar
Jan Möbius committed
84 85 86 87
# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

88 89 90
# 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
Jan Möbius's avatar
Jan Möbius committed
91 92 93 94
# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

95 96 97 98 99 100 101 102
# 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"
Jan Möbius's avatar
Jan Möbius committed
103 104
# "represents" "a" "an" "the"

105
ABBREVIATE_BRIEF       =
Jan Möbius's avatar
Jan Möbius committed
106

107 108
# 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
Jan Möbius's avatar
Jan Möbius committed
109 110 111 112
# description.

ALWAYS_DETAILED_SEC    = NO

113 114 115
# 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
Jan Möbius's avatar
Jan Möbius committed
116 117 118 119
# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

120 121
# 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
Jan Möbius's avatar
Jan Möbius committed
122 123 124 125
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

126 127 128 129 130
# 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
Jan Möbius's avatar
Jan Möbius committed
131 132 133
# 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.
Jan Möbius's avatar
Jan Möbius committed
134

135 136
STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@ \
                         @CMAKE_SOURCE_DIR@/src
Jan Möbius's avatar
Jan Möbius committed
137

138 139 140 141 142
# 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
Jan Möbius's avatar
Jan Möbius committed
143 144
# are normally passed to the compiler using the -I flag.

145 146
STRIP_FROM_INC_PATH    = @CMAKE_SOURCE_DIR@ \
                         @CMAKE_SOURCE_DIR@/src
Jan Möbius's avatar
Jan Möbius committed
147

148 149
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful if your file system
Jan Möbius's avatar
Jan Möbius committed
150 151
# doesn't support long names like on DOS, Mac, or CD-ROM.

152
SHORT_NAMES            = YES
Jan Möbius's avatar
Jan Möbius committed
153

154 155 156 157
# 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
Jan Möbius's avatar
Jan Möbius committed
158 159 160 161
# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = YES

162 163 164 165
# 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
Jan Möbius's avatar
Jan Möbius committed
166 167 168 169
# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

170 171 172 173
# 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
Jan Möbius's avatar
Jan Möbius committed
174 175 176 177
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

178 179
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
Jan Möbius's avatar
Jan Möbius committed
180 181 182 183
# re-implements.

INHERIT_DOCS           = YES

184 185
# 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
Jan Möbius's avatar
Jan Möbius committed
186 187 188 189
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

190
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
Jan Möbius's avatar
Jan Möbius committed
191 192 193 194
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

195 196 197 198 199
# 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:".
Jan Möbius's avatar
Jan Möbius committed
200 201
# You can put \n's in the value part of an alias to insert newlines.

202 203 204 205 206 207 208 209
ALIASES                =

# 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 Möbius's avatar
Jan Möbius committed
210

211 212 213
# 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
Jan Möbius's avatar
Jan Möbius committed
214 215 216 217
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

218 219 220
# 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
Jan Möbius's avatar
Jan Möbius committed
221 222 223 224
# scopes will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

225 226
# 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
Jan Möbius's avatar
Jan Möbius committed
227 228 229 230
# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

231 232
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
Jan Möbius's avatar
Jan Möbius committed
233 234 235 236
# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

237
# Doxygen selects the parser to use depending on the extension of the files it
Jan Möbius's avatar
Jan Möbius committed
238 239 240 241 242 243 244 245 246
# 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.
247 248 249 250 251 252 253 254 255 256 257 258

EXTENSION_MAPPING      =

# 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

Jan Möbius's avatar
Jan Möbius committed
259 260 261 262 263 264 265
# 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

266 267 268 269 270
# 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 makes the inheritance and collaboration
Jan Möbius's avatar
Jan Möbius committed
271 272
# diagrams that involve STL classes more complete and accurate.

Jan Möbius's avatar
Jan Möbius committed
273
BUILTIN_STL_SUPPORT    = YES
Jan Möbius's avatar
Jan Möbius committed
274

275
# If you use Microsoft's C++/CLI language, you should set this option to YES to
Jan Möbius's avatar
Jan Möbius committed
276 277 278 279
# enable parsing support.

CPP_CLI_SUPPORT        = NO

280 281
# 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
Jan Möbius's avatar
Jan Möbius committed
282 283 284 285
# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

Jan Möbius's avatar
Jan Möbius committed
286 287 288 289
# 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
290
# setting a simple type. If this is not the case, or you want to show the
Jan Möbius's avatar
Jan Möbius committed
291 292 293 294
# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

295 296 297
# 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
Jan Möbius's avatar
Jan Möbius committed
298 299 300 301
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = YES

302 303 304 305
# 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
Jan Möbius's avatar
Jan Möbius committed
306 307 308 309
# the \nosubgrouping command.

SUBGROUPING            = YES

310 311 312 313 314 315 316 317
# 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
Jan Möbius's avatar
Jan Möbius committed
318 319 320 321 322
# unions with only public data fields or simple typedef 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).
323 324 325 326 327 328 329 330 331

INLINE_SIMPLE_STRUCTS  = NO

# 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
Jan Möbius's avatar
Jan Möbius committed
332 333 334 335
# types are typedef'ed and only the typedef is referenced, never the tag name.

TYPEDEF_HIDES_STRUCT   = NO

Jan Möbius's avatar
Jan Möbius committed
336 337 338 339 340 341 342 343
# 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.
344 345 346

LOOKUP_CACHE_SIZE      = 0

Jan Möbius's avatar
Jan Möbius committed
347 348 349 350
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

351 352 353
# 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
Jan Möbius's avatar
Jan Möbius committed
354
# the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES
Jan Möbius's avatar
Jan Möbius committed
355 356 357

EXTRACT_ALL            = NO

358
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
Jan Möbius's avatar
Jan Möbius committed
359 360 361 362
# will be included in the documentation.

EXTRACT_PRIVATE        = NO

Jan Möbius's avatar
Jan Möbius committed
363 364
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
# scope will be included in the documentation.
365 366 367 368

EXTRACT_PACKAGE        = NO

# If the EXTRACT_STATIC tag is set to YES all static members of a file
Jan Möbius's avatar
Jan Möbius committed
369 370 371 372
# will be included in the documentation.

EXTRACT_STATIC         = NO

373 374
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
Jan Möbius's avatar
Jan Möbius committed
375 376 377 378
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

379 380 381
# 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.
Jan Möbius's avatar
Jan Möbius committed
382 383 384 385
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

386 387 388 389 390
# 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
# anonymous namespaces are hidden.
Jan Möbius's avatar
Jan Möbius committed
391 392 393

EXTRACT_ANON_NSPACES   = NO

394 395 396 397
# 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.
Jan Möbius's avatar
Jan Möbius committed
398 399 400 401
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

402 403 404
# 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
Jan Möbius's avatar
Jan Möbius committed
405 406 407 408
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

409 410 411
# 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
Jan Möbius's avatar
Jan Möbius committed
412 413 414 415
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

416 417 418
# 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
Jan Möbius's avatar
Jan Möbius committed
419 420 421 422
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

423 424 425
# 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.
Jan Möbius's avatar
Jan Möbius committed
426 427 428 429
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = YES

430 431 432 433
# 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
Jan Möbius's avatar
Jan Möbius committed
434 435 436 437
# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = YES

438 439
# 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
Jan Möbius's avatar
Jan Möbius committed
440 441 442 443
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

444 445
# 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
Jan Möbius's avatar
Jan Möbius committed
446 447 448 449
# of that file.

SHOW_INCLUDE_FILES     = YES

450 451 452 453 454 455 456
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
# will list include files with double quotes in the documentation
# rather than with sharp brackets.

FORCE_LOCAL_INCLUDES   = NO

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
Jan Möbius's avatar
Jan Möbius committed
457 458 459 460
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

461 462 463
# 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
Jan Möbius's avatar
Jan Möbius committed
464 465 466 467
# declaration order.

SORT_MEMBER_DOCS       = YES

468 469 470
# 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
Jan Möbius's avatar
Jan Möbius committed
471 472 473 474
# declaration order.

SORT_BRIEF_DOCS        = NO

475 476 477 478 479 480 481 482 483 484 485 486
# 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
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.

SORT_MEMBERS_CTORS_1ST = NO

# 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)
Jan Möbius's avatar
Jan Möbius committed
487 488 489 490
# the group names will appear in their defined order.

SORT_GROUP_NAMES       = NO

491 492 493 494 495 496
# 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
Jan Möbius's avatar
Jan Möbius committed
497 498 499 500
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

501 502 503 504 505 506 507 508 509 510 511
# 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

# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
Jan Möbius's avatar
Jan Möbius committed
512 513 514 515
# commands in the documentation.

GENERATE_TODOLIST      = YES

516 517
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
Jan Möbius's avatar
Jan Möbius committed
518 519 520 521
# commands in the documentation.

GENERATE_TESTLIST      = YES

522 523
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
Jan Möbius's avatar
Jan Möbius committed
524 525 526 527
# commands in the documentation.

GENERATE_BUGLIST       = YES

528 529
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
Jan Möbius's avatar
Jan Möbius committed
530 531 532 533
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

534
# The ENABLED_SECTIONS tag can be used to enable conditional
Jan Möbius's avatar
Jan Möbius committed
535 536
# documentation sections, marked by \if section-label ... \endif
# and \cond section-label ... \endcond blocks.
Jan Möbius's avatar
Jan Möbius committed
537

538
ENABLED_SECTIONS       = OPENMESH_INTERNAL_DOC
Jan Möbius's avatar
Jan Möbius committed
539

540 541 542 543 544 545
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or macro 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 macros in the
# documentation can be controlled using \showinitializer or \hideinitializer
Jan Möbius's avatar
Jan Möbius committed
546 547 548 549
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

550 551
# 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
Jan Möbius's avatar
Jan Möbius committed
552 553 554 555
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

556 557
# 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
Jan Möbius's avatar
Jan Möbius committed
558 559 560 561
# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

562 563 564
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page.
# This will remove the Namespaces entry from the Quick Index
Jan Möbius's avatar
Jan Möbius committed
565 566 567 568
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

569 570 571 572 573 574
# 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
Jan Möbius's avatar
Jan Möbius committed
575 576
# is used as the file version. See the manual for examples.

577
FILE_VERSION_FILTER    =
Jan Möbius's avatar
Jan Möbius committed
578

579 580
# 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
Jan Möbius's avatar
Jan Möbius committed
581
# output files in an output format independent way. To create the layout file
582 583 584
# that represents doxygen's defaults, run doxygen with the -l option.
# You can optionally specify a file name after the option, if omitted
# DoxygenLayout.xml will be used as the name of the layout file.
Jan Möbius's avatar
Jan Möbius committed
585

586 587 588 589 590 591 592 593
LAYOUT_FILE            =

# 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
Jan Möbius's avatar
Jan Möbius committed
594 595
# feature you need bibtex and perl available in the search path. Do not use
# file names with spaces, bibtex cannot handle them.
596 597

CITE_BIB_FILES         =
Jan Möbius's avatar
Jan Möbius committed
598 599 600 601 602

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

603
# The QUIET tag can be used to turn on/off the messages that are generated
Jan Möbius's avatar
Jan Möbius committed
604 605 606 607
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = YES

608 609
# 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
Jan Möbius's avatar
Jan Möbius committed
610 611 612 613
# NO is used.

WARNINGS               = YES

614 615
# 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
Jan Möbius's avatar
Jan Möbius committed
616 617
# automatically be disabled.

Jan Möbius's avatar
Jan Möbius committed
618
WARN_IF_UNDOCUMENTED   = NO
Jan Möbius's avatar
Jan Möbius committed
619

620 621 622
# 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
Jan Möbius's avatar
Jan Möbius committed
623 624 625 626
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

627 628 629 630
# The WARN_NO_PARAMDOC option can be enabled 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
Jan Möbius's avatar
Jan Möbius committed
631 632 633 634
# documentation.

WARN_NO_PARAMDOC       = NO

635 636 637 638 639
# 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
Jan Möbius's avatar
Jan Möbius committed
640 641 642 643
# be obtained via FILE_VERSION_FILTER)

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

644 645
# 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
Jan Möbius's avatar
Jan Möbius committed
646 647
# to stderr.

648
WARN_LOGFILE           =
Jan Möbius's avatar
Jan Möbius committed
649 650 651 652 653

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

654 655 656
# 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
Jan Möbius's avatar
Jan Möbius committed
657 658 659 660
# with spaces.

INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/..

661 662 663 664
# 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
Jan Möbius's avatar
Jan Möbius committed
665 666 667 668
# the list of possible encodings.

INPUT_ENCODING         = UTF-8

669 670 671 672 673 674 675
# 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++ *.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
Jan Möbius's avatar
Jan Möbius committed
676 677 678 679 680

FILE_PATTERNS          = *.cc \
                         *.hh \
                         *.docu

681 682
# 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.
Jan Möbius's avatar
Jan Möbius committed
683 684 685 686
# If left blank NO is used.

RECURSIVE              = YES

687 688
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
Jan Möbius's avatar
Jan Möbius committed
689
# subdirectory from a directory tree whose root is specified with the INPUT tag.
690 691
# Note that relative paths are relative to the directory from which doxygen is
# run.
Jan Möbius's avatar
Jan Möbius committed
692 693

EXCLUDE                = @CMAKE_CURRENT_SOURCE_DIR@/Examples \
694
                         @CMAKE_CURRENT_SOURCE_DIR@/../src/OpenMesh/Tools/Test \
Jan Möbius's avatar
Jan Möbius committed
695
                         @CMAKE_CURRENT_SOURCE_DIR@/../src/OpenMesh/Apps/Unsupported \
696
                         @CMAKE_CURRENT_BINARY_DIR@
Jan Möbius's avatar
Jan Möbius committed
697

698 699
# 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
Jan Möbius's avatar
Jan Möbius committed
700 701 702 703
# from the input.

EXCLUDE_SYMLINKS       = NO

704 705 706 707
# 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
Jan Möbius's avatar
Jan Möbius committed
708 709 710 711 712 713 714 715
# for example use the pattern */test/*

EXCLUDE_PATTERNS       = .svn \
                         CVS \
                         Debian64 \
                         *.moc.cc \
                         footer.hh

716 717 718 719
# 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,
Jan Möbius's avatar
Jan Möbius committed
720 721
# AClass::ANamespace, ANamespace::*Test

722
EXCLUDE_SYMBOLS        =
Jan Möbius's avatar
Jan Möbius committed
723

724 725
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
Jan Möbius's avatar
Jan Möbius committed
726 727 728 729 730
# the \include command).

EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/Examples \
                         @CMAKE_CURRENT_SOURCE_DIR@/Tutorial

731 732 733
# 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
Jan Möbius's avatar
Jan Möbius committed
734 735 736
# blank all files are included.

EXAMPLE_PATTERNS       = *.cc \
Jan Möbius's avatar
Jan Möbius committed
737 738
                         *.hh \
                         *.txt
Jan Möbius's avatar
Jan Möbius committed
739

740 741 742
# 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.
Jan Möbius's avatar
Jan Möbius committed
743 744 745 746
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

747 748
# 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
Jan Möbius's avatar
Jan Möbius committed
749 750 751 752
# the \image command).

IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images

753 754 755 756 757 758
# 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.
Jan Möbius's avatar
Jan Möbius committed
759 760 761 762
# If FILTER_PATTERNS is specified, this tag will be ignored.
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
Jan Möbius's avatar
Jan Möbius committed
763

764
INPUT_FILTER           =
Jan Möbius's avatar
Jan Möbius committed
765

766 767 768 769 770 771 772 773
# 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 or if
# non of the patterns match the file name, INPUT_FILTER is applied.
Jan Möbius's avatar
Jan Möbius committed
774

775
FILTER_PATTERNS        =
Jan Möbius's avatar
Jan Möbius committed
776

777 778
# 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
Jan Möbius's avatar
Jan Möbius committed
779 780 781 782
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

783 784 785 786 787 788 789 790
# 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 =

Jan Möbius's avatar
Jan Möbius committed
791 792 793 794 795 796 797
# 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 =

Jan Möbius's avatar
Jan Möbius committed
798 799 800 801
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

802 803 804
# 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
Jan Möbius's avatar
Jan Möbius committed
805 806 807 808
# VERBATIM_HEADERS is set to NO.

SOURCE_BROWSER         = NO

809
# Setting the INLINE_SOURCES tag to YES will include the body
Jan Möbius's avatar
Jan Möbius committed
810 811 812 813
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

814 815
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
Jan Möbius's avatar
Jan Möbius committed
816
# fragments. Normal C, C++ and Fortran comments will always remain visible.
Jan Möbius's avatar
Jan Möbius committed
817 818 819

STRIP_CODE_COMMENTS    = YES

820 821
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
Jan Möbius's avatar
Jan Möbius committed
822 823 824 825
# functions referencing it will be listed.

REFERENCED_BY_RELATION = NO

826 827
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
Jan Möbius's avatar
Jan Möbius committed
828 829 830 831
# called/used by that function will be listed.

REFERENCES_RELATION    = NO

832 833 834 835
# 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.
Jan Möbius's avatar
Jan Möbius committed
836 837 838 839
# Otherwise they will link to the documentation.

REFERENCES_LINK_SOURCE = YES

840 841 842 843
# 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
Jan Möbius's avatar
Jan Möbius committed
844 845 846 847
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

848 849
# 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
Jan Möbius's avatar
Jan Möbius committed
850 851 852 853 854 855 856 857
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

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

858 859
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
Jan Möbius's avatar
Jan Möbius committed
860 861 862 863
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = NO

864 865
# 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
Jan Möbius's avatar
Jan Möbius committed
866 867 868 869
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

870 871 872
# 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
Jan Möbius's avatar
Jan Möbius committed
873 874
# should be ignored while generating the index headers.

875
IGNORE_PREFIX          =
Jan Möbius's avatar
Jan Möbius committed
876 877 878 879 880

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

881
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
Jan Möbius's avatar
Jan Möbius committed
882 883 884 885
# generate HTML output.

GENERATE_HTML          = YES

886 887
# 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
Jan Möbius's avatar
Jan Möbius committed
888 889 890 891
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

892 893
# 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
Jan Möbius's avatar
Jan Möbius committed
894 895 896 897
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
# 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
# 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!

HTML_HEADER            =

# 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
Jan Möbius's avatar
Jan Möbius committed
913 914 915 916
# standard footer.

HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/html/acg_footer.html

917 918
# 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
Jan Möbius's avatar
Jan Möbius committed
919 920 921 922
# 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.
923 924 925

HTML_STYLESHEET        =

Jan Möbius's avatar
Jan Möbius committed
926 927 928 929 930 931 932 933 934 935
# 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  =

936 937 938
# 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
Jan Möbius's avatar
Jan Möbius committed
939
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
940 941 942 943 944 945 946 947 948 949 950 951 952 953
# 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       =

# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
# Doxygen will adjust the colors in the style sheet and background images
# 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.
# The allowed range is 0 to 359.

HTML_COLORSTYLE_HUE    = 220
Jan Möbius's avatar
Jan Möbius committed
954

955 956 957
# 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
# grayscales only. A value of 255 will produce the most vivid colors.
Jan Möbius's avatar
Jan Möbius committed
958

959
HTML_COLORSTYLE_SAT    = 100
Jan Möbius's avatar
Jan Möbius committed
960

961 962 963 964 965 966
# 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,
# and 100 does not change the gamma.
Jan Möbius's avatar
Jan Möbius committed
967

968 969 970 971 972 973 974 975 976 977 978
HTML_COLORSTYLE_GAMMA  = 80

# 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
# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP         = YES

# 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.
Jan Möbius's avatar
Jan Möbius committed
979 980 981

HTML_DYNAMIC_SECTIONS  = NO

982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
# 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

# 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
# for more information.
Jan Möbius's avatar
Jan Möbius committed
1003 1004 1005

GENERATE_DOCSET        = NO

1006 1007 1008
# 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)
Jan Möbius's avatar
Jan Möbius committed
1009 1010 1011 1012
# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

1013 1014 1015
# 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
Jan Möbius's avatar
Jan Möbius committed
1016 1017 1018 1019
# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

Jan Möbius's avatar
Jan Möbius committed
1020 1021 1022
# 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.
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032

DOCSET_PUBLISHER_ID    = org.doxygen.Publisher

# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.

DOCSET_PUBLISHER_NAME  = Publisher

# 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)
Jan Möbius's avatar
Jan Möbius committed
1033 1034 1035 1036
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

1037 1038 1039
# 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
Jan Möbius's avatar
Jan Möbius committed
1040 1041
# written to the html output directory.

1042
CHM_FILE               =
Jan Möbius's avatar
Jan Möbius committed
1043

1044 1045 1046
# 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
Jan Möbius's avatar
Jan Möbius committed
1047 1048
# the HTML help compiler on the generated index.hhp.

1049
HHC_LOCATION           =
Jan Möbius's avatar
Jan Möbius committed
1050

1051 1052
# 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
Jan Möbius's avatar
Jan Möbius committed
1053 1054 1055 1056
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

1057 1058
# 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
Jan Möbius's avatar
Jan Möbius committed
1059 1060
# content.

1061
CHM_INDEX_ENCODING     =
Jan Möbius's avatar
Jan Möbius committed
1062

1063 1064
# 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
Jan Möbius's avatar
Jan Möbius committed
1065 1066 1067 1068
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

1069
# The TOC_EXPAND flag can be set to YES to add extra items for group members
Jan Möbius's avatar
Jan Möbius committed
1070 1071 1072 1073
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             = NO

1074 1075 1076 1077
# 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
# Qt Compressed Help (.qch) of the generated HTML documentation.
Jan Möbius's avatar
Jan Möbius committed
1078 1079 1080

GENERATE_QHP           = NO

1081 1082
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
Jan Möbius's avatar
Jan Möbius committed
1083 1084
# The path specified is relative to the HTML output folder.

1085
QCH_FILE               =
Jan Möbius's avatar
Jan Möbius committed
1086

1087 1088
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
Jan Möbius's avatar
Jan Möbius committed
1089 1090
# http://doc.trolltech.com/qthelpproject.html#namespace

1091
QHP_NAMESPACE          =
Jan Möbius's avatar
Jan Möbius committed
1092

1093 1094
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
Jan Möbius's avatar
Jan Möbius committed
1095 1096 1097 1098
# http://doc.trolltech.com/qthelpproject.html#virtual-folders

QHP_VIRTUAL_FOLDER     = doc

1099 1100
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
# add. For more information please see
Jan Möbius's avatar
Jan Möbius committed
1101 1102
# http://doc.trolltech.com/qthelpproject.html#custom-filters

1103
QHP_CUST_FILTER_NAME   =
Jan Möbius's avatar
Jan Möbius committed
1104

1105 1106 1107 1108
# 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">
# Qt Help Project / Custom Filters</a>.
Jan Möbius's avatar
Jan Möbius committed
1109

1110
QHP_CUST_FILTER_ATTRS  =
Jan Möbius's avatar
Jan Möbius committed
1111

1112 1113 1114 1115 1116
# 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">
# Qt Help Project / Filter Attributes</a>.
Jan Möbius's avatar
Jan Möbius committed
1117

1118
QHP_SECT_FILTER_ATTRS  =
Jan Möbius's avatar
Jan Möbius committed
1119

1120 1121 1122
# 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
Jan Möbius's avatar
Jan Möbius committed
1123 1124
# .qhp file.

1125
QHG_LOCATION           =
Jan Möbius's avatar
Jan Möbius committed
1126

1127 1128 1129 1130 1131 1132 1133 1134
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
#  will be generated, which together with the HTML files, form an Eclipse help
# 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
# the help appears.
Jan Möbius's avatar
Jan Möbius committed
1135

1136
GENERATE_ECLIPSEHELP   = NO
Jan Möbius's avatar
Jan Möbius committed
1137

1138 1139 1140
# A unique identifier for the eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have
# this name.
Jan Möbius's avatar
Jan Möbius committed
1141

1142
ECLIPSE_DOC_ID         = org.doxygen.Project
Jan Möbius's avatar
Jan Möbius committed
1143

1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
# 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.

DISABLE_INDEX          = NO

# 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).
# Windows users are probably better off using the HTML help feature.
# 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.
Jan Möbius's avatar
Jan Möbius committed
1161

Jan Möbius's avatar
Jan Möbius committed
1162
GENERATE_TREEVIEW      = ALL
Jan Möbius's avatar
Jan Möbius committed
1163

1164 1165 1166 1167 1168 1169 1170 1171 1172
# 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.

ENUM_VALUES_PER_LINE   = 4

# 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
Jan Möbius's avatar
Jan Möbius committed
1173 1174
# is shown.

Jan Möbius's avatar
Jan Möbius committed
1175
TREEVIEW_WIDTH         = 300
Jan Möbius's avatar
Jan Möbius committed
1176

1177 1178 1179 1180 1181 1182 1183 1184 1185
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
# links to external symbols imported via tag files in a separate window.

EXT_LINKS_IN_WINDOW    = NO

# 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
Jan Möbius's avatar
Jan Möbius committed
1186 1187 1188 1189
# to force them to be regenerated.

FORMULA_FONTSIZE       = 10

1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
# 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
# in the HTML output before the changes have effect.

FORMULA_TRANSPARENT    = YES

# 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

Jan Möbius's avatar
Jan Möbius committed
1207 1208 1209 1210 1211 1212 1213
# When MathJax is enabled you can set the default output format to be used for
# the 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

1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
# 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 Möbius's avatar
Jan Möbius committed
1231 1232 1233 1234 1235
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript
# pieces of code that will be used on startup of the MathJax code.

MATHJAX_CODEFILE       =

1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
# 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
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.

SEARCHENGINE           = YES

# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
Jan Möbius's avatar
Jan Möbius committed
1247 1248 1249 1250 1251 1252
# 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.
1253 1254 1255

SERVER_BASED_SEARCH    = NO

Jan Möbius's avatar
Jan Möbius committed
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 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
# 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  =

Jan Möbius's avatar
Jan Möbius committed
1296 1297 1298 1299
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

1300
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
Jan Möbius's avatar
Jan Möbius committed
1301 1302 1303 1304
# generate Latex output.

GENERATE_LATEX         = NO

1305 1306
# 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
Jan Möbius's avatar
Jan Möbius committed
1307 1308 1309 1310
# put in front of it. If left blank `latex' will be used as the default path.

LATEX_OUTPUT           = latex

1311
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
Jan Möbius's avatar
Jan Möbius committed
1312
# invoked. If left blank `latex' will be used as the default command name.
1313 1314 1315
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
# Makefile that is written to the output directory.
Jan Möbius's avatar
Jan Möbius committed
1316 1317 1318

LATEX_CMD_NAME         = latex

1319 1320
# 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
Jan Möbius's avatar
Jan Möbius committed
1321 1322 1323 1324
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

1325 1326
# 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
Jan Möbius's avatar
Jan Möbius committed
1327 1328 1329 1330
# save some trees in general.

COMPACT_LATEX          = NO

1331 1332
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, letter, legal and
Jan Möbius's avatar
Jan Möbius committed
1333
# executive. If left blank a4 will be used.
Jan Möbius's avatar
Jan Möbius committed
1334 1335 1336

PAPER_TYPE             = a4wide

1337
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
Jan Möbius's avatar
Jan Möbius committed
1338 1339
# packages that should be included in the LaTeX output.

1340
EXTRA_PACKAGES         =
Jan Möbius's avatar
Jan Möbius committed
1341

1342 1343 1344
# 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
Jan Möbius's avatar
Jan Möbius committed
1345 1346
# standard header. Notice: only use this tag if you know what you are doing!

1347 1348 1349 1350 1351 1352
LATEX_HEADER           =

# 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!
Jan Möbius's avatar
Jan Möbius committed
1353

1354 1355
LATEX_FOOTER           =

Jan Möbius's avatar
Jan Möbius committed
1356 1357 1358 1359 1360 1361 1362
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images
# or other source files which should be copied to the LaTeX output directory.
# Note that the files will be copied as-is; there are no commands or markers
# available.

LATEX_EXTRA_FILES      =

1363 1364 1365
# 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
Jan Möbius's avatar
Jan Möbius committed
1366 1367 1368 1369
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = YES

1370 1371
# 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
Jan Möbius's avatar
Jan Möbius committed
1372 1373 1374 1375
# higher quality PDF documentation.

USE_PDFLATEX           = YES

1376 1377 1378
# 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.
Jan Möbius's avatar
Jan Möbius committed
1379 1380 1381 1382
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

1383 1384
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
Jan Möbius's avatar
Jan Möbius committed
1385 1386 1387 1388
# in the output.

LATEX_HIDE_INDICES     = NO

1389 1390 1391 1392
# 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
# such as SOURCE_BROWSER.
Jan Möbius's avatar
Jan Möbius committed
1393 1394 1395

LATEX_SOURCE_CODE      = NO

1396 1397 1398 1399 1400 1401
# 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

Jan Möbius's avatar
Jan Möbius committed
1402 1403 1404 1405
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

1406 1407
# 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
Jan Möbius's avatar
Jan Möbius committed
1408 1409 1410 1411
# other RTF readers or editors.

GENERATE_RTF           = NO

1412 1413
# 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
Jan Möbius's avatar
Jan Möbius committed
1414 1415 1416 1417
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

1418 1419
# 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
Jan Möbius's avatar
Jan Möbius committed
1420 1421 1422 1423
# save some trees in general.

COMPACT_RTF            = NO

1424 1425 1426 1427 1428
# 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.
Jan Möbius's avatar
Jan Möbius committed
1429 1430 1431 1432
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

1433 1434
# Load style sheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assignments. You only have to provide
Jan Möbius's avatar
Jan Möbius committed
1435 1436
# replacements, missing definitions are set to their default value.

1437
RTF_STYLESHEET_FILE    =
Jan Möbius's avatar
Jan Möbius committed
1438

1439
# Set optional variables used in the generation of an rtf document.
Jan Möbius's avatar
Jan Möbius committed
1440 1441
# Syntax is similar to doxygen's config file.

1442
RTF_EXTENSIONS_FILE    =
Jan Möbius's avatar
Jan Möbius committed
1443 1444 1445 1446 1447

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

1448
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
Jan Möbius's avatar
Jan Möbius committed
1449 1450 1451 1452
# generate man pages

GENERATE_MAN           = NO

1453 1454
# 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
Jan Möbius's avatar
Jan Möbius committed
1455 1456 1457 1458
# put in front of it. If left blank `man' will be used as the default path.

MAN_OUTPUT             = man

1459
# The MAN_EXTENSION tag determines the extension that is added to
Jan Möbius's avatar
Jan Möbius committed
1460 1461 1462 1463
# the generated man pages (default is the subroutine's section .3)

MAN_EXTENSION          = .3

1464 1465 1466 1467
# 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
Jan Möbius's avatar
Jan Möbius committed
1468 1469 1470 1471 1472 1473 1474 1475
# would be unable to find the correct page. The default is NO.

MAN_LINKS              = NO

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

1476 1477
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
Jan Möbius's avatar
Jan Möbius committed
1478 1479 1480 1481
# the code including all documentation.

GENERATE_XML           = NO

1482 1483
# 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
Jan Möbius's avatar
Jan Möbius committed
1484 1485 1486 1487
# put in front of it. If left blank `xml' will be used as the default path.

XML_OUTPUT             = xml

1488 1489
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
Jan Möbius's avatar
Jan Möbius committed
1490 1491
# syntax of the XML files.

1492
XML_SCHEMA             =
Jan Möbius's avatar
Jan Möbius committed
1493

1494 1495
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
Jan Möbius's avatar
Jan Möbius committed
1496 1497
# syntax of the XML files.

1498
XML_DTD                =
Jan Möbius's avatar
Jan Möbius committed
1499

1500 1501 1502
# 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
Jan Möbius's avatar
Jan Möbius committed
1503 1504 1505 1506
# enabling this will significantly increase the size of the XML output.

XML_PROGRAMLISTING     = YES

Jan Möbius's avatar
Jan Möbius committed
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
#---------------------------------------------------------------------------
# configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------

# If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files
# that can be used to generate PDF.

GENERATE_DOCBOOK       = NO

# The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
# front of it. If left blank docbook will be used as the default path.

DOCBOOK_OUTPUT         = docbook

Jan Möbius's avatar
Jan Möbius committed
1522 1523 1524 1525
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

1526 1527 1528 1529
# 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
Jan Möbius's avatar
Jan Möbius committed
1530 1531 1532 1533 1534 1535 1536 1537
# and incomplete at the moment.

GENERATE_AUTOGEN_DEF   = NO

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