include/doxyfile
author Sam Lantinga <slouken@libsdl.org>
Sun, 28 May 2006 13:04:16 +0000
branchSDL-1.3
changeset 1662 782fd950bd46
child 5067 61d53410eb41
permissions -rw-r--r--
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.

WARNING: None of the video drivers have been updated for the new API yet! The API is still under design and very fluid.

The code is now run through a consistent indent format:
indent -i4 -nut -nsc -br -ce

The headers are being converted to automatically generate doxygen documentation.
slouken@1662
     1
# Doxyfile 1.4.4
slouken@1662
     2
slouken@1662
     3
# This file describes the settings to be used by the documentation system
slouken@1662
     4
# doxygen (www.doxygen.org) for a project
slouken@1662
     5
#
slouken@1662
     6
# All text after a hash (#) is considered a comment and will be ignored
slouken@1662
     7
# The format is:
slouken@1662
     8
#       TAG = value [value, ...]
slouken@1662
     9
# For lists items can also be appended using:
slouken@1662
    10
#       TAG += value [value, ...]
slouken@1662
    11
# Values that contain spaces should be placed between quotes (" ")
slouken@1662
    12
slouken@1662
    13
#---------------------------------------------------------------------------
slouken@1662
    14
# Project related configuration options
slouken@1662
    15
#---------------------------------------------------------------------------
slouken@1662
    16
slouken@1662
    17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
slouken@1662
    18
# by quotes) that should identify the project.
slouken@1662
    19
slouken@1662
    20
PROJECT_NAME           = SDL
slouken@1662
    21
slouken@1662
    22
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
slouken@1662
    23
# This could be handy for archiving the generated documentation or 
slouken@1662
    24
# if some version control system is used.
slouken@1662
    25
slouken@1662
    26
PROJECT_NUMBER         = 1.3.0
slouken@1662
    27
slouken@1662
    28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
slouken@1662
    29
# base path where the generated documentation will be put. 
slouken@1662
    30
# If a relative path is entered, it will be relative to the location 
slouken@1662
    31
# where doxygen was started. If left blank the current directory will be used.
slouken@1662
    32
slouken@1662
    33
OUTPUT_DIRECTORY       = docs
slouken@1662
    34
slouken@1662
    35
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
slouken@1662
    36
# 4096 sub-directories (in 2 levels) under the output directory of each output 
slouken@1662
    37
# format and will distribute the generated files over these directories. 
slouken@1662
    38
# Enabling this option can be useful when feeding doxygen a huge amount of 
slouken@1662
    39
# source files, where putting all generated files in the same directory would 
slouken@1662
    40
# otherwise cause performance problems for the file system.
slouken@1662
    41
slouken@1662
    42
CREATE_SUBDIRS         = NO
slouken@1662
    43
slouken@1662
    44
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
slouken@1662
    45
# documentation generated by doxygen is written. Doxygen will use this 
slouken@1662
    46
# information to generate all constant output in the proper language. 
slouken@1662
    47
# The default language is English, other supported languages are: 
slouken@1662
    48
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 
slouken@1662
    49
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 
slouken@1662
    50
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 
slouken@1662
    51
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 
slouken@1662
    52
# Swedish, and Ukrainian.
slouken@1662
    53
slouken@1662
    54
OUTPUT_LANGUAGE        = English
slouken@1662
    55
slouken@1662
    56
# This tag can be used to specify the encoding used in the generated output. 
slouken@1662
    57
# The encoding is not always determined by the language that is chosen, 
slouken@1662
    58
# but also whether or not the output is meant for Windows or non-Windows users. 
slouken@1662
    59
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
slouken@1662
    60
# forces the Windows encoding (this is the default for the Windows binary), 
slouken@1662
    61
# whereas setting the tag to NO uses a Unix-style encoding (the default for 
slouken@1662
    62
# all platforms other than Windows).
slouken@1662
    63
slouken@1662
    64
USE_WINDOWS_ENCODING   = NO
slouken@1662
    65
slouken@1662
    66
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
slouken@1662
    67
# include brief member descriptions after the members that are listed in 
slouken@1662
    68
# the file and class documentation (similar to JavaDoc). 
slouken@1662
    69
# Set to NO to disable this.
slouken@1662
    70
slouken@1662
    71
BRIEF_MEMBER_DESC      = YES
slouken@1662
    72
slouken@1662
    73
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
slouken@1662
    74
# the brief description of a member or function before the detailed description. 
slouken@1662
    75
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
slouken@1662
    76
# brief descriptions will be completely suppressed.
slouken@1662
    77
slouken@1662
    78
REPEAT_BRIEF           = YES
slouken@1662
    79
slouken@1662
    80
# This tag implements a quasi-intelligent brief description abbreviator 
slouken@1662
    81
# that is used to form the text in various listings. Each string 
slouken@1662
    82
# in this list, if found as the leading text of the brief description, will be 
slouken@1662
    83
# stripped from the text and the result after processing the whole list, is 
slouken@1662
    84
# used as the annotated text. Otherwise, the brief description is used as-is. 
slouken@1662
    85
# If left blank, the following values are used ("$name" is automatically 
slouken@1662
    86
# replaced with the name of the entity): "The $name class" "The $name widget" 
slouken@1662
    87
# "The $name file" "is" "provides" "specifies" "contains" 
slouken@1662
    88
# "represents" "a" "an" "the"
slouken@1662
    89
slouken@1662
    90
ABBREVIATE_BRIEF       = 
slouken@1662
    91
slouken@1662
    92
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
slouken@1662
    93
# Doxygen will generate a detailed section even if there is only a brief 
slouken@1662
    94
# description.
slouken@1662
    95
slouken@1662
    96
ALWAYS_DETAILED_SEC    = NO
slouken@1662
    97
slouken@1662
    98
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
slouken@1662
    99
# inherited members of a class in the documentation of that class as if those 
slouken@1662
   100
# members were ordinary class members. Constructors, destructors and assignment 
slouken@1662
   101
# operators of the base classes will not be shown.
slouken@1662
   102
slouken@1662
   103
INLINE_INHERITED_MEMB  = NO
slouken@1662
   104
slouken@1662
   105
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
slouken@1662
   106
# path before files name in the file list and in the header files. If set 
slouken@1662
   107
# to NO the shortest path that makes the file name unique will be used.
slouken@1662
   108
slouken@1662
   109
FULL_PATH_NAMES        = YES
slouken@1662
   110
slouken@1662
   111
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
slouken@1662
   112
# can be used to strip a user-defined part of the path. Stripping is 
slouken@1662
   113
# only done if one of the specified strings matches the left-hand part of 
slouken@1662
   114
# the path. The tag can be used to show relative paths in the file list. 
slouken@1662
   115
# If left blank the directory from which doxygen is run is used as the 
slouken@1662
   116
# path to strip.
slouken@1662
   117
slouken@1662
   118
STRIP_FROM_PATH        = 
slouken@1662
   119
slouken@1662
   120
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
slouken@1662
   121
# the path mentioned in the documentation of a class, which tells 
slouken@1662
   122
# the reader which header file to include in order to use a class. 
slouken@1662
   123
# If left blank only the name of the header file containing the class 
slouken@1662
   124
# definition is used. Otherwise one should specify the include paths that 
slouken@1662
   125
# are normally passed to the compiler using the -I flag.
slouken@1662
   126
slouken@1662
   127
STRIP_FROM_INC_PATH    = 
slouken@1662
   128
slouken@1662
   129
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
slouken@1662
   130
# (but less readable) file names. This can be useful is your file systems 
slouken@1662
   131
# doesn't support long names like on DOS, Mac, or CD-ROM.
slouken@1662
   132
slouken@1662
   133
SHORT_NAMES            = NO
slouken@1662
   134
slouken@1662
   135
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
slouken@1662
   136
# will interpret the first line (until the first dot) of a JavaDoc-style 
slouken@1662
   137
# comment as the brief description. If set to NO, the JavaDoc 
slouken@1662
   138
# comments will behave just like the Qt-style comments (thus requiring an 
slouken@1662
   139
