Doxyfile
author Ozkan Sezer <sezero@users.sourceforge.net>
Wed, 24 May 2017 11:28:05 -0400
changeset 599 f0d57c9b72d8
parent 463 6e50a61059b8
permissions -rw-r--r--
timidity.c: fix potential buffer overrun in RWgets

(num_read check was off-by-one.) also simplify the procedure a bit.
(transplanted from 0c4026dd32742e8b7d33fb96d40fe3c03b02f90c)
icculus@354
     1
# Doxyfile 1.2.16
icculus@354
     2
icculus@354
     3
# This file describes the settings to be used by the documentation system
icculus@354
     4
# doxygen (www.doxygen.org) for a project
icculus@354
     5
#
icculus@354
     6
# All text after a hash (#) is considered a comment and will be ignored
icculus@354
     7
# The format is:
icculus@354
     8
#       TAG = value [value, ...]
icculus@354
     9
# For lists items can also be appended using:
icculus@354
    10
#       TAG += value [value, ...]
icculus@354
    11
# Values that contain spaces should be placed between quotes (" ")
icculus@354
    12
icculus@354
    13
#---------------------------------------------------------------------------
icculus@354
    14
# General configuration options
icculus@354
    15
#---------------------------------------------------------------------------
icculus@354
    16
icculus@430
    17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
icculus@354
    18
# by quotes) that should identify the project.
icculus@354
    19
icculus@354
    20
PROJECT_NAME           = SDL_sound
icculus@354
    21
icculus@430
    22
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
icculus@430
    23
# This could be handy for archiving the generated documentation or
icculus@354
    24
# if some version control system is used.
icculus@354
    25
icculus@463
    26
PROJECT_NUMBER         = 1.0.1
icculus@354
    27
icculus@430
    28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
icculus@430
    29
# base path where the generated documentation will be put.
icculus@430
    30
# If a relative path is entered, it will be relative to the location
icculus@354
    31
# where doxygen was started. If left blank the current directory will be used.
icculus@354
    32
icculus@354
    33
OUTPUT_DIRECTORY       = docs
icculus@354
    34
icculus@430
    35
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
icculus@430
    36
# documentation generated by doxygen is written. Doxygen will use this
icculus@430
    37
# information to generate all constant output in the proper language.
icculus@430
    38
# The default language is English, other supported languages are:
icculus@430
    39
# Brazilian, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
icculus@430
    40
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean,
icculus@430
    41
# Norwegian, Polish, Portuguese, Romanian, Russian, Slovak, Slovene,
icculus@354
    42
# Spanish, Swedish and Ukrainian.
icculus@354
    43
icculus@354
    44
OUTPUT_LANGUAGE        = English
icculus@354
    45
icculus@430
    46
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
icculus@430
    47
# documentation are documented, even if no documentation was available.
icculus@430
    48
# Private class members and static file members will be hidden unless
icculus@354
    49
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
icculus@354
    50
icculus@354
    51
EXTRACT_ALL            = NO
icculus@354
    52
icculus@430
    53
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
icculus@354
    54
# will be included in the documentation.
icculus@354
    55
icculus@354
    56
EXTRACT_PRIVATE        = NO
icculus@354
    57
icculus@430
    58
# If the EXTRACT_STATIC tag is set to YES all static members of a file
icculus@354
    59
# will be included in the documentation.
icculus@354
    60
icculus@354
    61
EXTRACT_STATIC         = NO
icculus@354
    62
icculus@430
    63
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
icculus@430
    64
# defined locally in source files will be included in the documentation.
icculus@354
    65
# If set to NO only classes defined in header files are included.
icculus@354
    66
icculus@354
    67
EXTRACT_LOCAL_CLASSES  = NO
icculus@354
    68
icculus@430
    69
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
icculus@430
    70
# undocumented members of documented classes, files or namespaces.
icculus@430
    71
# If set to NO (the default) these members will be included in the
icculus@430
    72
# various overviews, but no documentation section is generated.
icculus@354
    73
# This option has no effect if EXTRACT_ALL is enabled.
icculus@354
    74
icculus@354
    75
HIDE_UNDOC_MEMBERS     = NO
icculus@354
    76
icculus@430
    77
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
icculus@430
    78
# undocumented classes that are normally visible in the class hierarchy.
icculus@430
    79
# If set to NO (the default) these class will be included in the various
icculus@354
    80
# overviews. This option has no effect if EXTRACT_ALL is enabled.
icculus@354
    81
icculus@354
    82
HIDE_UNDOC_CLASSES     = NO
icculus@354
    83
icculus@430
    84
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
icculus@430
    85
# include brief member descriptions after the members that are listed in
icculus@430
    86
# the file and class documentation (similar to JavaDoc).
icculus@354
    87
# Set to NO to disable this.
icculus@354
    88
icculus@354
    89
BRIEF_MEMBER_DESC      = YES
icculus@354
    90
icculus@430
    91
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
icculus@430
    92
# the brief description of a member or function before the detailed description.
icculus@430
    93
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
icculus@354
    94
# brief descriptions will be completely suppressed.
icculus@354
    95
icculus@354
    96
REPEAT_BRIEF           = YES
icculus@354
    97
icculus@430
    98
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
icculus@430
    99
# Doxygen will generate a detailed section even if there is only a brief
icculus@354
   100
# description.
icculus@354
   101
icculus@354
   102
ALWAYS_DETAILED_SEC    = NO
icculus@354
   103
icculus@430
   104
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
icculus@430
   105
# members of a class in the documentation of that class as if those members were
icculus@430
   106
# ordinary class members. Constructors, destructors and assignment operators of
icculus@354
   107
# the base classes will not be shown.
icculus@354
   108
icculus@354
   109
INLINE_INHERITED_MEMB  = NO
icculus@354
   110
icculus@430
   111
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
icculus@430
   112
