doxygenConfig 64.9 KB
Newer Older
Alexander Wiebel's avatar
Alexander Wiebel committed
1
# Doxyfile 1.6.2
2 3 4 5 6 7 8 9 10 11 12 13

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

#---------------------------------------------------------------------------
14
# Project related configuration options
15 16
#---------------------------------------------------------------------------

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

DOXYFILE_ENCODING      = UTF-8

Alexander Wiebel's avatar
Alexander Wiebel committed
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 27
# by quotes) that should identify the project.

wiebel's avatar
wiebel committed
28
PROJECT_NAME           = OpenWalnut
29

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

34
PROJECT_NUMBER         = 1.3.1
35

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

OUTPUT_DIRECTORY       = doc/developer/

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

CREATE_SUBDIRS         = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
52 53 54 55 56 57 58 59 60 61
# 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-Cyrilic, Slovak,
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62 63 64

OUTPUT_LANGUAGE        = English

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

BRIEF_MEMBER_DESC      = YES

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

REPEAT_BRIEF           = YES

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

Alexander Wiebel's avatar
Alexander Wiebel committed
89
ABBREVIATE_BRIEF       =
90

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

ALWAYS_DETAILED_SEC    = YES

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

INLINE_INHERITED_MEMB  = NO

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

FULL_PATH_NAMES        = NO

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

Alexander Wiebel's avatar
Alexander Wiebel committed
117
STRIP_FROM_PATH        =
118

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

Alexander Wiebel's avatar
Alexander Wiebel committed
126
STRIP_FROM_INC_PATH    =
127

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

SHORT_NAMES            = NO

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

JAVADOC_AUTOBRIEF      = YES

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

QT_AUTOBRIEF           = NO

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

MULTILINE_CPP_IS_BRIEF = NO

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

INHERIT_DOCS           = YES

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

SEPARATE_MEMBER_PAGES  = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
170
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171 172
# Doxygen uses this value to replace tabs by spaces in code fragments.

173
TAB_SIZE               = 4
174

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

182 183 184 185 186 187 188 189
# for simple notes/problem notes
ALIASES                +=  "note=\par Notes:\n"
ALIASES                +=  "problem=\par Problems:\n"

# reminders and todos which are referenced on "related pages" tab
ALIASES                +=  "reminder=\xrefitem reminders \"Reminder\" \"Reminders\""
ALIASES                +=  "todo=\xrefitem todo \"Todo\" \"Todo List\"  <b>All:</b>"
ALIASES                +=  "todo{1}=\xrefitem todo \"Todo\" \"Todo List\" <b>\1:</b>"
190

Alexander Wiebel's avatar
Alexander Wiebel committed
191 192 193
# 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
194 195 196 197
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
198 199 200
# 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
201 202 203 204
# scopes will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
205 206
# 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
207 208 209 210
# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
211 212
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
213 214 215 216
# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
# 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, C#, 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 you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
233 234
# diagrams that involve STL classes more complete and accurate.

235
BUILTIN_STL_SUPPORT    = YES
236

Alexander Wiebel's avatar
Alexander Wiebel committed
237
# If you use Microsoft's C++/CLI language, you should set this option to YES to
238 239 240 241
# enable parsing support.

CPP_CLI_SUPPORT        = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
242 243
# 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
244 245 246 247
# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
248 249 250 251 252
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
253 254 255 256
# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
257 258 259
# 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
260 261 262 263
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
264 265 266 267
# 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
268 269 270 271
# the \nosubgrouping command.

SUBGROUPING            = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
272 273 274 275 276 277
# 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
278 279 280 281
# types are typedef'ed and only the typedef is referenced, never the tag name.

TYPEDEF_HIDES_STRUCT   = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
# 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 penality.
# 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 rougly 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

SYMBOL_CACHE_SIZE      = 0

298 299 300
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
301

Alexander Wiebel's avatar
Alexander Wiebel committed
302 303 304
# 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
305 306
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

307
EXTRACT_ALL            = NO
308