# explicit @brief command for a brief description.
slouken@1662
   140
slouken@1662
   141
JAVADOC_AUTOBRIEF      = NO
slouken@1662
   142
slouken@1662
   143
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
slouken@1662
   144
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
slouken@1662
   145
# comments) as a brief description. This used to be the default behaviour. 
slouken@1662
   146
# The new default is to treat a multi-line C++ comment block as a detailed 
slouken@1662
   147
# description. Set this tag to YES if you prefer the old behaviour instead.
slouken@1662
   148
slouken@1662
   149
MULTILINE_CPP_IS_BRIEF = NO
slouken@1662
   150
slouken@1662
   151
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
slouken@1662
   152
# will output the detailed description near the top, like JavaDoc.
slouken@1662
   153
# If set to NO, the detailed description appears after the member 
slouken@1662
   154
# documentation.
slouken@1662
   155
slouken@1662
   156
DETAILS_AT_TOP         = NO
slouken@1662
   157
slouken@1662
   158
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
slouken@1662
   159
# member inherits the documentation from any documented member that it 
slouken@1662
   160
# re-implements.
slouken@1662
   161
slouken@1662
   162
INHERIT_DOCS           = YES
slouken@1662
   163
slouken@1662
   164
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
slouken@1662
   165
# tag is set to YES, then doxygen will reuse the documentation of the first 
slouken@1662
   166
# member in the group (if any) for the other members of the group. By default 
slouken@1662
   167
# all members of a group must be documented explicitly.
slouken@1662
   168
slouken@1662
   169
DISTRIBUTE_GROUP_DOC   = NO
slouken@1662
   170
slouken@1662
   171
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
slouken@1662
   172
# a new page for each member. If set to NO, the documentation of a member will 
slouken@1662
   173
# be part of the file/class/namespace that contains it.
slouken@1662
   174
slouken@1662
   175
SEPARATE_MEMBER_PAGES  = NO
slouken@1662
   176
slouken@1662
   177
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
slouken@1662
   178
# Doxygen uses this value to replace tabs by spaces in code fragments.
slouken@1662
   179
slouken@1662
   180
TAB_SIZE               = 8
slouken@1662
   181
slouken@1662
   182
# This tag can be used to specify a number of aliases that acts 
slouken@1662
   183
# as commands in the documentation. An alias has the form "name=value". 
slouken@1662
   184
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
slouken@1662
   185
# put the command \sideeffect (or @sideeffect) in the documentation, which 
slouken@1662
   186
# will result in a user-defined paragraph with heading "Side Effects:". 
slouken@1662
   187
# You can put \n's in the value part of an alias to insert newlines.
slouken@1662
   188
slouken@1662
   189
ALIASES                = 
slouken@1662
   190
slouken@1662
   191
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
slouken@1662
   192
# sources only. Doxygen will then generate output that is more tailored for C. 
slouken@1662
   193
# For instance, some of the names that are used will be different. The list 
slouken@1662
   194
# of all members will be omitted, etc.
slouken@1662
   195
slouken@1662
   196
OPTIMIZE_OUTPUT_FOR_C  = YES
slouken@1662
   197
slouken@1662
   198
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
slouken@1662
   199
# only. Doxygen will then generate output that is more tailored for Java. 
slouken@1662
   200
# For instance, namespaces will be presented as packages, qualified scopes 
slouken@1662
   201
# will look different, etc.
slouken@1662
   202
slouken@1662
   203
OPTIMIZE_OUTPUT_JAVA   = NO
slouken@1662
   204
slouken@1662
   205
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
slouken@1662
   206
# the same type (for instance a group of public functions) to be put as a 
slouken@1662
   207
# subgroup of that type (e.g. under the Public Functions section). Set it to 
slouken@1662
   208
# NO to prevent subgrouping. Alternatively, this can be done per class using 
slouken@1662
   209
# the \nosubgrouping command.
slouken@1662
   210
slouken@1662
   211
SUBGROUPING            = YES
slouken@1662
   212
slouken@1662
   213
#---------------------------------------------------------------------------
slouken@1662
   214
# Build related configuration options
slouken@1662
   215
#---------------------------------------------------------------------------
slouken@1662
   216
slouken@1662
   217
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
slouken@1662
   218
# documentation are documented, even if no documentation was available. 
slouken@1662
   219
# Private class members and static file members will be hidden unless 
slouken@1662
   220
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
slouken@1662
   221
slouken@1662
   222
EXTRACT_ALL            = NO
slouken@1662
   223
slouken@1662
   224
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
slouken@1662
   225
# will be included in the documentation.
slouken@1662
   226
slouken@1662
   227
EXTRACT_PRIVATE        = NO
slouken@1662
   228
slouken@1662
   229
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
slouken@1662
   230
# will be included in the documentation.
slouken@1662
   231
slouken@1662
   232
EXTRACT_STATIC         = NO
slouken@1662
   233
slouken@1662
   234
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
slouken@1662
   235
# defined locally in source files will be included in the documentation. 
slouken@1662
   236
# If set to NO only classes defined in header files are included.
slouken@1662
   237
slouken@1662
   238
EXTRACT_LOCAL_CLASSES  = YES
slouken@1662
   239
slouken@1662
   240
# This flag is only useful for Objective-C code. When set to YES local 
slouken@1662
   241
# methods, which are defined in the implementation section but not in 
slouken@1662
   242
# the interface are included in the documentation. 
slouken@1662
   243
# If set to NO (the default) only methods in the interface are included.
slouken@1662
   244
slouken@1662
   245
EXTRACT_LOCAL_METHODS  = NO
slouken@1662
   246
slouken@1662
   247
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
slouken@1662
   248
# undocumented members of documented classes, files or namespaces. 
slouken@1662
   249
# If set to NO (the default) these members will be included in the 
slouken@1662
   250
# various overviews, but no documentation section is generated. 
slouken@1662
   251
# This option has no effect if EXTRACT_ALL is enabled.
slouken@1662
   252
slouken@1662
   253
HIDE_UNDOC_MEMBERS     = NO
slouken@1662
   254
slouken@1662
   255
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
slouken@1662
   256
# undocumented classes that are normally visible in the class hierarchy. 
slouken@1662
   257
# If set to NO (the default) these classes will be included in the various 
slouken@1662
   258
# overviews. This option has no effect if EXTRACT_ALL is enabled.
slouken@1662
   259
slouken@1662
   260
HIDE_UNDOC_CLASSES     = NO
slouken@1662
   261
slouken@1662
   262
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
slouken@1662
   263
# friend (class|struct|union) declarations. 
slouken@1662
   264
# If set to NO (the default) these declarations will be included in the 
slouken@1662
   265
# documentation.
slouken@1662
   266
slouken@1662
   267
HIDE_FRIEND_COMPOUNDS  = NO
slouken@1662
   268
slouken@1662
   269
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
slouken@1662
   270
# documentation blocks found inside the body of a function. 
slouken@1662
   271
# If set to NO (the default) these blocks will be appended to the 
slouken@1662
   272
# function's detailed documentation block.
slouken@1662
   273
slouken@1662
   274
HIDE_IN_BODY_DOCS      = NO
slouken@1662
   275
slouken@1662
   276
# The INTERNAL_DOCS tag determines if documentation 
slouken@1662
   277
# that is typed after a \internal command is included. If the tag is set 
slouken@1662
   278
# to NO (the default) then the documentation will be excluded. 
slouken@1662
   279
# Set it to YES to include the internal documentation.
slouken@1662
   280
slouken@1662
   281
INTERNAL_DOCS          = NO
slouken@1662
   282
slouken@1662
   283
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
slouken@1662
   284
# file names in lower-case letters. If set to YES upper-case letters are also 
slouken@1662
   285
# allowed. This is useful if you have classes or files whose names only differ 
slouken@1662
   286
# in case and if your file system supports case sensitive file names. Windows 
slouken@1662
   287
# and Mac users are advised to set this option to NO.
slouken@1662
   288
slouken@1662
   289
CASE_SENSE_NAMES       = YES
slouken@1662
   290
slouken@1662
   291
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
slouken@1662
   292