# path before files name in the file list and in the header files. If set
icculus@354
   113
# to NO the shortest path that makes the file name unique will be used.
icculus@354
   114
icculus@354
   115
FULL_PATH_NAMES        = NO
icculus@354
   116
icculus@430
   117
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
icculus@430
   118
# can be used to strip a user defined part of the path. Stripping is
icculus@430
   119
# only done if one of the specified strings matches the left-hand part of
icculus@354
   120
# the path. It is allowed to use relative paths in the argument list.
icculus@354
   121
icculus@430
   122
STRIP_FROM_PATH        =
icculus@354
   123
icculus@430
   124
# The INTERNAL_DOCS tag determines if documentation
icculus@430
   125
# that is typed after a \internal command is included. If the tag is set
icculus@430
   126
# to NO (the default) then the documentation will be excluded.
icculus@354
   127
# Set it to YES to include the internal documentation.
icculus@354
   128
icculus@354
   129
INTERNAL_DOCS          = NO
icculus@354
   130
icculus@430
   131
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
icculus@430
   132
# doxygen to hide any special comment blocks from generated source code
icculus@354
   133
# fragments. Normal C and C++ comments will always remain visible.
icculus@354
   134
icculus@354
   135
STRIP_CODE_COMMENTS    = YES
icculus@354
   136
icculus@430
   137
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
icculus@430
   138
# file names in lower case letters. If set to YES upper case letters are also
icculus@430
   139
# allowed. This is useful if you have classes or files whose names only differ
icculus@430
   140
# in case and if your file system supports case sensitive file names. Windows
icculus@354
   141
# users are adviced to set this option to NO.
icculus@354
   142
icculus@354
   143
CASE_SENSE_NAMES       = YES
icculus@354
   144
icculus@430
   145
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
icculus@430
   146
# (but less readable) file names. This can be useful is your file systems
icculus@354
   147
# doesn't support long names like on DOS, Mac, or CD-ROM.
icculus@354
   148
icculus@354
   149
SHORT_NAMES            = NO
icculus@354
   150
icculus@430
   151
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
icculus@430
   152
# will show members with their full class and namespace scopes in the
icculus@354
   153
# documentation. If set to YES the scope will be hidden.
icculus@354
   154
icculus@354
   155
HIDE_SCOPE_NAMES       = NO
icculus@354
   156
icculus@430
   157
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
icculus@430
   158
# will generate a verbatim copy of the header file for each class for
icculus@354
   159
# which an include is specified. Set to NO to disable this.
icculus@354
   160
icculus@354
   161
VERBATIM_HEADERS       = YES
icculus@354
   162
icculus@430
   163
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
icculus@430
   164
# will put list of the files that are included by a file in the documentation
icculus@354
   165
# of that file.
icculus@354
   166
icculus@354
   167
SHOW_INCLUDE_FILES     = YES
icculus@354
   168
icculus@430
   169
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
icculus@430
   170
# will interpret the first line (until the first dot) of a JavaDoc-style
icculus@430
   171
# comment as the brief description. If set to NO, the JavaDoc
icculus@430
   172
# comments  will behave just like the Qt-style comments (thus requiring an
icculus@354
   173
# explict @brief command for a brief description.
icculus@354
   174
icculus@354
   175
JAVADOC_AUTOBRIEF      = NO
icculus@354
   176
icculus@430
   177
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
icculus@354
   178
# will output the detailed description near the top, like JavaDoc.
icculus@430
   179
# If set to NO, the detailed description appears after the member
icculus@354
   180
# documentation.
icculus@354
   181
icculus@354
   182
DETAILS_AT_TOP         = NO
icculus@354
   183
icculus@430
   184
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
icculus@430
   185
# member inherits the documentation from any documented member that it
icculus@354
   186
# reimplements.
icculus@354
   187
icculus@354
   188
INHERIT_DOCS           = YES
icculus@354
   189
icculus@430
   190
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
icculus@354
   191
# is inserted in the documentation for inline members.
icculus@354
   192
icculus@354
   193
INLINE_INFO            = YES
icculus@354
   194
icculus@430
   195
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
icculus@430
   196
# will sort the (detailed) documentation of file and class members
icculus@430
   197
# alphabetically by member name. If set to NO the members will appear in
icculus@354
   198
# declaration order.
icculus@354
   199
icculus@354
   200
SORT_MEMBER_DOCS       = YES
icculus@354
   201
icculus@430
   202
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
icculus@430
   203
# tag is set to YES, then doxygen will reuse the documentation of the first
icculus@430
   204
# member in the group (if any) for the other members of the group. By default
icculus@354
   205
# all members of a group must be documented explicitly.
icculus@354
   206
icculus@354
   207
DISTRIBUTE_GROUP_DOC   = NO
icculus@354
   208
icculus@430
   209
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
icculus@354
   210
# Doxygen uses this value to replace tabs by spaces in code fragments.
icculus@354
   211
icculus@354
   212
TAB_SIZE               = 4
icculus@354
   213
icculus@430
   214
# The GENERATE_TODOLIST tag can be used to enable (YES) or
icculus@430
   215
# disable (NO) the todo list. This list is created by putting \todo
icculus@354
   216
# commands in the documentation.
icculus@354
   217
icculus@354
   218
GENERATE_TODOLIST      = YES
icculus@354
   219
icculus@430
   220
# The GENERATE_TESTLIST tag can be used to enable (YES) or
icculus@430
   221
# disable (NO) the test list. This list is created by putting \test
icculus@354
   222
# commands in the documentation.
icculus@354
   223
icculus@354
   224
GENERATE_TESTLIST      = YES
icculus@354
   225
icculus@430
   226
# The GENERATE_BUGLIST tag can be used to enable (YES) or
icculus@430
   227
# disable (NO) the bug list. This list is created by putting \bug
icculus@354
   228
