Mercurial > hg > ucx / changeset

     1.1 --- a/.hgignore	Sun Nov 24 17:57:25 2019 +0100
     1.2 +++ b/.hgignore	Thu Dec 19 18:40:00 2019 +0100
     1.3 @@ -29,3 +29,5 @@
     1.4  ^test/ucxtest
     1.5  /test-suite.log$
     1.6  ^ucx-.*\.tar.gz$
     1.7 +^.idea/
     1.8 +^cmake-build-

     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/CMakeLists.txt	Thu Dec 19 18:40:00 2019 +0100
     2.3 @@ -0,0 +1,58 @@
     2.4 +cmake_minimum_required(VERSION 3.15)
     2.5 +project(ucx)
     2.6 +
     2.7 +# Autotools Buildsystem
     2.8 +add_custom_command(
     2.9 +        OUTPUT ${CMAKE_SOURCE_DIR}/configure
    2.10 +        MAIN_DEPENDENCY ${CMAKE_SOURCE_DIR}/configure.ac
    2.11 +        COMMAND ${CMAKE_SOURCE_DIR}/autogen.sh
    2.12 +        COMMENT "Generating configure script.")
    2.13 +
    2.14 +add_custom_command(
    2.15 +        OUTPUT ${CMAKE_SOURCE_DIR}/Makefile
    2.16 +        DEPENDS ${CMAKE_SOURCE_DIR}/configure
    2.17 +        COMMAND ${CMAKE_SOURCE_DIR}/configure
    2.18 +        COMMENT "Configuring project.")
    2.19 +
    2.20 +add_custom_target(libucx-build
    2.21 +        DEPENDS ${CMAKE_SOURCE_DIR}/Makefile
    2.22 +        COMMAND $(MAKE) -f ${CMAKE_SOURCE_DIR}/Makefile
    2.23 +        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
    2.24 +
    2.25 +add_custom_target(libucx-clean
    2.26 +        DEPENDS ${CMAKE_SOURCE_DIR}/Makefile
    2.27 +        COMMAND $(MAKE) -f ${CMAKE_SOURCE_DIR}/Makefile clean
    2.28 +        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
    2.29 +
    2.30 +add_custom_target(libucx-check
    2.31 +        DEPENDS ${CMAKE_SOURCE_DIR}/Makefile
    2.32 +        COMMAND $(MAKE) ${CMAKE_SOURCE_DIR}/Makefile check
    2.33 +        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
    2.34 +
    2.35 +# Web Documentation
    2.36 +add_subdirectory(docs/src)
    2.37 +
    2.38 +# API Documentation
    2.39 +find_package(Doxygen)
    2.40 +option(BUILD_DOCUMENTATION "Create API documentation." ${DOXYGEN_FOUND})
    2.41 +
    2.42 +if(BUILD_DOCUMENTATION)
    2.43 +    if(NOT DOXYGEN_FOUND)
    2.44 +        message(FATAL_ERROR "Doxygen is needed to build the documentation.")
    2.45 +    endif()
    2.46 +
    2.47 +    set(DOXY_INPUT ${CMAKE_SOURCE_DIR}/src)
    2.48 +    set(DOXY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/docs)
    2.49 +    set(DOXY_PROJECT_LOGO ${CMAKE_SOURCE_DIR}/uaplogo.png)
    2.50 +
    2.51 +    configure_file(${CMAKE_SOURCE_DIR}/cmake_infile.doxygen ${CMAKE_BINARY_DIR}/Doxyfile)
    2.52 +
    2.53 +    add_custom_target(docs-api
    2.54 +            COMMAND ${DOXYGEN_EXECUTABLE}
    2.55 +            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
    2.56 +            COMMENT "Generating API documentation with Doxygen")
    2.57 +endif()
    2.58 +
    2.59 +add_custom_target(docs-all DEPENDS docs-html docs-api)
    2.60 +
    2.61 +add_custom_target(build-all DEPENDS docs-all libucx-check)

     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/cmake_infile.doxygen	Thu Dec 19 18:40:00 2019 +0100
     3.3 @@ -0,0 +1,2312 @@
     3.4 +# Doxyfile 1.8.7
     3.5 +
     3.6 +# This file describes the settings to be used by the documentation system
     3.7 +# doxygen (www.doxygen.org) for a project.
     3.8 +#
     3.9 +# All text after a double hash (##) is considered a comment and is placed in
    3.10 +# front of the TAG it is preceding.
    3.11 +#
    3.12 +# All text after a single hash (#) is considered a comment and will be ignored.
    3.13 +# The format is:
    3.14 +# TAG = value [value, ...]
    3.15 +# For lists, items can also be appended using:
    3.16 +# TAG += value [value, ...]
    3.17 +# Values that contain spaces should be placed between quotes (\" \").
    3.18 +
    3.19 +#---------------------------------------------------------------------------
    3.20 +# Project related configuration options
    3.21 +#---------------------------------------------------------------------------
    3.22 +
    3.23 +# This tag specifies the encoding used for all characters in the config file
    3.24 +# that follow. The default is UTF-8 which is also the encoding used for all text
    3.25 +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
    3.26 +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
    3.27 +# for the list of possible encodings.
    3.28 +# The default value is: UTF-8.
    3.29 +
    3.30 +DOXYFILE_ENCODING      = UTF-8
    3.31 +
    3.32 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
    3.33 +# double-quotes, unless you are using Doxywizard) that should identify the
    3.34 +# project for which the documentation is generated. This name is used in the
    3.35 +# title of most generated pages and in a few other places.
    3.36 +# The default value is: My Project.
    3.37 +
    3.38 +PROJECT_NAME           = "ucx"
    3.39 +
    3.40 +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
    3.41 +# could be handy for archiving the generated documentation or if some version
    3.42 +# control system is used.
    3.43 +
    3.44 +PROJECT_NUMBER         =
    3.45 +
    3.46 +# Using the PROJECT_BRIEF tag one can provide an optional one line description
    3.47 +# for a project that appears at the top of each page and should give viewer a
    3.48 +# quick idea about the purpose of the project. Keep the description short.
    3.49 +
    3.50 +PROJECT_BRIEF          = "UAP Common Extensions"
    3.51 +
    3.52 +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
    3.53 +# the documentation. The maximum height of the logo should not exceed 55 pixels
    3.54 +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
    3.55 +# to the output directory.
    3.56 +
    3.57 +PROJECT_LOGO           = @DOXY_PROJECT_LOGO@
    3.58 +
    3.59 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
    3.60 +# into which the generated documentation will be written. If a relative path is
    3.61 +# entered, it will be relative to the location where doxygen was started. If
    3.62 +# left blank the current directory will be used.
    3.63 +
    3.64 +OUTPUT_DIRECTORY       = @DOXY_OUTPUT_DIRECTORY@
    3.65 +
    3.66 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
    3.67 +# directories (in 2 levels) under the output directory of each output format and
    3.68 +# will distribute the generated files over these directories. Enabling this
    3.69 +# option can be useful when feeding doxygen a huge amount of source files, where
    3.70 +# putting all generated files in the same directory would otherwise causes
    3.71 +# performance problems for the file system.
    3.72 +# The default value is: NO.
    3.73 +
    3.74 +CREATE_SUBDIRS         = NO
    3.75 +
    3.76 +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
    3.77 +# characters to appear in the names of generated files. If set to NO, non-ASCII
    3.78 +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
    3.79 +# U+3044.
    3.80 +# The default value is: NO.
    3.81 +
    3.82 +ALLOW_UNICODE_NAMES    = NO
    3.83 +
    3.84 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
    3.85 +# documentation generated by doxygen is written. Doxygen will use this
    3.86 +# information to generate all constant output in the proper language.
    3.87 +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
    3.88 +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
    3.89 +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
    3.90 +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
    3.91 +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
    3.92 +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
    3.93 +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
    3.94 +# Ukrainian and Vietnamese.
    3.95 +# The default value is: English.
    3.96 +
    3.97 +OUTPUT_LANGUAGE        = English
    3.98 +
    3.99 +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
   3.100 +# descriptions after the members that are listed in the file and class
   3.101 +# documentation (similar to Javadoc). Set to NO to disable this.
   3.102 +# The default value is: YES.
   3.103 +
   3.104 +BRIEF_MEMBER_DESC      = YES
   3.105 +
   3.106 +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
   3.107 +# description of a member or function before the detailed description
   3.108 +#
   3.109 +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
   3.110 +# brief descriptions will be completely suppressed.
   3.111 +# The default value is: YES.
   3.112 +
   3.113 +REPEAT_BRIEF           = YES
   3.114 +
   3.115 +# This tag implements a quasi-intelligent brief description abbreviator that is
   3.116 +# used to form the text in various listings. Each string in this list, if found
   3.117 +# as the leading text of the brief description, will be stripped from the text
   3.118 +# and the result, after processing the whole list, is used as the annotated
   3.119 +# text. Otherwise, the brief description is used as-is. If left blank, the
   3.120 +# following values are used ($name is automatically replaced with the name of
   3.121 +# the entity):The $name class, The $name widget, The $name file, is, provides,
   3.122 +# specifies, contains, represents, a, an and the.
   3.123 +
   3.124 +ABBREVIATE_BRIEF       =
   3.125 +
   3.126 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
   3.127 +# doxygen will generate a detailed section even if there is only a brief
   3.128 +# description.
   3.129 +# The default value is: NO.
   3.130 +
   3.131 +ALWAYS_DETAILED_SEC    = NO
   3.132 +
   3.133 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
   3.134 +# inherited members of a class in the documentation of that class as if those
   3.135 +# members were ordinary class members. Constructors, destructors and assignment
   3.136 +# operators of the base classes will not be shown.
   3.137 +# The default value is: NO.
   3.138 +
   3.139 +INLINE_INHERITED_MEMB  = NO
   3.140 +
   3.141 +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
   3.142 +# before files name in the file list and in the header files. If set to NO the
   3.143 +# shortest path that makes the file name unique will be used
   3.144 +# The default value is: YES.
   3.145 +
   3.146 +FULL_PATH_NAMES        = YES
   3.147 +
   3.148 +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
   3.149 +# Stripping is only done if one of the specified strings matches the left-hand
   3.150 +# part of the path. The tag can be used to show relative paths in the file list.
   3.151 +# If left blank the directory from which doxygen is run is used as the path to
   3.152 +# strip.
   3.153 +#
   3.154 +# Note that you can specify absolute paths here, but also relative paths, which
   3.155 +# will be relative from the directory where doxygen is started.
   3.156 +# This tag requires that the tag FULL_PATH_NAMES is set to YES.
   3.157 +
   3.158 +STRIP_FROM_PATH        =
   3.159 +
   3.160 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
   3.161 +# path mentioned in the documentation of a class, which tells the reader which
   3.162 +# header file to include in order to use a class. If left blank only the name of
   3.163 +# the header file containing the class definition is used. Otherwise one should
   3.164 +# specify the list of include paths that are normally passed to the compiler
   3.165 +# using the -I flag.
   3.166 +
   3.167 +STRIP_FROM_INC_PATH    =
   3.168 +
   3.169 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
   3.170 +# less readable) file names. This can be useful is your file systems doesn't
   3.171 +# support long names like on DOS, Mac, or CD-ROM.
   3.172 +# The default value is: NO.
   3.173 +
   3.174 +SHORT_NAMES            = NO
   3.175 +
   3.176 +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
   3.177 +# first line (until the first dot) of a Javadoc-style comment as the brief
   3.178 +# description. If set to NO, the Javadoc-style will behave just like regular Qt-
   3.179 +# style comments (thus requiring an explicit @brief command for a brief
   3.180 +# description.)
   3.181 +# The default value is: NO.
   3.182 +
   3.183 +JAVADOC_AUTOBRIEF      = YES
   3.184 +
   3.185 +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
   3.186 +# line (until the first dot) of a Qt-style comment as the brief description. If
   3.187 +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
   3.188 +# requiring an explicit \brief command for a brief description.)
   3.189 +# The default value is: NO.
   3.190 +
   3.191 +QT_AUTOBRIEF           = NO
   3.192 +
   3.193 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
   3.194 +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
   3.195 +# a brief description. This used to be the default behavior. The new default is
   3.196 +# to treat a multi-line C++ comment block as a detailed description. Set this
   3.197 +# tag to YES if you prefer the old behavior instead.
   3.198 +#
   3.199 +# Note that setting this tag to YES also means that rational rose comments are
   3.200 +# not recognized any more.
   3.201 +# The default value is: NO.
   3.202 +
   3.203 +MULTILINE_CPP_IS_BRIEF = NO
   3.204 +
   3.205 +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
   3.206 +# documentation from any documented member that it re-implements.
   3.207 +# The default value is: YES.
   3.208 +
   3.209 +INHERIT_DOCS           = YES
   3.210 +
   3.211 +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
   3.212 +# new page for each member. If set to NO, the documentation of a member will be
   3.213 +# part of the file/class/namespace that contains it.
   3.214 +# The default value is: NO.
   3.215 +
   3.216 +SEPARATE_MEMBER_PAGES  = NO
   3.217 +
   3.218 +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
   3.219 +# uses this value to replace tabs by spaces in code fragments.
   3.220 +# Minimum value: 1, maximum value: 16, default value: 4.
   3.221 +
   3.222 +TAB_SIZE               = 4
   3.223 +
   3.224 +# This tag can be used to specify a number of aliases that act as commands in
   3.225 +# the documentation. An alias has the form:
   3.226 +# name=value
   3.227 +# For example adding
   3.228 +# "sideeffect=@par Side Effects:\n"
   3.229 +# will allow you to put the command \sideeffect (or @sideeffect) in the
   3.230 +# documentation, which will result in a user-defined paragraph with heading
   3.231 +# "Side Effects:". You can put \n's in the value part of an alias to insert
   3.232 +# newlines.
   3.233 +
   3.234 +ALIASES                =
   3.235 +
   3.236 +# This tag can be used to specify a number of word-keyword mappings (TCL only).
   3.237 +# A mapping has the form "name=value". For example adding "class=itcl::class"
   3.238 +# will allow you to use the command class in the itcl::class meaning.
   3.239 +
   3.240 +TCL_SUBST              =
   3.241 +
   3.242 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
   3.243 +# only. Doxygen will then generate output that is more tailored for C. For
   3.244 +# instance, some of the names that are used will be different. The list of all
   3.245 +# members will be omitted, etc.
   3.246 +# The default value is: NO.
   3.247 +
   3.248 +OPTIMIZE_OUTPUT_FOR_C  = YES
   3.249 +
   3.250 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
   3.251 +# Python sources only. Doxygen will then generate output that is more tailored
   3.252 +# for that language. For instance, namespaces will be presented as packages,
   3.253 +# qualified scopes will look different, etc.
   3.254 +# The default value is: NO.
   3.255 +
   3.256 +OPTIMIZE_OUTPUT_JAVA   = NO
   3.257 +
   3.258 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
   3.259 +# sources. Doxygen will then generate output that is tailored for Fortran.
   3.260 +# The default value is: NO.
   3.261 +
   3.262 +OPTIMIZE_FOR_FORTRAN   = NO
   3.263 +
   3.264 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
   3.265 +# sources. Doxygen will then generate output that is tailored for VHDL.
   3.266 +# The default value is: NO.
   3.267 +
   3.268 +OPTIMIZE_OUTPUT_VHDL   = NO
   3.269 +
   3.270 +# Doxygen selects the parser to use depending on the extension of the files it
   3.271 +# parses. With this tag you can assign which parser to use for a given
   3.272 +# extension. Doxygen has a built-in mapping, but you can override or extend it
   3.273 +# using this tag. The format is ext=language, where ext is a file extension, and
   3.274 +# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
   3.275 +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
   3.276 +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
   3.277 +# Fortran. In the later case the parser tries to guess whether the code is fixed
   3.278 +# or free formatted code, this is the default for Fortran type files), VHDL. For
   3.279 +# instance to make doxygen treat .inc files as Fortran files (default is PHP),
   3.280 +# and .f files as C (default is Fortran), use: inc=Fortran f=C.
   3.281 +#
   3.282 +# Note For files without extension you can use no_extension as a placeholder.
   3.283 +#
   3.284 +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
   3.285 +# the files are not read by doxygen.
   3.286 +
   3.287 +EXTENSION_MAPPING      =
   3.288 +
   3.289 +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
   3.290 +# according to the Markdown format, which allows for more readable
   3.291 +# documentation. See http://daringfireball.net/projects/markdown/ for details.
   3.292 +# The output of markdown processing is further processed by doxygen, so you can
   3.293 +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
   3.294 +# case of backward compatibilities issues.
   3.295 +# The default value is: YES.
   3.296 +
   3.297 +MARKDOWN_SUPPORT       = YES
   3.298 +
   3.299 +# When enabled doxygen tries to link words that correspond to documented
   3.300 +# classes, or namespaces to their corresponding documentation. Such a link can
   3.301 +# be prevented in individual cases by by putting a % sign in front of the word
   3.302 +# or globally by setting AUTOLINK_SUPPORT to NO.
   3.303 +# The default value is: YES.
   3.304 +
   3.305 +AUTOLINK_SUPPORT       = YES
   3.306 +
   3.307 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
   3.308 +# to include (a tag file for) the STL sources as input, then you should set this
   3.309 +# tag to YES in order to let doxygen match functions declarations and
   3.310 +# definitions whose arguments contain STL classes (e.g. func(std::string);
   3.311 +# versus func(std::string) {}). This also make the inheritance and collaboration
   3.312 +# diagrams that involve STL classes more complete and accurate.
   3.313 +# The default value is: NO.
   3.314 +
   3.315 +BUILTIN_STL_SUPPORT    = NO
   3.316 +
   3.317 +# If you use Microsoft's C++/CLI language, you should set this option to YES to
   3.318 +# enable parsing support.
   3.319 +# The default value is: NO.
   3.320 +
   3.321 +CPP_CLI_SUPPORT        = NO
   3.322 +
   3.323 +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
   3.324 +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
   3.325 +# will parse them like normal C++ but will assume all classes use public instead
   3.326 +# of private inheritance when no explicit protection keyword is present.
   3.327 +# The default value is: NO.
   3.328 +
   3.329 +SIP_SUPPORT            = NO
   3.330 +
   3.331 +# For Microsoft's IDL there are propget and propput attributes to indicate
   3.332 +# getter and setter methods for a property. Setting this option to YES will make
   3.333 +# doxygen to replace the get and set methods by a property in the documentation.
   3.334 +# This will only work if the methods are indeed getting or setting a simple
   3.335 +# type. If this is not the case, or you want to show the methods anyway, you
   3.336 +# should set this option to NO.
   3.337 +# The default value is: YES.
   3.338 +
   3.339 +IDL_PROPERTY_SUPPORT   = YES
   3.340 +
   3.341 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
   3.342 +# tag is set to YES, then doxygen will reuse the documentation of the first
   3.343 +# member in the group (if any) for the other members of the group. By default
   3.344 +# all members of a group must be documented explicitly.
   3.345 +# The default value is: NO.
   3.346 +
   3.347 +DISTRIBUTE_GROUP_DOC   = NO
   3.348 +
   3.349 +# Set the SUBGROUPING tag to YES to allow class member groups of the same type
   3.350 +# (for instance a group of public functions) to be put as a subgroup of that
   3.351 +# type (e.g. under the Public Functions section). Set it to NO to prevent
   3.352 +# subgrouping. Alternatively, this can be done per class using the
   3.353 +# \nosubgrouping command.
   3.354 +# The default value is: YES.
   3.355 +
   3.356 +SUBGROUPING            = YES
   3.357 +
   3.358 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
   3.359 +# are shown inside the group in which they are included (e.g. using \ingroup)
   3.360 +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
   3.361 +# and RTF).
   3.362 +#
   3.363 +# Note that this feature does not work in combination with
   3.364 +# SEPARATE_MEMBER_PAGES.
   3.365 +# The default value is: NO.
   3.366 +
   3.367 +INLINE_GROUPED_CLASSES = NO
   3.368 +
   3.369 +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
   3.370 +# with only public data fields or simple typedef fields will be shown inline in
   3.371 +# the documentation of the scope in which they are defined (i.e. file,
   3.372 +# namespace, or group documentation), provided this scope is documented. If set
   3.373 +# to NO, structs, classes, and unions are shown on a separate page (for HTML and
   3.374 +# Man pages) or section (for LaTeX and RTF).
   3.375 +# The default value is: NO.
   3.376 +
   3.377 +INLINE_SIMPLE_STRUCTS  = NO
   3.378 +
   3.379 +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
   3.380 +# enum is documented as struct, union, or enum with the name of the typedef. So
   3.381 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
   3.382 +# with name TypeT. When disabled the typedef will appear as a member of a file,
   3.383 +# namespace, or class. And the struct will be named TypeS. This can typically be
   3.384 +# useful for C code in case the coding convention dictates that all compound
   3.385 +# types are typedef'ed and only the typedef is referenced, never the tag name.
   3.386 +# The default value is: NO.
   3.387 +
   3.388 +TYPEDEF_HIDES_STRUCT   = NO
   3.389 +
   3.390 +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
   3.391 +# cache is used to resolve symbols given their name and scope. Since this can be
   3.392 +# an expensive process and often the same symbol appears multiple times in the
   3.393 +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
   3.394 +# doxygen will become slower. If the cache is too large, memory is wasted. The
   3.395 +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
   3.396 +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
   3.397 +# symbols. At the end of a run doxygen will report the cache usage and suggest
   3.398 +# the optimal cache size from a speed point of view.
   3.399 +# Minimum value: 0, maximum value: 9, default value: 0.
   3.400 +
   3.401 +LOOKUP_CACHE_SIZE      = 0
   3.402 +
   3.403 +#---------------------------------------------------------------------------
   3.404 +# Build related configuration options
   3.405 +#---------------------------------------------------------------------------
   3.406 +
   3.407 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
   3.408 +# documentation are documented, even if no documentation was available. Private
   3.409 +# class members and static file members will be hidden unless the
   3.410 +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
   3.411 +# Note: This will also disable the warnings about undocumented members that are
   3.412 +# normally produced when WARNINGS is set to YES.
   3.413 +# The default value is: NO.
   3.414 +
   3.415 +EXTRACT_ALL            = NO
   3.416 +
   3.417 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
   3.418 +# be included in the documentation.
   3.419 +# The default value is: NO.
   3.420 +
   3.421 +EXTRACT_PRIVATE        = NO
   3.422 +
   3.423 +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
   3.424 +# scope will be included in the documentation.
   3.425 +# The default value is: NO.
   3.426 +
   3.427 +EXTRACT_PACKAGE        = NO
   3.428 +
   3.429 +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
   3.430 +# included in the documentation.
   3.431 +# The default value is: NO.
   3.432 +
   3.433 +EXTRACT_STATIC         = NO
   3.434 +
   3.435 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
   3.436 +# locally in source files will be included in the documentation. If set to NO
   3.437 +# only classes defined in header files are included. Does not have any effect
   3.438 +# for Java sources.
   3.439 +# The default value is: YES.
   3.440 +
   3.441 +EXTRACT_LOCAL_CLASSES  = YES
   3.442 +
   3.443 +# This flag is only useful for Objective-C code. When set to YES local methods,
   3.444 +# which are defined in the implementation section but not in the interface are
   3.445 +# included in the documentation. If set to NO only methods in the interface are
   3.446 +# included.
   3.447 +# The default value is: NO.
   3.448 +
   3.449 +EXTRACT_LOCAL_METHODS  = NO
   3.450 +
   3.451 +# If this flag is set to YES, the members of anonymous namespaces will be
   3.452 +# extracted and appear in the documentation as a namespace called
   3.453 +# 'anonymous_namespace{file}', where file will be replaced with the base name of
   3.454 +# the file that contains the anonymous namespace. By default anonymous namespace
   3.455 +# are hidden.
   3.456 +# The default value is: NO.
   3.457 +
   3.458 +EXTRACT_ANON_NSPACES   = NO
   3.459 +
   3.460 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
   3.461 +# undocumented members inside documented classes or files. If set to NO these
   3.462 +# members will be included in the various overviews, but no documentation
   3.463 +# section is generated. This option has no effect if EXTRACT_ALL is enabled.
   3.464 +# The default value is: NO.
   3.465 +
   3.466 +HIDE_UNDOC_MEMBERS     = NO
   3.467 +
   3.468 +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
   3.469 +# undocumented classes that are normally visible in the class hierarchy. If set
   3.470 +# to NO these classes will be included in the various overviews. This option has
   3.471 +# no effect if EXTRACT_ALL is enabled.
   3.472 +# The default value is: NO.
   3.473 +
   3.474 +HIDE_UNDOC_CLASSES     = NO
   3.475 +
   3.476 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
   3.477 +# (class|struct|union) declarations. If set to NO these declarations will be
   3.478 +# included in the documentation.
   3.479 +# The default value is: NO.
   3.480 +
   3.481 +HIDE_FRIEND_COMPOUNDS  = NO
   3.482 +
   3.483 +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
   3.484 +# documentation blocks found inside the body of a function. If set to NO these
   3.485 +# blocks will be appended to the function's detailed documentation block.
   3.486 +# The default value is: NO.
   3.487 +
   3.488 +HIDE_IN_BODY_DOCS      = NO
   3.489 +
   3.490 +# The INTERNAL_DOCS tag determines if documentation that is typed after a
   3.491 +# \internal command is included. If the tag is set to NO then the documentation
   3.492 +# will be excluded. Set it to YES to include the internal documentation.
   3.493 +# The default value is: NO.
   3.494 +
   3.495 +INTERNAL_DOCS          = NO
   3.496 +
   3.497 +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
   3.498 +# names in lower-case letters. If set to YES upper-case letters are also
   3.499 +# allowed. This is useful if you have classes or files whose names only differ
   3.500 +# in case and if your file system supports case sensitive file names. Windows
   3.501 +# and Mac users are advised to set this option to NO.
   3.502 +# The default value is: system dependent.
   3.503 +
   3.504 +CASE_SENSE_NAMES       = YES
   3.505 +
   3.506 +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
   3.507 +# their full class and namespace scopes in the documentation. If set to YES the
   3.508 +# scope will be hidden.
   3.509 +# The default value is: NO.
   3.510 +
   3.511 +HIDE_SCOPE_NAMES       = NO
   3.512 +
   3.513 +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
   3.514 +# the files that are included by a file in the documentation of that file.
   3.515 +# The default value is: YES.
   3.516 +
   3.517 +SHOW_INCLUDE_FILES     = YES
   3.518 +
   3.519 +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
   3.520 +# grouped member an include statement to the documentation, telling the reader
   3.521 +# which file to include in order to use the member.
   3.522 +# The default value is: NO.
   3.523 +
   3.524 +SHOW_GROUPED_MEMB_INC  = NO
   3.525 +
   3.526 +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
   3.527 +# files with double quotes in the documentation rather than with sharp brackets.
   3.528 +# The default value is: NO.
   3.529 +
   3.530 +FORCE_LOCAL_INCLUDES   = NO
   3.531 +
   3.532 +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
   3.533 +# documentation for inline members.
   3.534 +# The default value is: YES.
   3.535 +
   3.536 +INLINE_INFO            = YES
   3.537 +
   3.538 +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
   3.539 +# (detailed) documentation of file and class members alphabetically by member
   3.540 +# name. If set to NO the members will appear in declaration order.
   3.541 +# The default value is: YES.
   3.542 +
   3.543 +SORT_MEMBER_DOCS       = YES
   3.544 +
   3.545 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
   3.546 +# descriptions of file, namespace and class members alphabetically by member
   3.547 +# name. If set to NO the members will appear in declaration order. Note that
   3.548 +# this will also influence the order of the classes in the class list.
   3.549 +# The default value is: NO.
   3.550 +
   3.551 +SORT_BRIEF_DOCS        = NO
   3.552 +
   3.553 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
   3.554 +# (brief and detailed) documentation of class members so that constructors and
   3.555 +# destructors are listed first. If set to NO the constructors will appear in the
   3.556 +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
   3.557 +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
   3.558 +# member documentation.
   3.559 +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
   3.560 +# detailed member documentation.
   3.561 +# The default value is: NO.
   3.562 +
   3.563 +SORT_MEMBERS_CTORS_1ST = NO
   3.564 +
   3.565 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
   3.566 +# of group names into alphabetical order. If set to NO the group names will
   3.567 +# appear in their defined order.
   3.568 +# The default value is: NO.
   3.569 +
   3.570 +SORT_GROUP_NAMES       = NO
   3.571 +
   3.572 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
   3.573 +# fully-qualified names, including namespaces. If set to NO, the class list will
   3.574 +# be sorted only by class name, not including the namespace part.
   3.575 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
   3.576 +# Note: This option applies only to the class list, not to the alphabetical
   3.577 +# list.
   3.578 +# The default value is: NO.
   3.579 +
   3.580 +SORT_BY_SCOPE_NAME     = NO
   3.581 +
   3.582 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
   3.583 +# type resolution of all parameters of a function it will reject a match between
   3.584 +# the prototype and the implementation of a member function even if there is
   3.585 +# only one candidate or it is obvious which candidate to choose by doing a
   3.586 +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
   3.587 +# accept a match between prototype and implementation in such cases.
   3.588 +# The default value is: NO.
   3.589 +
   3.590 +STRICT_PROTO_MATCHING  = NO
   3.591 +
   3.592 +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
   3.593 +# todo list. This list is created by putting \todo commands in the
   3.594 +# documentation.
   3.595 +# The default value is: YES.
   3.596 +
   3.597 +GENERATE_TODOLIST      = YES
   3.598 +
   3.599 +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
   3.600 +# test list. This list is created by putting \test commands in the
   3.601 +# documentation.
   3.602 +# The default value is: YES.
   3.603 +
   3.604 +GENERATE_TESTLIST      = YES
   3.605 +
   3.606 +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
   3.607 +# list. This list is created by putting \bug commands in the documentation.
   3.608 +# The default value is: YES.
   3.609 +
   3.610 +GENERATE_BUGLIST       = YES
   3.611 +
   3.612 +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
   3.613 +# the deprecated list. This list is created by putting \deprecated commands in
   3.614 +# the documentation.
   3.615 +# The default value is: YES.
   3.616 +
   3.617 +GENERATE_DEPRECATEDLIST= YES
   3.618 +
   3.619 +# The ENABLED_SECTIONS tag can be used to enable conditional documentation
   3.620 +# sections, marked by \if <section_label> ... \endif and \cond <section_label>
   3.621 +# ... \endcond blocks.
   3.622 +
   3.623 +ENABLED_SECTIONS       =
   3.624 +
   3.625 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
   3.626 +# initial value of a variable or macro / define can have for it to appear in the
   3.627 +# documentation. If the initializer consists of more lines than specified here
   3.628 +# it will be hidden. Use a value of 0 to hide initializers completely. The
   3.629 +# appearance of the value of individual variables and macros / defines can be
   3.630 +# controlled using \showinitializer or \hideinitializer command in the
   3.631 +# documentation regardless of this setting.
   3.632 +# Minimum value: 0, maximum value: 10000, default value: 30.
   3.633 +
   3.634 +MAX_INITIALIZER_LINES  = 30
   3.635 +
   3.636 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
   3.637 +# the bottom of the documentation of classes and structs. If set to YES the list
   3.638 +# will mention the files that were used to generate the documentation.
   3.639 +# The default value is: YES.
   3.640 +
   3.641 +SHOW_USED_FILES        = YES
   3.642 +
   3.643 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
   3.644 +# will remove the Files entry from the Quick Index and from the Folder Tree View
   3.645 +# (if specified).
   3.646 +# The default value is: YES.
   3.647 +
   3.648 +SHOW_FILES             = YES
   3.649 +
   3.650 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
   3.651 +# page. This will remove the Namespaces entry from the Quick Index and from the
   3.652 +# Folder Tree View (if specified).
   3.653 +# The default value is: YES.
   3.654 +
   3.655 +SHOW_NAMESPACES        = YES
   3.656 +
   3.657 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that
   3.658 +# doxygen should invoke to get the current version for each file (typically from
   3.659 +# the version control system). Doxygen will invoke the program by executing (via
   3.660 +# popen()) the command command input-file, where command is the value of the
   3.661 +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
   3.662 +# by doxygen. Whatever the program writes to standard output is used as the file
   3.663 +# version. For an example see the documentation.
   3.664 +
   3.665 +FILE_VERSION_FILTER    =
   3.666 +
   3.667 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
   3.668 +# by doxygen. The layout file controls the global structure of the generated
   3.669 +# output files in an output format independent way. To create the layout file
   3.670 +# that represents doxygen's defaults, run doxygen with the -l option. You can
   3.671 +# optionally specify a file name after the option, if omitted DoxygenLayout.xml
   3.672 +# will be used as the name of the layout file.
   3.673 +#
   3.674 +# Note that if you run doxygen from a directory containing a file called
   3.675 +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
   3.676 +# tag is left empty.
   3.677 +
   3.678 +LAYOUT_FILE            =
   3.679 +
   3.680 +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
   3.681 +# the reference definitions. This must be a list of .bib files. The .bib
   3.682 +# extension is automatically appended if omitted. This requires the bibtex tool
   3.683 +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
   3.684 +# For LaTeX the style of the bibliography can be controlled using
   3.685 +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
   3.686 +# search path. Do not use file names with spaces, bibtex cannot handle them. See
   3.687 +# also \cite for info how to create references.
   3.688 +
   3.689 +CITE_BIB_FILES         =
   3.690 +
   3.691 +#---------------------------------------------------------------------------
   3.692 +# Configuration options related to warning and progress messages
   3.693 +#---------------------------------------------------------------------------
   3.694 +
   3.695 +# The QUIET tag can be used to turn on/off the messages that are generated to
   3.696 +# standard output by doxygen. If QUIET is set to YES this implies that the
   3.697 +# messages are off.
   3.698 +# The default value is: NO.
   3.699 +
   3.700 +QUIET                  = YES
   3.701 +
   3.702 +# The WARNINGS tag can be used to turn on/off the warning messages that are
   3.703 +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
   3.704 +# this implies that the warnings are on.
   3.705 +#
   3.706 +# Tip: Turn warnings on while writing the documentation.
   3.707 +# The default value is: YES.
   3.708 +
   3.709 +WARNINGS               = YES
   3.710 +
   3.711 +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
   3.712 +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
   3.713 +# will automatically be disabled.
   3.714 +# The default value is: YES.
   3.715 +
   3.716 +WARN_IF_UNDOCUMENTED   = YES
   3.717 +
   3.718 +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
   3.719 +# potential errors in the documentation, such as not documenting some parameters
   3.720 +# in a documented function, or documenting parameters that don't exist or using
   3.721 +# markup commands wrongly.
   3.722 +# The default value is: YES.
   3.723 +
   3.724 +WARN_IF_DOC_ERROR      = YES
   3.725 +
   3.726 +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
   3.727 +# are documented, but have no documentation for their parameters or return
   3.728 +# value. If set to NO doxygen will only warn about wrong or incomplete parameter
   3.729 +# documentation, but not about the absence of documentation.
   3.730 +# The default value is: NO.
   3.731 +
   3.732 +WARN_NO_PARAMDOC       = YES
   3.733 +
   3.734 +# The WARN_FORMAT tag determines the format of the warning messages that doxygen
   3.735 +# can produce. The string should contain the $file, $line, and $text tags, which
   3.736 +# will be replaced by the file and line number from which the warning originated
   3.737 +# and the warning text. Optionally the format may contain $version, which will
   3.738 +# be replaced by the version of the file (if it could be obtained via
   3.739 +# FILE_VERSION_FILTER)
   3.740 +# The default value is: $file:$line: $text.
   3.741 +
   3.742 +WARN_FORMAT            = "$file:$line: $text"
   3.743 +
   3.744 +# The WARN_LOGFILE tag can be used to specify a file to which warning and error
   3.745 +# messages should be written. If left blank the output is written to standard
   3.746 +# error (stderr).
   3.747 +
   3.748 +WARN_LOGFILE           =
   3.749 +
   3.750 +#---------------------------------------------------------------------------
   3.751 +# Configuration options related to the input files
   3.752 +#---------------------------------------------------------------------------
   3.753 +
   3.754 +# The INPUT tag is used to specify the files and/or directories that contain
   3.755 +# documented source files. You may enter file names like myfile.cpp or
   3.756 +# directories like /usr/src/myproject. Separate the files or directories with
   3.757 +# spaces.
   3.758 +# Note: If this tag is empty the current directory is searched.
   3.759 +
   3.760 +INPUT                  = @DOXY_INPUT@
   3.761 +
   3.762 +# This tag can be used to specify the character encoding of the source files
   3.763 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
   3.764 +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
   3.765 +# documentation (see: http://www.gnu.org/software/libiconv) for the list of
   3.766 +# possible encodings.
   3.767 +# The default value is: UTF-8.
   3.768 +
   3.769 +INPUT_ENCODING         = UTF-8
   3.770 +
   3.771 +# If the value of the INPUT tag contains directories, you can use the
   3.772 +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
   3.773 +# *.h) to filter out the source-files in the directories. If left blank the
   3.774 +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
   3.775 +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
   3.776 +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
   3.777 +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
   3.778 +# *.qsf, *.as and *.js.
   3.779 +
   3.780 +FILE_PATTERNS          =
   3.781 +
   3.782 +# The RECURSIVE tag can be used to specify whether or not subdirectories should
   3.783 +# be searched for input files as well.
   3.784 +# The default value is: NO.
   3.785 +
   3.786 +RECURSIVE              = YES
   3.787 +
   3.788 +# The EXCLUDE tag can be used to specify files and/or directories that should be
   3.789 +# excluded from the INPUT source files. This way you can easily exclude a
   3.790 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
   3.791 +#
   3.792 +# Note that relative paths are relative to the directory from which doxygen is
   3.793 +# run.
   3.794 +
   3.795 +EXCLUDE                =
   3.796 +
   3.797 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
   3.798 +# directories that are symbolic links (a Unix file system feature) are excluded
   3.799 +# from the input.
   3.800 +# The default value is: NO.
   3.801 +
   3.802 +EXCLUDE_SYMLINKS       = NO
   3.803 +
   3.804 +# If the value of the INPUT tag contains directories, you can use the
   3.805 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
   3.806 +# certain files from those directories.
   3.807 +#
   3.808 +# Note that the wildcards are matched against the file with absolute path, so to
   3.809 +# exclude all test directories for example use the pattern */test/*
   3.810 +
   3.811 +EXCLUDE_PATTERNS       =
   3.812 +
   3.813 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
   3.814 +# (namespaces, classes, functions, etc.) that should be excluded from the
   3.815 +# output. The symbol name can be a fully qualified name, a word, or if the
   3.816 +# wildcard * is used, a substring. Examples: ANamespace, AClass,
   3.817 +# AClass::ANamespace, ANamespace::*Test
   3.818 +#
   3.819 +# Note that the wildcards are matched against the file with absolute path, so to
   3.820 +# exclude all test directories use the pattern */test/*
   3.821 +
   3.822 +EXCLUDE_SYMBOLS        =
   3.823 +
   3.824 +# The EXAMPLE_PATH tag can be used to specify one or more files or directories
   3.825 +# that contain example code fragments that are included (see the \include
   3.826 +# command).
   3.827 +
   3.828 +EXAMPLE_PATH           =
   3.829 +
   3.830 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
   3.831 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
   3.832 +# *.h) to filter out the source-files in the directories. If left blank all
   3.833 +# files are included.
   3.834 +
   3.835 +EXAMPLE_PATTERNS       =
   3.836 +
   3.837 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
   3.838 +# searched for input files to be used with the \include or \dontinclude commands
   3.839 +# irrespective of the value of the RECURSIVE tag.
   3.840 +# The default value is: NO.
   3.841 +
   3.842 +EXAMPLE_RECURSIVE      = NO
   3.843 +
   3.844 +# The IMAGE_PATH tag can be used to specify one or more files or directories
   3.845 +# that contain images that are to be included in the documentation (see the
   3.846 +# \image command).
   3.847 +
   3.848 +IMAGE_PATH             =
   3.849 +
   3.850 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
   3.851 +# invoke to filter for each input file. Doxygen will invoke the filter program
   3.852 +# by executing (via popen()) the command:
   3.853 +#
   3.854 +# <filter> <input-file>
   3.855 +#
   3.856 +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
   3.857 +# name of an input file. Doxygen will then use the output that the filter
   3.858 +# program writes to standard output. If FILTER_PATTERNS is specified, this tag
   3.859 +# will be ignored.
   3.860 +#
   3.861 +# Note that the filter must not add or remove lines; it is applied before the
   3.862 +# code is scanned, but not when the output code is generated. If lines are added
   3.863 +# or removed, the anchors will not be placed correctly.
   3.864 +
   3.865 +INPUT_FILTER           =
   3.866 +
   3.867 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
   3.868 +# basis. Doxygen will compare the file name with each pattern and apply the
   3.869 +# filter if there is a match. The filters are a list of the form: pattern=filter
   3.870 +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
   3.871 +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
   3.872 +# patterns match the file name, INPUT_FILTER is applied.
   3.873 +
   3.874 +FILTER_PATTERNS        =
   3.875 +
   3.876 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
   3.877 +# INPUT_FILTER ) will also be used to filter the input files that are used for
   3.878 +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
   3.879 +# The default value is: NO.
   3.880 +
   3.881 +FILTER_SOURCE_FILES    = NO
   3.882 +
   3.883 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
   3.884 +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
   3.885 +# it is also possible to disable source filtering for a specific pattern using
   3.886 +# *.ext= (so without naming a filter).
   3.887 +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
   3.888 +
   3.889 +FILTER_SOURCE_PATTERNS =
   3.890 +
   3.891 +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
   3.892 +# is part of the input, its contents will be placed on the main page
   3.893 +# (index.html). This can be useful if you have a project on for instance GitHub
   3.894 +# and want to reuse the introduction page also for the doxygen output.
   3.895 +
   3.896 +USE_MDFILE_AS_MAINPAGE =
   3.897 +
   3.898 +#---------------------------------------------------------------------------
   3.899 +# Configuration options related to source browsing
   3.900 +#---------------------------------------------------------------------------
   3.901 +
   3.902 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
   3.903 +# generated. Documented entities will be cross-referenced with these sources.
   3.904 +#
   3.905 +# Note: To get rid of all source code in the generated output, make sure that
   3.906 +# also VERBATIM_HEADERS is set to NO.
   3.907 +# The default value is: NO.
   3.908 +
   3.909 +SOURCE_BROWSER         = NO
   3.910 +
   3.911 +# Setting the INLINE_SOURCES tag to YES will include the body of functions,
   3.912 +# classes and enums directly into the documentation.
   3.913 +# The default value is: NO.
   3.914 +
   3.915 +INLINE_SOURCES         = NO
   3.916 +
   3.917 +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
   3.918 +# special comment blocks from generated source code fragments. Normal C, C++ and
   3.919 +# Fortran comments will always remain visible.
   3.920 +# The default value is: YES.
   3.921 +
   3.922 +STRIP_CODE_COMMENTS    = YES
   3.923 +
   3.924 +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
   3.925 +# function all documented functions referencing it will be listed.
   3.926 +# The default value is: NO.
   3.927 +
   3.928 +REFERENCED_BY_RELATION = NO
   3.929 +
   3.930 +# If the REFERENCES_RELATION tag is set to YES then for each documented function
   3.931 +# all documented entities called/used by that function will be listed.
   3.932 +# The default value is: NO.
   3.933 +
   3.934 +REFERENCES_RELATION    = NO
   3.935 +
   3.936 +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
   3.937 +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
   3.938 +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
   3.939 +# link to the documentation.
   3.940 +# The default value is: YES.
   3.941 +
   3.942 +REFERENCES_LINK_SOURCE = YES
   3.943 +
   3.944 +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
   3.945 +# source code will show a tooltip with additional information such as prototype,
   3.946 +# brief description and links to the definition and documentation. Since this
   3.947 +# will make the HTML file larger and loading of large files a bit slower, you
   3.948 +# can opt to disable this feature.
   3.949 +# The default value is: YES.
   3.950 +# This tag requires that the tag SOURCE_BROWSER is set to YES.
   3.951 +
   3.952 +SOURCE_TOOLTIPS        = YES
   3.953 +
   3.954 +# If the USE_HTAGS tag is set to YES then the references to source code will
   3.955 +# point to the HTML generated by the htags(1) tool instead of doxygen built-in
   3.956 +# source browser. The htags tool is part of GNU's global source tagging system
   3.957 +# (see http://www.gnu.org/software/global/global.html). You will need version
   3.958 +# 4.8.6 or higher.
   3.959 +#
   3.960 +# To use it do the following:
   3.961 +# - Install the latest version of global
   3.962 +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
   3.963 +# - Make sure the INPUT points to the root of the source tree
   3.964 +# - Run doxygen as normal
   3.965 +#
   3.966 +# Doxygen will invoke htags (and that will in turn invoke gtags), so these
   3.967 +# tools must be available from the command line (i.e. in the search path).
   3.968 +#
   3.969 +# The result: instead of the source browser generated by doxygen, the links to
   3.970 +# source code will now point to the output of htags.
   3.971 +# The default value is: NO.
   3.972 +# This tag requires that the tag SOURCE_BROWSER is set to YES.
   3.973 +
   3.974 +USE_HTAGS              = NO
   3.975 +
   3.976 +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
   3.977 +# verbatim copy of the header file for each class for which an include is
   3.978 +# specified. Set to NO to disable this.
   3.979 +# See also: Section \class.
   3.980 +# The default value is: YES.
   3.981 +
   3.982 +VERBATIM_HEADERS       = YES
   3.983 +
   3.984 +#---------------------------------------------------------------------------
   3.985 +# Configuration options related to the alphabetical class index
   3.986 +#---------------------------------------------------------------------------
   3.987 +
   3.988 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
   3.989 +# compounds will be generated. Enable this if the project contains a lot of
   3.990 +# classes, structs, unions or interfaces.
   3.991 +# The default value is: YES.
   3.992 +
   3.993 +ALPHABETICAL_INDEX     = YES
   3.994 +
   3.995 +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
   3.996 +# which the alphabetical index list will be split.
   3.997 +# Minimum value: 1, maximum value: 20, default value: 5.
   3.998 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
   3.999 +
  3.1000 +COLS_IN_ALPHA_INDEX    = 5
  3.1001 +
  3.1002 +# In case all classes in a project start with a common prefix, all classes will
  3.1003 +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
  3.1004 +# can be used to specify a prefix (or a list of prefixes) that should be ignored
  3.1005 +# while generating the index headers.
  3.1006 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  3.1007 +
  3.1008 +IGNORE_PREFIX          =
  3.1009 +
  3.1010 +#---------------------------------------------------------------------------
  3.1011 +# Configuration options related to the HTML output
  3.1012 +#---------------------------------------------------------------------------
  3.1013 +
  3.1014 +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
  3.1015 +# The default value is: YES.
  3.1016 +
  3.1017 +GENERATE_HTML          = YES
  3.1018 +
  3.1019 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  3.1020 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  3.1021 +# it.
  3.1022 +# The default directory is: html.
  3.1023 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1024 +
  3.1025 +HTML_OUTPUT            = web/api
  3.1026 +
  3.1027 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  3.1028 +# generated HTML page (for example: .htm, .php, .asp).
  3.1029 +# The default value is: .html.
  3.1030 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1031 +
  3.1032 +HTML_FILE_EXTENSION    = .html
  3.1033 +
  3.1034 +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  3.1035 +# each generated HTML page. If the tag is left blank doxygen will generate a
  3.1036 +# standard header.
  3.1037 +#
  3.1038 +# To get valid HTML the header file that includes any scripts and style sheets
  3.1039 +# that doxygen needs, which is dependent on the configuration options used (e.g.
  3.1040 +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  3.1041 +# default header using
  3.1042 +# doxygen -w html new_header.html new_footer.html new_stylesheet.css
  3.1043 +# YourConfigFile
  3.1044 +# and then modify the file new_header.html. See also section "Doxygen usage"
  3.1045 +# for information on how to generate the default header that doxygen normally
  3.1046 +# uses.
  3.1047 +# Note: The header is subject to change so you typically have to regenerate the
  3.1048 +# default header when upgrading to a newer version of doxygen. For a description
  3.1049 +# of the possible markers and block names see the documentation.
  3.1050 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1051 +
  3.1052 +HTML_HEADER            =
  3.1053 +
  3.1054 +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  3.1055 +# generated HTML page. If the tag is left blank doxygen will generate a standard
  3.1056 +# footer. See HTML_HEADER for more information on how to generate a default
  3.1057 +# footer and what special commands can be used inside the footer. See also
  3.1058 +# section "Doxygen usage" for information on how to generate the default footer
  3.1059 +# that doxygen normally uses.
  3.1060 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1061 +
  3.1062 +HTML_FOOTER            =
  3.1063 +
  3.1064 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  3.1065 +# sheet that is used by each HTML page. It can be used to fine-tune the look of
  3.1066 +# the HTML output. If left blank doxygen will generate a default style sheet.
  3.1067 +# See also section "Doxygen usage" for information on how to generate the style
  3.1068 +# sheet that doxygen normally uses.
  3.1069 +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  3.1070 +# it is more robust and this tag (HTML_STYLESHEET) will in the future become
  3.1071 +# obsolete.
  3.1072 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1073 +
  3.1074 +HTML_STYLESHEET        =
  3.1075 +
  3.1076 +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
  3.1077 +# defined cascading style sheet that is included after the standard style sheets
  3.1078 +# created by doxygen. Using this option one can overrule certain style aspects.
  3.1079 +# This is preferred over using HTML_STYLESHEET since it does not replace the
  3.1080 +# standard style sheet and is therefor more robust against future updates.
  3.1081 +# Doxygen will copy the style sheet file to the output directory. For an example
  3.1082 +# see the documentation.
  3.1083 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1084 +
  3.1085 +HTML_EXTRA_STYLESHEET  =
  3.1086 +
  3.1087 +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  3.1088 +# other source files which should be copied to the HTML output directory. Note
  3.1089 +# that these files will be copied to the base HTML output directory. Use the
  3.1090 +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  3.1091 +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  3.1092 +# files will be copied as-is; there are no commands or markers available.
  3.1093 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1094 +
  3.1095 +HTML_EXTRA_FILES       =
  3.1096 +
  3.1097 +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  3.1098 +# will adjust the colors in the stylesheet and background images according to
  3.1099 +# this color. Hue is specified as an angle on a colorwheel, see
  3.1100 +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
  3.1101 +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  3.1102 +# purple, and 360 is red again.
  3.1103 +# Minimum value: 0, maximum value: 359, default value: 220.
  3.1104 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1105 +
  3.1106 +HTML_COLORSTYLE_HUE    = 220
  3.1107 +
  3.1108 +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  3.1109 +# in the HTML output. For a value of 0 the output will use grayscales only. A
  3.1110 +# value of 255 will produce the most vivid colors.
  3.1111 +# Minimum value: 0, maximum value: 255, default value: 100.
  3.1112 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1113 +
  3.1114 +HTML_COLORSTYLE_SAT    = 100
  3.1115 +
  3.1116 +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  3.1117 +# luminance component of the colors in the HTML output. Values below 100
  3.1118 +# gradually make the output lighter, whereas values above 100 make the output
  3.1119 +# darker. The value divided by 100 is the actual gamma applied, so 80 represents
  3.1120 +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  3.1121 +# change the gamma.
  3.1122 +# Minimum value: 40, maximum value: 240, default value: 80.
  3.1123 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1124 +
  3.1125 +HTML_COLORSTYLE_GAMMA  = 80
  3.1126 +
  3.1127 +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  3.1128 +# page will contain the date and time when the page was generated. Setting this
  3.1129 +# to NO can help when comparing the output of multiple runs.
  3.1130 +# The default value is: YES.
  3.1131 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1132 +
  3.1133 +HTML_TIMESTAMP         = YES
  3.1134 +
  3.1135 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  3.1136 +# documentation will contain sections that can be hidden and shown after the
  3.1137 +# page has loaded.
  3.1138 +# The default value is: NO.
  3.1139 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1140 +
  3.1141 +HTML_DYNAMIC_SECTIONS  = NO
  3.1142 +
  3.1143 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
  3.1144 +# shown in the various tree structured indices initially; the user can expand
  3.1145 +# and collapse entries dynamically later on. Doxygen will expand the tree to
  3.1146 +# such a level that at most the specified number of entries are visible (unless
  3.1147 +# a fully collapsed tree already exceeds this amount). So setting the number of
  3.1148 +# entries 1 will produce a full collapsed tree by default. 0 is a special value
  3.1149 +# representing an infinite number of entries and will result in a full expanded
  3.1150 +# tree by default.
  3.1151 +# Minimum value: 0, maximum value: 9999, default value: 100.
  3.1152 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1153 +
  3.1154 +HTML_INDEX_NUM_ENTRIES = 100
  3.1155 +
  3.1156 +# If the GENERATE_DOCSET tag is set to YES, additional index files will be
  3.1157 +# generated that can be used as input for Apple's Xcode 3 integrated development
  3.1158 +# environment (see: http://developer.apple.com/tools/xcode/), introduced with
  3.1159 +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
  3.1160 +# Makefile in the HTML output directory. Running make will produce the docset in
  3.1161 +# that directory and running make install will install the docset in
  3.1162 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
  3.1163 +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  3.1164 +# for more information.
  3.1165 +# The default value is: NO.
  3.1166 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1167 +
  3.1168 +GENERATE_DOCSET        = NO
  3.1169 +
  3.1170 +# This tag determines the name of the docset feed. A documentation feed provides
  3.1171 +# an umbrella under which multiple documentation sets from a single provider
  3.1172 +# (such as a company or product suite) can be grouped.
  3.1173 +# The default value is: Doxygen generated docs.
  3.1174 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  3.1175 +
  3.1176 +DOCSET_FEEDNAME        = "Doxygen generated docs"
  3.1177 +
  3.1178 +# This tag specifies a string that should uniquely identify the documentation
  3.1179 +# set bundle. This should be a reverse domain-name style string, e.g.
  3.1180 +# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  3.1181 +# The default value is: org.doxygen.Project.
  3.1182 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  3.1183 +
  3.1184 +DOCSET_BUNDLE_ID       = org.doxygen.Project
  3.1185 +
  3.1186 +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
  3.1187 +# the documentation publisher. This should be a reverse domain-name style
  3.1188 +# string, e.g. com.mycompany.MyDocSet.documentation.
  3.1189 +# The default value is: org.doxygen.Publisher.
  3.1190 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  3.1191 +
  3.1192 +DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
  3.1193 +
  3.1194 +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
  3.1195 +# The default value is: Publisher.
  3.1196 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  3.1197 +
  3.1198 +DOCSET_PUBLISHER_NAME  = Publisher
  3.1199 +
  3.1200 +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  3.1201 +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  3.1202 +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  3.1203 +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  3.1204 +# Windows.
  3.1205 +#
  3.1206 +# The HTML Help Workshop contains a compiler that can convert all HTML output
  3.1207 +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  3.1208 +# files are now used as the Windows 98 help format, and will replace the old
  3.1209 +# Windows help format (.hlp) on all Windows platforms in the future. Compressed
  3.1210 +# HTML files also contain an index, a table of contents, and you can search for
  3.1211 +# words in the documentation. The HTML workshop also contains a viewer for
  3.1212 +# compressed HTML files.
  3.1213 +# The default value is: NO.
  3.1214 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1215 +
  3.1216 +GENERATE_HTMLHELP      = NO
  3.1217 +
  3.1218 +# The CHM_FILE tag can be used to specify the file name of the resulting .chm
  3.1219 +# file. You can add a path in front of the file if the result should not be
  3.1220 +# written to the html output directory.
  3.1221 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  3.1222 +
  3.1223 +CHM_FILE               =
  3.1224 +
  3.1225 +# The HHC_LOCATION tag can be used to specify the location (absolute path
  3.1226 +# including file name) of the HTML help compiler ( hhc.exe). If non-empty
  3.1227 +# doxygen will try to run the HTML help compiler on the generated index.hhp.
  3.1228 +# The file has to be specified with full path.
  3.1229 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  3.1230 +
  3.1231 +HHC_LOCATION           =
  3.1232 +
  3.1233 +# The GENERATE_CHI flag controls if a separate .chi index file is generated (
  3.1234 +# YES) or that it should be included in the master .chm file ( NO).
  3.1235 +# The default value is: NO.
  3.1236 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  3.1237 +
  3.1238 +GENERATE_CHI           = NO
  3.1239 +
  3.1240 +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
  3.1241 +# and project file content.
  3.1242 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  3.1243 +
  3.1244 +CHM_INDEX_ENCODING     =
  3.1245 +
  3.1246 +# The BINARY_TOC flag controls whether a binary table of contents is generated (
  3.1247 +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
  3.1248 +# enables the Previous and Next buttons.
  3.1249 +# The default value is: NO.
  3.1250 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  3.1251 +
  3.1252 +BINARY_TOC             = NO
  3.1253 +
  3.1254 +# The TOC_EXPAND flag can be set to YES to add extra items for group members to
  3.1255 +# the table of contents of the HTML help documentation and to the tree view.
  3.1256 +# The default value is: NO.
  3.1257 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  3.1258 +
  3.1259 +TOC_EXPAND             = NO
  3.1260 +
  3.1261 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  3.1262 +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
  3.1263 +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
  3.1264 +# (.qch) of the generated HTML documentation.
  3.1265 +# The default value is: NO.
  3.1266 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1267 +
  3.1268 +GENERATE_QHP           = NO
  3.1269 +
  3.1270 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
  3.1271 +# the file name of the resulting .qch file. The path specified is relative to
  3.1272 +# the HTML output folder.
  3.1273 +# This tag requires that the tag GENERATE_QHP is set to YES.
  3.1274 +
  3.1275 +QCH_FILE               =
  3.1276 +
  3.1277 +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  3.1278 +# Project output. For more information please see Qt Help Project / Namespace
  3.1279 +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  3.1280 +# The default value is: org.doxygen.Project.
  3.1281 +# This tag requires that the tag GENERATE_QHP is set to YES.
  3.1282 +
  3.1283 +QHP_NAMESPACE          = org.doxygen.Project
  3.1284 +
  3.1285 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  3.1286 +# Help Project output. For more information please see Qt Help Project / Virtual
  3.1287 +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  3.1288 +# folders).
  3.1289 +# The default value is: doc.
  3.1290 +# This tag requires that the tag GENERATE_QHP is set to YES.
  3.1291 +
  3.1292 +QHP_VIRTUAL_FOLDER     = doc
  3.1293 +
  3.1294 +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  3.1295 +# filter to add. For more information please see Qt Help Project / Custom
  3.1296 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  3.1297 +# filters).
  3.1298 +# This tag requires that the tag GENERATE_QHP is set to YES.
  3.1299 +
  3.1300 +QHP_CUST_FILTER_NAME   =
  3.1301 +
  3.1302 +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  3.1303 +# custom filter to add. For more information please see Qt Help Project / Custom
  3.1304 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  3.1305 +# filters).
  3.1306 +# This tag requires that the tag GENERATE_QHP is set to YES.
  3.1307 +
  3.1308 +QHP_CUST_FILTER_ATTRS  =
  3.1309 +
  3.1310 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  3.1311 +# project's filter section matches. Qt Help Project / Filter Attributes (see:
  3.1312 +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  3.1313 +# This tag requires that the tag GENERATE_QHP is set to YES.
  3.1314 +
  3.1315 +QHP_SECT_FILTER_ATTRS  =
  3.1316 +
  3.1317 +# The QHG_LOCATION tag can be used to specify the location of Qt's
  3.1318 +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  3.1319 +# generated .qhp file.
  3.1320 +# This tag requires that the tag GENERATE_QHP is set to YES.
  3.1321 +
  3.1322 +QHG_LOCATION           =
  3.1323 +
  3.1324 +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
  3.1325 +# generated, together with the HTML files, they form an Eclipse help plugin. To
  3.1326 +# install this plugin and make it available under the help contents menu in
  3.1327 +# Eclipse, the contents of the directory containing the HTML and XML files needs
  3.1328 +# to be copied into the plugins directory of eclipse. The name of the directory
  3.1329 +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
  3.1330 +# After copying Eclipse needs to be restarted before the help appears.
  3.1331 +# The default value is: NO.
  3.1332 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1333 +
  3.1334 +GENERATE_ECLIPSEHELP   = NO
  3.1335 +
  3.1336 +# A unique identifier for the Eclipse help plugin. When installing the plugin
  3.1337 +# the directory name containing the HTML and XML files should also have this
  3.1338 +# name. Each documentation set should have its own identifier.
  3.1339 +# The default value is: org.doxygen.Project.
  3.1340 +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
  3.1341 +
  3.1342 +ECLIPSE_DOC_ID         = org.doxygen.Project
  3.1343 +
  3.1344 +# If you want full control over the layout of the generated HTML pages it might
  3.1345 +# be necessary to disable the index and replace it with your own. The
  3.1346 +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
  3.1347 +# of each HTML page. A value of NO enables the index and the value YES disables
  3.1348 +# it. Since the tabs in the index contain the same information as the navigation
  3.1349 +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
  3.1350 +# The default value is: NO.
  3.1351 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1352 +
  3.1353 +DISABLE_INDEX          = NO
  3.1354 +
  3.1355 +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  3.1356 +# structure should be generated to display hierarchical information. If the tag
  3.1357 +# value is set to YES, a side panel will be generated containing a tree-like
  3.1358 +# index structure (just like the one that is generated for HTML Help). For this
  3.1359 +# to work a browser that supports JavaScript, DHTML, CSS and frames is required
  3.1360 +# (i.e. any modern browser). Windows users are probably better off using the
  3.1361 +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
  3.1362 +# further fine-tune the look of the index. As an example, the default style
  3.1363 +# sheet generated by doxygen has an example that shows how to put an image at
  3.1364 +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  3.1365 +# the same information as the tab index, you could consider setting
  3.1366 +# DISABLE_INDEX to YES when enabling this option.
  3.1367 +# The default value is: NO.
  3.1368 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1369 +
  3.1370 +GENERATE_TREEVIEW      = NO
  3.1371 +
  3.1372 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  3.1373 +# doxygen will group on one line in the generated HTML documentation.
  3.1374 +#
  3.1375 +# Note that a value of 0 will completely suppress the enum values from appearing
  3.1376 +# in the overview section.
  3.1377 +# Minimum value: 0, maximum value: 20, default value: 4.
  3.1378 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1379 +
  3.1380 +ENUM_VALUES_PER_LINE   = 4
  3.1381 +
  3.1382 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
  3.1383 +# to set the initial width (in pixels) of the frame in which the tree is shown.
  3.1384 +# Minimum value: 0, maximum value: 1500, default value: 250.
  3.1385 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1386 +
  3.1387 +TREEVIEW_WIDTH         = 250
  3.1388 +
  3.1389 +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
  3.1390 +# external symbols imported via tag files in a separate window.
  3.1391 +# The default value is: NO.
  3.1392 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1393 +
  3.1394 +EXT_LINKS_IN_WINDOW    = NO
  3.1395 +
  3.1396 +# Use this tag to change the font size of LaTeX formulas included as images in
  3.1397 +# the HTML documentation. When you change the font size after a successful
  3.1398 +# doxygen run you need to manually remove any form_*.png images from the HTML
  3.1399 +# output directory to force them to be regenerated.
  3.1400 +# Minimum value: 8, maximum value: 50, default value: 10.
  3.1401 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1402 +
  3.1403 +FORMULA_FONTSIZE       = 10
  3.1404 +
  3.1405 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images
  3.1406 +# generated for formulas are transparent PNGs. Transparent PNGs are not
  3.1407 +# supported properly for IE 6.0, but are supported on all modern browsers.
  3.1408 +#
  3.1409 +# Note that when changing this option you need to delete any form_*.png files in
  3.1410 +# the HTML output directory before the changes have effect.
  3.1411 +# The default value is: YES.
  3.1412 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1413 +
  3.1414 +FORMULA_TRANSPARENT    = YES
  3.1415 +
  3.1416 +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  3.1417 +# http://www.mathjax.org) which uses client side Javascript for the rendering
  3.1418 +# instead of using prerendered bitmaps. Use this if you do not have LaTeX
  3.1419 +# installed or if you want to formulas look prettier in the HTML output. When
  3.1420 +# enabled you may also need to install MathJax separately and configure the path
  3.1421 +# to it using the MATHJAX_RELPATH option.
  3.1422 +# The default value is: NO.
  3.1423 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1424 +
  3.1425 +USE_MATHJAX            = NO
  3.1426 +
  3.1427 +# When MathJax is enabled you can set the default output format to be used for
  3.1428 +# the MathJax output. See the MathJax site (see:
  3.1429 +# http://docs.mathjax.org/en/latest/output.html) for more details.
  3.1430 +# Possible values are: HTML-CSS (which is slower, but has the best
  3.1431 +# compatibility), NativeMML (i.e. MathML) and SVG.
  3.1432 +# The default value is: HTML-CSS.
  3.1433 +# This tag requires that the tag USE_MATHJAX is set to YES.
  3.1434 +
  3.1435 +MATHJAX_FORMAT         = HTML-CSS
  3.1436 +
  3.1437 +# When MathJax is enabled you need to specify the location relative to the HTML
  3.1438 +# output directory using the MATHJAX_RELPATH option. The destination directory
  3.1439 +# should contain the MathJax.js script. For instance, if the mathjax directory
  3.1440 +# is located at the same level as the HTML output directory, then
  3.1441 +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  3.1442 +# Content Delivery Network so you can quickly see the result without installing
  3.1443 +# MathJax. However, it is strongly recommended to install a local copy of
  3.1444 +# MathJax from http://www.mathjax.org before deployment.
  3.1445 +# The default value is: http://cdn.mathjax.org/mathjax/latest.
  3.1446 +# This tag requires that the tag USE_MATHJAX is set to YES.
  3.1447 +
  3.1448 +MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
  3.1449 +
  3.1450 +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  3.1451 +# extension names that should be enabled during MathJax rendering. For example
  3.1452 +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  3.1453 +# This tag requires that the tag USE_MATHJAX is set to YES.
  3.1454 +
  3.1455 +MATHJAX_EXTENSIONS     =
  3.1456 +
  3.1457 +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  3.1458 +# of code that will be used on startup of the MathJax code. See the MathJax site
  3.1459 +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  3.1460 +# example see the documentation.
  3.1461 +# This tag requires that the tag USE_MATHJAX is set to YES.
  3.1462 +
  3.1463 +MATHJAX_CODEFILE       =
  3.1464 +
  3.1465 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
  3.1466 +# the HTML output. The underlying search engine uses javascript and DHTML and
  3.1467 +# should work on any modern browser. Note that when using HTML help
  3.1468 +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
  3.1469 +# there is already a search function so this one should typically be disabled.
  3.1470 +# For large projects the javascript based search engine can be slow, then
  3.1471 +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
  3.1472 +# search using the keyboard; to jump to the search box use <access key> + S
  3.1473 +# (what the <access key> is depends on the OS and browser, but it is typically
  3.1474 +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
  3.1475 +# key> to jump into the search results window, the results can be navigated
  3.1476 +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
  3.1477 +# the search. The filter options can be selected when the cursor is inside the
  3.1478 +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
  3.1479 +# to select a filter and <Enter> or <escape> to activate or cancel the filter
  3.1480 +# option.
  3.1481 +# The default value is: YES.
  3.1482 +# This tag requires that the tag GENERATE_HTML is set to YES.
  3.1483 +
  3.1484 +SEARCHENGINE           = YES
  3.1485 +
  3.1486 +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  3.1487 +# implemented using a web server instead of a web client using Javascript. There
  3.1488 +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  3.1489 +# setting. When disabled, doxygen will generate a PHP script for searching and
  3.1490 +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  3.1491 +# and searching needs to be provided by external tools. See the section
  3.1492 +# "External Indexing and Searching" for details.
  3.1493 +# The default value is: NO.
  3.1494 +# This tag requires that the tag SEARCHENGINE is set to YES.
  3.1495 +
  3.1496 +SERVER_BASED_SEARCH    = NO
  3.1497 +
  3.1498 +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
  3.1499 +# script for searching. Instead the search results are written to an XML file
  3.1500 +# which needs to be processed by an external indexer. Doxygen will invoke an
  3.1501 +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  3.1502 +# search results.
  3.1503 +#
  3.1504 +# Doxygen ships with an example indexer ( doxyindexer) and search engine
  3.1505 +# (doxysearch.cgi) which are based on the open source search engine library
  3.1506 +# Xapian (see: http://xapian.org/).
  3.1507 +#
  3.1508 +# See the section "External Indexing and Searching" for details.
  3.1509 +# The default value is: NO.
  3.1510 +# This tag requires that the tag SEARCHENGINE is set to YES.
  3.1511 +
  3.1512 +EXTERNAL_SEARCH        = NO
  3.1513 +
  3.1514 +# The SEARCHENGINE_URL should point to a search engine hosted by a web server
  3.1515 +# which will return the search results when EXTERNAL_SEARCH is enabled.
  3.1516 +#
  3.1517 +# Doxygen ships with an example indexer ( doxyindexer) and search engine
  3.1518 +# (doxysearch.cgi) which are based on the open source search engine library
  3.1519 +# Xapian (see: http://xapian.org/). See the section "External Indexing and
  3.1520 +# Searching" for details.
  3.1521 +# This tag requires that the tag SEARCHENGINE is set to YES.
  3.1522 +
  3.1523 +SEARCHENGINE_URL       =
  3.1524 +
  3.1525 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  3.1526 +# search data is written to a file for indexing by an external tool. With the
  3.1527 +# SEARCHDATA_FILE tag the name of this file can be specified.
  3.1528 +# The default file is: searchdata.xml.
  3.1529 +# This tag requires that the tag SEARCHENGINE is set to YES.
  3.1530 +
  3.1531 +SEARCHDATA_FILE        = searchdata.xml
  3.1532 +
  3.1533 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
  3.1534 +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  3.1535 +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  3.1536 +# projects and redirect the results back to the right project.
  3.1537 +# This tag requires that the tag SEARCHENGINE is set to YES.
  3.1538 +
  3.1539 +EXTERNAL_SEARCH_ID     =
  3.1540 +
  3.1541 +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  3.1542 +# projects other than the one defined by this configuration file, but that are
  3.1543 +# all added to the same external search index. Each project needs to have a
  3.1544 +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
  3.1545 +# to a relative location where the documentation can be found. The format is:
  3.1546 +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
  3.1547 +# This tag requires that the tag SEARCHENGINE is set to YES.
  3.1548 +
  3.1549 +EXTRA_SEARCH_MAPPINGS  =
  3.1550 +
  3.1551 +#---------------------------------------------------------------------------
  3.1552 +# Configuration options related to the LaTeX output
  3.1553 +#---------------------------------------------------------------------------
  3.1554 +
  3.1555 +# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
  3.1556 +# The default value is: YES.
  3.1557 +
  3.1558 +GENERATE_LATEX         = NO
  3.1559 +
  3.1560 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
  3.1561 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  3.1562 +# it.
  3.1563 +# The default directory is: latex.
  3.1564 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1565 +
  3.1566 +LATEX_OUTPUT           = latex
  3.1567 +
  3.1568 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  3.1569 +# invoked.
  3.1570 +#
  3.1571 +# Note that when enabling USE_PDFLATEX this option is only used for generating
  3.1572 +# bitmaps for formulas in the HTML output, but not in the Makefile that is
  3.1573 +# written to the output directory.
  3.1574 +# The default file is: latex.
  3.1575 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1576 +
  3.1577 +LATEX_CMD_NAME         = latex
  3.1578 +
  3.1579 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  3.1580 +# index for LaTeX.
  3.1581 +# The default file is: makeindex.
  3.1582 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1583 +
  3.1584 +MAKEINDEX_CMD_NAME     = makeindex
  3.1585 +
  3.1586 +# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
  3.1587 +# documents. This may be useful for small projects and may help to save some
  3.1588 +# trees in general.
  3.1589 +# The default value is: NO.
  3.1590 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1591 +
  3.1592 +COMPACT_LATEX          = NO
  3.1593 +
  3.1594 +# The PAPER_TYPE tag can be used to set the paper type that is used by the
  3.1595 +# printer.
  3.1596 +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
  3.1597 +# 14 inches) and executive (7.25 x 10.5 inches).
  3.1598 +# The default value is: a4.
  3.1599 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1600 +
  3.1601 +PAPER_TYPE             = a4
  3.1602 +
  3.1603 +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  3.1604 +# that should be included in the LaTeX output. To get the times font for
  3.1605 +# instance you can specify
  3.1606 +# EXTRA_PACKAGES=times
  3.1607 +# If left blank no extra packages will be included.
  3.1608 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1609 +
  3.1610 +EXTRA_PACKAGES         =
  3.1611 +
  3.1612 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  3.1613 +# generated LaTeX document. The header should contain everything until the first
  3.1614 +# chapter. If it is left blank doxygen will generate a standard header. See
  3.1615 +# section "Doxygen usage" for information on how to let doxygen write the
  3.1616 +# default header to a separate file.
  3.1617 +#
  3.1618 +# Note: Only use a user-defined header if you know what you are doing! The
  3.1619 +# following commands have a special meaning inside the header: $title,
  3.1620 +# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
  3.1621 +# replace them by respectively the title of the page, the current date and time,
  3.1622 +# only the current date, the version number of doxygen, the project name (see
  3.1623 +# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
  3.1624 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1625 +
  3.1626 +LATEX_HEADER           =
  3.1627 +
  3.1628 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  3.1629 +# generated LaTeX document. The footer should contain everything after the last
  3.1630 +# chapter. If it is left blank doxygen will generate a standard footer.
  3.1631 +#
  3.1632 +# Note: Only use a user-defined footer if you know what you are doing!
  3.1633 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1634 +
  3.1635 +LATEX_FOOTER           =
  3.1636 +
  3.1637 +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  3.1638 +# other source files which should be copied to the LATEX_OUTPUT output
  3.1639 +# directory. Note that the files will be copied as-is; there are no commands or
  3.1640 +# markers available.
  3.1641 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1642 +
  3.1643 +LATEX_EXTRA_FILES      =
  3.1644 +
  3.1645 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
  3.1646 +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
  3.1647 +# contain links (just like the HTML output) instead of page references. This
  3.1648 +# makes the output suitable for online browsing using a PDF viewer.
  3.1649 +# The default value is: YES.
  3.1650 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1651 +
  3.1652 +PDF_HYPERLINKS         = YES
  3.1653 +
  3.1654 +# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  3.1655 +# the PDF file directly from the LaTeX files. Set this option to YES to get a
  3.1656 +# higher quality PDF documentation.
  3.1657 +# The default value is: YES.
  3.1658 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1659 +
  3.1660 +USE_PDFLATEX           = YES
  3.1661 +
  3.1662 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  3.1663 +# command to the generated LaTeX files. This will instruct LaTeX to keep running
  3.1664 +# if errors occur, instead of asking the user for help. This option is also used
  3.1665 +# when generating formulas in HTML.
  3.1666 +# The default value is: NO.
  3.1667 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1668 +
  3.1669 +LATEX_BATCHMODE        = NO
  3.1670 +
  3.1671 +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
  3.1672 +# index chapters (such as File Index, Compound Index, etc.) in the output.
  3.1673 +# The default value is: NO.
  3.1674 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1675 +
  3.1676 +LATEX_HIDE_INDICES     = NO
  3.1677 +
  3.1678 +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
  3.1679 +# code with syntax highlighting in the LaTeX output.
  3.1680 +#
  3.1681 +# Note that which sources are shown also depends on other settings such as
  3.1682 +# SOURCE_BROWSER.
  3.1683 +# The default value is: NO.
  3.1684 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1685 +
  3.1686 +LATEX_SOURCE_CODE      = NO
  3.1687 +
  3.1688 +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  3.1689 +# bibliography, e.g. plainnat, or ieeetr. See
  3.1690 +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  3.1691 +# The default value is: plain.
  3.1692 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  3.1693 +
  3.1694 +LATEX_BIB_STYLE        = plain
  3.1695 +
  3.1696 +#---------------------------------------------------------------------------
  3.1697 +# Configuration options related to the RTF output
  3.1698 +#---------------------------------------------------------------------------
  3.1699 +
  3.1700 +# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
  3.1701 +# RTF output is optimized for Word 97 and may not look too pretty with other RTF
  3.1702 +# readers/editors.
  3.1703 +# The default value is: NO.
  3.1704 +
  3.1705 +GENERATE_RTF           = NO
  3.1706 +
  3.1707 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
  3.1708 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  3.1709 +# it.
  3.1710 +# The default directory is: rtf.
  3.1711 +# This tag requires that the tag GENERATE_RTF is set to YES.
  3.1712 +
  3.1713 +RTF_OUTPUT             = rtf
  3.1714 +
  3.1715 +# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
  3.1716 +# documents. This may be useful for small projects and may help to save some
  3.1717 +# trees in general.
  3.1718 +# The default value is: NO.
  3.1719 +# This tag requires that the tag GENERATE_RTF is set to YES.
  3.1720 +
  3.1721 +COMPACT_RTF            = NO
  3.1722 +
  3.1723 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
  3.1724 +# contain hyperlink fields. The RTF file will contain links (just like the HTML
  3.1725 +# output) instead of page references. This makes the output suitable for online
  3.1726 +# browsing using Word or some other Word compatible readers that support those
  3.1727 +# fields.
  3.1728 +#
  3.1729 +# Note: WordPad (write) and others do not support links.
  3.1730 +# The default value is: NO.
  3.1731 +# This tag requires that the tag GENERATE_RTF is set to YES.
  3.1732 +
  3.1733 +RTF_HYPERLINKS         = NO
  3.1734 +
  3.1735 +# Load stylesheet definitions from file. Syntax is similar to doxygen's config
  3.1736 +# file, i.e. a series of assignments. You only have to provide replacements,
  3.1737 +# missing definitions are set to their default value.
  3.1738 +#
  3.1739 +# See also section "Doxygen usage" for information on how to generate the
  3.1740 +# default style sheet that doxygen normally uses.
  3.1741 +# This tag requires that the tag GENERATE_RTF is set to YES.
  3.1742 +
  3.1743 +RTF_STYLESHEET_FILE    =
  3.1744 +
  3.1745 +# Set optional variables used in the generation of an RTF document. Syntax is
  3.1746 +# similar to doxygen's config file. A template extensions file can be generated
  3.1747 +# using doxygen -e rtf extensionFile.
  3.1748 +# This tag requires that the tag GENERATE_RTF is set to YES.
  3.1749 +
  3.1750 +RTF_EXTENSIONS_FILE    =
  3.1751 +
  3.1752 +#---------------------------------------------------------------------------
  3.1753 +# Configuration options related to the man page output
  3.1754 +#---------------------------------------------------------------------------
  3.1755 +
  3.1756 +# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
  3.1757 +# classes and files.
  3.1758 +# The default value is: NO.
  3.1759 +
  3.1760 +GENERATE_MAN           = NO
  3.1761 +
  3.1762 +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
  3.1763 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  3.1764 +# it. A directory man3 will be created inside the directory specified by
  3.1765 +# MAN_OUTPUT.
  3.1766 +# The default directory is: man.
  3.1767 +# This tag requires that the tag GENERATE_MAN is set to YES.
  3.1768 +
  3.1769 +MAN_OUTPUT             = man
  3.1770 +
  3.1771 +# The MAN_EXTENSION tag determines the extension that is added to the generated
  3.1772 +# man pages. In case the manual section does not start with a number, the number
  3.1773 +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
  3.1774 +# optional.
  3.1775 +# The default value is: .3.
  3.1776 +# This tag requires that the tag GENERATE_MAN is set to YES.
  3.1777 +
  3.1778 +MAN_EXTENSION          = .3
  3.1779 +
  3.1780 +# The MAN_SUBDIR tag determines the name of the directory created within
  3.1781 +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
  3.1782 +# MAN_EXTENSION with the initial . removed.
  3.1783 +# This tag requires that the tag GENERATE_MAN is set to YES.
  3.1784 +
  3.1785 +MAN_SUBDIR             =
  3.1786 +
  3.1787 +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
  3.1788 +# will generate one additional man file for each entity documented in the real
  3.1789 +# man page(s). These additional files only source the real man page, but without
  3.1790 +# them the man command would be unable to find the correct page.
  3.1791 +# The default value is: NO.
  3.1792 +# This tag requires that the tag GENERATE_MAN is set to YES.
  3.1793 +
  3.1794 +MAN_LINKS              = NO
  3.1795 +
  3.1796 +#---------------------------------------------------------------------------
  3.1797 +# Configuration options related to the XML output
  3.1798 +#---------------------------------------------------------------------------
  3.1799 +
  3.1800 +# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
  3.1801 +# captures the structure of the code including all documentation.
  3.1802 +# The default value is: NO.
  3.1803 +
  3.1804 +GENERATE_XML           = NO
  3.1805 +
  3.1806 +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
  3.1807 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  3.1808 +# it.
  3.1809 +# The default directory is: xml.
  3.1810 +# This tag requires that the tag GENERATE_XML is set to YES.
  3.1811 +
  3.1812 +XML_OUTPUT             = xml
  3.1813 +
  3.1814 +# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
  3.1815 +# listings (including syntax highlighting and cross-referencing information) to
  3.1816 +# the XML output. Note that enabling this will significantly increase the size
  3.1817 +# of the XML output.
  3.1818 +# The default value is: YES.
  3.1819 +# This tag requires that the tag GENERATE_XML is set to YES.
  3.1820 +
  3.1821 +XML_PROGRAMLISTING     = YES
  3.1822 +
  3.1823 +#---------------------------------------------------------------------------
  3.1824 +# Configuration options related to the DOCBOOK output
  3.1825 +#---------------------------------------------------------------------------
  3.1826 +
  3.1827 +# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
  3.1828 +# that can be used to generate PDF.
  3.1829 +# The default value is: NO.
  3.1830 +
  3.1831 +GENERATE_DOCBOOK       = NO
  3.1832 +
  3.1833 +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
  3.1834 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
  3.1835 +# front of it.
  3.1836 +# The default directory is: docbook.
  3.1837 +# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  3.1838 +
  3.1839 +DOCBOOK_OUTPUT         = docbook
  3.1840 +
  3.1841 +#---------------------------------------------------------------------------
  3.1842 +# Configuration options for the AutoGen Definitions output
  3.1843 +#---------------------------------------------------------------------------
  3.1844 +
  3.1845 +# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
  3.1846 +# Definitions (see http://autogen.sf.net) file that captures the structure of
  3.1847 +# the code including all documentation. Note that this feature is still
  3.1848 +# experimental and incomplete at the moment.
  3.1849 +# The default value is: NO.
  3.1850 +
  3.1851 +GENERATE_AUTOGEN_DEF   = NO
  3.1852 +
  3.1853 +#---------------------------------------------------------------------------
  3.1854 +# Configuration options related to the Perl module output
  3.1855 +#---------------------------------------------------------------------------
  3.1856 +
  3.1857 +# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
  3.1858 +# file that captures the structure of the code including all documentation.
  3.1859 +#
  3.1860 +# Note that this feature is still experimental and incomplete at the moment.
  3.1861 +# The default value is: NO.
  3.1862 +
  3.1863 +GENERATE_PERLMOD       = NO
  3.1864 +
  3.1865 +# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
  3.1866 +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  3.1867 +# output from the Perl module output.
  3.1868 +# The default value is: NO.
  3.1869 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
  3.1870 +
  3.1871 +PERLMOD_LATEX          = NO
  3.1872 +
  3.1873 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
  3.1874 +# formatted so it can be parsed by a human reader. This is useful if you want to
  3.1875 +# understand what is going on. On the other hand, if this tag is set to NO the
  3.1876 +# size of the Perl module output will be much smaller and Perl will parse it
  3.1877 +# just the same.
  3.1878 +# The default value is: YES.
  3.1879 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
  3.1880 +
  3.1881 +PERLMOD_PRETTY         = YES
  3.1882 +
  3.1883 +# The names of the make variables in the generated doxyrules.make file are
  3.1884 +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
  3.1885 +# so different doxyrules.make files included by the same Makefile don't
  3.1886 +# overwrite each other's variables.
  3.1887 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
  3.1888 +
  3.1889 +PERLMOD_MAKEVAR_PREFIX =
  3.1890 +
  3.1891 +#---------------------------------------------------------------------------
  3.1892 +# Configuration options related to the preprocessor
  3.1893 +#---------------------------------------------------------------------------
  3.1894 +
  3.1895 +# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
  3.1896 +# C-preprocessor directives found in the sources and include files.
  3.1897 +# The default value is: YES.
  3.1898 +
  3.1899 +ENABLE_PREPROCESSING   = YES
  3.1900 +
  3.1901 +# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
  3.1902 +# in the source code. If set to NO only conditional compilation will be
  3.1903 +# performed. Macro expansion can be done in a controlled way by setting
  3.1904 +# EXPAND_ONLY_PREDEF to YES.
  3.1905 +# The default value is: NO.
  3.1906 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  3.1907 +
  3.1908 +MACRO_EXPANSION        = NO
  3.1909 +
  3.1910 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
  3.1911 +# the macro expansion is limited to the macros specified with the PREDEFINED and
  3.1912 +# EXPAND_AS_DEFINED tags.
  3.1913 +# The default value is: NO.
  3.1914 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  3.1915 +
  3.1916 +EXPAND_ONLY_PREDEF     = NO
  3.1917 +
  3.1918 +# If the SEARCH_INCLUDES tag is set to YES the includes files in the
  3.1919 +# INCLUDE_PATH will be searched if a #include is found.
  3.1920 +# The default value is: YES.
  3.1921 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  3.1922 +
  3.1923 +SEARCH_INCLUDES        = YES
  3.1924 +
  3.1925 +# The INCLUDE_PATH tag can be used to specify one or more directories that
  3.1926 +# contain include files that are not input files but should be processed by the
  3.1927 +# preprocessor.
  3.1928 +# This tag requires that the tag SEARCH_INCLUDES is set to YES.
  3.1929 +
  3.1930 +INCLUDE_PATH           =
  3.1931 +
  3.1932 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  3.1933 +# patterns (like *.h and *.hpp) to filter out the header-files in the
  3.1934 +# directories. If left blank, the patterns specified with FILE_PATTERNS will be
  3.1935 +# used.
  3.1936 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  3.1937 +
  3.1938 +INCLUDE_FILE_PATTERNS  =
  3.1939 +
  3.1940 +# The PREDEFINED tag can be used to specify one or more macro names that are
  3.1941 +# defined before the preprocessor is started (similar to the -D option of e.g.
  3.1942 +# gcc). The argument of the tag is a list of macros of the form: name or
  3.1943 +# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
  3.1944 +# is assumed. To prevent a macro definition from being undefined via #undef or
  3.1945 +# recursively expanded use the := operator instead of the = operator.
  3.1946 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  3.1947 +
  3.1948 +PREDEFINED             =
  3.1949 +
  3.1950 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
  3.1951 +# tag can be used to specify a list of macro names that should be expanded. The
  3.1952 +# macro definition that is found in the sources will be used. Use the PREDEFINED
  3.1953 +# tag if you want to use a different macro definition that overrules the
  3.1954 +# definition found in the source code.
  3.1955 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  3.1956 +
  3.1957 +EXPAND_AS_DEFINED      =
  3.1958 +
  3.1959 +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
  3.1960 +# remove all references to function-like macros that are alone on a line, have
  3.1961 +# an all uppercase name, and do not end with a semicolon. Such function macros
  3.1962 +# are typically used for boiler-plate code, and will confuse the parser if not
  3.1963 +# removed.
  3.1964 +# The default value is: YES.
  3.1965 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  3.1966 +
  3.1967 +SKIP_FUNCTION_MACROS   = YES
  3.1968 +
  3.1969 +#---------------------------------------------------------------------------
  3.1970 +# Configuration options related to external references
  3.1971 +#---------------------------------------------------------------------------
  3.1972 +
  3.1973 +# The TAGFILES tag can be used to specify one or more tag files. For each tag
  3.1974 +# file the location of the external documentation should be added. The format of
  3.1975 +# a tag file without this location is as follows:
  3.1976 +# TAGFILES = file1 file2 ...
  3.1977 +# Adding location for the tag files is done as follows:
  3.1978 +# TAGFILES = file1=loc1 "file2 = loc2" ...
  3.1979 +# where loc1 and loc2 can be relative or absolute paths or URLs. See the
  3.1980 +# section "Linking to external documentation" for more information about the use
  3.1981 +# of tag files.
  3.1982 +# Note: Each tag file must have a unique name (where the name does NOT include
  3.1983 +# the path). If a tag file is not located in the directory in which doxygen is
  3.1984 +# run, you must also specify the path to the tagfile here.
  3.1985 +
  3.1986 +TAGFILES               =
  3.1987 +
  3.1988 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
  3.1989 +# tag file that is based on the input files it reads. See section "Linking to
  3.1990 +# external documentation" for more information about the usage of tag files.
  3.1991 +
  3.1992 +GENERATE_TAGFILE       =
  3.1993 +
  3.1994 +# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
  3.1995 +# class index. If set to NO only the inherited external classes will be listed.
  3.1996 +# The default value is: NO.
  3.1997 +
  3.1998 +ALLEXTERNALS           = NO
  3.1999 +
  3.2000 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
  3.2001 +# the modules index. If set to NO, only the current project's groups will be
  3.2002 +# listed.
  3.2003 +# The default value is: YES.
  3.2004 +
  3.2005 +EXTERNAL_GROUPS        = YES
  3.2006 +
  3.2007 +# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
  3.2008 +# the related pages index. If set to NO, only the current project's pages will
  3.2009 +# be listed.
  3.2010 +# The default value is: YES.
  3.2011 +
  3.2012 +EXTERNAL_PAGES         = YES
  3.2013 +
  3.2014 +# The PERL_PATH should be the absolute path and name of the perl script
  3.2015 +# interpreter (i.e. the result of 'which perl').
  3.2016 +# The default file (with absolute path) is: /usr/bin/perl.
  3.2017 +
  3.2018 +PERL_PATH              = /usr/bin/perl
  3.2019 +
  3.2020 +#---------------------------------------------------------------------------
  3.2021 +# Configuration options related to the dot tool
  3.2022 +#---------------------------------------------------------------------------
  3.2023 +
  3.2024 +# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
  3.2025 +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
  3.2026 +# NO turns the diagrams off. Note that this option also works with HAVE_DOT
  3.2027 +# disabled, but it is recommended to install and use dot, since it yields more
  3.2028 +# powerful graphs.
  3.2029 +# The default value is: YES.
  3.2030 +
  3.2031 +CLASS_DIAGRAMS         = YES
  3.2032 +
  3.2033 +# You can define message sequence charts within doxygen comments using the \msc
  3.2034 +# command. Doxygen will then run the mscgen tool (see:
  3.2035 +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
  3.2036 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where
  3.2037 +# the mscgen tool resides. If left empty the tool is assumed to be found in the
  3.2038 +# default search path.
  3.2039 +
  3.2040 +MSCGEN_PATH            =
  3.2041 +
  3.2042 +# You can include diagrams made with dia in doxygen documentation. Doxygen will
  3.2043 +# then run dia to produce the diagram and insert it in the documentation. The
  3.2044 +# DIA_PATH tag allows you to specify the directory where the dia binary resides.
  3.2045 +# If left empty dia is assumed to be found in the default search path.
  3.2046 +
  3.2047 +DIA_PATH               =
  3.2048 +
  3.2049 +# If set to YES, the inheritance and collaboration graphs will hide inheritance
  3.2050 +# and usage relations if the target is undocumented or is not a class.
  3.2051 +# The default value is: YES.
  3.2052 +
  3.2053 +HIDE_UNDOC_RELATIONS   = YES
  3.2054 +
  3.2055 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  3.2056 +# available from the path. This tool is part of Graphviz (see:
  3.2057 +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  3.2058 +# Bell Labs. The other options in this section have no effect if this option is
  3.2059 +# set to NO
  3.2060 +# The default value is: YES.
  3.2061 +
  3.2062 +HAVE_DOT               = NO
  3.2063 +
  3.2064 +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
  3.2065 +# to run in parallel. When set to 0 doxygen will base this on the number of
  3.2066 +# processors available in the system. You can set it explicitly to a value
  3.2067 +# larger than 0 to get control over the balance between CPU load and processing
  3.2068 +# speed.
  3.2069 +# Minimum value: 0, maximum value: 32, default value: 0.
  3.2070 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2071 +
  3.2072 +DOT_NUM_THREADS        = 0
  3.2073 +
  3.2074 +# When you want a differently looking font n the dot files that doxygen
  3.2075 +# generates you can specify the font name using DOT_FONTNAME. You need to make
  3.2076 +# sure dot is able to find the font, which can be done by putting it in a
  3.2077 +# standard location or by setting the DOTFONTPATH environment variable or by
  3.2078 +# setting DOT_FONTPATH to the directory containing the font.
  3.2079 +# The default value is: Helvetica.
  3.2080 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2081 +
  3.2082 +DOT_FONTNAME           = Helvetica
  3.2083 +
  3.2084 +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  3.2085 +# dot graphs.
  3.2086 +# Minimum value: 4, maximum value: 24, default value: 10.
  3.2087 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2088 +
  3.2089 +DOT_FONTSIZE           = 10
  3.2090 +
  3.2091 +# By default doxygen will tell dot to use the default font as specified with
  3.2092 +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  3.2093 +# the path where dot can find it using this tag.
  3.2094 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2095 +
  3.2096 +DOT_FONTPATH           =
  3.2097 +
  3.2098 +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  3.2099 +# each documented class showing the direct and indirect inheritance relations.
  3.2100 +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  3.2101 +# The default value is: YES.
  3.2102 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2103 +
  3.2104 +CLASS_GRAPH            = YES
  3.2105 +
  3.2106 +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
  3.2107 +# graph for each documented class showing the direct and indirect implementation
  3.2108 +# dependencies (inheritance, containment, and class references variables) of the
  3.2109 +# class with other documented classes.
  3.2110 +# The default value is: YES.
  3.2111 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2112 +
  3.2113 +COLLABORATION_GRAPH    = YES
  3.2114 +
  3.2115 +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  3.2116 +# groups, showing the direct groups dependencies.
  3.2117 +# The default value is: YES.
  3.2118 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2119 +
  3.2120 +GROUP_GRAPHS           = YES
  3.2121 +
  3.2122 +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  3.2123 +# collaboration diagrams in a style similar to the OMG's Unified Modeling
  3.2124 +# Language.
  3.2125 +# The default value is: NO.
  3.2126 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2127 +
  3.2128 +UML_LOOK               = NO
  3.2129 +
  3.2130 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
  3.2131 +# class node. If there are many fields or methods and many nodes the graph may
  3.2132 +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
  3.2133 +# number of items for each type to make the size more manageable. Set this to 0
  3.2134 +# for no limit. Note that the threshold may be exceeded by 50% before the limit
  3.2135 +# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
  3.2136 +# but if the number exceeds 15, the total amount of fields shown is limited to
  3.2137 +# 10.
  3.2138 +# Minimum value: 0, maximum value: 100, default value: 10.
  3.2139 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2140 +
  3.2141 +UML_LIMIT_NUM_FIELDS   = 10
  3.2142 +
  3.2143 +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  3.2144 +# collaboration graphs will show the relations between templates and their
  3.2145 +# instances.
  3.2146 +# The default value is: NO.
  3.2147 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2148 +
  3.2149 +TEMPLATE_RELATIONS     = NO
  3.2150 +
  3.2151 +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
  3.2152 +# YES then doxygen will generate a graph for each documented file showing the
  3.2153 +# direct and indirect include dependencies of the file with other documented
  3.2154 +# files.
  3.2155 +# The default value is: YES.
  3.2156 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2157 +
  3.2158 +INCLUDE_GRAPH          = YES
  3.2159 +
  3.2160 +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
  3.2161 +# set to YES then doxygen will generate a graph for each documented file showing
  3.2162 +# the direct and indirect include dependencies of the file with other documented
  3.2163 +# files.
  3.2164 +# The default value is: YES.
  3.2165 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2166 +
  3.2167 +INCLUDED_BY_GRAPH      = YES
  3.2168 +
  3.2169 +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
  3.2170 +# dependency graph for every global function or class method.
  3.2171 +#
  3.2172 +# Note that enabling this option will significantly increase the time of a run.
  3.2173 +# So in most cases it will be better to enable call graphs for selected
  3.2174 +# functions only using the \callgraph command.
  3.2175 +# The default value is: NO.
  3.2176 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2177 +
  3.2178 +CALL_GRAPH             = NO
  3.2179 +
  3.2180 +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
  3.2181 +# dependency graph for every global function or class method.
  3.2182 +#
  3.2183 +# Note that enabling this option will significantly increase the time of a run.
  3.2184 +# So in most cases it will be better to enable caller graphs for selected
  3.2185 +# functions only using the \callergraph command.
  3.2186 +# The default value is: NO.
  3.2187 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2188 +
  3.2189 +CALLER_GRAPH           = NO
  3.2190 +
  3.2191 +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
  3.2192 +# hierarchy of all classes instead of a textual one.
  3.2193 +# The default value is: YES.
  3.2194 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2195 +
  3.2196 +GRAPHICAL_HIERARCHY    = YES
  3.2197 +
  3.2198 +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
  3.2199 +# dependencies a directory has on other directories in a graphical way. The
  3.2200 +# dependency relations are determined by the #include relations between the
  3.2201 +# files in the directories.
  3.2202 +# The default value is: YES.
  3.2203 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2204 +
  3.2205 +DIRECTORY_GRAPH        = YES
  3.2206 +
  3.2207 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  3.2208 +# generated by dot.
  3.2209 +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  3.2210 +# to make the SVG files visible in IE 9+ (other browsers do not have this
  3.2211 +# requirement).
  3.2212 +# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
  3.2213 +# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
  3.2214 +# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
  3.2215 +# The default value is: png.
  3.2216 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2217 +
  3.2218 +DOT_IMAGE_FORMAT       = png
  3.2219 +
  3.2220 +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  3.2221 +# enable generation of interactive SVG images that allow zooming and panning.
  3.2222 +#
  3.2223 +# Note that this requires a modern browser other than Internet Explorer. Tested
  3.2224 +# and working are Firefox, Chrome, Safari, and Opera.
  3.2225 +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
  3.2226 +# the SVG files visible. Older versions of IE do not have SVG support.
  3.2227 +# The default value is: NO.
  3.2228 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2229 +
  3.2230 +INTERACTIVE_SVG        = NO
  3.2231 +
  3.2232 +# The DOT_PATH tag can be used to specify the path where the dot tool can be
  3.2233 +# found. If left blank, it is assumed the dot tool can be found in the path.
  3.2234 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2235 +
  3.2236 +DOT_PATH               =
  3.2237 +
  3.2238 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
  3.2239 +# contain dot files that are included in the documentation (see the \dotfile
  3.2240 +# command).
  3.2241 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2242 +
  3.2243 +DOTFILE_DIRS           =
  3.2244 +
  3.2245 +# The MSCFILE_DIRS tag can be used to specify one or more directories that
  3.2246 +# contain msc files that are included in the documentation (see the \mscfile
  3.2247 +# command).
  3.2248 +
  3.2249 +MSCFILE_DIRS           =
  3.2250 +
  3.2251 +# The DIAFILE_DIRS tag can be used to specify one or more directories that
  3.2252 +# contain dia files that are included in the documentation (see the \diafile
  3.2253 +# command).
  3.2254 +
  3.2255 +DIAFILE_DIRS           =
  3.2256 +
  3.2257 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  3.2258 +# that will be shown in the graph. If the number of nodes in a graph becomes
  3.2259 +# larger than this value, doxygen will truncate the graph, which is visualized
  3.2260 +# by representing a node as a red box. Note that doxygen if the number of direct
  3.2261 +# children of the root node in a graph is already larger than
  3.2262 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
  3.2263 +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  3.2264 +# Minimum value: 0, maximum value: 10000, default value: 50.
  3.2265 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2266 +
  3.2267 +DOT_GRAPH_MAX_NODES    = 50
  3.2268 +
  3.2269 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
  3.2270 +# generated by dot. A depth value of 3 means that only nodes reachable from the
  3.2271 +# root by following a path via at most 3 edges will be shown. Nodes that lay
  3.2272 +# further from the root node will be omitted. Note that setting this option to 1
  3.2273 +# or 2 may greatly reduce the computation time needed for large code bases. Also
  3.2274 +# note that the size of a graph can be further restricted by
  3.2275 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  3.2276 +# Minimum value: 0, maximum value: 1000, default value: 0.
  3.2277 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2278 +
  3.2279 +MAX_DOT_GRAPH_DEPTH    = 0
  3.2280 +
  3.2281 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  3.2282 +# background. This is disabled by default, because dot on Windows does not seem
  3.2283 +# to support this out of the box.
  3.2284 +#
  3.2285 +# Warning: Depending on the platform used, enabling this option may lead to
  3.2286 +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  3.2287 +# read).
  3.2288 +# The default value is: NO.
  3.2289 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2290 +
  3.2291 +DOT_TRANSPARENT        = NO
  3.2292 +
  3.2293 +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  3.2294 +# files in one run (i.e. multiple -o and -T options on the command line). This
  3.2295 +# makes dot run faster, but since only newer versions of dot (>1.8.10) support
  3.2296 +# this, this feature is disabled by default.
  3.2297 +# The default value is: NO.
  3.2298 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2299 +
  3.2300 +DOT_MULTI_TARGETS      = YES
  3.2301 +
  3.2302 +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  3.2303 +# explaining the meaning of the various boxes and arrows in the dot generated
  3.2304 +# graphs.
  3.2305 +# The default value is: YES.
  3.2306 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2307 +
  3.2308 +GENERATE_LEGEND        = YES
  3.2309 +
  3.2310 +# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
  3.2311 +# files that are used to generate the various graphs.
  3.2312 +# The default value is: YES.
  3.2313 +# This tag requires that the tag HAVE_DOT is set to YES.
  3.2314 +
  3.2315 +DOT_CLEANUP            = YES

     4.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     4.2 +++ b/docs/src/CMakeLists.txt	Thu Dec 19 18:40:00 2019 +0100
     4.3 @@ -0,0 +1,63 @@
     4.4 +#
     4.5 +# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     4.6 +#
     4.7 +# Copyright 2019 Mike Becker, Olaf Wintermann All rights reserved.
     4.8 +#
     4.9 +# Redistribution and use in source and binary forms, with or without
    4.10 +# modification, are permitted provided that the following conditions are met:
    4.11 +#
    4.12 +#   1. Redistributions of source code must retain the above copyright
    4.13 +#      notice, this list of conditions and the following disclaimer.
    4.14 +#
    4.15 +#   2. Redistributions in binary form must reproduce the above copyright
    4.16 +#      notice, this list of conditions and the following disclaimer in the
    4.17 +#      documentation and/or other materials provided with the distribution.
    4.18 +#
    4.19 +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    4.20 +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    4.21 +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    4.22 +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    4.23 +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    4.24 +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    4.25 +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    4.26 +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    4.27 +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    4.28 +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    4.29 +# POSSIBILITY OF SUCH DAMAGE.
    4.30 +#
    4.31 +
    4.32 +set(PANDOC_DESTDIR ${CMAKE_BINARY_DIR}/docs/web)
    4.33 +set(PANDOC_ARGS -c ucx.css -B header.html -A footer.html -T 'UAP Common Extensions')
    4.34 +set(PANDOC_SRC index.md license.md modules.md install.md)
    4.35 +set(LOGO_PATH ../../uaplogo.png)
    4.36 +
    4.37 +if (NOT EXISTS ${PANDOC_EXECUTABLE})
    4.38 +    find_program(PANDOC_EXECUTABLE pandoc)
    4.39 +    if(NOT EXISTS ${PANDOC_EXECUTABLE})
    4.40 +        message(WARNING Pandoc not found, docs-html target will not be generated.)
    4.41 +        return()
    4.42 +    endif()
    4.43 +endif()
    4.44 +
    4.45 +message(STATUS "HTML Documentation will be generated at: ${PANDOC_DESTDIR}.")
    4.46 +file(MAKE_DIRECTORY ${PANDOC_DESTDIR})
    4.47 +
    4.48 +foreach(source_file ${PANDOC_SRC})
    4.49 +    string(REPLACE .md .html dest_file ${source_file})
    4.50 +    string(PREPEND dest_file "${PANDOC_DESTDIR}/")
    4.51 +    list(APPEND PANDOC_DEST ${dest_file})
    4.52 +    add_custom_command(
    4.53 +            OUTPUT ${dest_file}
    4.54 +            COMMAND ${PANDOC_EXECUTABLE} ${PANDOC_ARGS}  -o ${dest_file} ${source_file}
    4.55 +            WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
    4.56 +            MAIN_DEPENDENCY ${source_file}
    4.57 +    )
    4.58 +endforeach()
    4.59 +
    4.60 +add_custom_target(docs-html
    4.61 +        COMMAND ${CMAKE_COMMAND} -E copy ucx.css ${PANDOC_DESTDIR}/ucx.css
    4.62 +        COMMAND ${CMAKE_COMMAND} -E copy ${LOGO_PATH} ${PANDOC_DESTDIR}/uaplogo.png
    4.63 +        DEPENDS ${PANDOC_DEST}
    4.64 +        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
    4.65 +        COMMENT "Generating HTML documentation with pandoc."
    4.66 +)