# will show members with their full class and namespace scopes in the 
slouken@1662
   293
# documentation. If set to YES the scope will be hidden.
slouken@1662
   294
slouken@1662
   295
HIDE_SCOPE_NAMES       = NO
slouken@1662
   296
slouken@1662
   297
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
slouken@1662
   298
# will put a list of the files that are included by a file in the documentation 
slouken@1662
   299
# of that file.
slouken@1662
   300
slouken@1662
   301
SHOW_INCLUDE_FILES     = YES
slouken@1662
   302
slouken@1662
   303
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
slouken@1662
   304
# is inserted in the documentation for inline members.
slouken@1662
   305
slouken@1662
   306
INLINE_INFO            = YES
slouken@1662
   307
slouken@1662
   308
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
slouken@1662
   309
# will sort the (detailed) documentation of file and class members 
slouken@1662
   310
# alphabetically by member name. If set to NO the members will appear in 
slouken@1662
   311
# declaration order.
slouken@1662
   312
slouken@1662
   313
SORT_MEMBER_DOCS       = YES
slouken@1662
   314
slouken@1662
   315
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
slouken@1662
   316
# brief documentation of file, namespace and class members alphabetically 
slouken@1662
   317
# by member name. If set to NO (the default) the members will appear in 
slouken@1662
   318
# declaration order.
slouken@1662
   319
slouken@1662
   320
SORT_BRIEF_DOCS        = NO
slouken@1662
   321
slouken@1662
   322
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
slouken@1662
   323
# sorted by fully-qualified names, including namespaces. If set to 
slouken@1662
   324
# NO (the default), the class list will be sorted only by class name, 
slouken@1662
   325
# not including the namespace part. 
slouken@1662
   326
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
slouken@1662
   327
# Note: This option applies only to the class list, not to the 
slouken@1662
   328
# alphabetical list.
slouken@1662
   329
slouken@1662
   330
SORT_BY_SCOPE_NAME     = NO
slouken@1662
   331
slouken@1662
   332
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
slouken@1662
   333
# disable (NO) the todo list. This list is created by putting \todo 
slouken@1662
   334
# commands in the documentation.
slouken@1662
   335
slouken@1662
   336
GENERATE_TODOLIST      = YES
slouken@1662
   337
slouken@1662
   338
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
slouken@1662
   339
# disable (NO) the test list. This list is created by putting \test 
slouken@1662
   340
# commands in the documentation.
slouken@1662
   341
slouken@1662
   342
GENERATE_TESTLIST      = YES
slouken@1662
   343
slouken@1662
   344
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
slouken@1662
   345
# disable (NO) the bug list. This list is created by putting \bug 
slouken@1662
   346
# commands in the documentation.
slouken@1662
   347
slouken@1662
   348
GENERATE_BUGLIST       = YES
slouken@1662
   349
slouken@1662
   350
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
slouken@1662
   351
# disable (NO) the deprecated list. This list is created by putting 
slouken@1662
   352
# \deprecated commands in the documentation.
slouken@1662
   353
slouken@1662
   354
GENERATE_DEPRECATEDLIST= YES
slouken@1662
   355
slouken@1662
   356
# The ENABLED_SECTIONS tag can be used to enable conditional 
slouken@1662
   357
# documentation sections, marked by \if sectionname ... \endif.
slouken@1662
   358
slouken@1662
   359
ENABLED_SECTIONS       = 
slouken@1662
   360
slouken@1662
   361
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
slouken@1662
   362
# the initial value of a variable or define consists of for it to appear in 
slouken@1662
   363
# the documentation. If the initializer consists of more lines than specified 
slouken@1662
   364
# here it will be hidden. Use a value of 0 to hide initializers completely. 
slouken@1662
   365
# The appearance of the initializer of individual variables and defines in the 
slouken@1662
   366
# documentation can be controlled using \showinitializer or \hideinitializer 
slouken@1662
   367
# command in the documentation regardless of this setting.
slouken@1662
   368
slouken@1662
   369
MAX_INITIALIZER_LINES  = 30
slouken@1662
   370
slouken@1662
   371
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
slouken@1662
   372
# at the bottom of the documentation of classes and structs. If set to YES the 
slouken@1662
   373
# list will mention the files that were used to generate the documentation.
slouken@1662
   374
slouken@1662
   375
SHOW_USED_FILES        = YES
slouken@1662
   376
slouken@1662
   377
# If the sources in your project are distributed over multiple directories 
slouken@1662
   378
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
slouken@1662
   379
# in the documentation. The default is YES.
slouken@1662
   380
slouken@1662
   381
SHOW_DIRECTORIES       = YES
slouken@1662
   382
slouken@1662
   383
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
slouken@1662
   384
# doxygen should invoke to get the current version for each file (typically from the 
slouken@1662
   385
# version control system). Doxygen will invoke the program by executing (via 
slouken@1662
   386
# popen()) the command <command> <input-file>, where <command> is the value of 
slouken@1662
   387
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
slouken@1662
   388
# provided by doxygen. Whatever the progam writes to standard output 
slouken@1662
   389
# is used as the file version. See the manual for examples.
slouken@1662
   390
slouken@1662
   391
FILE_VERSION_FILTER    = 
slouken@1662
   392
slouken@1662
   393
#---------------------------------------------------------------------------
slouken@1662
   394
# configuration options related to warning and progress messages
slouken@1662
   395
#---------------------------------------------------------------------------
slouken@1662
   396
slouken@1662
   397
# The QUIET tag can be used to turn on/off the messages that are generated 
slouken@1662
   398
# by doxygen. Possible values are YES and NO. If left blank NO is used.
slouken@1662
   399
slouken@1662
   400
QUIET                  = NO
slouken@1662
   401
slouken@1662
   402
# The WARNINGS tag can be used to turn on/off the warning messages that are 
slouken@1662
   403
# generated by doxygen. Possible values are YES and NO. If left blank 
slouken@1662
   404
# NO is used.
slouken@1662
   405
slouken@1662
   406
WARNINGS               = YES
slouken@1662
   407
slouken@1662
   408
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
slouken@1662
   409
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
slouken@1662
   410
# automatically be disabled.
slouken@1662
   411
slouken@1662
   412
WARN_IF_UNDOCUMENTED   = YES
slouken@1662
   413
slouken@1662
   414
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
slouken@1662
   415
# potential errors in the documentation, such as not documenting some 
slouken@1662
   416
# parameters in a documented function, or documenting parameters that 
slouken@1662
   417
# don't exist or using markup commands wrongly.
slouken@1662
   418
slouken@1662
   419
WARN_IF_DOC_ERROR      = YES
slouken@1662
   420
slouken@1662
   421
# This WARN_NO_PARAMDOC option can be abled to get warnings for 
slouken@1662
   422
# functions that are documented, but have no documentation for their parameters 
slouken@1662
   423
# or return value. If set to NO (the default) doxygen will only warn about 
slouken@1662
   424
# wrong or incomplete parameter documentation, but not about the absence of 
slouken@1662
   425
# documentation.
slouken@1662
   426
slouken@1662
   427
WARN_NO_PARAMDOC       = NO
slouken@1662
   428
slouken@1662
   429
# The WARN_FORMAT tag determines the format of the warning messages that 
slouken@1662
   430
# doxygen can produce. The string should contain the $file, $line, and $text 
slouken@1662
   431
# tags, which will be replaced by the file and line number from which the 
slouken@1662
   432
# warning originated and the warning text. Optionally the format may contain 
slouken@1662
   433
# $version, which will be replaced by the version of the file (if it could 
slouken@1662
   434
# be obtained via FILE_VERSION_FILTER)
slouken@1662
   435
slouken@1662
   436
WARN_FORMAT            = "$file:$line: $text"
slouken@1662
   437
slouken@1662
   438
# The WARN_LOGFILE tag can be used to specify a file to which warning 
slouken@1662
   439
# and error messages should be written. If left blank the output is written 
slouken@1662
   440
# to stderr.
slouken@1662
   441
slouken@1662
   442
WARN_LOGFILE           = 
slouken@1662
   443
