doxy.config.in 75.6 KB
Newer Older
1
# Doxyfile 1.8.1
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
#
6
# All text after a hash (#) is considered a comment and will be ignored.
Jan Möbius's avatar
Jan Möbius committed
7 8 9 10
# The format is:
#       TAG = value [value, ...]
# For lists items can also be appended using:
#       TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ").
Jan Möbius's avatar
Jan Möbius committed
12 13 14 15 16

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

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

DOXYFILE_ENCODING      = UTF-8

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

PROJECT_NAME           = OpenMesh

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
Jan Möbius's avatar
Jan Möbius committed
33 34 35 36
# if some version control system is used.

PROJECT_NUMBER         =

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
# 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
53 54 55 56
# where doxygen was started. If left blank the current directory will be used.

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

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

CREATE_SUBDIRS         = NO

66 67 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
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
Jan Möbius's avatar
Jan Möbius committed
75 76 77 78
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.

OUTPUT_LANGUAGE        = English

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

BRIEF_MEMBER_DESC      = YES

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

REPEAT_BRIEF           = YES

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"
Jan Möbius's avatar
Jan Möbius committed
101 102
# "represents" "a" "an" "the"

103
ABBREVIATE_BRIEF       =
Jan Möbius's avatar
Jan Möbius committed
104

105 106
# 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
107 108 109 110
# description.

ALWAYS_DETAILED_SEC    = NO

111 112 113
# 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
114 115 116 117
# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

118 119
# 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
120 121 122 123
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

124 125 126 127 128
# 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
129 130
# path to strip.

131 132
STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@ \
                         @CMAKE_SOURCE_DIR@/src
Jan Möbius's avatar
Jan Möbius committed
133

134 135 136 137 138
# 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
139 140
# are normally passed to the compiler using the -I flag.

141 142
STRIP_FROM_INC_PATH    = @CMAKE_SOURCE_DIR@ \
                         @CMAKE_SOURCE_DIR@/src
Jan Möbius's avatar
Jan Möbius committed
143

144 145
# 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
146 147
# doesn't support long names like on DOS, Mac, or CD-ROM.

148
SHORT_NAMES            = YES
Jan Möbius's avatar
Jan Möbius committed
149

150 151 152 153
# 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
154 155 156 157
# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = YES

158 159 160 161
# 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
162 163 164 165
# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

166 167 168 169
# 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
170 171 172 173
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

174 175
# 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
176 177 178 179
# re-implements.

INHERIT_DOCS           = YES

180 181
# 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
182 183 184 185
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

186
# 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
187 188 189 190
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

191 192 193 194 195
# 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
196 197
# You can put \n's in the value part of an alias to insert newlines.

198 199 200 201 202 203 204 205
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
206

207 208 209
# 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
210 211 212 213
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

214 215 216
# 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
217 218 219 220
# scopes will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

221 222
# 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
223 224 225 226
# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

227 228
# 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
229 230 231 232
# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
# Doxygen selects the parser to use depending on the extension of the files it
# 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.

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

# 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
259 260
# diagrams that involve STL classes more complete and accurate.

Jan Möbius's avatar
Jan Möbius committed
261
BUILTIN_STL_SUPPORT    = YES
Jan Möbius's avatar
Jan Möbius committed
262

263
# 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
264 265 266 267
# enable parsing support.

CPP_CLI_SUPPORT        = NO

268 269
# 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
270 271 272 273
# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

274 275 276 277 278
# 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
# 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
279 280 281 282
# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

283 284 285
# 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
286 287 288 289
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = YES

290 291 292 293
# 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
294 295 296 297
# the \nosubgrouping command.

SUBGROUPING            = YES

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
# 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

# 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
320 321 322 323
# types are typedef'ed and only the typedef is referenced, never the tag name.

TYPEDEF_HIDES_STRUCT   = NO

324 325 326 327 328 329 330 331 332 333 334 335 336
# 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
# causing a significant performance penalty.
# 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
# a logarithmic scale so increasing the size by one will roughly double the
# 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,
# corresponding to a cache size of 2^16 = 65536 symbols.
Jan Möbius's avatar
Jan Möbius committed
337 338 339

SYMBOL_CACHE_SIZE      = 0

340 341 342 343 344 345 346 347 348 349 350
# 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

Jan Möbius's avatar
Jan Möbius committed
351 352 353 354
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

355 356 357
# 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
358 359 360 361
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = NO

362
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
Jan Möbius's avatar
Jan Möbius committed
363 364 365 366
# will be included in the documentation.