Alexander Wiebel's avatar
Alexander Wiebel committed
309
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
310 311 312 313
# will be included in the documentation.

EXTRACT_PRIVATE        = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
314
# If the EXTRACT_STATIC tag is set to YES all static members of a file
315 316 317 318
# will be included in the documentation.

EXTRACT_STATIC         = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
319 320
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
321 322 323 324
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
325 326 327
# 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.
328 329 330 331
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
332 333 334 335
# 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
336 337 338 339
# anonymous namespace are hidden.

EXTRACT_ANON_NSPACES   = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
340 341 342 343
# 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.
344 345 346 347
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
348 349 350
# 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
351 352 353 354
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
355 356 357
# 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
358 359 360 361
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
362 363 364
# 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
365 366 367 368
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
369 370 371
# 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.
372 373 374 375
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
376 377 378 379
# 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
380
# and Mac users are advised to set this option to NO.
381 382 383

CASE_SENSE_NAMES       = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
384 385
# 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
386 387 388 389
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
390 391
# 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
392 393 394 395
# of that file.

SHOW_INCLUDE_FILES     = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
396 397 398 399 400 401 402
# 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]
403 404 405 406
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
407 408 409
# 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
410 411 412 413
# declaration order.

SORT_MEMBER_DOCS       = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
414 415 416
# 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
417
# declaration order.
418

419
SORT_BRIEF_DOCS        = NO
420

Alexander Wiebel's avatar
Alexander Wiebel committed
421 422 423 424 425 426
# 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)
427
# the group names will appear in their defined order.
428

429 430
SORT_GROUP_NAMES       = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
431 432 433 434 435 436
# 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
437 438 439
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO
440

Alexander Wiebel's avatar
Alexander Wiebel committed
441 442
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
443 444 445 446
# commands in the documentation.

GENERATE_TODOLIST      = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
447 448
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
449 450 451 452
# commands in the documentation.

GENERATE_TESTLIST      = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
453 454
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
455 456 457 458
# commands in the documentation.

GENERATE_BUGLIST       = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
459 460
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
461 462 463 464
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

Alexander Wiebel's avatar
Alexander Wiebel committed
465
# The ENABLED_SECTIONS tag can be used to enable conditional
466 467
# documentation sections, marked by \if sectionname ... \endif.

Alexander Wiebel's avatar
Alexander Wiebel committed
468
ENABLED_SECTIONS       =
469

Alexander Wiebel's avatar
Alexander Wiebel committed
470 471 472 473 474 475
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
476 477 478 479
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

Alexander Wiebel's avatar
Alexander Wiebel committed
480 481
# 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
482 483 484 485
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
486 487
# 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
488 489 490 491
# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
492 493 494
# 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
495 496 497 498
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
499 500 501 502 503 504
# 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
505 506
# is used as the file version. See the manual for examples.

Alexander Wiebel's avatar
Alexander Wiebel committed
507 508 509 510 511 512 513 514 515
FILE_VERSION_FILTER    =

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

Sebastian Eichelbaum's avatar
[DOC]  
Sebastian Eichelbaum committed
516
# LAYOUT_FILE            = doc/developer/doxygenLayout.xml
517

518 519 520 521
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

Alexander Wiebel's avatar
Alexander Wiebel committed
522
# The QUIET tag can be used to turn on/off the messages that are generated
523 524 525 526
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
527 528
# 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
529 530 531 532
# NO is used.

WARNINGS               = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
533 534
# 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
535 536
# automatically be disabled.

537
WARN_IF_UNDOCUMENTED   = YES
538

Alexander Wiebel's avatar
Alexander Wiebel committed
539 540 541
# 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
542 543 544 545
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
546 547 548 549
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
# or return value. If set to NO (the default) doxygen will only warn about
# wrong or incomplete parameter documentation, but not about the absence of
550 551
# documentation.

552
WARN_NO_PARAMDOC       = YES
553

Alexander Wiebel's avatar
Alexander Wiebel committed
554 555 556 557 558
# 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
559
# be obtained via FILE_VERSION_FILTER)
560 561 562

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