slouken@1662
   444
#---------------------------------------------------------------------------
slouken@1662
   445
# configuration options related to the input files
slouken@1662
   446
#---------------------------------------------------------------------------
slouken@1662
   447
slouken@1662
   448
# The INPUT tag can be used to specify the files and/or directories that contain 
slouken@1662
   449
# documented source files. You may enter file names like "myfile.cpp" or 
slouken@1662
   450
# directories like "/usr/src/myproject". Separate the files or directories 
slouken@1662
   451
# with spaces.
slouken@1662
   452
slouken@1662
   453
INPUT                  = 
slouken@1662
   454
slouken@1662
   455
# If the value of the INPUT tag contains directories, you can use the 
slouken@1662
   456
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
slouken@1662
   457
# and *.h) to filter out the source-files in the directories. If left 
slouken@1662
   458
# blank the following patterns are tested: 
slouken@1662
   459
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
slouken@1662
   460
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
slouken@1662
   461
slouken@1662
   462
FILE_PATTERNS          = 
slouken@1662
   463
slouken@1662
   464
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
slouken@1662
   465
# should be searched for input files as well. Possible values are YES and NO. 
slouken@1662
   466
# If left blank NO is used.
slouken@1662
   467
slouken@1662
   468
RECURSIVE              = NO
slouken@1662
   469
slouken@1662
   470
# The EXCLUDE tag can be used to specify files and/or directories that should 
slouken@1662
   471
# excluded from the INPUT source files. This way you can easily exclude a 
slouken@1662
   472
# subdirectory from a directory tree whose root is specified with the INPUT tag.
slouken@1662
   473
slouken@1662
   474
EXCLUDE                = 
slouken@1662
   475
slouken@1662
   476
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
slouken@1662
   477
# directories that are symbolic links (a Unix filesystem feature) are excluded 
slouken@1662
   478
# from the input.
slouken@1662
   479
slouken@1662
   480
EXCLUDE_SYMLINKS       = NO
slouken@1662
   481
slouken@1662
   482
# If the value of the INPUT tag contains directories, you can use the 
slouken@1662
   483
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
slouken@1662
   484
# certain files from those directories. Note that the wildcards are matched 
slouken@1662
   485
# against the file with absolute path, so to exclude all test directories 
slouken@1662
   486
# for example use the pattern */test/*
slouken@1662
   487
slouken@1662
   488
EXCLUDE_PATTERNS       = 
slouken@1662
   489
slouken@1662
   490
# The EXAMPLE_PATH tag can be used to specify one or more files or 
slouken@1662
   491
# directories that contain example code fragments that are included (see 
slouken@1662
   492
# the \include command).
slouken@1662
   493
slouken@1662
   494
EXAMPLE_PATH           = 
slouken@1662
   495
slouken@1662
   496
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
slouken@1662
   497
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
slouken@1662
   498
# and *.h) to filter out the source-files in the directories. If left 
slouken@1662
   499
# blank all files are included.
slouken@1662
   500
slouken@1662
   501
EXAMPLE_PATTERNS       = 
slouken@1662
   502
slouken@1662
   503
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
slouken@1662
   504
# searched for input files to be used with the \include or \dontinclude 
slouken@1662
   505
# commands irrespective of the value of the RECURSIVE tag. 
slouken@1662
   506
# Possible values are YES and NO. If left blank NO is used.
slouken@1662
   507
slouken@1662
   508
EXAMPLE_RECURSIVE      = NO
slouken@1662
   509
slouken@1662
   510
# The IMAGE_PATH tag can be used to specify one or more files or 
slouken@1662
   511
# directories that contain image that are included in the documentation (see 
slouken@1662
   512
# the \image command).
slouken@1662
   513
slouken@1662
   514
IMAGE_PATH             = 
slouken@1662
   515
slouken@1662
   516
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
slouken@1662
   517
# invoke to filter for each input file. Doxygen will invoke the filter program 
slouken@1662
   518
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
slouken@1662
   519
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
slouken@1662
   520
# input file. Doxygen will then use the output that the filter program writes 
slouken@1662
   521
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
slouken@1662
   522
# ignored.
slouken@1662
   523
slouken@1662
   524
INPUT_FILTER           = 
slouken@1662
   525
slouken@1662
   526
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
slouken@1662
   527
# basis.  Doxygen will compare the file name with each pattern and apply the 
slouken@1662
   528
# filter if there is a match.  The filters are a list of the form: 
slouken@1662
   529
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
slouken@1662
   530
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
slouken@1662
   531
# is applied to all files.
slouken@1662
   532
slouken@1662
   533
FILTER_PATTERNS        = 
slouken@1662
   534
slouken@1662
   535
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
slouken@1662
   536
# INPUT_FILTER) will be used to filter the input files when producing source 
slouken@1662
   537
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
slouken@1662
   538
slouken@1662
   539
FILTER_SOURCE_FILES    = NO
slouken@1662
   540
slouken@1662
   541
#---------------------------------------------------------------------------
slouken@1662
   542
# configuration options related to source browsing
slouken@1662
   543
#---------------------------------------------------------------------------
slouken@1662
   544
slouken@1662
   545
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
slouken@1662
   546
# be generated. Documented entities will be cross-referenced with these sources. 
slouken@1662
   547
# Note: To get rid of all source code in the generated output, make sure also 
slouken@1662
   548
# VERBATIM_HEADERS is set to NO.
slouken@1662
   549
slouken@1662
   550
SOURCE_BROWSER         = NO
slouken@1662
   551
slouken@1662
   552
# Setting the INLINE_SOURCES tag to YES will include the body 
slouken@1662
   553
# of functions and classes directly in the documentation.
slouken@1662
   554
slouken@1662
   555
INLINE_SOURCES         = NO
slouken@1662
   556
slouken@1662
   557
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
slouken@1662
   558
# doxygen to hide any special comment blocks from generated source code 
slouken@1662
   559
# fragments. Normal C and C++ comments will always remain visible.
slouken@1662
   560
slouken@1662
   561
STRIP_CODE_COMMENTS    = YES
slouken@1662
   562
slouken@1662
   563
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
slouken@1662
   564
# then for each documented function all documented 
slouken@1662
   565
# functions referencing it will be listed.
slouken@1662
   566
slouken@1662
   567
REFERENCED_BY_RELATION = YES
slouken@1662
   568
slouken@1662
   569
# If the REFERENCES_RELATION tag is set to YES (the default) 
slouken@1662
   570
# then for each documented function all documented entities 
slouken@1662
   571
# called/used by that function will be listed.
slouken@1662
   572
slouken@1662
   573
REFERENCES_RELATION    = YES
slouken@1662
   574
slouken@1662
   575
# If the USE_HTAGS tag is set to YES then the references to source code 
slouken@1662
   576
# will point to the HTML generated by the htags(1) tool instead of doxygen 
slouken@1662
   577
# built-in source browser. The htags tool is part of GNU's global source 
slouken@1662
   578
# tagging system (see http://www.gnu.org/software/global/global.html). You 
slouken@1662
   579
# will need version 4.8.6 or higher.
slouken@1662
   580
slouken@1662
   581
USE_HTAGS              = NO
slouken@1662
   582
slouken@1662
   583
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
slouken@1662
   584
# will generate a verbatim copy of the header file for each class for 
slouken@1662
   585
# which an include is specified. Set to NO to disable this.
slouken@1662
   586
slouken@1662
   587
VERBATIM_HEADERS       = YES
slouken@1662
   588
slouken@1662
   589
#---------------------------------------------------------------------------
slouken@1662
   590
# configuration options related to the alphabetical class index
slouken@1662
   591
#---------------------------------------------------------------------------
slouken@1662
   592
slouken@1662
   593
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
slouken@1662
   594
# of all compounds will be generated. Enable this if the project 
slouken@1662
   595
# contains a lot of classes, structs, unions or interfaces.
slouken@1662
   596
slouken@1662
   597
ALPHABETICAL_INDEX     = NO
slouken@1662
   598
slouken@1662
   599
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
slouken@1662
   600
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
slouken@1662
   601