# commands in the documentation.
icculus@354
   229
icculus@354
   230
GENERATE_BUGLIST       = YES
icculus@354
   231
icculus@430
   232
# This tag can be used to specify a number of aliases that acts
icculus@430
   233
# as commands in the documentation. An alias has the form "name=value".
icculus@430
   234
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
icculus@430
   235
# put the command \sideeffect (or @sideeffect) in the documentation, which
icculus@430
   236
# will result in a user defined paragraph with heading "Side Effects:".
icculus@354
   237
# You can put \n's in the value part of an alias to insert newlines.
icculus@354
   238
icculus@430
   239
ALIASES                =
icculus@354
   240
icculus@430
   241
# The ENABLED_SECTIONS tag can be used to enable conditional
icculus@354
   242
# documentation sections, marked by \if sectionname ... \endif.
icculus@354
   243
icculus@430
   244
ENABLED_SECTIONS       =
icculus@354
   245
icculus@430
   246
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
icculus@430
   247
# the initial value of a variable or define consist of for it to appear in
icculus@430
   248
# the documentation. If the initializer consists of more lines than specified
icculus@430
   249
# here it will be hidden. Use a value of 0 to hide initializers completely.
icculus@430
   250
# The appearance of the initializer of individual variables and defines in the
icculus@430
   251
# documentation can be controlled using \showinitializer or \hideinitializer
icculus@354
   252
# command in the documentation regardless of this setting.
icculus@354
   253
icculus@354
   254
MAX_INITIALIZER_LINES  = 30
icculus@354
   255
icculus@430
   256
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
icculus@430
   257
# only. Doxygen will then generate output that is more tailored for C.
icculus@430
   258
# For instance some of the names that are used will be different. The list
icculus@354
   259
# of all members will be omitted, etc.
icculus@354
   260
icculus@354
   261
OPTIMIZE_OUTPUT_FOR_C  = YES
icculus@354
   262
icculus@430
   263
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
icculus@430
   264
# only. Doxygen will then generate output that is more tailored for Java.
icculus@430
   265
# For instance namespaces will be presented as packages, qualified scopes
icculus@354
   266
# will look different, etc.
icculus@354
   267
icculus@354
   268
OPTIMIZE_OUTPUT_JAVA   = NO
icculus@354
   269
icculus@430
   270
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
icculus@430
   271
# at the bottom of the documentation of classes and structs. If set to YES the
icculus@354
   272
# list will mention the files that were used to generate the documentation.
icculus@354
   273
icculus@354
   274
SHOW_USED_FILES        = YES
icculus@354
   275
icculus@354
   276
#---------------------------------------------------------------------------
icculus@354
   277
# configuration options related to warning and progress messages
icculus@354
   278
#---------------------------------------------------------------------------
icculus@354
   279
icculus@430
   280
# The QUIET tag can be used to turn on/off the messages that are generated
icculus@354
   281
# by doxygen. Possible values are YES and NO. If left blank NO is used.
icculus@354
   282
icculus@354
   283
QUIET                  = NO
icculus@354
   284
icculus@430
   285
# The WARNINGS tag can be used to turn on/off the warning messages that are
icculus@430
   286
# generated by doxygen. Possible values are YES and NO. If left blank
icculus@354
   287
# NO is used.
icculus@354
   288
icculus@354
   289
WARNINGS               = YES
icculus@354
   290
icculus@430
   291
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
icculus@430
   292
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
icculus@354
   293
# automatically be disabled.
icculus@354
   294
icculus@354
   295
WARN_IF_UNDOCUMENTED   = YES
icculus@354
   296
icculus@430
   297
# The WARN_FORMAT tag determines the format of the warning messages that
icculus@430
   298
# doxygen can produce. The string should contain the $file, $line, and $text
icculus@430
   299
# tags, which will be replaced by the file and line number from which the
icculus@354
   300
# warning originated and the warning text.
icculus@354
   301
icculus@354
   302
WARN_FORMAT            = "$file:$line: $text"
icculus@354
   303
icculus@430
   304
# The WARN_LOGFILE tag can be used to specify a file to which warning
icculus@430
   305
# and error messages should be written. If left blank the output is written
icculus@354
   306
# to stderr.
icculus@354
   307
icculus@430
   308
WARN_LOGFILE           =
icculus@354
   309
icculus@354
   310
#---------------------------------------------------------------------------
icculus@354
   311
# configuration options related to the input files
icculus@354
   312
#---------------------------------------------------------------------------
icculus@354
   313
icculus@430
   314
# The INPUT tag can be used to specify the files and/or directories that contain
icculus@430
   315
# documented source files. You may enter file names like "myfile.cpp" or
icculus@430
   316
# directories like "/usr/src/myproject". Separate the files or directories
icculus@354
   317
# with spaces.
icculus@354
   318
icculus@354
   319
INPUT                  = SDL_sound.h
icculus@354
   320
icculus@430
   321
# If the value of the INPUT tag contains directories, you can use the
icculus@430
   322
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
icculus@430
   323
# and *.h) to filter out the source-files in the directories. If left
icculus@430
   324
# blank the following patterns are tested:
icculus@430
   325
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
icculus@354
   326
# *.h++ *.idl *.odl
icculus@354
   327
icculus@430
   328
FILE_PATTERNS          =
icculus@354
   329
icculus@430
   330
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
icculus@430
   331
# should be searched for input files as well. Possible values are YES and NO.
icculus@354
   332
# If left blank NO is used.
icculus@354
   333
icculus@354
   334
RECURSIVE              = NO
icculus@354
   335
icculus@430
   336
# The EXCLUDE tag can be used to specify files and/or directories that should
icculus@430
   337
# excluded from the INPUT source files. This way you can easily exclude a
icculus@354
   338