EXTRACT_PRIVATE        = NO

367 368 369 370 371
# 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

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

EXTRACT_STATIC         = NO

376 377
# 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
378 379 380 381
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

382 383 384
# 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
385 386 387 388
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

389 390 391 392 393
# 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
394 395 396

EXTRACT_ANON_NSPACES   = NO

397 398 399 400
# 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
401 402 403 404
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

405 406 407
# 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
408 409 410 411
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

412 413 414
# 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
415 416 417 418
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

419 420 421
# 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
422 423 424 425
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

426 427 428
# 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
429 430 431 432
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = YES

433 434 435 436
# 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
437 438 439 440
# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = YES

441 442
# 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
443 444 445 446
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

447 448
# 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
449 450 451 452
# of that file.

SHOW_INCLUDE_FILES     = YES

453 454 455 456 457 458 459
# 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
460 461 462 463
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

464 465 466
# 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
467 468 469 470
# declaration order.

SORT_MEMBER_DOCS       = YES

471 472 473
# 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
474 475 476 477
# declaration order.

SORT_BRIEF_DOCS        = NO

478 479 480 481 482 483 484 485 486 487 488 489
# 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
490 491 492 493
# the group names will appear in their defined order.

SORT_GROUP_NAMES       = NO

494 495 496 497 498 499
# 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
500 501 502 503
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

504 505 506 507 508 509 510 511 512 513 514
# 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
515 516 517 518
# commands in the documentation.

GENERATE_TODOLIST      = YES

519 520
# 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
521 522 523 524
# commands in the documentation.

GENERATE_TESTLIST      = YES

525 526
# 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
527 528 529 530
# commands in the documentation.

GENERATE_BUGLIST       = YES

531 532
# 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
533 534 535 536
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

537
# The ENABLED_SECTIONS tag can be used to enable conditional
Jan Möbius's avatar
Jan Möbius committed
538 539
# documentation sections, marked by \if sectionname ... \endif.

540
ENABLED_SECTIONS       = OPENMESH_INTERNAL_DOC
Jan Möbius's avatar
Jan Möbius committed
541

542 543 544 545 546 547
# 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
548 549 550 551
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

552 553
# 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
554 555 556 557
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

558 559
# 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
560 561 562 563
# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

564 565 566
# 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
567 568 569 570
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

571 572 573 574 575 576
# 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
577 578
# is used as the file version. See the manual for examples.

579
FILE_VERSION_FILTER    =
Jan Möbius's avatar
Jan Möbius committed
580

581 582 583 584 585 586
# 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
# output files in an output format independent way. The create the layout file
# 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
587

588 589 590 591 592 593 594 595 596 597 598
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
# feature you need bibtex and perl available in the search path.

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

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

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

QUIET                  = YES

609 610
# 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
611 612 613 614
# NO is used.

WARNINGS               = YES

615 616
# 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
617 618
# automatically be disabled.

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

621 622 623
# 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
624 625 626 627
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

628 629 630 631
# 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
632 633 634 635
# documentation.

WARN_NO_PARAMDOC       = NO

636 637 638 639 640
# 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
641 642 643 644
# be obtained via FILE_VERSION_FILTER)

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

645 646
# 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
647 648
# to stderr.

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

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

655 656 657
# 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
658 659 660 661
# with spaces.

INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/..

662 663 664 665
# 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
666 667 668 669
# the list of possible encodings.

INPUT_ENCODING         = UTF-8

670 671 672 673 674 675 676
# 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
677 678 679 680 681

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

682 683
# 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
684 685 686 687
# If left blank NO is used.

RECURSIVE              = YES

688 689
# 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
690
# subdirectory from a directory tree whose root is specified with the INPUT tag.
691 692
# Note that relative paths are relative to the directory from which doxygen is
# run.
Jan Möbius's avatar
Jan Möbius committed
693 694

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

699 700
# 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
701 702 703 704
# from the input.

EXCLUDE_SYMLINKS       = NO

705 706 707 708
# 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
709 710 711 712 713 714 715 716
# for example use the pattern */test/*

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

717 718 719 720
# 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
721 722
# AClass::ANamespace, ANamespace::*Test

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

725 726
# 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
727 728 729 730 731
# the \include command).

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

732 733 734
# 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
735 736 737
# blank all files are included.

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

741 742 743
# 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
744 745 746 747
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

748 749
# 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
750 751 752 753
# the \image command).

IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images