# in which this list will be split (can be a number in the range [1..20])
slouken@1662
   602
slouken@1662
   603
COLS_IN_ALPHA_INDEX    = 5
slouken@1662
   604
slouken@1662
   605
# In case all classes in a project start with a common prefix, all 
slouken@1662
   606
# classes will be put under the same header in the alphabetical index. 
slouken@1662
   607
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
slouken@1662
   608
# should be ignored while generating the index headers.
slouken@1662
   609
slouken@1662
   610
IGNORE_PREFIX          = 
slouken@1662
   611
slouken@1662
   612
#---------------------------------------------------------------------------
slouken@1662
   613
# configuration options related to the HTML output
slouken@1662
   614
#---------------------------------------------------------------------------
slouken@1662
   615
slouken@1662
   616
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
slouken@1662
   617
# generate HTML output.
slouken@1662
   618
slouken@1662
   619
GENERATE_HTML          = YES
slouken@1662
   620
slouken@1662
   621
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
slouken@1662
   622
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
slouken@1662
   623
# put in front of it. If left blank `html' will be used as the default path.
slouken@1662
   624
slouken@1662
   625
HTML_OUTPUT            = html
slouken@1662
   626
slouken@1662
   627
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
slouken@1662
   628
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
slouken@1662
   629
# doxygen will generate files with .html extension.
slouken@1662
   630
slouken@1662
   631
HTML_FILE_EXTENSION    = .html
slouken@1662
   632
slouken@1662
   633
# The HTML_HEADER tag can be used to specify a personal HTML header for 
slouken@1662
   634
# each generated HTML page. If it is left blank doxygen will generate a 
slouken@1662
   635
# standard header.
slouken@1662
   636
slouken@1662
   637
HTML_HEADER            = 
slouken@1662
   638
slouken@1662
   639
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
slouken@1662
   640
# each generated HTML page. If it is left blank doxygen will generate a 
slouken@1662
   641
# standard footer.
slouken@1662
   642
slouken@1662
   643
HTML_FOOTER            = 
slouken@1662
   644
slouken@1662
   645
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
slouken@1662
   646
# style sheet that is used by each HTML page. It can be used to 
slouken@1662
   647
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
slouken@1662
   648
# will generate a default style sheet. Note that doxygen will try to copy 
slouken@1662
   649
# the style sheet file to the HTML output directory, so don't put your own 
slouken@1662
   650
# stylesheet in the HTML output directory as well, or it will be erased!
slouken@1662
   651
slouken@1662
   652
HTML_STYLESHEET        = 
slouken@1662
   653
slouken@1662
   654
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
slouken@1662
   655
# files or namespaces will be aligned in HTML using tables. If set to 
slouken@1662
   656
# NO a bullet list will be used.
slouken@1662
   657
slouken@1662
   658
HTML_ALIGN_MEMBERS     = YES
slouken@1662
   659
slouken@1662
   660
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
slouken@1662
   661
# will be generated that can be used as input for tools like the 
slouken@1662
   662
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
slouken@1662
   663
# of the generated HTML documentation.
slouken@1662
   664
slouken@1662
   665
GENERATE_HTMLHELP      = NO
slouken@1662
   666
slouken@1662
   667
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
slouken@1662
   668
# be used to specify the file name of the resulting .chm file. You 
slouken@1662
   669
# can add a path in front of the file if the result should not be 
slouken@1662
   670
# written to the html output directory.
slouken@1662
   671
slouken@1662
   672
CHM_FILE               = 
slouken@1662
   673
slouken@1662
   674
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
slouken@1662
   675
# be used to specify the location (absolute path including file name) of 
slouken@1662
   676
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
slouken@1662
   677
# the HTML help compiler on the generated index.hhp.
slouken@1662
   678
slouken@1662
   679
HHC_LOCATION           = 
slouken@1662
   680
slouken@1662
   681
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
slouken@1662
   682
# controls if a separate .chi index file is generated (YES) or that 
slouken@1662
   683
# it should be included in the master .chm file (NO).
slouken@1662
   684
slouken@1662
   685
GENERATE_CHI           = NO
slouken@1662
   686
slouken@1662
   687
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
slouken@1662
   688
# controls whether a binary table of contents is generated (YES) or a 
slouken@1662
   689
# normal table of contents (NO) in the .chm file.
slouken@1662
   690
slouken@1662
   691
BINARY_TOC             = NO
slouken@1662
   692
slouken@1662
   693
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
slouken@1662
   694
# to the contents of the HTML help documentation and to the tree view.
slouken@1662
   695
slouken@1662
   696
TOC_EXPAND             = NO
slouken@1662
   697
slouken@1662
   698
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
slouken@1662
   699
# top of each HTML page. The value NO (the default) enables the index and 
slouken@1662
   700
# the value YES disables it.
slouken@1662
   701
slouken@1662
   702
DISABLE_INDEX          = NO
slouken@1662
   703
slouken@1662
   704
# This tag can be used to set the number of enum values (range [1..20]) 
slouken@1662
   705
# that doxygen will group on one line in the generated HTML documentation.
slouken@1662
   706
slouken@1662
   707
ENUM_VALUES_PER_LINE   = 4
slouken@1662
   708
slouken@1662
   709
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
slouken@1662
   710
# generated containing a tree-like index structure (just like the one that 
slouken@1662
   711
# is generated for HTML Help). For this to work a browser that supports 
slouken@1662
   712
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
slouken@1662
   713
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
slouken@1662
   714
# probably better off using the HTML help feature.
slouken@1662
   715
slouken@1662
   716
GENERATE_TREEVIEW      = NO
slouken@1662
   717
slouken@1662
   718
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
slouken@1662
   719
# used to set the initial width (in pixels) of the frame in which the tree 
slouken@1662
   720
# is shown.
slouken@1662
   721
slouken@1662
   722
TREEVIEW_WIDTH         = 250
slouken@1662
   723
slouken@1662
   724
#---------------------------------------------------------------------------
slouken@1662
   725
# configuration options related to the LaTeX output
slouken@1662
   726
#---------------------------------------------------------------------------
slouken@1662
   727
slouken@1662
   728
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
slouken@1662
   729
# generate Latex output.
slouken@1662
   730
slouken@1662
   731
GENERATE_LATEX         = YES
slouken@1662
   732
slouken@1662
   733
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
slouken@1662
   734
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
slouken@1662
   735
# put in front of it. If left blank `latex' will be used as the default path.
slouken@1662
   736
slouken@1662
   737
LATEX_OUTPUT           = latex
slouken@1662
   738
slouken@1662
   739
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
slouken@1662
   740
# invoked. If left blank `latex' will be used as the default command name.
slouken@1662
   741
slouken@1662
   742
LATEX_CMD_NAME         = latex
slouken@1662
   743
slouken@1662
   744
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
slouken@1662
   745
# generate index for LaTeX. If left blank `makeindex' will be used as the 
slouken@1662
   746
# default command name.
slouken@1662
   747
slouken@1662
   748
MAKEINDEX_CMD_NAME     = makeindex
slouken@1662
   749
slouken@1662
   750
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
slouken@1662
   751
# LaTeX documents. This may be useful for small projects and may help to 
slouken@1662
   752
# save some trees in general.
slouken@1662
   753
slouken@1662
   754
COMPACT_LATEX          = NO
slouken@1662
   755
slouken@1662
   756
# The PAPER_TYPE tag can be used to set the paper type that is used 
slouken@1662
   757
# by the printer. Possible values are: a4, a4wide, letter, legal and 
slouken@1662
   758
# executive. If left blank a4wide will be used.
slouken@1662
   759
slouken@1662
   760
PAPER_TYPE             = a4wide
slouken@1662
   761
slouken@1662
   762
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
slouken@1662
   763
# packages that should be included in the LaTeX output.
slouken@1662
   764
slouken@1662
   765
EXTRA_PACKAGES         = 
slouken@1662
   766
slouken@1662
   767
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
slouken@1662
   768
# the generated latex document. The header should contain everything until 
slouken@1662
   769
# the first chapter. If it is left blank doxygen will generate a 
slouken@1662
   770