# subdirectory from a directory tree whose root is specified with the INPUT tag.
icculus@354
   339
icculus@430
   340
EXCLUDE                =
icculus@354
   341
icculus@430
   342
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
icculus@354
   343
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
icculus@354
   344
icculus@354
   345
EXCLUDE_SYMLINKS       = NO
icculus@354
   346
icculus@430
   347
# If the value of the INPUT tag contains directories, you can use the
icculus@430
   348
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
icculus@354
   349
# certain files from those directories.
icculus@354
   350
icculus@430
   351
EXCLUDE_PATTERNS       =
icculus@354
   352
icculus@430
   353
# The EXAMPLE_PATH tag can be used to specify one or more files or
icculus@430
   354
# directories that contain example code fragments that are included (see
icculus@354
   355
# the \include command).
icculus@354
   356
icculus@430
   357
EXAMPLE_PATH           =
icculus@354
   358
icculus@430
   359
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
icculus@430
   360
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
icculus@430
   361
# and *.h) to filter out the source-files in the directories. If left
icculus@354
   362
# blank all files are included.
icculus@354
   363
icculus@430
   364
EXAMPLE_PATTERNS       =
icculus@354
   365
icculus@430
   366
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
icculus@430
   367
# searched for input files to be used with the \include or \dontinclude
icculus@430
   368
# commands irrespective of the value of the RECURSIVE tag.
icculus@354
   369
# Possible values are YES and NO. If left blank NO is used.
icculus@354
   370
icculus@354
   371
EXAMPLE_RECURSIVE      = NO
icculus@354
   372
icculus@430
   373
# The IMAGE_PATH tag can be used to specify one or more files or
icculus@430
   374
# directories that contain image that are included in the documentation (see
icculus@354
   375
# the \image command).
icculus@354
   376
icculus@430
   377
IMAGE_PATH             =
icculus@354
   378
icculus@430
   379
# The INPUT_FILTER tag can be used to specify a program that doxygen should
icculus@430
   380
# invoke to filter for each input file. Doxygen will invoke the filter program
icculus@430
   381
# by executing (via popen()) the command <filter> <input-file>, where <filter>
icculus@430
   382
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
icculus@430
   383
# input file. Doxygen will then use the output that the filter program writes
icculus@354
   384
# to standard output.
icculus@354
   385
icculus@430
   386
INPUT_FILTER           =
icculus@354
   387
icculus@430
   388
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
icculus@430
   389
# INPUT_FILTER) will be used to filter the input files when producing source
icculus@354
   390
# files to browse.
icculus@354
   391
icculus@354
   392
FILTER_SOURCE_FILES    = NO
icculus@354
   393
icculus@354
   394
#---------------------------------------------------------------------------
icculus@354
   395
# configuration options related to source browsing
icculus@354
   396
#---------------------------------------------------------------------------
icculus@354
   397
icculus@430
   398
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
icculus@354
   399
# be generated. Documented entities will be cross-referenced with these sources.
icculus@354
   400
icculus@354
   401
SOURCE_BROWSER         = NO
icculus@354
   402
icculus@430
   403
# Setting the INLINE_SOURCES tag to YES will include the body
icculus@354
   404
# of functions and classes directly in the documentation.
icculus@354
   405
icculus@354
   406
INLINE_SOURCES         = NO
icculus@354
   407
icculus@430
   408
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
icculus@430
   409
# then for each documented function all documented
icculus@354
   410
# functions referencing it will be listed.
icculus@354
   411
icculus@354
   412
REFERENCED_BY_RELATION = YES
icculus@354
   413
icculus@430
   414
# If the REFERENCES_RELATION tag is set to YES (the default)
icculus@430
   415
# then for each documented function all documented entities
icculus@354
   416
# called/used by that function will be listed.
icculus@354
   417
icculus@354
   418
REFERENCES_RELATION    = YES
icculus@354
   419
icculus@354
   420
#---------------------------------------------------------------------------
icculus@354
   421
# configuration options related to the alphabetical class index
icculus@354
   422
#---------------------------------------------------------------------------
icculus@354
   423
icculus@430
   424
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
icculus@430
   425
# of all compounds will be generated. Enable this if the project
icculus@354
   426
# contains a lot of classes, structs, unions or interfaces.
icculus@354
   427
icculus@354
   428
ALPHABETICAL_INDEX     = NO
icculus@354
   429
icculus@430
   430
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
icculus@430
   431
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
icculus@354
   432
# in which this list will be split (can be a number in the range [1..20])
icculus@354
   433
icculus@354
   434
COLS_IN_ALPHA_INDEX    = 5
icculus@354
   435
icculus@430
   436
# In case all classes in a project start with a common prefix, all
icculus@430
   437
# classes will be put under the same header in the alphabetical index.
icculus@430
   438
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
icculus@354
   439
# should be ignored while generating the index headers.
icculus@354
   440
icculus@354
   441
IGNORE_PREFIX          =
icculus@354
   442
icculus@354
   443
#---------------------------------------------------------------------------
icculus@354
   444
# configuration options related to the HTML output
icculus@354
   445
#---------------------------------------------------------------------------
icculus@354
   446
icculus@430
   447
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
icculus@354
   448
# generate HTML output.
icculus@354
   449
icculus@354
   450
GENERATE_HTML          = YES
icculus@354
   451
icculus@430
   452
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
icculus@430
   453
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
icculus@354
   454
# put in front of it. If left blank `html' will be used as the default path.
icculus@354
   455
icculus@354
   456
HTML_OUTPUT            = html
icculus@354
   457
icculus@430
   458
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
icculus@430
   459
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
icculus@354
   460
# doxygen will generate files with .html extension.
icculus@354
   461
icculus@354
   462
HTML_FILE_EXTENSION    = .html
icculus@354
   463
icculus@430
   464