754 755 756 757 758 759 760
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command <filter> <input-file>, where <filter>
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output.
# If FILTER_PATTERNS is specified, this tag will be
Jan Möbius's avatar
Jan Möbius committed
761 762
# ignored.

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

765 766 767 768 769 770 771 772
# 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
773

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

776 777
# 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
778 779 780 781
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

782 783 784 785 786 787 788 789
# 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
790 791 792 793
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

794 795 796
# 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
797 798 799 800
# VERBATIM_HEADERS is set to NO.

SOURCE_BROWSER         = NO

801
# Setting the INLINE_SOURCES tag to YES will include the body
Jan Möbius's avatar
Jan Möbius committed
802 803 804 805
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

806 807
# 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
808 809 810 811
# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = YES

812 813
# 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
814 815 816 817
# functions referencing it will be listed.

REFERENCED_BY_RELATION = NO

818 819
# 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
820 821 822 823
# called/used by that function will be listed.

REFERENCES_RELATION    = NO

824 825 826 827
# 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
828 829 830 831
# Otherwise they will link to the documentation.

REFERENCES_LINK_SOURCE = YES

832 833 834 835
# 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
836 837 838 839
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

840 841
# 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
842 843 844 845 846 847 848 849
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

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

850 851
# 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
852 853 854 855
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = NO

856 857
# 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
858 859 860 861
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

862 863 864
# 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
865 866
# should be ignored while generating the index headers.

867
IGNORE_PREFIX          =
Jan Möbius's avatar
Jan Möbius committed
868 869 870 871 872

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

873
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
Jan Möbius's avatar
Jan Möbius committed
874 875 876 877
# generate HTML output.

GENERATE_HTML          = YES

878 879
# 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
880 881 882 883
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

884 885
# 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
886 887 888 889
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
# 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
905 906 907 908
# standard footer.

HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/html/acg_footer.html

909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
# style sheet in the HTML output directory as well, or it will be erased!

HTML_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       =

# 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
936

937 938 939
# 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
940

941
HTML_COLORSTYLE_SAT    = 100
Jan Möbius's avatar
Jan Möbius committed
942

943 944 945 946 947 948
# 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
949

950 951 952 953 954 955 956 957 958 959 960
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
961 962 963

HTML_DYNAMIC_SECTIONS  = NO

964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
# 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
985 986 987

GENERATE_DOCSET        = NO

988 989 990
# 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
991 992 993 994
# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

995 996 997
# 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
998 999 1000 1001
# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
# 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.

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
1015 1016 1017 1018
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

1019 1020 1021
# 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
1022 1023
# written to the html output directory.

1024
CHM_FILE               =
Jan Möbius's avatar
Jan Möbius committed
1025

1026 1027 1028
# 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
1029 1030
# the HTML help compiler on the generated index.hhp.

1031
HHC_LOCATION           =
Jan Möbius's avatar
Jan Möbius committed
1032

1033 1034
# 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
1035 1036 1037 1038
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

1039 1040
# 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
1041 1042
# content.

1043
CHM_INDEX_ENCODING     =
Jan Möbius's avatar
Jan Möbius committed
1044

1045 1046
# 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
1047 1048 1049 1050
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

1051
# 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
1052 1053 1054 1055
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             = NO

1056 1057 1058 1059
# 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
1060 1061 1062

GENERATE_QHP           = NO

1063 1064
# 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
1065 1066
# The path specified is relative to the HTML output folder.

1067
QCH_FILE               =
Jan Möbius's avatar
Jan Möbius committed
1068

1069 1070
# 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
1071 1072
# http://doc.trolltech.com/qthelpproject.html#namespace

1073
QHP_NAMESPACE          =
Jan Möbius's avatar
Jan Möbius committed
1074

1075 1076
# 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
1077 1078 1079 1080
# http://doc.trolltech.com/qthelpproject.html#virtual-folders

QHP_VIRTUAL_FOLDER     = doc

1081 1082
# 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
1083 1084
# http://doc.trolltech.com/qthelpproject.html#custom-filters

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

1087 1088 1089 1090
# 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
1091

1092
QHP_CUST_FILTER_ATTRS  =
Jan Möbius's avatar
Jan Möbius committed
1093

1094 1095 1096 1097 1098
# 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
1099

1100
QHP_SECT_FILTER_ATTRS  =
Jan Möbius's avatar
Jan Möbius committed
1101

1102 1103 1104
# 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
1105 1106
# .qhp file.

1107
QHG_LOCATION           =
Jan Möbius's avatar
Jan Möbius committed
1108