# standard header. Notice: only use this tag if you know what you are doing!
slouken@1662
   771
slouken@1662
   772
LATEX_HEADER           = 
slouken@1662
   773
slouken@1662
   774
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
slouken@1662
   775
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
slouken@1662
   776
# contain links (just like the HTML output) instead of page references 
slouken@1662
   777
# This makes the output suitable for online browsing using a pdf viewer.
slouken@1662
   778
slouken@1662
   779
PDF_HYPERLINKS         = NO
slouken@1662
   780
slouken@1662
   781
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
slouken@1662
   782
# plain latex in the generated Makefile. Set this option to YES to get a 
slouken@1662
   783
# higher quality PDF documentation.
slouken@1662
   784
slouken@1662
   785
USE_PDFLATEX           = NO
slouken@1662
   786
slouken@1662
   787
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
slouken@1662
   788
# command to the generated LaTeX files. This will instruct LaTeX to keep 
slouken@1662
   789
# running if errors occur, instead of asking the user for help. 
slouken@1662
   790
# This option is also used when generating formulas in HTML.
slouken@1662
   791
slouken@1662
   792
LATEX_BATCHMODE        = NO
slouken@1662
   793
slouken@1662
   794
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
slouken@1662
   795
# include the index chapters (such as File Index, Compound Index, etc.) 
slouken@1662
   796
# in the output.
slouken@1662
   797
slouken@1662
   798
LATEX_HIDE_INDICES     = NO
slouken@1662
   799
slouken@1662
   800
#---------------------------------------------------------------------------
slouken@1662
   801
# configuration options related to the RTF output
slouken@1662
   802
#---------------------------------------------------------------------------
slouken@1662
   803
slouken@1662
   804
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
slouken@1662
   805
# The RTF output is optimized for Word 97 and may not look very pretty with 
slouken@1662
   806
# other RTF readers or editors.
slouken@1662
   807
slouken@1662
   808
GENERATE_RTF           = NO
slouken@1662
   809
slouken@1662
   810
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
slouken@1662
   811
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
slouken@1662
   812
# put in front of it. If left blank `rtf' will be used as the default path.
slouken@1662
   813
slouken@1662
   814
RTF_OUTPUT             = rtf
slouken@1662
   815
slouken@1662
   816
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
slouken@1662
   817
# RTF documents. This may be useful for small projects and may help to 
slouken@1662
   818
# save some trees in general.
slouken@1662
   819
slouken@1662
   820
COMPACT_RTF            = NO
slouken@1662
   821
slouken@1662
   822
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
slouken@1662
   823
# will contain hyperlink fields. The RTF file will 
slouken@1662
   824
# contain links (just like the HTML output) instead of page references. 
slouken@1662
   825
# This makes the output suitable for online browsing using WORD or other 
slouken@1662
   826
# programs which support those fields. 
slouken@1662
   827
# Note: wordpad (write) and others do not support links.
slouken@1662
   828
slouken@1662
   829
RTF_HYPERLINKS         = NO
slouken@1662
   830
slouken@1662
   831
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
slouken@1662
   832
# config file, i.e. a series of assignments. You only have to provide 
slouken@1662
   833
# replacements, missing definitions are set to their default value.
slouken@1662
   834
slouken@1662
   835
RTF_STYLESHEET_FILE    = 
slouken@1662
   836
slouken@1662
   837
# Set optional variables used in the generation of an rtf document. 
slouken@1662
   838
# Syntax is similar to doxygen's config file.
slouken@1662
   839
slouken@1662
   840
RTF_EXTENSIONS_FILE    = 
slouken@1662
   841
slouken@1662
   842
#---------------------------------------------------------------------------
slouken@1662
   843
# configuration options related to the man page output
slouken@1662
   844
#---------------------------------------------------------------------------
slouken@1662
   845
slouken@1662
   846
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
slouken@1662
   847
# generate man pages
slouken@1662
   848
slouken@1662
   849
GENERATE_MAN           = YES
slouken@1662
   850
slouken@1662
   851
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
slouken@1662
   852
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
slouken@1662
   853
# put in front of it. If left blank `man' will be used as the default path.
slouken@1662
   854
slouken@1662
   855
MAN_OUTPUT             = man
slouken@1662
   856
slouken@1662
   857
# The MAN_EXTENSION tag determines the extension that is added to 
slouken@1662
   858
# the generated man pages (default is the subroutine's section .3)
slouken@1662
   859
slouken@1662
   860
MAN_EXTENSION          = .3
slouken@1662
   861
slouken@1662
   862
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
slouken@1662
   863
# then it will generate one additional man file for each entity 
slouken@1662
   864
# documented in the real man page(s). These additional files 
slouken@1662
   865
# only source the real man page, but without them the man command 
slouken@1662
   866
# would be unable to find the correct page. The default is NO.
slouken@1662
   867
slouken@1662
   868
MAN_LINKS              = NO
slouken@1662
   869
slouken@1662
   870
#---------------------------------------------------------------------------
slouken@1662
   871
# configuration options related to the XML output
slouken@1662
   872
#---------------------------------------------------------------------------
slouken@1662
   873
slouken@1662
   874
# If the GENERATE_XML tag is set to YES Doxygen will 
slouken@1662
   875
# generate an XML file that captures the structure of 
slouken@1662
   876
# the code including all documentation.
slouken@1662
   877
slouken@1662
   878
GENERATE_XML           = NO
slouken@1662
   879
slouken@1662
   880
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
slouken@1662
   881
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
slouken@1662
   882
# put in front of it. If left blank `xml' will be used as the default path.
slouken@1662
   883
slouken@1662
   884
XML_OUTPUT             = xml
slouken@1662
   885
slouken@1662
   886
# The XML_SCHEMA tag can be used to specify an XML schema, 
slouken@1662
   887
# which can be used by a validating XML parser to check the 
slouken@1662
   888
# syntax of the XML files.
slouken@1662
   889
slouken@1662
   890
XML_SCHEMA             = 
slouken@1662
   891
slouken@1662
   892
# The XML_DTD tag can be used to specify an XML DTD, 
slouken@1662
   893
# which can be used by a validating XML parser to check the 
slouken@1662
   894
# syntax of the XML files.
slouken@1662
   895
slouken@1662
   896
XML_DTD                = 
slouken@1662
   897
slouken@1662
   898
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
slouken@1662
   899
# dump the program listings (including syntax highlighting 
slouken@1662
   900
# and cross-referencing information) to the XML output. Note that 
slouken@1662
   901
# enabling this will significantly increase the size of the XML output.
slouken@1662
   902
slouken@1662
   903
XML_PROGRAMLISTING     = YES
slouken@1662
   904
slouken@1662
   905
#---------------------------------------------------------------------------
slouken@1662
   906
# configuration options for the AutoGen Definitions output
slouken@1662
   907
#---------------------------------------------------------------------------
slouken@1662
   908
slouken@1662
   909
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
slouken@1662
   910
# generate an AutoGen Definitions (see autogen.sf.net) file 
slouken@1662
   911
# that captures the structure of the code including all 
slouken@1662
   912
# documentation. Note that this feature is still experimental 
slouken@1662
   913
# and incomplete at the moment.
slouken@1662
   914
slouken@1662
   915
GENERATE_AUTOGEN_DEF   = NO
slouken@1662
   916
slouken@1662
   917
#---------------------------------------------------------------------------
slouken@1662
   918
# configuration options related to the Perl module output
slouken@1662
   919
#---------------------------------------------------------------------------
slouken@1662
   920
slouken@1662
   921
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
slouken@1662
   922
# generate a Perl module file that captures the structure of 
slouken@1662
   923
# the code including all documentation. Note that this 
slouken@1662
   924
# feature is still experimental and incomplete at the 
slouken@1662
   925
# moment.
slouken@1662
   926
slouken@1662
   927
GENERATE_PERLMOD       = NO
slouken@1662
   928
slouken@1662
   929
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
slouken@1662
   930
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
slouken@1662
   931
# to generate PDF and DVI output from the Perl module output.
slouken@1662
   932