# The HTML_HEADER tag can be used to specify a personal HTML header for
icculus@430
   465
# each generated HTML page. If it is left blank doxygen will generate a
icculus@354
   466
# standard header.
icculus@354
   467
icculus@430
   468
HTML_HEADER            =
icculus@354
   469
icculus@430
   470
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
icculus@430
   471
# each generated HTML page. If it is left blank doxygen will generate a
icculus@354
   472
# standard footer.
icculus@354
   473
icculus@430
   474
HTML_FOOTER            =
icculus@354
   475
icculus@430
   476
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
icculus@430
   477
# style sheet that is used by each HTML page. It can be used to
icculus@430
   478
# fine-tune the look of the HTML output. If the tag is left blank doxygen
icculus@354
   479
# will generate a default style sheet
icculus@354
   480
icculus@430
   481
HTML_STYLESHEET        =
icculus@354
   482
icculus@430
   483
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
icculus@430
   484
# files or namespaces will be aligned in HTML using tables. If set to
icculus@354
   485
# NO a bullet list will be used.
icculus@354
   486
icculus@354
   487
HTML_ALIGN_MEMBERS     = YES
icculus@354
   488
icculus@430
   489
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
icculus@430
   490
# will be generated that can be used as input for tools like the
icculus@430
   491
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
icculus@354
   492
# of the generated HTML documentation.
icculus@354
   493
icculus@354
   494
GENERATE_HTMLHELP      = NO
icculus@354
   495
icculus@430
   496
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
icculus@430
   497
# controls if a separate .chi index file is generated (YES) or that
icculus@354
   498
# it should be included in the master .chm file (NO).
icculus@354
   499
icculus@354
   500
GENERATE_CHI           = NO
icculus@354
   501
icculus@430
   502
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
icculus@430
   503
# controls whether a binary table of contents is generated (YES) or a
icculus@354
   504
# normal table of contents (NO) in the .chm file.
icculus@354
   505
icculus@354
   506
BINARY_TOC             = NO
icculus@354
   507
icculus@430
   508
# The TOC_EXPAND flag can be set to YES to add extra items for group members
icculus@354
   509
# to the contents of the Html help documentation and to the tree view.
icculus@354
   510
icculus@354
   511
TOC_EXPAND             = NO
icculus@354
   512
icculus@430
   513
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
icculus@430
   514
# top of each HTML page. The value NO (the default) enables the index and
icculus@354
   515
# the value YES disables it.
icculus@354
   516
icculus@354
   517
DISABLE_INDEX          = NO
icculus@354
   518
icculus@430
   519
# This tag can be used to set the number of enum values (range [1..20])
icculus@354
   520
# that doxygen will group on one line in the generated HTML documentation.
icculus@354
   521
icculus@354
   522
ENUM_VALUES_PER_LINE   = 4
icculus@354
   523
icculus@354
   524
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
icculus@430
   525
# generated containing a tree-like index structure (just like the one that
icculus@430
   526
# is generated for HTML Help). For this to work a browser that supports
icculus@430
   527
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
icculus@430
   528
# or Internet explorer 4.0+). Note that for large projects the tree generation
icculus@430
   529
# can take a very long time. In such cases it is better to disable this feature.
icculus@354
   530
# Windows users are probably better off using the HTML help feature.
icculus@354
   531
icculus@354
   532
GENERATE_TREEVIEW      = NO
icculus@354
   533
icculus@430
   534
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
icculus@430
   535
# used to set the initial width (in pixels) of the frame in which the tree
icculus@354
   536
# is shown.
icculus@354
   537
icculus@354
   538
TREEVIEW_WIDTH         = 250
icculus@354
   539
icculus@354
   540
#---------------------------------------------------------------------------
icculus@354
   541
# configuration options related to the LaTeX output
icculus@354
   542
#---------------------------------------------------------------------------
icculus@354
   543
icculus@430
   544
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
icculus@354
   545
# generate Latex output.
icculus@354
   546
icculus@354
   547
GENERATE_LATEX         = YES
icculus@354
   548
icculus@430
   549
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
icculus@430
   550
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
icculus@354
   551
# put in front of it. If left blank `latex' will be used as the default path.
icculus@354
   552
icculus@354
   553
LATEX_OUTPUT           = latex
icculus@354
   554
icculus@354
   555
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
icculus@354
   556
icculus@354
   557
LATEX_CMD_NAME         = latex
icculus@354
   558
icculus@430
   559
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
icculus@430
   560
# generate index for LaTeX. If left blank `makeindex' will be used as the
icculus@354
   561
# default command name.
icculus@354
   562
icculus@354
   563
MAKEINDEX_CMD_NAME     = makeindex
icculus@354
   564
icculus@430
   565
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
icculus@430
   566
# LaTeX documents. This may be useful for small projects and may help to
icculus@354
   567
# save some trees in general.
icculus@354
   568
icculus@354
   569
COMPACT_LATEX          = NO
icculus@354
   570
icculus@430
   571
# The PAPER_TYPE tag can be used to set the paper type that is used
icculus@430
   572
# by the printer. Possible values are: a4, a4wide, letter, legal and
icculus@354
   573
# executive. If left blank a4wide will be used.
icculus@354
   574
icculus@354
   575
PAPER_TYPE             = a4wide
icculus@354
   576
icculus@430
   577
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
icculus@354
   578
# packages that should be included in the LaTeX output.
icculus@354
   579
icculus@430
   580
EXTRA_PACKAGES         =
icculus@354
   581
icculus@430
   582
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
icculus@430
   583
# the generated latex document. The header should contain everything until
icculus@430
   584
# the first chapter. If it is left blank doxygen will generate a
icculus@354
   585
# standard header. Notice: only use this tag if you know what you are doing!
icculus@354
   586
icculus@430
   587
LATEX_HEADER           =
icculus@354
   588