1109 1110 1111 1112 1113 1114 1115 1116
# 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
1117

1118
GENERATE_ECLIPSEHELP   = NO
Jan Möbius's avatar
Jan Möbius committed
1119

1120 1121 1122
# 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
1123

1124
ECLIPSE_DOC_ID         = org.doxygen.Project
Jan Möbius's avatar
Jan Möbius committed
1125

1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
# 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
1143

Jan Möbius's avatar
Jan Möbius committed
1144
GENERATE_TREEVIEW      = ALL
Jan Möbius's avatar
Jan Möbius committed
1145

1146 1147 1148 1149 1150 1151 1152 1153 1154
# 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
1155 1156
# is shown.

Jan Möbius's avatar
Jan Möbius committed
1157
TREEVIEW_WIDTH         = 300
Jan Möbius's avatar
Jan Möbius committed
1158

1159 1160 1161 1162 1163 1164 1165 1166 1167
# 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
1168 1169 1170 1171
# to force them to be regenerated.

FORMULA_FONTSIZE       = 10

1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
# 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

# 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     =

# 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
# implemented using a PHP enabled web server instead of at the web client
# using Javascript. Doxygen will generate the search PHP script and index
# file to put on the web server. The advantage of the server
# based approach is that it scales better to large projects and allows
# full text search. The disadvantages are that it is more difficult to setup
# and does not have live searching capabilities.

SERVER_BASED_SEARCH    = NO

Jan Möbius's avatar
Jan Möbius committed
1226 1227 1228 1229
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

1230
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
Jan Möbius's avatar
Jan Möbius committed
1231 1232 1233 1234
# generate Latex output.

GENERATE_LATEX         = NO

1235 1236
# 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
1237 1238 1239 1240
# put in front of it. If left blank `latex' will be used as the default path.

LATEX_OUTPUT           = latex

1241
# 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
1242
# invoked. If left blank `latex' will be used as the default command name.
1243 1244 1245
# 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
1246 1247 1248

LATEX_CMD_NAME         = latex

1249 1250
# 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
1251 1252 1253 1254
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

1255 1256
# 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
1257 1258 1259 1260
# save some trees in general.

COMPACT_LATEX          = NO

1261 1262
# 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
1263 1264 1265 1266
# executive. If left blank a4wide will be used.

PAPER_TYPE             = a4wide

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

1270
EXTRA_PACKAGES         =
Jan Möbius's avatar
Jan Möbius committed
1271

1272 1273 1274
# 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
1275 1276
# standard header. Notice: only use this tag if you know what you are doing!

1277 1278 1279 1280 1281 1282
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
1283

1284 1285 1286 1287 1288
LATEX_FOOTER           =

# 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
1289 1290 1291 1292
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = YES

1293 1294
# 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
1295 1296 1297 1298
# higher quality PDF documentation.

USE_PDFLATEX           = YES

1299 1300 1301
# 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
1302 1303 1304 1305
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

1306 1307
# 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
1308 1309 1310 1311
# in the output.

LATEX_HIDE_INDICES     = NO

1312 1313 1314 1315
# 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
1316 1317 1318

LATEX_SOURCE_CODE      = NO

1319 1320 1321 1322 1323 1324
# 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
1325 1326 1327 1328
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

1329 1330
# 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
1331 1332 1333 1334
# other RTF readers or editors.

GENERATE_RTF           = NO

1335 1336
# 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
1337 1338 1339 1340
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

1341 1342
# 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
1343 1344 1345 1346
# save some trees in general.

COMPACT_RTF            = NO

1347 1348 1349 1350 1351
# 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
1352 1353 1354 1355
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

1356 1357
# 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
1358 1359
# replacements, missing definitions are set to their default value.

1360
RTF_STYLESHEET_FILE    =
Jan Möbius's avatar
Jan Möbius committed
1361

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

1365
RTF_EXTENSIONS_FILE    =
Jan Möbius's avatar
Jan Möbius committed
1366 1367 1368 1369 1370

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

1371
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
Jan Möbius's avatar
Jan Möbius committed
1372 1373 1374 1375
# generate man pages

GENERATE_MAN           = NO

1376 1377
# 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
1378 1379 1380 1381
# put in front of it. If left blank `man' will be used as the default path.

MAN_OUTPUT             = man

1382
# The MAN_EXTENSION tag determines the extension that is added to
Jan Möbius's avatar
Jan Möbius committed
1383 1384 1385 1386
# the generated man pages (default is the subroutine's section .3)

MAN_EXTENSION          = .3