Alexander Wiebel's avatar
Alexander Wiebel committed
563 564
# 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
565 566
# to stderr.

567
WARN_LOGFILE           =
568 569 570 571 572

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

Alexander Wiebel's avatar
Alexander Wiebel committed
573 574 575
# 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
576 577 578 579
# with spaces.

INPUT                  = src

Alexander Wiebel's avatar
Alexander Wiebel committed
580 581 582 583
# 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
584 585 586 587
# the list of possible encodings.

INPUT_ENCODING         = UTF-8

Alexander Wiebel's avatar
Alexander Wiebel committed
588 589 590 591 592
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
593
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
594

595 596 597
FILE_PATTERNS          = *.h \
                         *.hpp \
                         *.cpp
598

Alexander Wiebel's avatar
Alexander Wiebel committed
599 600
# 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.
601 602 603 604
# If left blank NO is used.

RECURSIVE              = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
605 606
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
607 608
# subdirectory from a directory tree whose root is specified with the INPUT tag.

609
EXCLUDE                = src/modules/data/ext \
610 611
                         src/modules/lic/fibernavigator \
                         src/modules/lic/fantom
612

Alexander Wiebel's avatar
Alexander Wiebel committed
613 614
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
615
# from the input.
616 617 618

EXCLUDE_SYMLINKS       = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
619 620 621 622
# 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
623
# for example use the pattern */test/*
624

Alexander Wiebel's avatar
Alexander Wiebel committed
625
EXCLUDE_PATTERNS       =
626

Alexander Wiebel's avatar
Alexander Wiebel committed
627 628 629 630
# 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,
631 632
# AClass::ANamespace, ANamespace::*Test

Alexander Wiebel's avatar
Alexander Wiebel committed
633
EXCLUDE_SYMBOLS        =
634

Alexander Wiebel's avatar
Alexander Wiebel committed
635 636
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
637 638
# the \include command).

Alexander Wiebel's avatar
Alexander Wiebel committed
639
EXAMPLE_PATH           =
640

Alexander Wiebel's avatar
Alexander Wiebel committed
641 642 643
# 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
644 645
# blank all files are included.

Alexander Wiebel's avatar
Alexander Wiebel committed
646
EXAMPLE_PATTERNS       =
647

Alexander Wiebel's avatar
Alexander Wiebel committed
648 649 650
# 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.
651 652 653 654
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
655 656
# 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
657 658
# the \image command).

Alexander Wiebel's avatar
Alexander Wiebel committed
659
IMAGE_PATH             =
660

Alexander Wiebel's avatar
Alexander Wiebel committed
661 662 663 664 665 666 667
# 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
668
# ignored.
669

Alexander Wiebel's avatar
Alexander Wiebel committed
670
INPUT_FILTER           =
671

Alexander Wiebel's avatar
Alexander Wiebel committed
672 673 674 675 676 677 678
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis.
# Doxygen will compare the file name with each pattern and apply the
# filter if there is a match.
# The filters are a list of the form:
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
679 680
# is applied to all files.

Alexander Wiebel's avatar
Alexander Wiebel committed
681
FILTER_PATTERNS        =
682

Alexander Wiebel's avatar
Alexander Wiebel committed
683 684
# 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
685 686 687 688 689 690 691 692
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

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

Alexander Wiebel's avatar
Alexander Wiebel committed
693 694 695
# 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
696
# VERBATIM_HEADERS is set to NO.
697 698 699

SOURCE_BROWSER         = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
700
# Setting the INLINE_SOURCES tag to YES will include the body
701 702 703 704
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
705 706
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
707 708 709 710
# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
711 712
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
713 714 715 716
# functions referencing it will be listed.

REFERENCED_BY_RELATION = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
717 718
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
719 720 721 722
# called/used by that function will be listed.

REFERENCES_RELATION    = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
723 724 725 726
# 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.
727 728 729 730
# Otherwise they will link to the documentation.

REFERENCES_LINK_SOURCE = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
731 732 733 734
# 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
735 736 737 738
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
739 740
# 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
741 742 743 744 745 746 747 748
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

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