icculus@430
   589
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
icculus@430
   590
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
icculus@430
   591
# contain links (just like the HTML output) instead of page references
icculus@354
   592
# This makes the output suitable for online browsing using a pdf viewer.
icculus@354
   593
icculus@354
   594
PDF_HYPERLINKS         = NO
icculus@354
   595
icculus@430
   596
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
icculus@430
   597
# plain latex in the generated Makefile. Set this option to YES to get a
icculus@354
   598
# higher quality PDF documentation.
icculus@354
   599
icculus@354
   600
USE_PDFLATEX           = NO
icculus@354
   601
icculus@430
   602
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
icculus@430
   603
# command to the generated LaTeX files. This will instruct LaTeX to keep
icculus@430
   604
# running if errors occur, instead of asking the user for help.
icculus@354
   605
# This option is also used when generating formulas in HTML.
icculus@354
   606
icculus@354
   607
LATEX_BATCHMODE        = NO
icculus@354
   608
icculus@354
   609
#---------------------------------------------------------------------------
icculus@354
   610
# configuration options related to the RTF output
icculus@354
   611
#---------------------------------------------------------------------------
icculus@354
   612
icculus@430
   613
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
icculus@430
   614
# The RTF output is optimised for Word 97 and may not look very pretty with
icculus@354
   615
# other RTF readers or editors.
icculus@354
   616
icculus@354
   617
GENERATE_RTF           = NO
icculus@354
   618
icculus@430
   619
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
icculus@430
   620
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
icculus@354
   621
# put in front of it. If left blank `rtf' will be used as the default path.
icculus@354
   622
icculus@354
   623
RTF_OUTPUT             = rtf
icculus@354
   624
icculus@430
   625
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
icculus@430
   626
# RTF documents. This may be useful for small projects and may help to
icculus@354
   627
# save some trees in general.
icculus@354
   628
icculus@354
   629
COMPACT_RTF            = NO
icculus@354
   630
icculus@430
   631
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
icculus@430
   632
# will contain hyperlink fields. The RTF file will
icculus@430
   633
# contain links (just like the HTML output) instead of page references.
icculus@430
   634
# This makes the output suitable for online browsing using WORD or other
icculus@430
   635
# programs which support those fields.
icculus@354
   636
# Note: wordpad (write) and others do not support links.
icculus@354
   637
icculus@354
   638
RTF_HYPERLINKS         = NO
icculus@354
   639
icculus@430
   640
# Load stylesheet definitions from file. Syntax is similar to doxygen's
icculus@430
   641
# config file, i.e. a series of assigments. You only have to provide
icculus@354
   642
# replacements, missing definitions are set to their default value.
icculus@354
   643
icculus@430
   644
RTF_STYLESHEET_FILE    =
icculus@354
   645
icculus@430
   646
# Set optional variables used in the generation of an rtf document.
icculus@354
   647
# Syntax is similar to doxygen's config file.
icculus@354
   648
icculus@430
   649
RTF_EXTENSIONS_FILE    =
icculus@354
   650
icculus@354
   651
#---------------------------------------------------------------------------
icculus@354
   652
# configuration options related to the man page output
icculus@354
   653
#---------------------------------------------------------------------------
icculus@354
   654
icculus@430
   655
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
icculus@354
   656
# generate man pages
icculus@354
   657
icculus@354
   658
GENERATE_MAN           = YES
icculus@354
   659
icculus@430
   660
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
icculus@430
   661
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
icculus@354
   662
# put in front of it. If left blank `man' will be used as the default path.
icculus@354
   663
icculus@354
   664
MAN_OUTPUT             = man
icculus@354
   665
icculus@430
   666
# The MAN_EXTENSION tag determines the extension that is added to
icculus@354
   667
# the generated man pages (default is the subroutine's section .3)
icculus@354
   668
icculus@354
   669
MAN_EXTENSION          = .3
icculus@354
   670
icculus@430
   671
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
icculus@430
   672
# then it will generate one additional man file for each entity
icculus@430
   673
# documented in the real man page(s). These additional files
icculus@430
   674
# only source the real man page, but without them the man command
icculus@354
   675
# would be unable to find the correct page. The default is NO.
icculus@354
   676
icculus@354
   677
MAN_LINKS              = YES
icculus@354
   678
icculus@354
   679
#---------------------------------------------------------------------------
icculus@354
   680
# configuration options related to the XML output
icculus@354
   681
#---------------------------------------------------------------------------
icculus@354
   682
icculus@430
   683
# If the GENERATE_XML tag is set to YES Doxygen will
icculus@430
   684
# generate an XML file that captures the structure of
icculus@430
   685
# the code including all documentation. Note that this
icculus@430
   686
# feature is still experimental and incomplete at the
icculus@354
   687
# moment.
icculus@354
   688
icculus@354
   689
GENERATE_XML           = NO
icculus@354
   690
icculus@354
   691
#---------------------------------------------------------------------------
icculus@354
   692
# configuration options for the AutoGen Definitions output
icculus@354
   693
#---------------------------------------------------------------------------
icculus@354
   694
icculus@430
   695
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
icculus@430
   696
# generate an AutoGen Definitions (see autogen.sf.net) file
icculus@430
   697
# that captures the structure of the code including all
icculus@430
   698
# documentation. Note that this feature is still experimental
icculus@354
   699
# and incomplete at the moment.
icculus@354
   700
icculus@354
   701
GENERATE_AUTOGEN_DEF   = NO
icculus@354
   702
icculus@354
   703
#---------------------------------------------------------------------------
icculus@430
   704
# Configuration options related to the preprocessor
icculus@354
   705
#---------------------------------------------------------------------------
icculus@354
   706
icculus@430
   707
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
icculus@430
   708
# evaluate all C-preprocessor directives found in the sources and include
icculus@354
   709
# files.
icculus@354
   710
