1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/Doxyfile Wed Jul 17 11:47:02 2013 +0200
1.3 @@ -0,0 +1,1791 @@
1.4 +# Doxyfile 1.8.1.2
1.5 +#
1.6 +# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.7 +#
1.8 +# Copyright 2013 Olaf Wintermann. All rights reserved.
1.9 +#
1.10 +# Redistribution and use in source and binary forms, with or without
1.11 +# modification, are permitted provided that the following conditions are met:
1.12 +#
1.13 +# 1. Redistributions of source code must retain the above copyright
1.14 +# notice, this list of conditions and the following disclaimer.
1.15 +#
1.16 +# 2. Redistributions in binary form must reproduce the above copyright
1.17 +# notice, this list of conditions and the following disclaimer in the
1.18 +# documentation and/or other materials provided with the distribution.
1.19 +#
1.20 +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.21 +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.22 +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.23 +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1.24 +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1.25 +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1.26 +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1.27 +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.28 +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.29 +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1.30 +# POSSIBILITY OF SUCH DAMAGE.
1.31 +#
1.32 +# This file describes the settings to be used by the documentation system
1.33 +# doxygen (www.doxygen.org) for a project.
1.34 +#
1.35 +# All text after a hash (#) is considered a comment and will be ignored.
1.36 +# The format is:
1.37 +# TAG = value [value, ...]
1.38 +# For lists items can also be appended using:
1.39 +# TAG += value [value, ...]
1.40 +# Values that contain spaces should be placed between quotes (" ").
1.41 +
1.42 +#---------------------------------------------------------------------------
1.43 +# Project related configuration options
1.44 +#---------------------------------------------------------------------------
1.45 +
1.46 +# This tag specifies the encoding used for all characters in the config file
1.47 +# that follow. The default is UTF-8 which is also the encoding used for all
1.48 +# text before the first occurrence of this tag. Doxygen uses libiconv (or the
1.49 +# iconv built into libc) for the transcoding. See
1.50 +# http://www.gnu.org/software/libiconv for the list of possible encodings.
1.51 +
1.52 +DOXYFILE_ENCODING = UTF-8
1.53 +
1.54 +# The PROJECT_NAME tag is a single word (or sequence of words) that should
1.55 +# identify the project. Note that if you do not use Doxywizard you need
1.56 +# to put quotes around the project name if it contains spaces.
1.57 +
1.58 +PROJECT_NAME = "ucx"
1.59 +
1.60 +# The PROJECT_NUMBER tag can be used to enter a project or revision number.
1.61 +# This could be handy for archiving the generated documentation or
1.62 +# if some version control system is used.
1.63 +
1.64 +PROJECT_NUMBER =
1.65 +
1.66 +# Using the PROJECT_BRIEF tag one can provide an optional one line description
1.67 +# for a project that appears at the top of each page and should give viewer
1.68 +# a quick idea about the purpose of the project. Keep the description short.
1.69 +
1.70 +PROJECT_BRIEF = "UAP Common Extensions"
1.71 +
1.72 +# With the PROJECT_LOGO tag one can specify an logo or icon that is
1.73 +# included in the documentation. The maximum height of the logo should not
1.74 +# exceed 55 pixels and the maximum width should not exceed 200 pixels.
1.75 +# Doxygen will copy the logo to the output directory.
1.76 +
1.77 +PROJECT_LOGO = ./uaplogo.png
1.78 +
1.79 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
1.80 +# base path where the generated documentation will be put.
1.81 +# If a relative path is entered, it will be relative to the location
1.82 +# where doxygen was started. If left blank the current directory will be used.
1.83 +
1.84 +OUTPUT_DIRECTORY = doc
1.85 +
1.86 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
1.87 +# 4096 sub-directories (in 2 levels) under the output directory of each output
1.88 +# format and will distribute the generated files over these directories.
1.89 +# Enabling this option can be useful when feeding doxygen a huge amount of
1.90 +# source files, where putting all generated files in the same directory would
1.91 +# otherwise cause performance problems for the file system.
1.92 +
1.93 +CREATE_SUBDIRS = NO
1.94 +
1.95 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
1.96 +# documentation generated by doxygen is written. Doxygen will use this
1.97 +# information to generate all constant output in the proper language.
1.98 +# The default language is English, other supported languages are:
1.99 +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
1.100 +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
1.101 +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
1.102 +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
1.103 +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
1.104 +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
1.105 +
1.106 +OUTPUT_LANGUAGE = English
1.107 +
1.108 +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
1.109 +# include brief member descriptions after the members that are listed in
1.110 +# the file and class documentation (similar to JavaDoc).
1.111 +# Set to NO to disable this.
1.112 +
1.113 +BRIEF_MEMBER_DESC = YES
1.114 +
1.115 +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
1.116 +# the brief description of a member or function before the detailed description.
1.117 +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
1.118 +# brief descriptions will be completely suppressed.
1.119 +
1.120 +REPEAT_BRIEF = YES
1.121 +
1.122 +# This tag implements a quasi-intelligent brief description abbreviator
1.123 +# that is used to form the text in various listings. Each string
1.124 +# in this list, if found as the leading text of the brief description, will be
1.125 +# stripped from the text and the result after processing the whole list, is
1.126 +# used as the annotated text. Otherwise, the brief description is used as-is.
1.127 +# If left blank, the following values are used ("$name" is automatically
1.128 +# replaced with the name of the entity): "The $name class" "The $name widget"
1.129 +# "The $name file" "is" "provides" "specifies" "contains"
1.130 +# "represents" "a" "an" "the"
1.131 +
1.132 +ABBREVIATE_BRIEF =
1.133 +
1.134 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
1.135 +# Doxygen will generate a detailed section even if there is only a brief
1.136 +# description.
1.137 +
1.138 +ALWAYS_DETAILED_SEC = NO
1.139 +
1.140 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
1.141 +# inherited members of a class in the documentation of that class as if those
1.142 +# members were ordinary class members. Constructors, destructors and assignment
1.143 +# operators of the base classes will not be shown.
1.144 +
1.145 +INLINE_INHERITED_MEMB = NO
1.146 +
1.147 +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
1.148 +# path before files name in the file list and in the header files. If set
1.149 +# to NO the shortest path that makes the file name unique will be used.
1.150 +
1.151 +FULL_PATH_NAMES = YES
1.152 +
1.153 +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
1.154 +# can be used to strip a user-defined part of the path. Stripping is
1.155 +# only done if one of the specified strings matches the left-hand part of
1.156 +# the path. The tag can be used to show relative paths in the file list.
1.157 +# If left blank the directory from which doxygen is run is used as the
1.158 +# path to strip.
1.159 +
1.160 +STRIP_FROM_PATH =
1.161 +
1.162 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
1.163 +# the path mentioned in the documentation of a class, which tells
1.164 +# the reader which header file to include in order to use a class.
1.165 +# If left blank only the name of the header file containing the class
1.166 +# definition is used. Otherwise one should specify the include paths that
1.167 +# are normally passed to the compiler using the -I flag.
1.168 +
1.169 +STRIP_FROM_INC_PATH =
1.170 +
1.171 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
1.172 +# (but less readable) file names. This can be useful if your file system
1.173 +# doesn't support long names like on DOS, Mac, or CD-ROM.
1.174 +
1.175 +SHORT_NAMES = NO
1.176 +
1.177 +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
1.178 +# will interpret the first line (until the first dot) of a JavaDoc-style
1.179 +# comment as the brief description. If set to NO, the JavaDoc
1.180 +# comments will behave just like regular Qt-style comments
1.181 +# (thus requiring an explicit @brief command for a brief description.)
1.182 +
1.183 +JAVADOC_AUTOBRIEF = YES
1.184 +
1.185 +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
1.186 +# interpret the first line (until the first dot) of a Qt-style
1.187 +# comment as the brief description. If set to NO, the comments
1.188 +# will behave just like regular Qt-style comments (thus requiring
1.189 +# an explicit \brief command for a brief description.)
1.190 +
1.191 +QT_AUTOBRIEF = NO
1.192 +
1.193 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
1.194 +# treat a multi-line C++ special comment block (i.e. a block of //! or ///
1.195 +# comments) as a brief description. This used to be the default behaviour.
1.196 +# The new default is to treat a multi-line C++ comment block as a detailed
1.197 +# description. Set this tag to YES if you prefer the old behaviour instead.
1.198 +
1.199 +MULTILINE_CPP_IS_BRIEF = NO
1.200 +
1.201 +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
1.202 +# member inherits the documentation from any documented member that it
1.203 +# re-implements.
1.204 +
1.205 +INHERIT_DOCS = YES
1.206 +
1.207 +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
1.208 +# a new page for each member. If set to NO, the documentation of a member will
1.209 +# be part of the file/class/namespace that contains it.
1.210 +
1.211 +SEPARATE_MEMBER_PAGES = NO
1.212 +
1.213 +# The TAB_SIZE tag can be used to set the number of spaces in a tab.
1.214 +# Doxygen uses this value to replace tabs by spaces in code fragments.
1.215 +
1.216 +TAB_SIZE = 4
1.217 +
1.218 +# This tag can be used to specify a number of aliases that acts
1.219 +# as commands in the documentation. An alias has the form "name=value".
1.220 +# For example adding "sideeffect=\par Side Effects:\n" will allow you to
1.221 +# put the command \sideeffect (or @sideeffect) in the documentation, which
1.222 +# will result in a user-defined paragraph with heading "Side Effects:".
1.223 +# You can put \n's in the value part of an alias to insert newlines.
1.224 +
1.225 +ALIASES =
1.226 +
1.227 +# This tag can be used to specify a number of word-keyword mappings (TCL only).
1.228 +# A mapping has the form "name=value". For example adding
1.229 +# "class=itcl::class" will allow you to use the command class in the
1.230 +# itcl::class meaning.
1.231 +
1.232 +TCL_SUBST =
1.233 +
1.234 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
1.235 +# sources only. Doxygen will then generate output that is more tailored for C.
1.236 +# For instance, some of the names that are used will be different. The list
1.237 +# of all members will be omitted, etc.
1.238 +
1.239 +OPTIMIZE_OUTPUT_FOR_C = YES
1.240 +
1.241 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
1.242 +# sources only. Doxygen will then generate output that is more tailored for
1.243 +# Java. For instance, namespaces will be presented as packages, qualified
1.244 +# scopes will look different, etc.
1.245 +
1.246 +OPTIMIZE_OUTPUT_JAVA = NO
1.247 +
1.248 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
1.249 +# sources only. Doxygen will then generate output that is more tailored for
1.250 +# Fortran.
1.251 +
1.252 +OPTIMIZE_FOR_FORTRAN = NO
1.253 +
1.254 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
1.255 +# sources. Doxygen will then generate output that is tailored for
1.256 +# VHDL.
1.257 +
1.258 +OPTIMIZE_OUTPUT_VHDL = NO
1.259 +
1.260 +# Doxygen selects the parser to use depending on the extension of the files it
1.261 +# parses. With this tag you can assign which parser to use for a given extension.
1.262 +# Doxygen has a built-in mapping, but you can override or extend it using this
1.263 +# tag. The format is ext=language, where ext is a file extension, and language
1.264 +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
1.265 +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
1.266 +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
1.267 +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
1.268 +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
1.269 +
1.270 +EXTENSION_MAPPING =
1.271 +
1.272 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
1.273 +# to include (a tag file for) the STL sources as input, then you should
1.274 +# set this tag to YES in order to let doxygen match functions declarations and
1.275 +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
1.276 +# func(std::string) {}). This also makes the inheritance and collaboration
1.277 +# diagrams that involve STL classes more complete and accurate.
1.278 +
1.279 +BUILTIN_STL_SUPPORT = NO
1.280 +
1.281 +# If you use Microsoft's C++/CLI language, you should set this option to YES to
1.282 +# enable parsing support.
1.283 +
1.284 +CPP_CLI_SUPPORT = NO
1.285 +
1.286 +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
1.287 +# Doxygen will parse them like normal C++ but will assume all classes use public
1.288 +# instead of private inheritance when no explicit protection keyword is present.
1.289 +
1.290 +SIP_SUPPORT = NO
1.291 +
1.292 +# For Microsoft's IDL there are propget and propput attributes to indicate getter
1.293 +# and setter methods for a property. Setting this option to YES (the default)
1.294 +# will make doxygen replace the get and set methods by a property in the
1.295 +# documentation. This will only work if the methods are indeed getting or
1.296 +# setting a simple type. If this is not the case, or you want to show the
1.297 +# methods anyway, you should set this option to NO.
1.298 +
1.299 +IDL_PROPERTY_SUPPORT = YES
1.300 +
1.301 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
1.302 +# tag is set to YES, then doxygen will reuse the documentation of the first
1.303 +# member in the group (if any) for the other members of the group. By default
1.304 +# all members of a group must be documented explicitly.
1.305 +
1.306 +DISTRIBUTE_GROUP_DOC = NO
1.307 +
1.308 +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
1.309 +# the same type (for instance a group of public functions) to be put as a
1.310 +# subgroup of that type (e.g. under the Public Functions section). Set it to
1.311 +# NO to prevent subgrouping. Alternatively, this can be done per class using
1.312 +# the \nosubgrouping command.
1.313 +
1.314 +SUBGROUPING = YES
1.315 +
1.316 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
1.317 +# unions are shown inside the group in which they are included (e.g. using
1.318 +# @ingroup) instead of on a separate page (for HTML and Man pages) or
1.319 +# section (for LaTeX and RTF).
1.320 +
1.321 +INLINE_GROUPED_CLASSES = NO
1.322 +
1.323 +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
1.324 +# unions with only public data fields will be shown inline in the documentation
1.325 +# of the scope in which they are defined (i.e. file, namespace, or group
1.326 +# documentation), provided this scope is documented. If set to NO (the default),
1.327 +# structs, classes, and unions are shown on a separate page (for HTML and Man
1.328 +# pages) or section (for LaTeX and RTF).
1.329 +
1.330 +INLINE_SIMPLE_STRUCTS = NO
1.331 +
1.332 +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
1.333 +# is documented as struct, union, or enum with the name of the typedef. So
1.334 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
1.335 +# with name TypeT. When disabled the typedef will appear as a member of a file,
1.336 +# namespace, or class. And the struct will be named TypeS. This can typically
1.337 +# be useful for C code in case the coding convention dictates that all compound
1.338 +# types are typedef'ed and only the typedef is referenced, never the tag name.
1.339 +
1.340 +TYPEDEF_HIDES_STRUCT = NO
1.341 +
1.342 +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
1.343 +# determine which symbols to keep in memory and which to flush to disk.
1.344 +# When the cache is full, less often used symbols will be written to disk.
1.345 +# For small to medium size projects (<1000 input files) the default value is
1.346 +# probably good enough. For larger projects a too small cache size can cause
1.347 +# doxygen to be busy swapping symbols to and from disk most of the time
1.348 +# causing a significant performance penalty.
1.349 +# If the system has enough physical memory increasing the cache will improve the
1.350 +# performance by keeping more symbols in memory. Note that the value works on
1.351 +# a logarithmic scale so increasing the size by one will roughly double the
1.352 +# memory usage. The cache size is given by this formula:
1.353 +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
1.354 +# corresponding to a cache size of 2^16 = 65536 symbols.
1.355 +
1.356 +SYMBOL_CACHE_SIZE = 0
1.357 +
1.358 +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
1.359 +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
1.360 +# their name and scope. Since this can be an expensive process and often the
1.361 +# same symbol appear multiple times in the code, doxygen keeps a cache of
1.362 +# pre-resolved symbols. If the cache is too small doxygen will become slower.
1.363 +# If the cache is too large, memory is wasted. The cache size is given by this
1.364 +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
1.365 +# corresponding to a cache size of 2^16 = 65536 symbols.
1.366 +
1.367 +LOOKUP_CACHE_SIZE = 0
1.368 +
1.369 +#---------------------------------------------------------------------------
1.370 +# Build related configuration options
1.371 +#---------------------------------------------------------------------------
1.372 +
1.373 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
1.374 +# documentation are documented, even if no documentation was available.
1.375 +# Private class members and static file members will be hidden unless
1.376 +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
1.377 +
1.378 +EXTRACT_ALL = NO
1.379 +
1.380 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
1.381 +# will be included in the documentation.
1.382 +
1.383 +EXTRACT_PRIVATE = NO
1.384 +
1.385 +# If the EXTRACT_STATIC tag is set to YES all static members of a file
1.386 +# will be included in the documentation.
1.387 +
1.388 +EXTRACT_STATIC = NO
1.389 +
1.390 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
1.391 +# defined locally in source files will be included in the documentation.
1.392 +# If set to NO only classes defined in header files are included.
1.393 +
1.394 +EXTRACT_LOCAL_CLASSES = YES
1.395 +
1.396 +# This flag is only useful for Objective-C code. When set to YES local
1.397 +# methods, which are defined in the implementation section but not in
1.398 +# the interface are included in the documentation.
1.399 +# If set to NO (the default) only methods in the interface are included.
1.400 +
1.401 +EXTRACT_LOCAL_METHODS = NO
1.402 +
1.403 +# If this flag is set to YES, the members of anonymous namespaces will be
1.404 +# extracted and appear in the documentation as a namespace called
1.405 +# 'anonymous_namespace{file}', where file will be replaced with the base
1.406 +# name of the file that contains the anonymous namespace. By default
1.407 +# anonymous namespaces are hidden.
1.408 +
1.409 +EXTRACT_ANON_NSPACES = NO
1.410 +
1.411 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
1.412 +# undocumented members of documented classes, files or namespaces.
1.413 +# If set to NO (the default) these members will be included in the
1.414 +# various overviews, but no documentation section is generated.
1.415 +# This option has no effect if EXTRACT_ALL is enabled.
1.416 +
1.417 +HIDE_UNDOC_MEMBERS = NO
1.418 +
1.419 +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
1.420 +# undocumented classes that are normally visible in the class hierarchy.
1.421 +# If set to NO (the default) these classes will be included in the various
1.422 +# overviews. This option has no effect if EXTRACT_ALL is enabled.
1.423 +
1.424 +HIDE_UNDOC_CLASSES = NO
1.425 +
1.426 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
1.427 +# friend (class|struct|union) declarations.
1.428 +# If set to NO (the default) these declarations will be included in the
1.429 +# documentation.
1.430 +
1.431 +HIDE_FRIEND_COMPOUNDS = NO
1.432 +
1.433 +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
1.434 +# documentation blocks found inside the body of a function.
1.435 +# If set to NO (the default) these blocks will be appended to the
1.436 +# function's detailed documentation block.
1.437 +
1.438 +HIDE_IN_BODY_DOCS = NO
1.439 +
1.440 +# The INTERNAL_DOCS tag determines if documentation
1.441 +# that is typed after a \internal command is included. If the tag is set
1.442 +# to NO (the default) then the documentation will be excluded.
1.443 +# Set it to YES to include the internal documentation.
1.444 +
1.445 +INTERNAL_DOCS = NO
1.446 +
1.447 +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
1.448 +# file names in lower-case letters. If set to YES upper-case letters are also
1.449 +# allowed. This is useful if you have classes or files whose names only differ
1.450 +# in case and if your file system supports case sensitive file names. Windows
1.451 +# and Mac users are advised to set this option to NO.
1.452 +
1.453 +CASE_SENSE_NAMES = YES
1.454 +
1.455 +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
1.456 +# will show members with their full class and namespace scopes in the
1.457 +# documentation. If set to YES the scope will be hidden.
1.458 +
1.459 +HIDE_SCOPE_NAMES = NO
1.460 +
1.461 +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
1.462 +# will put a list of the files that are included by a file in the documentation
1.463 +# of that file.
1.464 +
1.465 +SHOW_INCLUDE_FILES = YES
1.466 +
1.467 +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
1.468 +# will list include files with double quotes in the documentation
1.469 +# rather than with sharp brackets.
1.470 +
1.471 +FORCE_LOCAL_INCLUDES = NO
1.472 +
1.473 +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
1.474 +# is inserted in the documentation for inline members.
1.475 +
1.476 +INLINE_INFO = YES
1.477 +
1.478 +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
1.479 +# will sort the (detailed) documentation of file and class members
1.480 +# alphabetically by member name. If set to NO the members will appear in
1.481 +# declaration order.
1.482 +
1.483 +SORT_MEMBER_DOCS = YES
1.484 +
1.485 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
1.486 +# brief documentation of file, namespace and class members alphabetically
1.487 +# by member name. If set to NO (the default) the members will appear in
1.488 +# declaration order.
1.489 +
1.490 +SORT_BRIEF_DOCS = NO
1.491 +
1.492 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
1.493 +# will sort the (brief and detailed) documentation of class members so that
1.494 +# constructors and destructors are listed first. If set to NO (the default)
1.495 +# the constructors will appear in the respective orders defined by
1.496 +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
1.497 +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
1.498 +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
1.499 +
1.500 +SORT_MEMBERS_CTORS_1ST = NO
1.501 +
1.502 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
1.503 +# hierarchy of group names into alphabetical order. If set to NO (the default)
1.504 +# the group names will appear in their defined order.
1.505 +
1.506 +SORT_GROUP_NAMES = NO
1.507 +
1.508 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
1.509 +# sorted by fully-qualified names, including namespaces. If set to
1.510 +# NO (the default), the class list will be sorted only by class name,
1.511 +# not including the namespace part.
1.512 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
1.513 +# Note: This option applies only to the class list, not to the
1.514 +# alphabetical list.
1.515 +
1.516 +SORT_BY_SCOPE_NAME = NO
1.517 +
1.518 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
1.519 +# do proper type resolution of all parameters of a function it will reject a
1.520 +# match between the prototype and the implementation of a member function even
1.521 +# if there is only one candidate or it is obvious which candidate to choose
1.522 +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
1.523 +# will still accept a match between prototype and implementation in such cases.
1.524 +
1.525 +STRICT_PROTO_MATCHING = NO
1.526 +
1.527 +# The GENERATE_TODOLIST tag can be used to enable (YES) or
1.528 +# disable (NO) the todo list. This list is created by putting \todo
1.529 +# commands in the documentation.
1.530 +
1.531 +GENERATE_TODOLIST = YES
1.532 +
1.533 +# The GENERATE_TESTLIST tag can be used to enable (YES) or
1.534 +# disable (NO) the test list. This list is created by putting \test
1.535 +# commands in the documentation.
1.536 +
1.537 +GENERATE_TESTLIST = YES
1.538 +
1.539 +# The GENERATE_BUGLIST tag can be used to enable (YES) or
1.540 +# disable (NO) the bug list. This list is created by putting \bug
1.541 +# commands in the documentation.
1.542 +
1.543 +GENERATE_BUGLIST = YES
1.544 +
1.545 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
1.546 +# disable (NO) the deprecated list. This list is created by putting
1.547 +# \deprecated commands in the documentation.
1.548 +
1.549 +GENERATE_DEPRECATEDLIST= YES
1.550 +
1.551 +# The ENABLED_SECTIONS tag can be used to enable conditional
1.552 +# documentation sections, marked by \if sectionname ... \endif.
1.553 +
1.554 +ENABLED_SECTIONS =
1.555 +
1.556 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
1.557 +# the initial value of a variable or macro consists of for it to appear in
1.558 +# the documentation. If the initializer consists of more lines than specified
1.559 +# here it will be hidden. Use a value of 0 to hide initializers completely.
1.560 +# The appearance of the initializer of individual variables and macros in the
1.561 +# documentation can be controlled using \showinitializer or \hideinitializer
1.562 +# command in the documentation regardless of this setting.
1.563 +
1.564 +MAX_INITIALIZER_LINES = 30
1.565 +
1.566 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
1.567 +# at the bottom of the documentation of classes and structs. If set to YES the
1.568 +# list will mention the files that were used to generate the documentation.
1.569 +
1.570 +SHOW_USED_FILES = YES
1.571 +
1.572 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
1.573 +# This will remove the Files entry from the Quick Index and from the
1.574 +# Folder Tree View (if specified). The default is YES.
1.575 +
1.576 +SHOW_FILES = YES
1.577 +
1.578 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
1.579 +# Namespaces page.
1.580 +# This will remove the Namespaces entry from the Quick Index
1.581 +# and from the Folder Tree View (if specified). The default is YES.
1.582 +
1.583 +SHOW_NAMESPACES = YES
1.584 +
1.585 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that
1.586 +# doxygen should invoke to get the current version for each file (typically from
1.587 +# the version control system). Doxygen will invoke the program by executing (via
1.588 +# popen()) the command <command> <input-file>, where <command> is the value of
1.589 +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
1.590 +# provided by doxygen. Whatever the program writes to standard output
1.591 +# is used as the file version. See the manual for examples.
1.592 +
1.593 +FILE_VERSION_FILTER =
1.594 +
1.595 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
1.596 +# by doxygen. The layout file controls the global structure of the generated
1.597 +# output files in an output format independent way. The create the layout file
1.598 +# that represents doxygen's defaults, run doxygen with the -l option.
1.599 +# You can optionally specify a file name after the option, if omitted
1.600 +# DoxygenLayout.xml will be used as the name of the layout file.
1.601 +
1.602 +LAYOUT_FILE =
1.603 +
1.604 +# The CITE_BIB_FILES tag can be used to specify one or more bib files
1.605 +# containing the references data. This must be a list of .bib files. The
1.606 +# .bib extension is automatically appended if omitted. Using this command
1.607 +# requires the bibtex tool to be installed. See also
1.608 +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
1.609 +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
1.610 +# feature you need bibtex and perl available in the search path.
1.611 +
1.612 +CITE_BIB_FILES =
1.613 +
1.614 +#---------------------------------------------------------------------------
1.615 +# configuration options related to warning and progress messages
1.616 +#---------------------------------------------------------------------------
1.617 +
1.618 +# The QUIET tag can be used to turn on/off the messages that are generated
1.619 +# by doxygen. Possible values are YES and NO. If left blank NO is used.
1.620 +
1.621 +QUIET = NO
1.622 +
1.623 +# The WARNINGS tag can be used to turn on/off the warning messages that are
1.624 +# generated by doxygen. Possible values are YES and NO. If left blank
1.625 +# NO is used.
1.626 +
1.627 +WARNINGS = YES
1.628 +
1.629 +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
1.630 +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
1.631 +# automatically be disabled.
1.632 +
1.633 +WARN_IF_UNDOCUMENTED = YES
1.634 +
1.635 +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
1.636 +# potential errors in the documentation, such as not documenting some
1.637 +# parameters in a documented function, or documenting parameters that
1.638 +# don't exist or using markup commands wrongly.
1.639 +
1.640 +WARN_IF_DOC_ERROR = YES
1.641 +
1.642 +# The WARN_NO_PARAMDOC option can be enabled to get warnings for
1.643 +# functions that are documented, but have no documentation for their parameters
1.644 +# or return value. If set to NO (the default) doxygen will only warn about
1.645 +# wrong or incomplete parameter documentation, but not about the absence of
1.646 +# documentation.
1.647 +
1.648 +WARN_NO_PARAMDOC = NO
1.649 +
1.650 +# The WARN_FORMAT tag determines the format of the warning messages that
1.651 +# doxygen can produce. The string should contain the $file, $line, and $text
1.652 +# tags, which will be replaced by the file and line number from which the
1.653 +# warning originated and the warning text. Optionally the format may contain
1.654 +# $version, which will be replaced by the version of the file (if it could
1.655 +# be obtained via FILE_VERSION_FILTER)
1.656 +
1.657 +WARN_FORMAT = "$file:$line: $text"
1.658 +
1.659 +# The WARN_LOGFILE tag can be used to specify a file to which warning
1.660 +# and error messages should be written. If left blank the output is written
1.661 +# to stderr.
1.662 +
1.663 +WARN_LOGFILE =
1.664 +
1.665 +#---------------------------------------------------------------------------
1.666 +# configuration options related to the input files
1.667 +#---------------------------------------------------------------------------
1.668 +
1.669 +# The INPUT tag can be used to specify the files and/or directories that contain
1.670 +# documented source files. You may enter file names like "myfile.cpp" or
1.671 +# directories like "/usr/src/myproject". Separate the files or directories
1.672 +# with spaces.
1.673 +
1.674 +INPUT = ./ucx
1.675 +
1.676 +# This tag can be used to specify the character encoding of the source files
1.677 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
1.678 +# also the default input encoding. Doxygen uses libiconv (or the iconv built
1.679 +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
1.680 +# the list of possible encodings.
1.681 +
1.682 +INPUT_ENCODING = UTF-8
1.683 +
1.684 +# If the value of the INPUT tag contains directories, you can use the
1.685 +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1.686 +# and *.h) to filter out the source-files in the directories. If left
1.687 +# blank the following patterns are tested:
1.688 +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
1.689 +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
1.690 +# *.f90 *.f *.for *.vhd *.vhdl
1.691 +
1.692 +FILE_PATTERNS =
1.693 +
1.694 +# The RECURSIVE tag can be used to turn specify whether or not subdirectories
1.695 +# should be searched for input files as well. Possible values are YES and NO.
1.696 +# If left blank NO is used.
1.697 +
1.698 +RECURSIVE = YES
1.699 +
1.700 +# The EXCLUDE tag can be used to specify files and/or directories that should be
1.701 +# excluded from the INPUT source files. This way you can easily exclude a
1.702 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
1.703 +# Note that relative paths are relative to the directory from which doxygen is
1.704 +# run.
1.705 +
1.706 +EXCLUDE =
1.707 +
1.708 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1.709 +# directories that are symbolic links (a Unix file system feature) are excluded
1.710 +# from the input.
1.711 +
1.712 +EXCLUDE_SYMLINKS = NO
1.713 +
1.714 +# If the value of the INPUT tag contains directories, you can use the
1.715 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1.716 +# certain files from those directories. Note that the wildcards are matched
1.717 +# against the file with absolute path, so to exclude all test directories
1.718 +# for example use the pattern */test/*
1.719 +
1.720 +EXCLUDE_PATTERNS =
1.721 +
1.722 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1.723 +# (namespaces, classes, functions, etc.) that should be excluded from the
1.724 +# output. The symbol name can be a fully qualified name, a word, or if the
1.725 +# wildcard * is used, a substring. Examples: ANamespace, AClass,
1.726 +# AClass::ANamespace, ANamespace::*Test
1.727 +
1.728 +EXCLUDE_SYMBOLS =
1.729 +
1.730 +# The EXAMPLE_PATH tag can be used to specify one or more files or
1.731 +# directories that contain example code fragments that are included (see
1.732 +# the \include command).
1.733 +
1.734 +EXAMPLE_PATH =
1.735 +
1.736 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1.737 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1.738 +# and *.h) to filter out the source-files in the directories. If left
1.739 +# blank all files are included.
1.740 +
1.741 +EXAMPLE_PATTERNS =
1.742 +
1.743 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1.744 +# searched for input files to be used with the \include or \dontinclude
1.745 +# commands irrespective of the value of the RECURSIVE tag.
1.746 +# Possible values are YES and NO. If left blank NO is used.
1.747 +
1.748 +EXAMPLE_RECURSIVE = NO
1.749 +
1.750 +# The IMAGE_PATH tag can be used to specify one or more files or
1.751 +# directories that contain image that are included in the documentation (see
1.752 +# the \image command).
1.753 +
1.754 +IMAGE_PATH =
1.755 +
1.756 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
1.757 +# invoke to filter for each input file. Doxygen will invoke the filter program
1.758 +# by executing (via popen()) the command <filter> <input-file>, where <filter>
1.759 +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
1.760 +# input file. Doxygen will then use the output that the filter program writes
1.761 +# to standard output.
1.762 +# If FILTER_PATTERNS is specified, this tag will be
1.763 +# ignored.
1.764 +
1.765 +INPUT_FILTER =
1.766 +
1.767 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1.768 +# basis.
1.769 +# Doxygen will compare the file name with each pattern and apply the
1.770 +# filter if there is a match.
1.771 +# The filters are a list of the form:
1.772 +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
1.773 +# info on how filters are used. If FILTER_PATTERNS is empty or if
1.774 +# non of the patterns match the file name, INPUT_FILTER is applied.
1.775 +
1.776 +FILTER_PATTERNS =
1.777 +
1.778 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1.779 +# INPUT_FILTER) will be used to filter the input files when producing source
1.780 +# files to browse (i.e. when SOURCE_BROWSER is set to YES).
1.781 +
1.782 +FILTER_SOURCE_FILES = NO
1.783 +
1.784 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1.785 +# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
1.786 +# and it is also possible to disable source filtering for a specific pattern
1.787 +# using *.ext= (so without naming a filter). This option only has effect when
1.788 +# FILTER_SOURCE_FILES is enabled.
1.789 +
1.790 +FILTER_SOURCE_PATTERNS =
1.791 +
1.792 +#---------------------------------------------------------------------------
1.793 +# configuration options related to source browsing
1.794 +#---------------------------------------------------------------------------
1.795 +
1.796 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will
1.797 +# be generated. Documented entities will be cross-referenced with these sources.
1.798 +# Note: To get rid of all source code in the generated output, make sure also
1.799 +# VERBATIM_HEADERS is set to NO.
1.800 +
1.801 +SOURCE_BROWSER = NO
1.802 +
1.803 +# Setting the INLINE_SOURCES tag to YES will include the body
1.804 +# of functions and classes directly in the documentation.
1.805 +
1.806 +INLINE_SOURCES = NO
1.807 +
1.808 +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
1.809 +# doxygen to hide any special comment blocks from generated source code
1.810 +# fragments. Normal C and C++ comments will always remain visible.
1.811 +
1.812 +STRIP_CODE_COMMENTS = YES
1.813 +
1.814 +# If the REFERENCED_BY_RELATION tag is set to YES
1.815 +# then for each documented function all documented
1.816 +# functions referencing it will be listed.
1.817 +
1.818 +REFERENCED_BY_RELATION = NO
1.819 +
1.820 +# If the REFERENCES_RELATION tag is set to YES
1.821 +# then for each documented function all documented entities
1.822 +# called/used by that function will be listed.
1.823 +
1.824 +REFERENCES_RELATION = NO
1.825 +
1.826 +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
1.827 +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
1.828 +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
1.829 +# link to the source code.
1.830 +# Otherwise they will link to the documentation.
1.831 +
1.832 +REFERENCES_LINK_SOURCE = YES
1.833 +
1.834 +# If the USE_HTAGS tag is set to YES then the references to source code
1.835 +# will point to the HTML generated by the htags(1) tool instead of doxygen
1.836 +# built-in source browser. The htags tool is part of GNU's global source
1.837 +# tagging system (see http://www.gnu.org/software/global/global.html). You
1.838 +# will need version 4.8.6 or higher.
1.839 +
1.840 +USE_HTAGS = NO
1.841 +
1.842 +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
1.843 +# will generate a verbatim copy of the header file for each class for
1.844 +# which an include is specified. Set to NO to disable this.
1.845 +
1.846 +VERBATIM_HEADERS = YES
1.847 +
1.848 +#---------------------------------------------------------------------------
1.849 +# configuration options related to the alphabetical class index
1.850 +#---------------------------------------------------------------------------
1.851 +
1.852 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
1.853 +# of all compounds will be generated. Enable this if the project
1.854 +# contains a lot of classes, structs, unions or interfaces.
1.855 +
1.856 +ALPHABETICAL_INDEX = YES
1.857 +
1.858 +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
1.859 +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
1.860 +# in which this list will be split (can be a number in the range [1..20])
1.861 +
1.862 +COLS_IN_ALPHA_INDEX = 5
1.863 +
1.864 +# In case all classes in a project start with a common prefix, all
1.865 +# classes will be put under the same header in the alphabetical index.
1.866 +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
1.867 +# should be ignored while generating the index headers.
1.868 +
1.869 +IGNORE_PREFIX =
1.870 +
1.871 +#---------------------------------------------------------------------------
1.872 +# configuration options related to the HTML output
1.873 +#---------------------------------------------------------------------------
1.874 +
1.875 +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1.876 +# generate HTML output.
1.877 +
1.878 +GENERATE_HTML = YES
1.879 +
1.880 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1.881 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.882 +# put in front of it. If left blank `html' will be used as the default path.
1.883 +
1.884 +HTML_OUTPUT = html
1.885 +
1.886 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
1.887 +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
1.888 +# doxygen will generate files with .html extension.
1.889 +
1.890 +HTML_FILE_EXTENSION = .html
1.891 +
1.892 +# The HTML_HEADER tag can be used to specify a personal HTML header for
1.893 +# each generated HTML page. If it is left blank doxygen will generate a
1.894 +# standard header. Note that when using a custom header you are responsible
1.895 +# for the proper inclusion of any scripts and style sheets that doxygen
1.896 +# needs, which is dependent on the configuration options used.
1.897 +# It is advised to generate a default header using "doxygen -w html
1.898 +# header.html footer.html stylesheet.css YourConfigFile" and then modify
1.899 +# that header. Note that the header is subject to change so you typically
1.900 +# have to redo this when upgrading to a newer version of doxygen or when
1.901 +# changing the value of configuration settings such as GENERATE_TREEVIEW!
1.902 +
1.903 +HTML_HEADER =
1.904 +
1.905 +# The HTML_FOOTER tag can be used to specify a personal HTML footer for
1.906 +# each generated HTML page. If it is left blank doxygen will generate a
1.907 +# standard footer.
1.908 +
1.909 +HTML_FOOTER =
1.910 +
1.911 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1.912 +# style sheet that is used by each HTML page. It can be used to
1.913 +# fine-tune the look of the HTML output. If the tag is left blank doxygen
1.914 +# will generate a default style sheet. Note that doxygen will try to copy
1.915 +# the style sheet file to the HTML output directory, so don't put your own
1.916 +# style sheet in the HTML output directory as well, or it will be erased!
1.917 +
1.918 +HTML_STYLESHEET =
1.919 +
1.920 +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1.921 +# other source files which should be copied to the HTML output directory. Note
1.922 +# that these files will be copied to the base HTML output directory. Use the
1.923 +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1.924 +# files. In the HTML_STYLESHEET file, use the file name only. Also note that
1.925 +# the files will be copied as-is; there are no commands or markers available.
1.926 +
1.927 +HTML_EXTRA_FILES =
1.928 +
1.929 +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
1.930 +# Doxygen will adjust the colors in the style sheet and background images
1.931 +# according to this color. Hue is specified as an angle on a colorwheel,
1.932 +# see http://en.wikipedia.org/wiki/Hue for more information.
1.933 +# For instance the value 0 represents red, 60 is yellow, 120 is green,
1.934 +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
1.935 +# The allowed range is 0 to 359.
1.936 +
1.937 +HTML_COLORSTYLE_HUE = 220
1.938 +
1.939 +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
1.940 +# the colors in the HTML output. For a value of 0 the output will use
1.941 +# grayscales only. A value of 255 will produce the most vivid colors.
1.942 +
1.943 +HTML_COLORSTYLE_SAT = 100
1.944 +
1.945 +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
1.946 +# the luminance component of the colors in the HTML output. Values below
1.947 +# 100 gradually make the output lighter, whereas values above 100 make
1.948 +# the output darker. The value divided by 100 is the actual gamma applied,
1.949 +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1.950 +# and 100 does not change the gamma.
1.951 +
1.952 +HTML_COLORSTYLE_GAMMA = 80
1.953 +
1.954 +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1.955 +# page will contain the date and time when the page was generated. Setting
1.956 +# this to NO can help when comparing the output of multiple runs.
1.957 +
1.958 +HTML_TIMESTAMP = YES
1.959 +
1.960 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1.961 +# documentation will contain sections that can be hidden and shown after the
1.962 +# page has loaded. For this to work a browser that supports
1.963 +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
1.964 +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
1.965 +
1.966 +HTML_DYNAMIC_SECTIONS = NO
1.967 +
1.968 +# If the GENERATE_DOCSET tag is set to YES, additional index files
1.969 +# will be generated that can be used as input for Apple's Xcode 3
1.970 +# integrated development environment, introduced with OSX 10.5 (Leopard).
1.971 +# To create a documentation set, doxygen will generate a Makefile in the
1.972 +# HTML output directory. Running make will produce the docset in that
1.973 +# directory and running "make install" will install the docset in
1.974 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1.975 +# it at startup.
1.976 +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1.977 +# for more information.
1.978 +
1.979 +GENERATE_DOCSET = NO
1.980 +
1.981 +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1.982 +# feed. A documentation feed provides an umbrella under which multiple
1.983 +# documentation sets from a single provider (such as a company or product suite)
1.984 +# can be grouped.
1.985 +
1.986 +DOCSET_FEEDNAME = "Doxygen generated docs"
1.987 +
1.988 +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1.989 +# should uniquely identify the documentation set bundle. This should be a
1.990 +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1.991 +# will append .docset to the name.
1.992 +
1.993 +DOCSET_BUNDLE_ID = org.doxygen.Project
1.994 +
1.995 +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1.996 +# the documentation publisher. This should be a reverse domain-name style
1.997 +# string, e.g. com.mycompany.MyDocSet.documentation.
1.998 +
1.999 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1.1000 +
1.1001 +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1.1002 +
1.1003 +DOCSET_PUBLISHER_NAME = Publisher
1.1004 +
1.1005 +# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1.1006 +# will be generated that can be used as input for tools like the
1.1007 +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1.1008 +# of the generated HTML documentation.
1.1009 +
1.1010 +GENERATE_HTMLHELP = NO
1.1011 +
1.1012 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1.1013 +# be used to specify the file name of the resulting .chm file. You
1.1014 +# can add a path in front of the file if the result should not be
1.1015 +# written to the html output directory.
1.1016 +
1.1017 +CHM_FILE =
1.1018 +
1.1019 +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1.1020 +# be used to specify the location (absolute path including file name) of
1.1021 +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1.1022 +# the HTML help compiler on the generated index.hhp.
1.1023 +
1.1024 +HHC_LOCATION =
1.1025 +
1.1026 +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1.1027 +# controls if a separate .chi index file is generated (YES) or that
1.1028 +# it should be included in the master .chm file (NO).
1.1029 +
1.1030 +GENERATE_CHI = NO
1.1031 +
1.1032 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1.1033 +# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1.1034 +# content.
1.1035 +
1.1036 +CHM_INDEX_ENCODING =
1.1037 +
1.1038 +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1.1039 +# controls whether a binary table of contents is generated (YES) or a
1.1040 +# normal table of contents (NO) in the .chm file.
1.1041 +
1.1042 +BINARY_TOC = NO
1.1043 +
1.1044 +# The TOC_EXPAND flag can be set to YES to add extra items for group members
1.1045 +# to the contents of the HTML help documentation and to the tree view.
1.1046 +
1.1047 +TOC_EXPAND = NO
1.1048 +
1.1049 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1.1050 +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1.1051 +# that can be used as input for Qt's qhelpgenerator to generate a
1.1052 +# Qt Compressed Help (.qch) of the generated HTML documentation.
1.1053 +
1.1054 +GENERATE_QHP = NO
1.1055 +
1.1056 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1.1057 +# be used to specify the file name of the resulting .qch file.
1.1058 +# The path specified is relative to the HTML output folder.
1.1059 +
1.1060 +QCH_FILE =
1.1061 +
1.1062 +# The QHP_NAMESPACE tag specifies the namespace to use when generating
1.1063 +# Qt Help Project output. For more information please see
1.1064 +# http://doc.trolltech.com/qthelpproject.html#namespace
1.1065 +
1.1066 +QHP_NAMESPACE = org.doxygen.Project
1.1067 +
1.1068 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1.1069 +# Qt Help Project output. For more information please see
1.1070 +# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1.1071 +
1.1072 +QHP_VIRTUAL_FOLDER = doc
1.1073 +
1.1074 +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1.1075 +# add. For more information please see
1.1076 +# http://doc.trolltech.com/qthelpproject.html#custom-filters
1.1077 +
1.1078 +QHP_CUST_FILTER_NAME =
1.1079 +
1.1080 +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1.1081 +# custom filter to add. For more information please see
1.1082 +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1.1083 +# Qt Help Project / Custom Filters</a>.
1.1084 +
1.1085 +QHP_CUST_FILTER_ATTRS =
1.1086 +
1.1087 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1.1088 +# project's
1.1089 +# filter section matches.
1.1090 +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1.1091 +# Qt Help Project / Filter Attributes</a>.
1.1092 +
1.1093 +QHP_SECT_FILTER_ATTRS =
1.1094 +
1.1095 +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1.1096 +# be used to specify the location of Qt's qhelpgenerator.
1.1097 +# If non-empty doxygen will try to run qhelpgenerator on the generated
1.1098 +# .qhp file.
1.1099 +
1.1100 +QHG_LOCATION =
1.1101 +
1.1102 +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1.1103 +# will be generated, which together with the HTML files, form an Eclipse help
1.1104 +# plugin. To install this plugin and make it available under the help contents
1.1105 +# menu in Eclipse, the contents of the directory containing the HTML and XML
1.1106 +# files needs to be copied into the plugins directory of eclipse. The name of
1.1107 +# the directory within the plugins directory should be the same as
1.1108 +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1.1109 +# the help appears.
1.1110 +
1.1111 +GENERATE_ECLIPSEHELP = NO
1.1112 +
1.1113 +# A unique identifier for the eclipse help plugin. When installing the plugin
1.1114 +# the directory name containing the HTML and XML files should also have
1.1115 +# this name.
1.1116 +
1.1117 +ECLIPSE_DOC_ID = org.doxygen.Project
1.1118 +
1.1119 +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1.1120 +# at top of each HTML page. The value NO (the default) enables the index and
1.1121 +# the value YES disables it. Since the tabs have the same information as the
1.1122 +# navigation tree you can set this option to NO if you already set
1.1123 +# GENERATE_TREEVIEW to YES.
1.1124 +
1.1125 +DISABLE_INDEX = NO
1.1126 +
1.1127 +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1.1128 +# structure should be generated to display hierarchical information.
1.1129 +# If the tag value is set to YES, a side panel will be generated
1.1130 +# containing a tree-like index structure (just like the one that
1.1131 +# is generated for HTML Help). For this to work a browser that supports
1.1132 +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1.1133 +# Windows users are probably better off using the HTML help feature.
1.1134 +# Since the tree basically has the same information as the tab index you
1.1135 +# could consider to set DISABLE_INDEX to NO when enabling this option.
1.1136 +
1.1137 +GENERATE_TREEVIEW = NO
1.1138 +
1.1139 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1.1140 +# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1.1141 +# documentation. Note that a value of 0 will completely suppress the enum
1.1142 +# values from appearing in the overview section.
1.1143 +
1.1144 +ENUM_VALUES_PER_LINE = 4
1.1145 +
1.1146 +
1.1147 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1.1148 +# used to set the initial width (in pixels) of the frame in which the tree
1.1149 +# is shown.
1.1150 +
1.1151 +TREEVIEW_WIDTH = 250
1.1152 +
1.1153 +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1.1154 +# links to external symbols imported via tag files in a separate window.
1.1155 +
1.1156 +EXT_LINKS_IN_WINDOW = NO
1.1157 +
1.1158 +# Use this tag to change the font size of Latex formulas included
1.1159 +# as images in the HTML documentation. The default is 10. Note that
1.1160 +# when you change the font size after a successful doxygen run you need
1.1161 +# to manually remove any form_*.png images from the HTML output directory
1.1162 +# to force them to be regenerated.
1.1163 +
1.1164 +FORMULA_FONTSIZE = 10
1.1165 +
1.1166 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1.1167 +# generated for formulas are transparent PNGs. Transparent PNGs are
1.1168 +# not supported properly for IE 6.0, but are supported on all modern browsers.
1.1169 +# Note that when changing this option you need to delete any form_*.png files
1.1170 +# in the HTML output before the changes have effect.
1.1171 +
1.1172 +FORMULA_TRANSPARENT = YES
1.1173 +
1.1174 +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1.1175 +# (see http://www.mathjax.org) which uses client side Javascript for the
1.1176 +# rendering instead of using prerendered bitmaps. Use this if you do not
1.1177 +# have LaTeX installed or if you want to formulas look prettier in the HTML
1.1178 +# output. When enabled you also need to install MathJax separately and
1.1179 +# configure the path to it using the MATHJAX_RELPATH option.
1.1180 +
1.1181 +USE_MATHJAX = NO
1.1182 +
1.1183 +# When MathJax is enabled you need to specify the location relative to the
1.1184 +# HTML output directory using the MATHJAX_RELPATH option. The destination
1.1185 +# directory should contain the MathJax.js script. For instance, if the mathjax
1.1186 +# directory is located at the same level as the HTML output directory, then
1.1187 +# MATHJAX_RELPATH should be ../mathjax. The default value points to the
1.1188 +# mathjax.org site, so you can quickly see the result without installing
1.1189 +# MathJax, but it is strongly recommended to install a local copy of MathJax
1.1190 +# before deployment.
1.1191 +
1.1192 +MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1.1193 +
1.1194 +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1.1195 +# names that should be enabled during MathJax rendering.
1.1196 +
1.1197 +MATHJAX_EXTENSIONS =
1.1198 +
1.1199 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1.1200 +# for the HTML output. The underlying search engine uses javascript
1.1201 +# and DHTML and should work on any modern browser. Note that when using
1.1202 +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1.1203 +# (GENERATE_DOCSET) there is already a search function so this one should
1.1204 +# typically be disabled. For large projects the javascript based search engine
1.1205 +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1.1206 +
1.1207 +SEARCHENGINE = YES
1.1208 +
1.1209 +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1.1210 +# implemented using a PHP enabled web server instead of at the web client
1.1211 +# using Javascript. Doxygen will generate the search PHP script and index
1.1212 +# file to put on the web server. The advantage of the server
1.1213 +# based approach is that it scales better to large projects and allows
1.1214 +# full text search. The disadvantages are that it is more difficult to setup
1.1215 +# and does not have live searching capabilities.
1.1216 +
1.1217 +SERVER_BASED_SEARCH = NO
1.1218 +
1.1219 +#---------------------------------------------------------------------------
1.1220 +# configuration options related to the LaTeX output
1.1221 +#---------------------------------------------------------------------------
1.1222 +
1.1223 +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1.1224 +# generate Latex output.
1.1225 +
1.1226 +GENERATE_LATEX = NO
1.1227 +
1.1228 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1.1229 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.1230 +# put in front of it. If left blank `latex' will be used as the default path.
1.1231 +
1.1232 +LATEX_OUTPUT = latex
1.1233 +
1.1234 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1.1235 +# invoked. If left blank `latex' will be used as the default command name.
1.1236 +# Note that when enabling USE_PDFLATEX this option is only used for
1.1237 +# generating bitmaps for formulas in the HTML output, but not in the
1.1238 +# Makefile that is written to the output directory.
1.1239 +
1.1240 +LATEX_CMD_NAME = latex
1.1241 +
1.1242 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1.1243 +# generate index for LaTeX. If left blank `makeindex' will be used as the
1.1244 +# default command name.
1.1245 +
1.1246 +MAKEINDEX_CMD_NAME = makeindex
1.1247 +
1.1248 +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1.1249 +# LaTeX documents. This may be useful for small projects and may help to
1.1250 +# save some trees in general.
1.1251 +
1.1252 +COMPACT_LATEX = NO
1.1253 +
1.1254 +# The PAPER_TYPE tag can be used to set the paper type that is used
1.1255 +# by the printer. Possible values are: a4, letter, legal and
1.1256 +# executive. If left blank a4wide will be used.
1.1257 +
1.1258 +PAPER_TYPE = a4
1.1259 +
1.1260 +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1.1261 +# packages that should be included in the LaTeX output.
1.1262 +
1.1263 +EXTRA_PACKAGES =
1.1264 +
1.1265 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1.1266 +# the generated latex document. The header should contain everything until
1.1267 +# the first chapter. If it is left blank doxygen will generate a
1.1268 +# standard header. Notice: only use this tag if you know what you are doing!
1.1269 +
1.1270 +LATEX_HEADER =
1.1271 +
1.1272 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1.1273 +# the generated latex document. The footer should contain everything after
1.1274 +# the last chapter. If it is left blank doxygen will generate a
1.1275 +# standard footer. Notice: only use this tag if you know what you are doing!
1.1276 +
1.1277 +LATEX_FOOTER =
1.1278 +
1.1279 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1.1280 +# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1.1281 +# contain links (just like the HTML output) instead of page references
1.1282 +# This makes the output suitable for online browsing using a pdf viewer.
1.1283 +
1.1284 +PDF_HYPERLINKS = YES
1.1285 +
1.1286 +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1.1287 +# plain latex in the generated Makefile. Set this option to YES to get a
1.1288 +# higher quality PDF documentation.
1.1289 +
1.1290 +USE_PDFLATEX = YES
1.1291 +
1.1292 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1.1293 +# command to the generated LaTeX files. This will instruct LaTeX to keep
1.1294 +# running if errors occur, instead of asking the user for help.
1.1295 +# This option is also used when generating formulas in HTML.
1.1296 +
1.1297 +LATEX_BATCHMODE = NO
1.1298 +
1.1299 +# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1.1300 +# include the index chapters (such as File Index, Compound Index, etc.)
1.1301 +# in the output.
1.1302 +
1.1303 +LATEX_HIDE_INDICES = NO
1.1304 +
1.1305 +# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1.1306 +# source code with syntax highlighting in the LaTeX output.
1.1307 +# Note that which sources are shown also depends on other settings
1.1308 +# such as SOURCE_BROWSER.
1.1309 +
1.1310 +LATEX_SOURCE_CODE = NO
1.1311 +
1.1312 +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1.1313 +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1.1314 +# http://en.wikipedia.org/wiki/BibTeX for more info.
1.1315 +
1.1316 +LATEX_BIB_STYLE = plain
1.1317 +
1.1318 +#---------------------------------------------------------------------------
1.1319 +# configuration options related to the RTF output
1.1320 +#---------------------------------------------------------------------------
1.1321 +
1.1322 +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1.1323 +# The RTF output is optimized for Word 97 and may not look very pretty with
1.1324 +# other RTF readers or editors.
1.1325 +
1.1326 +GENERATE_RTF = NO
1.1327 +
1.1328 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1.1329 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.1330 +# put in front of it. If left blank `rtf' will be used as the default path.
1.1331 +
1.1332 +RTF_OUTPUT = rtf
1.1333 +
1.1334 +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1.1335 +# RTF documents. This may be useful for small projects and may help to
1.1336 +# save some trees in general.
1.1337 +
1.1338 +COMPACT_RTF = NO
1.1339 +
1.1340 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1.1341 +# will contain hyperlink fields. The RTF file will
1.1342 +# contain links (just like the HTML output) instead of page references.
1.1343 +# This makes the output suitable for online browsing using WORD or other
1.1344 +# programs which support those fields.
1.1345 +# Note: wordpad (write) and others do not support links.
1.1346 +
1.1347 +RTF_HYPERLINKS = NO
1.1348 +
1.1349 +# Load style sheet definitions from file. Syntax is similar to doxygen's
1.1350 +# config file, i.e. a series of assignments. You only have to provide
1.1351 +# replacements, missing definitions are set to their default value.
1.1352 +
1.1353 +RTF_STYLESHEET_FILE =
1.1354 +
1.1355 +# Set optional variables used in the generation of an rtf document.
1.1356 +# Syntax is similar to doxygen's config file.
1.1357 +
1.1358 +RTF_EXTENSIONS_FILE =
1.1359 +
1.1360 +#---------------------------------------------------------------------------
1.1361 +# configuration options related to the man page output
1.1362 +#---------------------------------------------------------------------------
1.1363 +
1.1364 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1.1365 +# generate man pages
1.1366 +
1.1367 +GENERATE_MAN = NO
1.1368 +
1.1369 +# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1.1370 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.1371 +# put in front of it. If left blank `man' will be used as the default path.
1.1372 +
1.1373 +MAN_OUTPUT = man
1.1374 +
1.1375 +# The MAN_EXTENSION tag determines the extension that is added to
1.1376 +# the generated man pages (default is the subroutine's section .3)
1.1377 +
1.1378 +MAN_EXTENSION = .3
1.1379 +
1.1380 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1.1381 +# then it will generate one additional man file for each entity
1.1382 +# documented in the real man page(s). These additional files
1.1383 +# only source the real man page, but without them the man command
1.1384 +# would be unable to find the correct page. The default is NO.
1.1385 +
1.1386 +MAN_LINKS = NO
1.1387 +
1.1388 +#---------------------------------------------------------------------------
1.1389 +# configuration options related to the XML output
1.1390 +#---------------------------------------------------------------------------
1.1391 +
1.1392 +# If the GENERATE_XML tag is set to YES Doxygen will
1.1393 +# generate an XML file that captures the structure of
1.1394 +# the code including all documentation.
1.1395 +
1.1396 +GENERATE_XML = NO
1.1397 +
1.1398 +# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1.1399 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.1400 +# put in front of it. If left blank `xml' will be used as the default path.
1.1401 +
1.1402 +XML_OUTPUT = xml
1.1403 +
1.1404 +# The XML_SCHEMA tag can be used to specify an XML schema,
1.1405 +# which can be used by a validating XML parser to check the
1.1406 +# syntax of the XML files.
1.1407 +
1.1408 +XML_SCHEMA =
1.1409 +
1.1410 +# The XML_DTD tag can be used to specify an XML DTD,
1.1411 +# which can be used by a validating XML parser to check the
1.1412 +# syntax of the XML files.
1.1413 +
1.1414 +XML_DTD =
1.1415 +
1.1416 +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1.1417 +# dump the program listings (including syntax highlighting
1.1418 +# and cross-referencing information) to the XML output. Note that
1.1419 +# enabling this will significantly increase the size of the XML output.
1.1420 +
1.1421 +XML_PROGRAMLISTING = YES
1.1422 +
1.1423 +#---------------------------------------------------------------------------
1.1424 +# configuration options for the AutoGen Definitions output
1.1425 +#---------------------------------------------------------------------------
1.1426 +
1.1427 +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1.1428 +# generate an AutoGen Definitions (see autogen.sf.net) file
1.1429 +# that captures the structure of the code including all
1.1430 +# documentation. Note that this feature is still experimental
1.1431 +# and incomplete at the moment.
1.1432 +
1.1433 +GENERATE_AUTOGEN_DEF = NO
1.1434 +
1.1435 +#---------------------------------------------------------------------------
1.1436 +# configuration options related to the Perl module output
1.1437 +#---------------------------------------------------------------------------
1.1438 +
1.1439 +# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1.1440 +# generate a Perl module file that captures the structure of
1.1441 +# the code including all documentation. Note that this
1.1442 +# feature is still experimental and incomplete at the
1.1443 +# moment.
1.1444 +
1.1445 +GENERATE_PERLMOD = NO
1.1446 +
1.1447 +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1.1448 +# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1.1449 +# to generate PDF and DVI output from the Perl module output.
1.1450 +
1.1451 +PERLMOD_LATEX = NO
1.1452 +
1.1453 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1.1454 +# nicely formatted so it can be parsed by a human reader.
1.1455 +# This is useful
1.1456 +# if you want to understand what is going on.
1.1457 +# On the other hand, if this
1.1458 +# tag is set to NO the size of the Perl module output will be much smaller
1.1459 +# and Perl will parse it just the same.
1.1460 +
1.1461 +PERLMOD_PRETTY = YES
1.1462 +
1.1463 +# The names of the make variables in the generated doxyrules.make file
1.1464 +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1.1465 +# This is useful so different doxyrules.make files included by the same
1.1466 +# Makefile don't overwrite each other's variables.
1.1467 +
1.1468 +PERLMOD_MAKEVAR_PREFIX =
1.1469 +
1.1470 +#---------------------------------------------------------------------------
1.1471 +# Configuration options related to the preprocessor
1.1472 +#---------------------------------------------------------------------------
1.1473 +
1.1474 +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1.1475 +# evaluate all C-preprocessor directives found in the sources and include
1.1476 +# files.
1.1477 +
1.1478 +ENABLE_PREPROCESSING = YES
1.1479 +
1.1480 +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1.1481 +# names in the source code. If set to NO (the default) only conditional
1.1482 +# compilation will be performed. Macro expansion can be done in a controlled
1.1483 +# way by setting EXPAND_ONLY_PREDEF to YES.
1.1484 +
1.1485 +MACRO_EXPANSION = NO
1.1486 +
1.1487 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1.1488 +# then the macro expansion is limited to the macros specified with the
1.1489 +# PREDEFINED and EXPAND_AS_DEFINED tags.
1.1490 +
1.1491 +EXPAND_ONLY_PREDEF = NO
1.1492 +
1.1493 +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1.1494 +# pointed to by INCLUDE_PATH will be searched when a #include is found.
1.1495 +
1.1496 +SEARCH_INCLUDES = YES
1.1497 +
1.1498 +# The INCLUDE_PATH tag can be used to specify one or more directories that
1.1499 +# contain include files that are not input files but should be processed by
1.1500 +# the preprocessor.
1.1501 +
1.1502 +INCLUDE_PATH =
1.1503 +
1.1504 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1.1505 +# patterns (like *.h and *.hpp) to filter out the header-files in the
1.1506 +# directories. If left blank, the patterns specified with FILE_PATTERNS will
1.1507 +# be used.
1.1508 +
1.1509 +INCLUDE_FILE_PATTERNS =
1.1510 +
1.1511 +# The PREDEFINED tag can be used to specify one or more macro names that
1.1512 +# are defined before the preprocessor is started (similar to the -D option of
1.1513 +# gcc). The argument of the tag is a list of macros of the form: name
1.1514 +# or name=definition (no spaces). If the definition and the = are
1.1515 +# omitted =1 is assumed. To prevent a macro definition from being
1.1516 +# undefined via #undef or recursively expanded use the := operator
1.1517 +# instead of the = operator.
1.1518 +
1.1519 +PREDEFINED =
1.1520 +
1.1521 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1.1522 +# this tag can be used to specify a list of macro names that should be expanded.
1.1523 +# The macro definition that is found in the sources will be used.
1.1524 +# Use the PREDEFINED tag if you want to use a different macro definition that
1.1525 +# overrules the definition found in the source code.
1.1526 +
1.1527 +EXPAND_AS_DEFINED =
1.1528 +
1.1529 +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1.1530 +# doxygen's preprocessor will remove all references to function-like macros
1.1531 +# that are alone on a line, have an all uppercase name, and do not end with a
1.1532 +# semicolon, because these will confuse the parser if not removed.
1.1533 +
1.1534 +SKIP_FUNCTION_MACROS = YES
1.1535 +
1.1536 +#---------------------------------------------------------------------------
1.1537 +# Configuration::additions related to external references
1.1538 +#---------------------------------------------------------------------------
1.1539 +
1.1540 +# The TAGFILES option can be used to specify one or more tagfiles.
1.1541 +# Optionally an initial location of the external documentation
1.1542 +# can be added for each tagfile. The format of a tag file without
1.1543 +# this location is as follows:
1.1544 +#
1.1545 +# TAGFILES = file1 file2 ...
1.1546 +# Adding location for the tag files is done as follows:
1.1547 +#
1.1548 +# TAGFILES = file1=loc1 "file2 = loc2" ...
1.1549 +# where "loc1" and "loc2" can be relative or absolute paths or
1.1550 +# URLs. If a location is present for each tag, the installdox tool
1.1551 +# does not have to be run to correct the links.
1.1552 +# Note that each tag file must have a unique name
1.1553 +# (where the name does NOT include the path)
1.1554 +# If a tag file is not located in the directory in which doxygen
1.1555 +# is run, you must also specify the path to the tagfile here.
1.1556 +
1.1557 +TAGFILES =
1.1558 +
1.1559 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1.1560 +# a tag file that is based on the input files it reads.
1.1561 +
1.1562 +GENERATE_TAGFILE =
1.1563 +
1.1564 +# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1.1565 +# in the class index. If set to NO only the inherited external classes
1.1566 +# will be listed.
1.1567 +
1.1568 +ALLEXTERNALS = NO
1.1569 +
1.1570 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1.1571 +# in the modules index. If set to NO, only the current project's groups will
1.1572 +# be listed.
1.1573 +
1.1574 +EXTERNAL_GROUPS = YES
1.1575 +
1.1576 +# The PERL_PATH should be the absolute path and name of the perl script
1.1577 +# interpreter (i.e. the result of `which perl').
1.1578 +
1.1579 +PERL_PATH = /usr/bin/perl
1.1580 +
1.1581 +#---------------------------------------------------------------------------
1.1582 +# Configuration options related to the dot tool
1.1583 +#---------------------------------------------------------------------------
1.1584 +
1.1585 +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1.1586 +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1.1587 +# or super classes. Setting the tag to NO turns the diagrams off. Note that
1.1588 +# this option also works with HAVE_DOT disabled, but it is recommended to
1.1589 +# install and use dot, since it yields more powerful graphs.
1.1590 +
1.1591 +CLASS_DIAGRAMS = YES
1.1592 +
1.1593 +# You can define message sequence charts within doxygen comments using the \msc
1.1594 +# command. Doxygen will then run the mscgen tool (see
1.1595 +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1.1596 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1.1597 +# the mscgen tool resides. If left empty the tool is assumed to be found in the
1.1598 +# default search path.
1.1599 +
1.1600 +MSCGEN_PATH =
1.1601 +
1.1602 +# If set to YES, the inheritance and collaboration graphs will hide
1.1603 +# inheritance and usage relations if the target is undocumented
1.1604 +# or is not a class.
1.1605 +
1.1606 +HIDE_UNDOC_RELATIONS = YES
1.1607 +
1.1608 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1.1609 +# available from the path. This tool is part of Graphviz, a graph visualization
1.1610 +# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1.1611 +# have no effect if this option is set to NO (the default)
1.1612 +
1.1613 +HAVE_DOT = NO
1.1614 +
1.1615 +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1.1616 +# allowed to run in parallel. When set to 0 (the default) doxygen will
1.1617 +# base this on the number of processors available in the system. You can set it
1.1618 +# explicitly to a value larger than 0 to get control over the balance
1.1619 +# between CPU load and processing speed.
1.1620 +
1.1621 +DOT_NUM_THREADS = 0
1.1622 +
1.1623 +# By default doxygen will use the Helvetica font for all dot files that
1.1624 +# doxygen generates. When you want a differently looking font you can specify
1.1625 +# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1.1626 +# the font, which can be done by putting it in a standard location or by setting
1.1627 +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1.1628 +# directory containing the font.
1.1629 +
1.1630 +DOT_FONTNAME = Helvetica
1.1631 +
1.1632 +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1.1633 +# The default size is 10pt.
1.1634 +
1.1635 +DOT_FONTSIZE = 10
1.1636 +
1.1637 +# By default doxygen will tell dot to use the Helvetica font.
1.1638 +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1.1639 +# set the path where dot can find it.
1.1640 +
1.1641 +DOT_FONTPATH =
1.1642 +
1.1643 +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1.1644 +# will generate a graph for each documented class showing the direct and
1.1645 +# indirect inheritance relations. Setting this tag to YES will force the
1.1646 +# CLASS_DIAGRAMS tag to NO.
1.1647 +
1.1648 +CLASS_GRAPH = YES
1.1649 +
1.1650 +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1.1651 +# will generate a graph for each documented class showing the direct and
1.1652 +# indirect implementation dependencies (inheritance, containment, and
1.1653 +# class references variables) of the class with other documented classes.
1.1654 +
1.1655 +COLLABORATION_GRAPH = YES
1.1656 +
1.1657 +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1.1658 +# will generate a graph for groups, showing the direct groups dependencies
1.1659 +
1.1660 +GROUP_GRAPHS = YES
1.1661 +
1.1662 +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1.1663 +# collaboration diagrams in a style similar to the OMG's Unified Modeling
1.1664 +# Language.
1.1665 +
1.1666 +UML_LOOK = NO
1.1667 +
1.1668 +# If set to YES, the inheritance and collaboration graphs will show the
1.1669 +# relations between templates and their instances.
1.1670 +
1.1671 +TEMPLATE_RELATIONS = NO
1.1672 +
1.1673 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1.1674 +# tags are set to YES then doxygen will generate a graph for each documented
1.1675 +# file showing the direct and indirect include dependencies of the file with
1.1676 +# other documented files.
1.1677 +
1.1678 +INCLUDE_GRAPH = YES
1.1679 +
1.1680 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1.1681 +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1.1682 +# documented header file showing the documented files that directly or
1.1683 +# indirectly include this file.
1.1684 +
1.1685 +INCLUDED_BY_GRAPH = YES
1.1686 +
1.1687 +# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1.1688 +# doxygen will generate a call dependency graph for every global function
1.1689 +# or class method. Note that enabling this option will significantly increase
1.1690 +# the time of a run. So in most cases it will be better to enable call graphs
1.1691 +# for selected functions only using the \callgraph command.
1.1692 +
1.1693 +CALL_GRAPH = NO
1.1694 +
1.1695 +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1.1696 +# doxygen will generate a caller dependency graph for every global function
1.1697 +# or class method. Note that enabling this option will significantly increase
1.1698 +# the time of a run. So in most cases it will be better to enable caller
1.1699 +# graphs for selected functions only using the \callergraph command.
1.1700 +
1.1701 +CALLER_GRAPH = NO
1.1702 +
1.1703 +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1.1704 +# will generate a graphical hierarchy of all classes instead of a textual one.
1.1705 +
1.1706 +GRAPHICAL_HIERARCHY = YES
1.1707 +
1.1708 +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1.1709 +# then doxygen will show the dependencies a directory has on other directories
1.1710 +# in a graphical way. The dependency relations are determined by the #include
1.1711 +# relations between the files in the directories.
1.1712 +
1.1713 +DIRECTORY_GRAPH = YES
1.1714 +
1.1715 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1.1716 +# generated by dot. Possible values are svg, png, jpg, or gif.
1.1717 +# If left blank png will be used. If you choose svg you need to set
1.1718 +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1.1719 +# visible in IE 9+ (other browsers do not have this requirement).
1.1720 +
1.1721 +DOT_IMAGE_FORMAT = png
1.1722 +
1.1723 +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1.1724 +# enable generation of interactive SVG images that allow zooming and panning.
1.1725 +# Note that this requires a modern browser other than Internet Explorer.
1.1726 +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1.1727 +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1.1728 +# visible. Older versions of IE do not have SVG support.
1.1729 +
1.1730 +INTERACTIVE_SVG = NO
1.1731 +
1.1732 +# The tag DOT_PATH can be used to specify the path where the dot tool can be
1.1733 +# found. If left blank, it is assumed the dot tool can be found in the path.
1.1734 +
1.1735 +DOT_PATH =
1.1736 +
1.1737 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
1.1738 +# contain dot files that are included in the documentation (see the
1.1739 +# \dotfile command).
1.1740 +
1.1741 +DOTFILE_DIRS =
1.1742 +
1.1743 +# The MSCFILE_DIRS tag can be used to specify one or more directories that
1.1744 +# contain msc files that are included in the documentation (see the
1.1745 +# \mscfile command).
1.1746 +
1.1747 +MSCFILE_DIRS =
1.1748 +
1.1749 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1.1750 +# nodes that will be shown in the graph. If the number of nodes in a graph
1.1751 +# becomes larger than this value, doxygen will truncate the graph, which is
1.1752 +# visualized by representing a node as a red box. Note that doxygen if the
1.1753 +# number of direct children of the root node in a graph is already larger than
1.1754 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1.1755 +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1.1756 +
1.1757 +DOT_GRAPH_MAX_NODES = 50
1.1758 +
1.1759 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1.1760 +# graphs generated by dot. A depth value of 3 means that only nodes reachable
1.1761 +# from the root by following a path via at most 3 edges will be shown. Nodes
1.1762 +# that lay further from the root node will be omitted. Note that setting this
1.1763 +# option to 1 or 2 may greatly reduce the computation time needed for large
1.1764 +# code bases. Also note that the size of a graph can be further restricted by
1.1765 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1.1766 +
1.1767 +MAX_DOT_GRAPH_DEPTH = 0
1.1768 +
1.1769 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1.1770 +# background. This is disabled by default, because dot on Windows does not
1.1771 +# seem to support this out of the box. Warning: Depending on the platform used,
1.1772 +# enabling this option may lead to badly anti-aliased labels on the edges of
1.1773 +# a graph (i.e. they become hard to read).
1.1774 +
1.1775 +DOT_TRANSPARENT = NO
1.1776 +
1.1777 +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1.1778 +# files in one run (i.e. multiple -o and -T options on the command line). This
1.1779 +# makes dot run faster, but since only newer versions of dot (>1.8.10)
1.1780 +# support this, this feature is disabled by default.
1.1781 +
1.1782 +DOT_MULTI_TARGETS = YES
1.1783 +
1.1784 +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1.1785 +# generate a legend page explaining the meaning of the various boxes and
1.1786 +# arrows in the dot generated graphs.
1.1787 +
1.1788 +GENERATE_LEGEND = YES
1.1789 +
1.1790 +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1.1791 +# remove the intermediate dot files that are used to generate
1.1792 +# the various graphs.
1.1793 +
1.1794 +DOT_CLEANUP = YES