Alexander Wiebel's avatar
Alexander Wiebel committed
749 750
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
751 752 753 754
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
755 756
# 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
757 758 759 760
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 3

Alexander Wiebel's avatar
Alexander Wiebel committed
761 762 763
# 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
764 765
# should be ignored while generating the index headers.

766
IGNORE_PREFIX          = W
767 768 769 770 771

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

Alexander Wiebel's avatar
Alexander Wiebel committed
772
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
773 774 775 776
# generate HTML output.

GENERATE_HTML          = YES

Alexander Wiebel's avatar
Alexander Wiebel committed
777 778 779
# If the HTML_FOOTER_DESCRIPTION tag is set to YES, Doxygen will 
# add generated date, project name and doxygen version to HTML footer.

780 781
# THIS IS A SuSE only addon
# HTML_FOOTER_DESCRIPTION= NO
Alexander Wiebel's avatar
Alexander Wiebel committed
782 783 784

# 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
785 786 787 788
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

Alexander Wiebel's avatar
Alexander Wiebel committed
789 790
# 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
791 792 793 794
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

Alexander Wiebel's avatar
Alexander Wiebel committed
795 796
# 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
797 798
# standard header.

Alexander Wiebel's avatar
Alexander Wiebel committed
799
HTML_HEADER            =
800

Alexander Wiebel's avatar
Alexander Wiebel committed
801 802
# 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
803 804
# standard footer.

Alexander Wiebel's avatar
Alexander Wiebel committed
805
HTML_FOOTER            =
806

Alexander Wiebel's avatar
Alexander Wiebel committed
807 808 809 810 811
# 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
812
# stylesheet in the HTML output directory as well, or it will be erased!
813

Alexander Wiebel's avatar
Alexander Wiebel committed
814
HTML_STYLESHEET        =
815

Alexander Wiebel's avatar
Alexander Wiebel committed
816 817 818 819 820 821 822 823 824 825
# 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         = NO

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

828
HTML_DYNAMIC_SECTIONS  = YES
829

Alexander Wiebel's avatar
Alexander Wiebel committed
830 831 832 833 834 835 836 837
# 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.
838 839 840 841
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.

GENERATE_DOCSET        = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
842 843 844
# 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)
845 846 847 848
# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

Alexander Wiebel's avatar
Alexander Wiebel committed
849 850 851
# 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
852 853 854 855
# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

Alexander Wiebel's avatar
Alexander Wiebel committed
856 857 858
# 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)
859 860 861 862
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
863 864 865
# 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
866
# written to the html output directory.
867

Alexander Wiebel's avatar
Alexander Wiebel committed
868
CHM_FILE               =
869

Alexander Wiebel's avatar
Alexander Wiebel committed
870 871 872
# 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
873 874
# the HTML help compiler on the generated index.hhp.

Alexander Wiebel's avatar
Alexander Wiebel committed
875
HHC_LOCATION           =
876

Alexander Wiebel's avatar
Alexander Wiebel committed
877 878
# 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
879 880 881 882
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
883 884
# 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
885 886
# content.

Alexander Wiebel's avatar
Alexander Wiebel committed
887
CHM_INDEX_ENCODING     =
888

Alexander Wiebel's avatar
Alexander Wiebel committed
889 890
# 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
891 892 893 894
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
895
# The TOC_EXPAND flag can be set to YES to add extra items for group members
896 897 898 899
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
900 901 902 903 904 905 906 907 908 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 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
# 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.

GENERATE_QHP           = NO

# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.

QCH_FILE               =

# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#namespace

QHP_NAMESPACE          = org.doxygen.Project

# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#virtual-folders

QHP_VIRTUAL_FOLDER     = doc

# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
# For more information please see
# http://doc.trolltech.com/qthelpproject.html#custom-filters

QHP_CUST_FILTER_NAME   =

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

QHP_CUST_FILTER_ATTRS  =

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

QHP_SECT_FILTER_ATTRS  =

# 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
# .qhp file.

