include/doxyfile
branchSDL-1.2
changeset 4217 4c4113c2162c
child 6112 60dfd25009b0
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/include/doxyfile	Mon Sep 21 09:38:10 2009 +0000
     1.3 @@ -0,0 +1,946 @@
     1.4 +# Doxyfile 1.2.16
     1.5 +
     1.6 +# This file describes the settings to be used by the documentation system
     1.7 +# doxygen (www.doxygen.org) for a project
     1.8 +#
     1.9 +# All text after a hash (#) is considered a comment and will be ignored
    1.10 +# The format is:
    1.11 +#       TAG = value [value, ...]
    1.12 +# For lists items can also be appended using:
    1.13 +#       TAG += value [value, ...]
    1.14 +# Values that contain spaces should be placed between quotes (" ")
    1.15 +
    1.16 +#---------------------------------------------------------------------------
    1.17 +# General configuration options
    1.18 +#---------------------------------------------------------------------------
    1.19 +
    1.20 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    1.21 +# by quotes) that should identify the project.
    1.22 +
    1.23 +PROJECT_NAME           = SDL
    1.24 +
    1.25 +# The PROJECT_NUMBER tag can be used to enter a project or revision number.
    1.26 +# This could be handy for archiving the generated documentation or
    1.27 +# if some version control system is used.
    1.28 +
    1.29 +PROJECT_NUMBER         = 1.2.14
    1.30 +
    1.31 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
    1.32 +# base path where the generated documentation will be put.
    1.33 +# If a relative path is entered, it will be relative to the location
    1.34 +# where doxygen was started. If left blank the current directory will be used.
    1.35 +
    1.36 +OUTPUT_DIRECTORY       = docs
    1.37 +
    1.38 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
    1.39 +# documentation generated by doxygen is written. Doxygen will use this
    1.40 +# information to generate all constant output in the proper language.
    1.41 +# The default language is English, other supported languages are:
    1.42 +# Brazilian, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
    1.43 +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean,
    1.44 +# Norwegian, Polish, Portuguese, Romanian, Russian, Slovak, Slovene,
    1.45 +# Spanish, Swedish and Ukrainian.
    1.46 +
    1.47 +OUTPUT_LANGUAGE        = English
    1.48 +
    1.49 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
    1.50 +# documentation are documented, even if no documentation was available.
    1.51 +# Private class members and static file members will be hidden unless
    1.52 +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    1.53 +
    1.54 +EXTRACT_ALL            = NO
    1.55 +
    1.56 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    1.57 +# will be included in the documentation.
    1.58 +
    1.59 +EXTRACT_PRIVATE        = NO
    1.60 +
    1.61 +# If the EXTRACT_STATIC tag is set to YES all static members of a file
    1.62 +# will be included in the documentation.
    1.63 +
    1.64 +EXTRACT_STATIC         = NO
    1.65 +
    1.66 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
    1.67 +# defined locally in source files will be included in the documentation.
    1.68 +# If set to NO only classes defined in header files are included.
    1.69 +
    1.70 +EXTRACT_LOCAL_CLASSES  = NO
    1.71 +
    1.72 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    1.73 +# undocumented members of documented classes, files or namespaces.
    1.74 +# If set to NO (the default) these members will be included in the
    1.75 +# various overviews, but no documentation section is generated.
    1.76 +# This option has no effect if EXTRACT_ALL is enabled.
    1.77 +
    1.78 +HIDE_UNDOC_MEMBERS     = NO
    1.79 +
    1.80 +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
    1.81 +# undocumented classes that are normally visible in the class hierarchy.
    1.82 +# If set to NO (the default) these class will be included in the various
    1.83 +# overviews. This option has no effect if EXTRACT_ALL is enabled.
    1.84 +
    1.85 +HIDE_UNDOC_CLASSES     = NO
    1.86 +
    1.87 +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
    1.88 +# include brief member descriptions after the members that are listed in
    1.89 +# the file and class documentation (similar to JavaDoc).
    1.90 +# Set to NO to disable this.
    1.91 +
    1.92 +BRIEF_MEMBER_DESC      = YES
    1.93 +
    1.94 +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
    1.95 +# the brief description of a member or function before the detailed description.
    1.96 +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    1.97 +# brief descriptions will be completely suppressed.
    1.98 +
    1.99 +REPEAT_BRIEF           = YES
   1.100 +
   1.101 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
   1.102 +# Doxygen will generate a detailed section even if there is only a brief
   1.103 +# description.
   1.104 +
   1.105 +ALWAYS_DETAILED_SEC    = NO
   1.106 +
   1.107 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
   1.108 +# members of a class in the documentation of that class as if those members were
   1.109 +# ordinary class members. Constructors, destructors and assignment operators of
   1.110 +# the base classes will not be shown.
   1.111 +
   1.112 +INLINE_INHERITED_MEMB  = NO
   1.113 +
   1.114 +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
   1.115 +# path before files name in the file list and in the header files. If set
   1.116 +# to NO the shortest path that makes the file name unique will be used.
   1.117 +
   1.118 +FULL_PATH_NAMES        = NO
   1.119 +
   1.120 +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
   1.121 +# can be used to strip a user defined part of the path. Stripping is
   1.122 +# only done if one of the specified strings matches the left-hand part of
   1.123 +# the path. It is allowed to use relative paths in the argument list.
   1.124 +
   1.125 +STRIP_FROM_PATH        =
   1.126 +
   1.127 +# The INTERNAL_DOCS tag determines if documentation
   1.128 +# that is typed after a \internal command is included. If the tag is set
   1.129 +# to NO (the default) then the documentation will be excluded.
   1.130 +# Set it to YES to include the internal documentation.
   1.131 +
   1.132 +INTERNAL_DOCS          = NO
   1.133 +
   1.134 +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
   1.135 +# doxygen to hide any special comment blocks from generated source code
   1.136 +# fragments. Normal C and C++ comments will always remain visible.
   1.137 +
   1.138 +STRIP_CODE_COMMENTS    = YES
   1.139 +
   1.140 +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
   1.141 +# file names in lower case letters. If set to YES upper case letters are also
   1.142 +# allowed. This is useful if you have classes or files whose names only differ
   1.143 +# in case and if your file system supports case sensitive file names. Windows
   1.144 +# users are adviced to set this option to NO.
   1.145 +
   1.146 +CASE_SENSE_NAMES       = YES
   1.147 +
   1.148 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
   1.149 +# (but less readable) file names. This can be useful is your file systems
   1.150 +# doesn't support long names like on DOS, Mac, or CD-ROM.
   1.151 +
   1.152 +SHORT_NAMES            = NO
   1.153 +
   1.154 +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
   1.155 +# will show members with their full class and namespace scopes in the
   1.156 +# documentation. If set to YES the scope will be hidden.
   1.157 +
   1.158 +HIDE_SCOPE_NAMES       = NO
   1.159 +
   1.160 +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
   1.161 +# will generate a verbatim copy of the header file for each class for
   1.162 +# which an include is specified. Set to NO to disable this.
   1.163 +
   1.164 +VERBATIM_HEADERS       = YES
   1.165 +
   1.166 +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
   1.167 +# will put list of the files that are included by a file in the documentation
   1.168 +# of that file.
   1.169 +
   1.170 +SHOW_INCLUDE_FILES     = YES
   1.171 +
   1.172 +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
   1.173 +# will interpret the first line (until the first dot) of a JavaDoc-style
   1.174 +# comment as the brief description. If set to NO, the JavaDoc
   1.175 +# comments  will behave just like the Qt-style comments (thus requiring an
   1.176 +# explict @brief command for a brief description.
   1.177 +
   1.178 +JAVADOC_AUTOBRIEF      = NO
   1.179 +
   1.180 +# If the DETAILS_AT_TOP tag is set to YES then Doxygen
   1.181 +# will output the detailed description near the top, like JavaDoc.
   1.182 +# If set to NO, the detailed description appears after the member
   1.183 +# documentation.
   1.184 +
   1.185 +DETAILS_AT_TOP         = NO
   1.186 +
   1.187 +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
   1.188 +# member inherits the documentation from any documented member that it
   1.189 +# reimplements.
   1.190 +
   1.191 +INHERIT_DOCS           = YES
   1.192 +
   1.193 +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
   1.194 +# is inserted in the documentation for inline members.
   1.195 +
   1.196 +INLINE_INFO            = YES
   1.197 +
   1.198 +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
   1.199 +# will sort the (detailed) documentation of file and class members
   1.200 +# alphabetically by member name. If set to NO the members will appear in
   1.201 +# declaration order.
   1.202 +
   1.203 +SORT_MEMBER_DOCS       = YES
   1.204 +
   1.205 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
   1.206 +# tag is set to YES, then doxygen will reuse the documentation of the first
   1.207 +# member in the group (if any) for the other members of the group. By default
   1.208 +# all members of a group must be documented explicitly.
   1.209 +
   1.210 +DISTRIBUTE_GROUP_DOC   = NO
   1.211 +
   1.212 +# The TAB_SIZE tag can be used to set the number of spaces in a tab.
   1.213 +# Doxygen uses this value to replace tabs by spaces in code fragments.
   1.214 +
   1.215 +TAB_SIZE               = 4
   1.216 +
   1.217 +# The GENERATE_TODOLIST tag can be used to enable (YES) or
   1.218 +# disable (NO) the todo list. This list is created by putting \todo
   1.219 +# commands in the documentation.
   1.220 +
   1.221 +GENERATE_TODOLIST      = YES
   1.222 +
   1.223 +# The GENERATE_TESTLIST tag can be used to enable (YES) or
   1.224 +# disable (NO) the test list. This list is created by putting \test
   1.225 +# commands in the documentation.
   1.226 +
   1.227 +GENERATE_TESTLIST      = YES
   1.228 +
   1.229 +# The GENERATE_BUGLIST tag can be used to enable (YES) or
   1.230 +# disable (NO) the bug list. This list is created by putting \bug
   1.231 +# commands in the documentation.
   1.232 +
   1.233 +GENERATE_BUGLIST       = YES
   1.234 +
   1.235 +# This tag can be used to specify a number of aliases that acts
   1.236 +# as commands in the documentation. An alias has the form "name=value".
   1.237 +# For example adding "sideeffect=\par Side Effects:\n" will allow you to
   1.238 +# put the command \sideeffect (or @sideeffect) in the documentation, which
   1.239 +# will result in a user defined paragraph with heading "Side Effects:".
   1.240 +# You can put \n's in the value part of an alias to insert newlines.
   1.241 +
   1.242 +ALIASES                =
   1.243 +
   1.244 +# The ENABLED_SECTIONS tag can be used to enable conditional
   1.245 +# documentation sections, marked by \if sectionname ... \endif.
   1.246 +
   1.247 +ENABLED_SECTIONS       =
   1.248 +
   1.249 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
   1.250 +# the initial value of a variable or define consist of for it to appear in
   1.251 +# the documentation. If the initializer consists of more lines than specified
   1.252 +# here it will be hidden. Use a value of 0 to hide initializers completely.
   1.253 +# The appearance of the initializer of individual variables and defines in the
   1.254 +# documentation can be controlled using \showinitializer or \hideinitializer
   1.255 +# command in the documentation regardless of this setting.
   1.256 +
   1.257 +MAX_INITIALIZER_LINES  = 30
   1.258 +
   1.259 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
   1.260 +# only. Doxygen will then generate output that is more tailored for C.
   1.261 +# For instance some of the names that are used will be different. The list
   1.262 +# of all members will be omitted, etc.
   1.263 +
   1.264 +OPTIMIZE_OUTPUT_FOR_C  = YES
   1.265 +
   1.266 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
   1.267 +# only. Doxygen will then generate output that is more tailored for Java.
   1.268 +# For instance namespaces will be presented as packages, qualified scopes
   1.269 +# will look different, etc.
   1.270 +
   1.271 +OPTIMIZE_OUTPUT_JAVA   = NO
   1.272 +
   1.273 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
   1.274 +# at the bottom of the documentation of classes and structs. If set to YES the
   1.275 +# list will mention the files that were used to generate the documentation.
   1.276 +
   1.277 +SHOW_USED_FILES        = YES
   1.278 +
   1.279 +#---------------------------------------------------------------------------
   1.280 +# configuration options related to warning and progress messages
   1.281 +#---------------------------------------------------------------------------
   1.282 +
   1.283 +# The QUIET tag can be used to turn on/off the messages that are generated
   1.284 +# by doxygen. Possible values are YES and NO. If left blank NO is used.
   1.285 +
   1.286 +QUIET                  = NO
   1.287 +
   1.288 +# The WARNINGS tag can be used to turn on/off the warning messages that are
   1.289 +# generated by doxygen. Possible values are YES and NO. If left blank
   1.290 +# NO is used.
   1.291 +
   1.292 +WARNINGS               = YES
   1.293 +
   1.294 +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
   1.295 +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
   1.296 +# automatically be disabled.
   1.297 +
   1.298 +WARN_IF_UNDOCUMENTED   = YES
   1.299 +
   1.300 +# The WARN_FORMAT tag determines the format of the warning messages that
   1.301 +# doxygen can produce. The string should contain the $file, $line, and $text
   1.302 +# tags, which will be replaced by the file and line number from which the
   1.303 +# warning originated and the warning text.
   1.304 +
   1.305 +WARN_FORMAT            = "$file:$line: $text"
   1.306 +
   1.307 +# The WARN_LOGFILE tag can be used to specify a file to which warning
   1.308 +# and error messages should be written. If left blank the output is written
   1.309 +# to stderr.
   1.310 +
   1.311 +WARN_LOGFILE           =
   1.312 +
   1.313 +#---------------------------------------------------------------------------
   1.314 +# configuration options related to the input files
   1.315 +#---------------------------------------------------------------------------
   1.316 +
   1.317 +# The INPUT tag can be used to specify the files and/or directories that contain
   1.318 +# documented source files. You may enter file names like "myfile.cpp" or
   1.319 +# directories like "/usr/src/myproject". Separate the files or directories
   1.320 +# with spaces.
   1.321 +
   1.322 +INPUT                  = include
   1.323 +
   1.324 +# If the value of the INPUT tag contains directories, you can use the
   1.325 +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
   1.326 +# and *.h) to filter out the source-files in the directories. If left
   1.327 +# blank the following patterns are tested:
   1.328 +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
   1.329 +# *.h++ *.idl *.odl
   1.330 +
   1.331 +FILE_PATTERNS          = *.h
   1.332 +
   1.333 +# The RECURSIVE tag can be used to turn specify whether or not subdirectories
   1.334 +# should be searched for input files as well. Possible values are YES and NO.
   1.335 +# If left blank NO is used.
   1.336 +
   1.337 +RECURSIVE              = NO
   1.338 +
   1.339 +# The EXCLUDE tag can be used to specify files and/or directories that should
   1.340 +# excluded from the INPUT source files. This way you can easily exclude a
   1.341 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
   1.342 +
   1.343 +EXCLUDE                =
   1.344 +
   1.345 +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
   1.346 +# that are symbolic links (a Unix filesystem feature) are excluded from the input.
   1.347 +
   1.348 +EXCLUDE_SYMLINKS       = NO
   1.349 +
   1.350 +# If the value of the INPUT tag contains directories, you can use the
   1.351 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
   1.352 +# certain files from those directories.
   1.353 +
   1.354 +EXCLUDE_PATTERNS       =
   1.355 +
   1.356 +# The EXAMPLE_PATH tag can be used to specify one or more files or
   1.357 +# directories that contain example code fragments that are included (see
   1.358 +# the \include command).
   1.359 +
   1.360 +EXAMPLE_PATH           =
   1.361 +
   1.362 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
   1.363 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
   1.364 +# and *.h) to filter out the source-files in the directories. If left
   1.365 +# blank all files are included.
   1.366 +
   1.367 +EXAMPLE_PATTERNS       =
   1.368 +
   1.369 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
   1.370 +# searched for input files to be used with the \include or \dontinclude
   1.371 +# commands irrespective of the value of the RECURSIVE tag.
   1.372 +# Possible values are YES and NO. If left blank NO is used.
   1.373 +
   1.374 +EXAMPLE_RECURSIVE      = NO
   1.375 +
   1.376 +# The IMAGE_PATH tag can be used to specify one or more files or
   1.377 +# directories that contain image that are included in the documentation (see
   1.378 +# the \image command).
   1.379 +
   1.380 +IMAGE_PATH             =
   1.381 +
   1.382 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
   1.383 +# invoke to filter for each input file. Doxygen will invoke the filter program
   1.384 +# by executing (via popen()) the command <filter> <input-file>, where <filter>
   1.385 +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
   1.386 +# input file. Doxygen will then use the output that the filter program writes
   1.387 +# to standard output.
   1.388 +
   1.389 +INPUT_FILTER           =
   1.390 +
   1.391 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
   1.392 +# INPUT_FILTER) will be used to filter the input files when producing source
   1.393 +# files to browse.
   1.394 +
   1.395 +FILTER_SOURCE_FILES    = NO
   1.396 +
   1.397 +#---------------------------------------------------------------------------
   1.398 +# configuration options related to source browsing
   1.399 +#---------------------------------------------------------------------------
   1.400 +
   1.401 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will
   1.402 +# be generated. Documented entities will be cross-referenced with these sources.
   1.403 +
   1.404 +SOURCE_BROWSER         = NO
   1.405 +
   1.406 +# Setting the INLINE_SOURCES tag to YES will include the body
   1.407 +# of functions and classes directly in the documentation.
   1.408 +
   1.409 +INLINE_SOURCES         = NO
   1.410 +
   1.411 +# If the REFERENCED_BY_RELATION tag is set to YES (the default)
   1.412 +# then for each documented function all documented
   1.413 +# functions referencing it will be listed.
   1.414 +
   1.415 +REFERENCED_BY_RELATION = YES
   1.416 +
   1.417 +# If the REFERENCES_RELATION tag is set to YES (the default)
   1.418 +# then for each documented function all documented entities
   1.419 +# called/used by that function will be listed.
   1.420 +
   1.421 +REFERENCES_RELATION    = YES
   1.422 +
   1.423 +#---------------------------------------------------------------------------
   1.424 +# configuration options related to the alphabetical class index
   1.425 +#---------------------------------------------------------------------------
   1.426 +
   1.427 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
   1.428 +# of all compounds will be generated. Enable this if the project
   1.429 +# contains a lot of classes, structs, unions or interfaces.
   1.430 +
   1.431 +ALPHABETICAL_INDEX     = NO
   1.432 +
   1.433 +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
   1.434 +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
   1.435 +# in which this list will be split (can be a number in the range [1..20])
   1.436 +
   1.437 +COLS_IN_ALPHA_INDEX    = 5
   1.438 +
   1.439 +# In case all classes in a project start with a common prefix, all
   1.440 +# classes will be put under the same header in the alphabetical index.
   1.441 +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
   1.442 +# should be ignored while generating the index headers.
   1.443 +
   1.444 +IGNORE_PREFIX          =
   1.445 +
   1.446 +#---------------------------------------------------------------------------
   1.447 +# configuration options related to the HTML output
   1.448 +#---------------------------------------------------------------------------
   1.449 +
   1.450 +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
   1.451 +# generate HTML output.
   1.452 +
   1.453 +GENERATE_HTML          = YES
   1.454 +
   1.455 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
   1.456 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
   1.457 +# put in front of it. If left blank `html' will be used as the default path.
   1.458 +
   1.459 +HTML_OUTPUT            = html
   1.460 +
   1.461 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
   1.462 +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
   1.463 +# doxygen will generate files with .html extension.
   1.464 +
   1.465 +HTML_FILE_EXTENSION    = .html
   1.466 +
   1.467 +# The HTML_HEADER tag can be used to specify a personal HTML header for
   1.468 +# each generated HTML page. If it is left blank doxygen will generate a
   1.469 +# standard header.
   1.470 +
   1.471 +HTML_HEADER            =
   1.472 +
   1.473 +# The HTML_FOOTER tag can be used to specify a personal HTML footer for
   1.474 +# each generated HTML page. If it is left blank doxygen will generate a
   1.475 +# standard footer.
   1.476 +
   1.477 +HTML_FOOTER            =
   1.478 +
   1.479 +# The HTML_STYLESHEET tag can be used to specify a user defined cascading
   1.480 +# style sheet that is used by each HTML page. It can be used to
   1.481 +# fine-tune the look of the HTML output. If the tag is left blank doxygen
   1.482 +# will generate a default style sheet
   1.483 +
   1.484 +HTML_STYLESHEET        =
   1.485 +
   1.486 +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
   1.487 +# files or namespaces will be aligned in HTML using tables. If set to
   1.488 +# NO a bullet list will be used.
   1.489 +
   1.490 +HTML_ALIGN_MEMBERS     = YES
   1.491 +
   1.492 +# If the GENERATE_HTMLHELP tag is set to YES, additional index files
   1.493 +# will be generated that can be used as input for tools like the
   1.494 +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
   1.495 +# of the generated HTML documentation.
   1.496 +
   1.497 +GENERATE_HTMLHELP      = NO
   1.498 +
   1.499 +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
   1.500 +# controls if a separate .chi index file is generated (YES) or that
   1.501 +# it should be included in the master .chm file (NO).
   1.502 +
   1.503 +GENERATE_CHI           = NO
   1.504 +
   1.505 +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
   1.506 +# controls whether a binary table of contents is generated (YES) or a
   1.507 +# normal table of contents (NO) in the .chm file.
   1.508 +
   1.509 +BINARY_TOC             = NO
   1.510 +
   1.511 +# The TOC_EXPAND flag can be set to YES to add extra items for group members
   1.512 +# to the contents of the Html help documentation and to the tree view.
   1.513 +
   1.514 +TOC_EXPAND             = NO
   1.515 +
   1.516 +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
   1.517 +# top of each HTML page. The value NO (the default) enables the index and
   1.518 +# the value YES disables it.
   1.519 +
   1.520 +DISABLE_INDEX          = NO
   1.521 +
   1.522 +# This tag can be used to set the number of enum values (range [1..20])
   1.523 +# that doxygen will group on one line in the generated HTML documentation.
   1.524 +
   1.525 +ENUM_VALUES_PER_LINE   = 4
   1.526 +
   1.527 +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
   1.528 +# generated containing a tree-like index structure (just like the one that
   1.529 +# is generated for HTML Help). For this to work a browser that supports
   1.530 +# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
   1.531 +# or Internet explorer 4.0+). Note that for large projects the tree generation
   1.532 +# can take a very long time. In such cases it is better to disable this feature.
   1.533 +# Windows users are probably better off using the HTML help feature.
   1.534 +
   1.535 +GENERATE_TREEVIEW      = NO
   1.536 +
   1.537 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
   1.538 +# used to set the initial width (in pixels) of the frame in which the tree
   1.539 +# is shown.
   1.540 +
   1.541 +TREEVIEW_WIDTH         = 250
   1.542 +
   1.543 +#---------------------------------------------------------------------------
   1.544 +# configuration options related to the LaTeX output
   1.545 +#---------------------------------------------------------------------------
   1.546 +
   1.547 +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
   1.548 +# generate Latex output.
   1.549 +
   1.550 +GENERATE_LATEX         = NO
   1.551 +
   1.552 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
   1.553 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
   1.554 +# put in front of it. If left blank `latex' will be used as the default path.
   1.555 +
   1.556 +LATEX_OUTPUT           = latex
   1.557 +
   1.558 +# 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.
   1.559 +
   1.560 +LATEX_CMD_NAME         = latex
   1.561 +
   1.562 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
   1.563 +# generate index for LaTeX. If left blank `makeindex' will be used as the
   1.564 +# default command name.
   1.565 +
   1.566 +MAKEINDEX_CMD_NAME     = makeindex
   1.567 +
   1.568 +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
   1.569 +# LaTeX documents. This may be useful for small projects and may help to
   1.570 +# save some trees in general.
   1.571 +
   1.572 +COMPACT_LATEX          = NO
   1.573 +
   1.574 +# The PAPER_TYPE tag can be used to set the paper type that is used
   1.575 +# by the printer. Possible values are: a4, a4wide, letter, legal and
   1.576 +# executive. If left blank a4wide will be used.
   1.577 +
   1.578 +PAPER_TYPE             = a4wide
   1.579 +
   1.580 +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
   1.581 +# packages that should be included in the LaTeX output.
   1.582 +
   1.583 +EXTRA_PACKAGES         =
   1.584 +
   1.585 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
   1.586 +# the generated latex document. The header should contain everything until
   1.587 +# the first chapter. If it is left blank doxygen will generate a
   1.588 +# standard header. Notice: only use this tag if you know what you are doing!
   1.589 +
   1.590 +LATEX_HEADER           =
   1.591 +
   1.592 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
   1.593 +# is prepared for conversion to pdf (using ps2pdf). The pdf file will
   1.594 +# contain links (just like the HTML output) instead of page references
   1.595 +# This makes the output suitable for online browsing using a pdf viewer.
   1.596 +
   1.597 +PDF_HYPERLINKS         = NO
   1.598 +
   1.599 +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
   1.600 +# plain latex in the generated Makefile. Set this option to YES to get a
   1.601 +# higher quality PDF documentation.
   1.602 +
   1.603 +USE_PDFLATEX           = NO
   1.604 +
   1.605 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
   1.606 +# command to the generated LaTeX files. This will instruct LaTeX to keep
   1.607 +# running if errors occur, instead of asking the user for help.
   1.608 +# This option is also used when generating formulas in HTML.
   1.609 +
   1.610 +LATEX_BATCHMODE        = NO
   1.611 +
   1.612 +#---------------------------------------------------------------------------
   1.613 +# configuration options related to the RTF output
   1.614 +#---------------------------------------------------------------------------
   1.615 +
   1.616 +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
   1.617 +# The RTF output is optimised for Word 97 and may not look very pretty with
   1.618 +# other RTF readers or editors.
   1.619 +
   1.620 +GENERATE_RTF           = YES
   1.621 +
   1.622 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
   1.623 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
   1.624 +# put in front of it. If left blank `rtf' will be used as the default path.
   1.625 +
   1.626 +RTF_OUTPUT             = rtf
   1.627 +
   1.628 +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
   1.629 +# RTF documents. This may be useful for small projects and may help to
   1.630 +# save some trees in general.
   1.631 +
   1.632 +COMPACT_RTF            = NO
   1.633 +
   1.634 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
   1.635 +# will contain hyperlink fields. The RTF file will
   1.636 +# contain links (just like the HTML output) instead of page references.
   1.637 +# This makes the output suitable for online browsing using WORD or other
   1.638 +# programs which support those fields.
   1.639 +# Note: wordpad (write) and others do not support links.
   1.640 +
   1.641 +RTF_HYPERLINKS         = NO
   1.642 +
   1.643 +# Load stylesheet definitions from file. Syntax is similar to doxygen's
   1.644 +# config file, i.e. a series of assigments. You only have to provide
   1.645 +# replacements, missing definitions are set to their default value.
   1.646 +
   1.647 +RTF_STYLESHEET_FILE    =
   1.648 +
   1.649 +# Set optional variables used in the generation of an rtf document.
   1.650 +# Syntax is similar to doxygen's config file.
   1.651 +
   1.652 +RTF_EXTENSIONS_FILE    =
   1.653 +
   1.654 +#---------------------------------------------------------------------------
   1.655 +# configuration options related to the man page output
   1.656 +#---------------------------------------------------------------------------
   1.657 +
   1.658 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
   1.659 +# generate man pages
   1.660 +
   1.661 +GENERATE_MAN           = YES
   1.662 +
   1.663 +# The MAN_OUTPUT tag is used to specify where the man pages will be put.
   1.664 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
   1.665 +# put in front of it. If left blank `man' will be used as the default path.
   1.666 +
   1.667 +MAN_OUTPUT             = man
   1.668 +
   1.669 +# The MAN_EXTENSION tag determines the extension that is added to
   1.670 +# the generated man pages (default is the subroutine's section .3)
   1.671 +
   1.672 +MAN_EXTENSION          = .3
   1.673 +
   1.674 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
   1.675 +# then it will generate one additional man file for each entity
   1.676 +# documented in the real man page(s). These additional files
   1.677 +# only source the real man page, but without them the man command
   1.678 +# would be unable to find the correct page. The default is NO.
   1.679 +
   1.680 +MAN_LINKS              = YES
   1.681 +
   1.682 +#---------------------------------------------------------------------------
   1.683 +# configuration options related to the XML output
   1.684 +#---------------------------------------------------------------------------
   1.685 +
   1.686 +# If the GENERATE_XML tag is set to YES Doxygen will
   1.687 +# generate an XML file that captures the structure of
   1.688 +# the code including all documentation. Note that this
   1.689 +# feature is still experimental and incomplete at the
   1.690 +# moment.
   1.691 +
   1.692 +GENERATE_XML           = NO
   1.693 +
   1.694 +#---------------------------------------------------------------------------
   1.695 +# configuration options for the AutoGen Definitions output
   1.696 +#---------------------------------------------------------------------------
   1.697 +
   1.698 +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
   1.699 +# generate an AutoGen Definitions (see autogen.sf.net) file
   1.700 +# that captures the structure of the code including all
   1.701 +# documentation. Note that this feature is still experimental
   1.702 +# and incomplete at the moment.
   1.703 +
   1.704 +GENERATE_AUTOGEN_DEF   = NO
   1.705 +
   1.706 +#---------------------------------------------------------------------------
   1.707 +# Configuration options related to the preprocessor
   1.708 +#---------------------------------------------------------------------------
   1.709 +
   1.710 +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
   1.711 +# evaluate all C-preprocessor directives found in the sources and include
   1.712 +# files.
   1.713 +
   1.714 +ENABLE_PREPROCESSING   = YES
   1.715 +
   1.716 +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
   1.717 +# names in the source code. If set to NO (the default) only conditional
   1.718 +# compilation will be performed. Macro expansion can be done in a controlled
   1.719 +# way by setting EXPAND_ONLY_PREDEF to YES.
   1.720 +
   1.721 +MACRO_EXPANSION        = YES
   1.722 +
   1.723 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
   1.724 +# then the macro expansion is limited to the macros specified with the
   1.725 +# PREDEFINED and EXPAND_AS_PREDEFINED tags.
   1.726 +
   1.727 +EXPAND_ONLY_PREDEF     = YES
   1.728 +
   1.729 +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
   1.730 +# in the INCLUDE_PATH (see below) will be search if a #include is found.
   1.731 +
   1.732 +SEARCH_INCLUDES        = YES
   1.733 +
   1.734 +# The INCLUDE_PATH tag can be used to specify one or more directories that
   1.735 +# contain include files that are not input files but should be processed by
   1.736 +# the preprocessor.
   1.737 +
   1.738 +INCLUDE_PATH           =
   1.739 +
   1.740 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
   1.741 +# patterns (like *.h and *.hpp) to filter out the header-files in the
   1.742 +# directories. If left blank, the patterns specified with FILE_PATTERNS will
   1.743 +# be used.
   1.744 +
   1.745 +INCLUDE_FILE_PATTERNS  =
   1.746 +
   1.747 +# The PREDEFINED tag can be used to specify one or more macro names that
   1.748 +# are defined before the preprocessor is started (similar to the -D option of
   1.749 +# gcc). The argument of the tag is a list of macros of the form: name
   1.750 +# or name=definition (no spaces). If the definition and the = are
   1.751 +# omitted =1 is assumed.
   1.752 +
   1.753 +PREDEFINED             = DOXYGEN_SHOULD_IGNORE_THIS=1 SDLCALL= SNDDECLSPEC=
   1.754 +
   1.755 +# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
   1.756 +# this tag can be used to specify a list of macro names that should be expanded.
   1.757 +# The macro definition that is found in the sources will be used.
   1.758 +# Use the PREDEFINED tag if you want to use a different macro definition.
   1.759 +
   1.760 +EXPAND_AS_DEFINED      =
   1.761 +
   1.762 +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
   1.763 +# doxygen's preprocessor will remove all function-like macros that are alone
   1.764 +# on a line and do not end with a semicolon. Such function macros are typically
   1.765 +# used for boiler-plate code, and will confuse the parser if not removed.
   1.766 +
   1.767 +SKIP_FUNCTION_MACROS   = YES
   1.768 +
   1.769 +#---------------------------------------------------------------------------
   1.770 +# Configuration::addtions related to external references
   1.771 +#---------------------------------------------------------------------------
   1.772 +
   1.773 +# The TAGFILES tag can be used to specify one or more tagfiles.
   1.774 +
   1.775 +TAGFILES               =
   1.776 +
   1.777 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create
   1.778 +# a tag file that is based on the input files it reads.
   1.779 +
   1.780 +GENERATE_TAGFILE       =
   1.781 +
   1.782 +# If the ALLEXTERNALS tag is set to YES all external classes will be listed
   1.783 +# in the class index. If set to NO only the inherited external classes
   1.784 +# will be listed.
   1.785 +
   1.786 +ALLEXTERNALS           = NO
   1.787 +
   1.788 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
   1.789 +# in the modules index. If set to NO, only the current project's groups will
   1.790 +# be listed.
   1.791 +
   1.792 +EXTERNAL_GROUPS        = YES
   1.793 +
   1.794 +# The PERL_PATH should be the absolute path and name of the perl script
   1.795 +# interpreter (i.e. the result of `which perl').
   1.796 +
   1.797 +PERL_PATH              = /usr/bin/perl
   1.798 +
   1.799 +#---------------------------------------------------------------------------
   1.800 +# Configuration options related to the dot tool
   1.801 +#---------------------------------------------------------------------------
   1.802 +
   1.803 +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
   1.804 +# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
   1.805 +# super classes. Setting the tag to NO turns the diagrams off. Note that this
   1.806 +# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
   1.807 +# recommended to install and use dot, since it yields more powerful graphs.
   1.808 +
   1.809 +CLASS_DIAGRAMS         = NO
   1.810 +
   1.811 +# If set to YES, the inheritance and collaboration graphs will hide
   1.812 +# inheritance and usage relations if the target is undocumented
   1.813 +# or is not a class.
   1.814 +
   1.815 +HIDE_UNDOC_RELATIONS   = YES
   1.816 +
   1.817 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
   1.818 +# available from the path. This tool is part of Graphviz, a graph visualization
   1.819 +# toolkit from AT&T and Lucent Bell Labs. The other options in this section
   1.820 +# have no effect if this option is set to NO (the default)
   1.821 +
   1.822 +HAVE_DOT               = NO
   1.823 +
   1.824 +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
   1.825 +# will generate a graph for each documented class showing the direct and
   1.826 +# indirect inheritance relations. Setting this tag to YES will force the
   1.827 +# the CLASS_DIAGRAMS tag to NO.
   1.828 +
   1.829 +CLASS_GRAPH            = NO
   1.830 +
   1.831 +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
   1.832 +# will generate a graph for each documented class showing the direct and
   1.833 +# indirect implementation dependencies (inheritance, containment, and
   1.834 +# class references variables) of the class with other documented classes.
   1.835 +
   1.836 +COLLABORATION_GRAPH    = NO
   1.837 +
   1.838 +# If set to YES, the inheritance and collaboration graphs will show the
   1.839 +# relations between templates and their instances.
   1.840 +
   1.841 +TEMPLATE_RELATIONS     = NO
   1.842 +
   1.843 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
   1.844 +# tags are set to YES then doxygen will generate a graph for each documented
   1.845 +# file showing the direct and indirect include dependencies of the file with
   1.846 +# other documented files.
   1.847 +
   1.848 +INCLUDE_GRAPH          = NO
   1.849 +
   1.850 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
   1.851 +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
   1.852 +# documented header file showing the documented files that directly or
   1.853 +# indirectly include this file.
   1.854 +
   1.855 +INCLUDED_BY_GRAPH      = YES
   1.856 +
   1.857 +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
   1.858 +# will graphical hierarchy of all classes instead of a textual one.
   1.859 +
   1.860 +GRAPHICAL_HIERARCHY    = YES
   1.861 +
   1.862 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
   1.863 +# generated by dot. Possible values are png, jpg, or gif
   1.864 +# If left blank png will be used.
   1.865 +
   1.866 +DOT_IMAGE_FORMAT       = png
   1.867 +
   1.868 +# The tag DOT_PATH can be used to specify the path where the dot tool can be
   1.869 +# found. If left blank, it is assumed the dot tool can be found on the path.
   1.870 +
   1.871 +DOT_PATH               =
   1.872 +
   1.873 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
   1.874 +# contain dot files that are included in the documentation (see the
   1.875 +# \dotfile command).
   1.876 +
   1.877 +DOTFILE_DIRS           =
   1.878 +
   1.879 +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
   1.880 +# (in pixels) of the graphs generated by dot. If a graph becomes larger than
   1.881 +# this value, doxygen will try to truncate the graph, so that it fits within
   1.882 +# the specified constraint. Beware that most browsers cannot cope with very
   1.883 +# large images.
   1.884 +
   1.885 +MAX_DOT_GRAPH_WIDTH    = 1024
   1.886 +
   1.887 +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
   1.888 +# (in pixels) of the graphs generated by dot. If a graph becomes larger than
   1.889 +# this value, doxygen will try to truncate the graph, so that it fits within
   1.890 +# the specified constraint. Beware that most browsers cannot cope with very
   1.891 +# large images.
   1.892 +
   1.893 +MAX_DOT_GRAPH_HEIGHT   = 1024
   1.894 +
   1.895 +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
   1.896 +# generate a legend page explaining the meaning of the various boxes and
   1.897 +# arrows in the dot generated graphs.
   1.898 +
   1.899 +GENERATE_LEGEND        = YES
   1.900 +
   1.901 +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
   1.902 +# remove the intermedate dot files that are used to generate
   1.903 +# the various graphs.
   1.904 +
   1.905 +DOT_CLEANUP            = YES
   1.906 +
   1.907 +#---------------------------------------------------------------------------
   1.908 +# Configuration::addtions related to the search engine
   1.909 +#---------------------------------------------------------------------------
   1.910 +
   1.911 +# The SEARCHENGINE tag specifies whether or not a search engine should be
   1.912 +# used. If set to NO the values of all tags below this one will be ignored.
   1.913 +
   1.914 +SEARCHENGINE           = NO
   1.915 +
   1.916 +# The CGI_NAME tag should be the name of the CGI script that
   1.917 +# starts the search engine (doxysearch) with the correct parameters.
   1.918 +# A script with this name will be generated by doxygen.
   1.919 +
   1.920 +CGI_NAME               = search.cgi
   1.921 +
   1.922 +# The CGI_URL tag should be the absolute URL to the directory where the
   1.923 +# cgi binaries are located. See the documentation of your http daemon for
   1.924 +# details.
   1.925 +
   1.926 +CGI_URL                =
   1.927 +
   1.928 +# The DOC_URL tag should be the absolute URL to the directory where the
   1.929 +# documentation is located. If left blank the absolute path to the
   1.930 +# documentation, with file:// prepended to it, will be used.
   1.931 +
   1.932 +DOC_URL                =
   1.933 +
   1.934 +# The DOC_ABSPATH tag should be the absolute path to the directory where the
   1.935 +# documentation is located. If left blank the directory on the local machine
   1.936 +# will be used.
   1.937 +
   1.938 +DOC_ABSPATH            =
   1.939 +
   1.940 +# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
   1.941 +# is installed.
   1.942 +
   1.943 +BIN_ABSPATH            = /usr/local/bin/
   1.944 +
   1.945 +# The EXT_DOC_PATHS tag can be used to specify one or more paths to
   1.946 +# documentation generated for other projects. This allows doxysearch to search
   1.947 +# the documentation for these projects as well.
   1.948 +
   1.949 +EXT_DOC_PATHS          =