icculus@354
   711
ENABLE_PREPROCESSING   = YES
icculus@354
   712
icculus@430
   713
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
icculus@430
   714
# names in the source code. If set to NO (the default) only conditional
icculus@430
   715
# compilation will be performed. Macro expansion can be done in a controlled
icculus@354
   716
# way by setting EXPAND_ONLY_PREDEF to YES.
icculus@354
   717
icculus@354
   718
MACRO_EXPANSION        = YES
icculus@354
   719
icculus@430
   720
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
icculus@430
   721
# then the macro expansion is limited to the macros specified with the
icculus@354
   722
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
icculus@354
   723
icculus@354
   724
EXPAND_ONLY_PREDEF     = YES
icculus@354
   725
icculus@430
   726
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
icculus@354
   727
# in the INCLUDE_PATH (see below) will be search if a #include is found.
icculus@354
   728
icculus@354
   729
SEARCH_INCLUDES        = YES
icculus@354
   730
icculus@430
   731
# The INCLUDE_PATH tag can be used to specify one or more directories that
icculus@430
   732
# contain include files that are not input files but should be processed by
icculus@354
   733
# the preprocessor.
icculus@354
   734
icculus@430
   735
INCLUDE_PATH           =
icculus@354
   736
icculus@430
   737
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
icculus@430
   738
# patterns (like *.h and *.hpp) to filter out the header-files in the
icculus@430
   739
# directories. If left blank, the patterns specified with FILE_PATTERNS will
icculus@354
   740
# be used.
icculus@354
   741
icculus@430
   742
INCLUDE_FILE_PATTERNS  =
icculus@354
   743
icculus@430
   744
# The PREDEFINED tag can be used to specify one or more macro names that
icculus@430
   745
# are defined before the preprocessor is started (similar to the -D option of
icculus@430
   746
# gcc). The argument of the tag is a list of macros of the form: name
icculus@430
   747
# or name=definition (no spaces). If the definition and the = are
icculus@354
   748
# omitted =1 is assumed.
icculus@354
   749
icculus@418
   750
PREDEFINED             = DOXYGEN_SHOULD_IGNORE_THIS=1 SDLCALL= SNDDECLSPEC=
icculus@354
   751
icculus@430
   752
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
icculus@430
   753
# this tag can be used to specify a list of macro names that should be expanded.
icculus@430
   754
# The macro definition that is found in the sources will be used.
icculus@354
   755
# Use the PREDEFINED tag if you want to use a different macro definition.
icculus@354
   756
icculus@430
   757
EXPAND_AS_DEFINED      =
icculus@354
   758
icculus@430
   759
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
icculus@430
   760
# doxygen's preprocessor will remove all function-like macros that are alone
icculus@430
   761
# on a line and do not end with a semicolon. Such function macros are typically
icculus@354
   762
# used for boiler-plate code, and will confuse the parser if not removed.
icculus@354
   763
icculus@354
   764
SKIP_FUNCTION_MACROS   = YES
icculus@354
   765
icculus@354
   766
#---------------------------------------------------------------------------
icculus@430
   767
# Configuration::addtions related to external references
icculus@354
   768
#---------------------------------------------------------------------------
icculus@354
   769
icculus@354
   770
# The TAGFILES tag can be used to specify one or more tagfiles.
icculus@354
   771
icculus@430
   772
TAGFILES               =
icculus@354
   773
icculus@430
   774
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
icculus@354
   775
# a tag file that is based on the input files it reads.
icculus@354
   776
icculus@430
   777
GENERATE_TAGFILE       =
icculus@354
   778
icculus@430
   779
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
icculus@430
   780
# in the class index. If set to NO only the inherited external classes
icculus@354
   781
# will be listed.
icculus@354
   782
icculus@354
   783
ALLEXTERNALS           = NO
icculus@354
   784
icculus@430
   785
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
icculus@430
   786
# in the modules index. If set to NO, only the current project's groups will
icculus@354
   787
# be listed.
icculus@354
   788
icculus@354
   789
EXTERNAL_GROUPS        = YES
icculus@354
   790
icculus@430
   791
# The PERL_PATH should be the absolute path and name of the perl script
icculus@354
   792
# interpreter (i.e. the result of `which perl').
icculus@354
   793
icculus@354
   794
PERL_PATH              = /usr/bin/perl
icculus@354
   795
icculus@354
   796
#---------------------------------------------------------------------------
icculus@430
   797
# Configuration options related to the dot tool
icculus@354
   798
#---------------------------------------------------------------------------
icculus@354
   799
icculus@430
   800
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
icculus@430
   801
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
icculus@430
   802
# super classes. Setting the tag to NO turns the diagrams off. Note that this
icculus@430
   803
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
icculus@354
   804
# recommended to install and use dot, since it yields more powerful graphs.
icculus@354
   805
icculus@354
   806
CLASS_DIAGRAMS         = NO
icculus@354
   807
icculus@430
   808
# If set to YES, the inheritance and collaboration graphs will hide
icculus@430
   809
# inheritance and usage relations if the target is undocumented
icculus@354
   810
# or is not a class.
icculus@354
   811
icculus@354
   812
HIDE_UNDOC_RELATIONS   = YES
icculus@354
   813
icculus@430
   814
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
icculus@430
   815
# available from the path. This tool is part of Graphviz, a graph visualization
icculus@430
   816
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
icculus@354
   817
# have no effect if this option is set to NO (the default)
icculus@354
   818
icculus@354
   819
HAVE_DOT               = NO
icculus@354
   820
icculus@430
   821
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
icculus@430
   822
# will generate a graph for each documented class showing the direct and
icculus@430
   823
# indirect inheritance relations. Setting this tag to YES will force the
icculus@354
   824
# the CLASS_DIAGRAMS tag to NO.
icculus@354
   825
icculus@354
   826