QHG_LOCATION           =

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

GENERATE_ECLIPSEHELP   = NO

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

ECLIPSE_DOC_ID         = org.doxygen.Project

# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
967 968 969 970
# the value YES disables it.

DISABLE_INDEX          = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
971
# This tag can be used to set the number of enum values (range [1..20])
972 973 974 975
# that doxygen will group on one line in the generated HTML documentation.

ENUM_VALUES_PER_LINE   = 4

Alexander Wiebel's avatar
Alexander Wiebel committed
976 977
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
978
# If the tag value is set to FRAME, a side panel will be generated
Alexander Wiebel's avatar
Alexander Wiebel committed
979 980
# containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
981 982 983 984 985 986 987 988 989
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
# probably better off using the HTML help feature. Other possible values
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list;
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
# disables this behavior completely. For backwards compatibility with previous
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
# respectively.
990 991 992

GENERATE_TREEVIEW      = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
993 994
# 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
995 996 997 998
# is shown.

TREEVIEW_WIDTH         = 250

Alexander Wiebel's avatar
Alexander Wiebel committed
999 1000 1001 1002
# 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
1003 1004 1005 1006
# to force them to be regenerated.

FORMULA_FONTSIZE       = 10

Alexander Wiebel's avatar
Alexander Wiebel committed
1007 1008 1009 1010 1011
# 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.

1012
SEARCHENGINE           = NO
Alexander Wiebel's avatar
Alexander Wiebel committed
1013 1014 1015 1016 1017 1018 1019

# 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 disadvances is that it is more difficult to setup
# and does not have live searching capabilities.

SERVER_BASED_SEARCH    = NO

1020 1021 1022 1023
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

Alexander Wiebel's avatar
Alexander Wiebel committed
1024
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1025 1026 1027 1028
# generate Latex output.

GENERATE_LATEX         = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
1029 1030
# 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
1031 1032 1033 1034
# put in front of it. If left blank `latex' will be used as the default path.

LATEX_OUTPUT           = latex

Alexander Wiebel's avatar
Alexander Wiebel committed
1035
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1036
# invoked. If left blank `latex' will be used as the default command name.
Alexander Wiebel's avatar
Alexander Wiebel committed
1037 1038 1039
# 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.
1040 1041 1042

LATEX_CMD_NAME         = latex

Alexander Wiebel's avatar
Alexander Wiebel committed
1043 1044
# 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
1045 1046 1047 1048
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

Alexander Wiebel's avatar
Alexander Wiebel committed
1049 1050
# 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
1051 1052 1053 1054
# save some trees in general.

COMPACT_LATEX          = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
1055 1056
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
1057 1058 1059 1060
# executive. If left blank a4wide will be used.

PAPER_TYPE             = a4wide

Alexander Wiebel's avatar
Alexander Wiebel committed
1061
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1062 1063
# packages that should be included in the LaTeX output.

Alexander Wiebel's avatar
Alexander Wiebel committed
1064
EXTRA_PACKAGES         =
1065

Alexander Wiebel's avatar
Alexander Wiebel committed
1066 1067 1068
# 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
1069 1070
# standard header. Notice: only use this tag if you know what you are doing!

Alexander Wiebel's avatar
Alexander Wiebel committed
1071
LATEX_HEADER           =
1072

Alexander Wiebel's avatar
Alexander Wiebel committed
1073 1074 1075
# 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
1076 1077 1078 1079
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
1080 1081
# 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
1082 1083 1084 1085
# higher quality PDF documentation.

USE_PDFLATEX           = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
1086 1087 1088
# 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.
1089 1090 1091 1092
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
1093 1094
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
1095 1096 1097 1098
# in the output.

LATEX_HIDE_INDICES     = NO

Alexander Wiebel's avatar
Alexander Wiebel committed
1099 1100
# 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.

1101
LATEX_SOURCE_CODE      = YES
Alexander Wiebel's avatar
Alexander Wiebel committed
1102

1103 1104 1105 1106
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

Alexander Wiebel's avatar
Alexander Wiebel committed