include/doxyfile
author Sam Lantinga <slouken@libsdl.org>
Mon, 21 Sep 2009 09:38:10 +0000
branchSDL-1.2
changeset 4217 4c4113c2162c
child 6112 60dfd25009b0
permissions -rw-r--r--
Fixed bug #706

Ken Bull 2009-02-25 13:22:02 PST

Adds Doxygen support for all headers (except config and boilerplate headers) in
the include folder for SDL-1.2 revision 4446.

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