slouken@1662
   933
PERLMOD_LATEX          = NO
slouken@1662
   934
slouken@1662
   935
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
slouken@1662
   936
# nicely formatted so it can be parsed by a human reader.  This is useful 
slouken@1662
   937
# if you want to understand what is going on.  On the other hand, if this 
slouken@1662
   938
# tag is set to NO the size of the Perl module output will be much smaller 
slouken@1662
   939
# and Perl will parse it just the same.
slouken@1662
   940
slouken@1662
   941
PERLMOD_PRETTY         = YES
slouken@1662
   942
slouken@1662
   943
# The names of the make variables in the generated doxyrules.make file 
slouken@1662
   944
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
slouken@1662
   945
# This is useful so different doxyrules.make files included by the same 
slouken@1662
   946
# Makefile don't overwrite each other's variables.
slouken@1662
   947
slouken@1662
   948
PERLMOD_MAKEVAR_PREFIX = 
slouken@1662
   949
slouken@1662
   950
#---------------------------------------------------------------------------
slouken@1662
   951
# Configuration options related to the preprocessor   
slouken@1662
   952
#---------------------------------------------------------------------------
slouken@1662
   953
slouken@1662
   954
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
slouken@1662
   955
# evaluate all C-preprocessor directives found in the sources and include 
slouken@1662
   956
# files.
slouken@1662
   957
slouken@1662
   958
ENABLE_PREPROCESSING   = YES
slouken@1662
   959
slouken@1662
   960
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
slouken@1662
   961
# names in the source code. If set to NO (the default) only conditional 
slouken@1662
   962
# compilation will be performed. Macro expansion can be done in a controlled 
slouken@1662
   963
# way by setting EXPAND_ONLY_PREDEF to YES.
slouken@1662
   964
slouken@1662
   965
MACRO_EXPANSION        = YES
slouken@1662
   966
slouken@1662
   967
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
slouken@1662
   968
# then the macro expansion is limited to the macros specified with the 
slouken@1662
   969
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
slouken@1662
   970
slouken@1662
   971
EXPAND_ONLY_PREDEF     = YES
slouken@1662
   972
slouken@1662
   973
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
slouken@1662
   974
# in the INCLUDE_PATH (see below) will be search if a #include is found.
slouken@1662
   975
slouken@1662
   976
SEARCH_INCLUDES        = YES
slouken@1662
   977
slouken@1662
   978
# The INCLUDE_PATH tag can be used to specify one or more directories that 
slouken@1662
   979
# contain include files that are not input files but should be processed by 
slouken@1662
   980
# the preprocessor.
slouken@1662
   981
slouken@1662
   982
INCLUDE_PATH           = 
slouken@1662
   983
slouken@1662
   984
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
slouken@1662
   985
# patterns (like *.h and *.hpp) to filter out the header-files in the 
slouken@1662
   986
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
slouken@1662
   987
# be used.
slouken@1662
   988
slouken@1662
   989
INCLUDE_FILE_PATTERNS  = 
slouken@1662
   990
slouken@1662
   991
# The PREDEFINED tag can be used to specify one or more macro names that 
slouken@1662
   992
# are defined before the preprocessor is started (similar to the -D option of 
slouken@1662
   993
# gcc). The argument of the tag is a list of macros of the form: name 
slouken@1662
   994
# or name=definition (no spaces). If the definition and the = are 
slouken@1662
   995
# omitted =1 is assumed. To prevent a macro definition from being 
slouken@1662
   996
# undefined via #undef or recursively expanded use the := operator 
slouken@1662
   997
# instead of the = operator.
slouken@1662
   998
slouken@1662
   999
PREDEFINED             = DOXYGEN_SHOULD_IGNORE_THIS=1 \
slouken@1662
  1000
                         DECLSPEC= SDLCALL=
slouken@1662
  1001
slouken@1662
  1002
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
slouken@1662
  1003
# this tag can be used to specify a list of macro names that should be expanded. 
slouken@1662
  1004
# The macro definition that is found in the sources will be used. 
slouken@1662
  1005
# Use the PREDEFINED tag if you want to use a different macro definition.
slouken@1662
  1006
slouken@1662
  1007
EXPAND_AS_DEFINED      = 
slouken@1662
  1008
slouken@1662
  1009
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
slouken@1662
  1010
# doxygen's preprocessor will remove all function-like macros that are alone 
slouken@1662
  1011
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
slouken@1662
  1012
# function macros are typically used for boiler-plate code, and will confuse 
slouken@1662
  1013
# the parser if not removed.
slouken@1662
  1014
slouken@1662
  1015
SKIP_FUNCTION_MACROS   = YES
slouken@1662
  1016
slouken@1662
  1017
#---------------------------------------------------------------------------
slouken@1662
  1018
# Configuration::additions related to external references   
slouken@1662
  1019
#---------------------------------------------------------------------------
slouken@1662
  1020
slouken@1662
  1021
# The TAGFILES option can be used to specify one or more tagfiles. 
slouken@1662
  1022
# Optionally an initial location of the external documentation 
slouken@1662
  1023
# can be added for each tagfile. The format of a tag file without 
slouken@1662
  1024
# this location is as follows: 
slouken@1662
  1025
#   TAGFILES = file1 file2 ... 
slouken@1662
  1026
# Adding location for the tag files is done as follows: 
slouken@1662
  1027
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
slouken@1662
  1028
# where "loc1" and "loc2" can be relative or absolute paths or 
slouken@1662
  1029
# URLs. If a location is present for each tag, the installdox tool 
slouken@1662
  1030
# does not have to be run to correct the links.
slouken@1662
  1031
# Note that each tag file must have a unique name
slouken@1662
  1032
# (where the name does NOT include the path)
slouken@1662
  1033
# If a tag file is not located in the directory in which doxygen 
slouken@1662
  1034
# is run, you must also specify the path to the tagfile here.
slouken@1662
  1035
slouken@1662
  1036
TAGFILES               = 
slouken@1662
  1037
slouken@1662
  1038
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
slouken@1662
  1039
# a tag file that is based on the input files it reads.
slouken@1662
  1040
slouken@1662
  1041
GENERATE_TAGFILE       = 
slouken@1662
  1042
slouken@1662
  1043
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
slouken@1662
  1044
# in the class index. If set to NO only the inherited external classes 
slouken@1662
  1045
# will be listed.
slouken@1662
  1046
slouken@1662
  1047
ALLEXTERNALS           = NO
slouken@1662
  1048
slouken@1662
  1049
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
slouken@1662
  1050
# in the modules index. If set to NO, only the current project's groups will 
slouken@1662
  1051
# be listed.
slouken@1662
  1052
slouken@1662
  1053
EXTERNAL_GROUPS        = YES
slouken@1662
  1054
slouken@1662
  1055
# The PERL_PATH should be the absolute path and name of the perl script 
slouken@1662
  1056
# interpreter (i.e. the result of `which perl').
slouken@1662
  1057
slouken@1662
  1058
PERL_PATH              = /usr/bin/perl
slouken@1662
  1059
slouken@1662
  1060
#---------------------------------------------------------------------------
slouken@1662
  1061
# Configuration options related to the dot tool   
slouken@1662
  1062
#---------------------------------------------------------------------------
slouken@1662
  1063
slouken@1662
  1064
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
slouken@1662
  1065
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
slouken@1662
  1066
# or super classes. Setting the tag to NO turns the diagrams off. Note that 
slouken@1662
  1067
# this option is superseded by the HAVE_DOT option below. This is only a 
slouken@1662
  1068
# fallback. It is recommended to install and use dot, since it yields more 
slouken@1662
  1069
# powerful graphs.
slouken@1662
  1070
slouken@1662
  1071
CLASS_DIAGRAMS         = NO
slouken@1662
  1072
slouken@1662
  1073
# If set to YES, the inheritance and collaboration graphs will hide 
slouken@1662
  1074
# inheritance and usage relations if the target is undocumented 
slouken@1662
  1075
# or is not a class.
slouken@1662
  1076
slouken@1662
  1077
HIDE_UNDOC_RELATIONS   = YES
slouken@1662
  1078