CLASS_GRAPH            = NO
icculus@354
   827
icculus@430
   828
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
icculus@430
   829
# will generate a graph for each documented class showing the direct and
icculus@430
   830
# indirect implementation dependencies (inheritance, containment, and
icculus@354
   831
# class references variables) of the class with other documented classes.
icculus@354
   832
icculus@354
   833
COLLABORATION_GRAPH    = NO
icculus@354
   834
icculus@430
   835
# If set to YES, the inheritance and collaboration graphs will show the
icculus@354
   836
# relations between templates and their instances.
icculus@354
   837
icculus@354
   838
TEMPLATE_RELATIONS     = NO
icculus@354
   839
icculus@430
   840
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
icculus@430
   841
# tags are set to YES then doxygen will generate a graph for each documented
icculus@430
   842
# file showing the direct and indirect include dependencies of the file with
icculus@354
   843
# other documented files.
icculus@354
   844
icculus@354
   845
INCLUDE_GRAPH          = NO
icculus@354
   846
icculus@430
   847
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
icculus@430
   848
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
icculus@430
   849
# documented header file showing the documented files that directly or
icculus@354
   850
# indirectly include this file.
icculus@354
   851
icculus@354
   852
INCLUDED_BY_GRAPH      = YES
icculus@354
   853
icculus@430
   854
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
icculus@354
   855
# will graphical hierarchy of all classes instead of a textual one.
icculus@354
   856
icculus@354
   857
GRAPHICAL_HIERARCHY    = YES
icculus@354
   858
icculus@430
   859
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
icculus@354
   860
# generated by dot. Possible values are png, jpg, or gif
icculus@354
   861
# If left blank png will be used.
icculus@354
   862
icculus@354
   863
DOT_IMAGE_FORMAT       = png
icculus@354
   864
icculus@430
   865
# The tag DOT_PATH can be used to specify the path where the dot tool can be
icculus@354
   866
# found. If left blank, it is assumed the dot tool can be found on the path.
icculus@354
   867
icculus@430
   868
DOT_PATH               =
icculus@354
   869
icculus@430
   870
# The DOTFILE_DIRS tag can be used to specify one or more directories that
icculus@430
   871
# contain dot files that are included in the documentation (see the
icculus@354
   872
# \dotfile command).
icculus@354
   873
icculus@430
   874
DOTFILE_DIRS           =
icculus@354
   875
icculus@430
   876
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
icculus@430
   877
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
icculus@430
   878
# this value, doxygen will try to truncate the graph, so that it fits within
icculus@430
   879
# the specified constraint. Beware that most browsers cannot cope with very
icculus@354
   880
# large images.
icculus@354
   881
icculus@354
   882
MAX_DOT_GRAPH_WIDTH    = 1024
icculus@354
   883
icculus@430
   884
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
icculus@430
   885
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
icculus@430
   886
# this value, doxygen will try to truncate the graph, so that it fits within
icculus@430
   887
# the specified constraint. Beware that most browsers cannot cope with very
icculus@354
   888
# large images.
icculus@354
   889
icculus@354
   890
MAX_DOT_GRAPH_HEIGHT   = 1024
icculus@354
   891
icculus@430
   892
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
icculus@430
   893
# generate a legend page explaining the meaning of the various boxes and
icculus@354
   894
# arrows in the dot generated graphs.
icculus@354
   895
icculus@354
   896
GENERATE_LEGEND        = YES
icculus@354
   897
icculus@430
   898
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
icculus@430
   899
# remove the intermedate dot files that are used to generate
icculus@354
   900
# the various graphs.
icculus@354
   901
icculus@354
   902
DOT_CLEANUP            = YES
icculus@354
   903
icculus@354
   904
#---------------------------------------------------------------------------
icculus@430
   905
# Configuration::addtions related to the search engine
icculus@354
   906
#---------------------------------------------------------------------------
icculus@354
   907
icculus@430
   908
# The SEARCHENGINE tag specifies whether or not a search engine should be
icculus@354
   909
# used. If set to NO the values of all tags below this one will be ignored.
icculus@354
   910
icculus@354
   911
SEARCHENGINE           = NO
icculus@354
   912
icculus@430
   913
# The CGI_NAME tag should be the name of the CGI script that
icculus@430
   914
# starts the search engine (doxysearch) with the correct parameters.
icculus@354
   915
# A script with this name will be generated by doxygen.
icculus@354
   916
icculus@354
   917
CGI_NAME               = search.cgi
icculus@354
   918
icculus@430
   919
# The CGI_URL tag should be the absolute URL to the directory where the
icculus@430
   920
# cgi binaries are located. See the documentation of your http daemon for
icculus@354
   921
# details.
icculus@354
   922
icculus@430
   923
CGI_URL                =
icculus@354
   924
icculus@430
   925
# The DOC_URL tag should be the absolute URL to the directory where the
icculus@430
   926
# documentation is located. If left blank the absolute path to the
icculus@354
   927
# documentation, with file:// prepended to it, will be used.
icculus@354
   928
icculus@430
   929
DOC_URL                =
icculus@354
   930
icculus@430
   931
# The DOC_ABSPATH tag should be the absolute path to the directory where the
icculus@430
   932
# documentation is located. If left blank the directory on the local machine
icculus@354
   933
# will be used.
icculus@354
   934
icculus@430
   935
DOC_ABSPATH            =
icculus@354
   936
icculus@430
   937
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
icculus@354
   938
# is installed.
icculus@354
   939
icculus@354
   940
BIN_ABSPATH            = /usr/local/bin/
icculus@354
   941
icculus@430
   942
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
icculus@430
   943
# documentation generated for other projects. This allows doxysearch to search
icculus@354
   944
# the documentation for these projects as well.
icculus@354
   945
icculus@430
   946
EXT_DOC_PATHS          =