1387 1388 1389 1390
# 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
1391 1392 1393 1394 1395 1396 1397 1398
# would be unable to find the correct page. The default is NO.

MAN_LINKS              = NO

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

1399 1400
# 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
1401 1402 1403 1404
# the code including all documentation.

GENERATE_XML           = NO

1405 1406
# 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
1407 1408 1409 1410
# put in front of it. If left blank `xml' will be used as the default path.

XML_OUTPUT             = xml

1411 1412
# 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
1413 1414
# syntax of the XML files.

1415
XML_SCHEMA             =
Jan Möbius's avatar
Jan Möbius committed
1416

1417 1418
# 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
1419 1420
# syntax of the XML files.

1421
XML_DTD                =
Jan Möbius's avatar
Jan Möbius committed
1422

1423 1424 1425
# 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
1426 1427 1428 1429 1430 1431 1432 1433
# enabling this will significantly increase the size of the XML output.

XML_PROGRAMLISTING     = YES

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

1434 1435 1436 1437
# 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
1438 1439 1440 1441 1442 1443 1444 1445
# and incomplete at the moment.

GENERATE_AUTOGEN_DEF   = NO

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

1446 1447 1448 1449
# 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
Jan Möbius's avatar
Jan Möbius committed
1450 1451 1452 1453
# moment.

GENERATE_PERLMOD       = NO

1454 1455
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
Jan Möbius's avatar
Jan Möbius committed
1456 1457 1458 1459
# to generate PDF and DVI output from the Perl module output.

PERLMOD_LATEX          = NO

1460 1461 1462 1463 1464 1465
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
# nicely formatted so it can be parsed by a human reader.
# This is useful
# if you want to understand what is going on.
# On the other hand, if this
# tag is set to NO the size of the Perl module output will be much smaller
Jan Möbius's avatar
Jan Möbius committed
1466 1467 1468 1469
# and Perl will parse it just the same.

PERLMOD_PRETTY         = YES

1470 1471 1472
# 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
Jan Möbius's avatar
Jan Möbius committed
1473 1474
# Makefile don't overwrite each other's variables.

1475
PERLMOD_MAKEVAR_PREFIX =
Jan Möbius's avatar
Jan Möbius committed
1476 1477

#---------------------------------------------------------------------------
1478
# Configuration options related to the preprocessor
Jan Möbius's avatar
Jan Möbius committed
1479 1480
#---------------------------------------------------------------------------

1481 1482
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
Jan Möbius's avatar
Jan Möbius committed
1483 1484 1485 1486
# files.

ENABLE_PREPROCESSING   = YES

1487 1488 1489
# 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
Jan Möbius's avatar
Jan Möbius committed
1490 1491 1492 1493
# way by setting EXPAND_ONLY_PREDEF to YES.

MACRO_EXPANSION        = YES

1494 1495
# 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
Jan Möbius's avatar
Jan Möbius committed
1496 1497 1498 1499
# PREDEFINED and EXPAND_AS_DEFINED tags.

EXPAND_ONLY_PREDEF     = NO

1500 1501
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
# pointed to by INCLUDE_PATH will be searched when a #include is found.
Jan Möbius's avatar
Jan Möbius committed
1502 1503 1504

SEARCH_INCLUDES        = YES

1505 1506
# 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
Jan Möbius's avatar
Jan Möbius committed
1507 1508
# the preprocessor.

1509 1510
INCLUDE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/../src \
                         @CMAKE_CURRENT_SOURCE_DIR@/../
Jan Möbius's avatar
Jan Möbius committed
1511

1512 1513 1514
# 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
Jan Möbius's avatar
Jan Möbius committed
1515 1516
# be used.

1517
INCLUDE_FILE_PATTERNS  =
Jan Möbius's avatar
Jan Möbius committed
1518

1519 1520 1521 1522 1523 1524
# 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
Jan Möbius's avatar
Jan Möbius committed
1525 1526 1527
# instead of the = operator.

PREDEFINED             = DOXYGEN \
1528 1529
                         OM_Attribute=class \
                         DOXY_IGNORE_THIS
Jan Möbius's avatar
Jan Möbius committed
1530

1531 1532 1533 1534 1535
# 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.
# Use the PREDEFINED tag if you want to use a different macro definition that
# overrules the definition found in the source code.
Jan Möbius's avatar
Jan Möbius committed
1536

1537
EXPAND_AS_DEFINED      =
Jan Möbius's avatar
Jan Möbius committed
1538

1539 1540 1541 1542
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# 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.