slouken@1662
  1079
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
slouken@1662
  1080
# available from the path. This tool is part of Graphviz, a graph visualization 
slouken@1662
  1081
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
slouken@1662
  1082
# have no effect if this option is set to NO (the default)
slouken@1662
  1083
slouken@1662
  1084
HAVE_DOT               = NO
slouken@1662
  1085
slouken@1662
  1086
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
slouken@1662
  1087
# will generate a graph for each documented class showing the direct and 
slouken@1662
  1088
# indirect inheritance relations. Setting this tag to YES will force the 
slouken@1662
  1089
# the CLASS_DIAGRAMS tag to NO.
slouken@1662
  1090
slouken@1662
  1091
CLASS_GRAPH            = YES
slouken@1662
  1092
slouken@1662
  1093
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
slouken@1662
  1094
# will generate a graph for each documented class showing the direct and 
slouken@1662
  1095
# indirect implementation dependencies (inheritance, containment, and 
slouken@1662
  1096
# class references variables) of the class with other documented classes.
slouken@1662
  1097
slouken@1662
  1098
COLLABORATION_GRAPH    = YES
slouken@1662
  1099
slouken@1662
  1100
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
slouken@1662
  1101
# will generate a graph for groups, showing the direct groups dependencies
slouken@1662
  1102
slouken@1662
  1103
GROUP_GRAPHS           = YES
slouken@1662
  1104
slouken@1662
  1105
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
slouken@1662
  1106
# collaboration diagrams in a style similar to the OMG's Unified Modeling 
slouken@1662
  1107
# Language.
slouken@1662
  1108
slouken@1662
  1109
UML_LOOK               = NO
slouken@1662
  1110
slouken@1662
  1111
# If set to YES, the inheritance and collaboration graphs will show the 
slouken@1662
  1112
# relations between templates and their instances.
slouken@1662
  1113
slouken@1662
  1114
TEMPLATE_RELATIONS     = NO
slouken@1662
  1115
slouken@1662
  1116
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
slouken@1662
  1117
# tags are set to YES then doxygen will generate a graph for each documented 
slouken@1662
  1118
# file showing the direct and indirect include dependencies of the file with 
slouken@1662
  1119
# other documented files.
slouken@1662
  1120
slouken@1662
  1121
INCLUDE_GRAPH          = NO
slouken@1662
  1122
slouken@1662
  1123
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
slouken@1662
  1124
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
slouken@1662
  1125
# documented header file showing the documented files that directly or 
slouken@1662
  1126
# indirectly include this file.
slouken@1662
  1127
slouken@1662
  1128
INCLUDED_BY_GRAPH      = YES
slouken@1662
  1129
slouken@1662
  1130
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
slouken@1662
  1131
# generate a call dependency graph for every global function or class method. 
slouken@1662
  1132
# Note that enabling this option will significantly increase the time of a run. 
slouken@1662
  1133
# So in most cases it will be better to enable call graphs for selected 
slouken@1662
  1134
# functions only using the \callgraph command.
slouken@1662
  1135
slouken@1662
  1136
CALL_GRAPH             = NO
slouken@1662
  1137
slouken@1662
  1138
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
slouken@1662
  1139
# will graphical hierarchy of all classes instead of a textual one.
slouken@1662
  1140
slouken@1662
  1141
GRAPHICAL_HIERARCHY    = YES
slouken@1662
  1142
slouken@1662
  1143
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
slouken@1662
  1144
# then doxygen will show the dependencies a directory has on other directories 
slouken@1662
  1145
# in a graphical way. The dependency relations are determined by the #include
slouken@1662
  1146
# relations between the files in the directories.
slouken@1662
  1147
slouken@1662
  1148
DIRECTORY_GRAPH        = YES
slouken@1662
  1149
slouken@1662
  1150
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
slouken@1662
  1151
# generated by dot. Possible values are png, jpg, or gif
slouken@1662
  1152
# If left blank png will be used.
slouken@1662
  1153
slouken@1662
  1154
DOT_IMAGE_FORMAT       = png
slouken@1662
  1155
slouken@1662
  1156
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
slouken@1662
  1157
# found. If left blank, it is assumed the dot tool can be found in the path.
slouken@1662
  1158
slouken@1662
  1159
DOT_PATH               = 
slouken@1662
  1160
slouken@1662
  1161
# The DOTFILE_DIRS tag can be used to specify one or more directories that 
slouken@1662
  1162
# contain dot files that are included in the documentation (see the 
slouken@1662
  1163
# \dotfile command).
slouken@1662
  1164
slouken@1662
  1165
DOTFILE_DIRS           = 
slouken@1662
  1166
slouken@1662
  1167
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
slouken@1662
  1168
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
slouken@1662
  1169
# this value, doxygen will try to truncate the graph, so that it fits within 
slouken@1662
  1170
# the specified constraint. Beware that most browsers cannot cope with very 
slouken@1662
  1171
# large images.
slouken@1662
  1172
slouken@1662
  1173
MAX_DOT_GRAPH_WIDTH    = 1024
slouken@1662
  1174
slouken@1662
  1175
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
slouken@1662
  1176
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
slouken@1662
  1177
# this value, doxygen will try to truncate the graph, so that it fits within 
slouken@1662
  1178
# the specified constraint. Beware that most browsers cannot cope with very 
slouken@1662
  1179
# large images.
slouken@1662
  1180
slouken@1662
  1181
MAX_DOT_GRAPH_HEIGHT   = 1024
slouken@1662
  1182
slouken@1662
  1183
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
slouken@1662
  1184
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
slouken@1662
  1185
# from the root by following a path via at most 3 edges will be shown. Nodes 
slouken@1662
  1186
# that lay further from the root node will be omitted. Note that setting this 
slouken@1662
  1187
# option to 1 or 2 may greatly reduce the computation time needed for large 
slouken@1662
  1188
# code bases. Also note that a graph may be further truncated if the graph's 
slouken@1662
  1189
# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
slouken@1662
  1190
# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
slouken@1662
  1191
# the graph is not depth-constrained.
slouken@1662
  1192
slouken@1662
  1193
MAX_DOT_GRAPH_DEPTH    = 0
slouken@1662
  1194
slouken@1662
  1195
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
slouken@1662
  1196
# background. This is disabled by default, which results in a white background. 
slouken@1662
  1197
# Warning: Depending on the platform used, enabling this option may lead to 
slouken@1662
  1198
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
slouken@1662
  1199
# read).
slouken@1662
  1200
slouken@1662
  1201
DOT_TRANSPARENT        = NO
slouken@1662
  1202
slouken@1662
  1203
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
slouken@1662
  1204
# files in one run (i.e. multiple -o and -T options on the command line). This 
slouken@1662
  1205
# makes dot run faster, but since only newer versions of dot (>1.8.10) 
slouken@1662
  1206
# support this, this feature is disabled by default.
slouken@1662
  1207
slouken@1662
  1208
DOT_MULTI_TARGETS      = NO
slouken@1662
  1209
slouken@1662
  1210
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
slouken@1662
  1211
# generate a legend page explaining the meaning of the various boxes and 
slouken@1662
  1212
# arrows in the dot generated graphs.
slouken@1662
  1213
slouken@1662
  1214
GENERATE_LEGEND        = YES
slouken@1662
  1215
slouken@1662
  1216
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
slouken@1662
  1217
# remove the intermediate dot files that are used to generate 
slouken@1662
  1218
# the various graphs.
slouken@1662
  1219
slouken@1662
  1220
DOT_CLEANUP            = YES
slouken@1662
  1221
slouken@1662
  1222
#---------------------------------------------------------------------------
slouken@1662
  1223
# Configuration::additions related to the search engine   
slouken@1662
  1224
#---------------------------------------------------------------------------
slouken@1662
  1225
slouken@1662
  1226
# The SEARCHENGINE tag specifies whether or not a search engine should be 
slouken@1662
  1227
# used. If set to NO the values of all tags below this one will be ignored.
slouken@1662
  1228
slouken@1662
  1229
SEARCHENGINE           = NO