1.1 --- a/Doxyfile Thu Oct 15 12:39:50 2015 +0200 1.2 +++ b/Doxyfile Thu Oct 15 14:21:38 2015 +0200 1.3 @@ -1,136 +1,129 @@ 1.4 -# Doxyfile 1.8.1.2 1.5 -# 1.6 -# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 1.7 -# 1.8 -# Copyright 2015 Olaf Wintermann. All rights reserved. 1.9 -# 1.10 -# Redistribution and use in source and binary forms, with or without 1.11 -# modification, are permitted provided that the following conditions are met: 1.12 -# 1.13 -# 1. Redistributions of source code must retain the above copyright 1.14 -# notice, this list of conditions and the following disclaimer. 1.15 -# 1.16 -# 2. Redistributions in binary form must reproduce the above copyright 1.17 -# notice, this list of conditions and the following disclaimer in the 1.18 -# documentation and/or other materials provided with the distribution. 1.19 -# 1.20 -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 1.21 -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1.22 -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1.23 -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 1.24 -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 1.25 -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 1.26 -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 1.27 -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 1.28 -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 1.29 -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 1.30 -# POSSIBILITY OF SUCH DAMAGE. 1.31 -# 1.32 +# Doxyfile 1.8.7 1.33 + 1.34 # This file describes the settings to be used by the documentation system 1.35 # doxygen (www.doxygen.org) for a project. 1.36 # 1.37 -# All text after a hash (#) is considered a comment and will be ignored. 1.38 +# All text after a double hash (##) is considered a comment and is placed in 1.39 +# front of the TAG it is preceding. 1.40 +# 1.41 +# All text after a single hash (#) is considered a comment and will be ignored. 1.42 # The format is: 1.43 -# TAG = value [value, ...] 1.44 -# For lists items can also be appended using: 1.45 -# TAG += value [value, ...] 1.46 -# Values that contain spaces should be placed between quotes (" "). 1.47 +# TAG = value [value, ...] 1.48 +# For lists, items can also be appended using: 1.49 +# TAG += value [value, ...] 1.50 +# Values that contain spaces should be placed between quotes (\" \"). 1.51 1.52 #--------------------------------------------------------------------------- 1.53 # Project related configuration options 1.54 #--------------------------------------------------------------------------- 1.55 1.56 # This tag specifies the encoding used for all characters in the config file 1.57 -# that follow. The default is UTF-8 which is also the encoding used for all 1.58 -# text before the first occurrence of this tag. Doxygen uses libiconv (or the 1.59 -# iconv built into libc) for the transcoding. See 1.60 -# http://www.gnu.org/software/libiconv for the list of possible encodings. 1.61 +# that follow. The default is UTF-8 which is also the encoding used for all text 1.62 +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 1.63 +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 1.64 +# for the list of possible encodings. 1.65 +# The default value is: UTF-8. 1.66 1.67 DOXYFILE_ENCODING = UTF-8 1.68 1.69 -# The PROJECT_NAME tag is a single word (or sequence of words) that should 1.70 -# identify the project. Note that if you do not use Doxywizard you need 1.71 -# to put quotes around the project name if it contains spaces. 1.72 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 1.73 +# double-quotes, unless you are using Doxywizard) that should identify the 1.74 +# project for which the documentation is generated. This name is used in the 1.75 +# title of most generated pages and in a few other places. 1.76 +# The default value is: My Project. 1.77 1.78 PROJECT_NAME = "ucx" 1.79 1.80 -# The PROJECT_NUMBER tag can be used to enter a project or revision number. 1.81 -# This could be handy for archiving the generated documentation or 1.82 -# if some version control system is used. 1.83 +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This 1.84 +# could be handy for archiving the generated documentation or if some version 1.85 +# control system is used. 1.86 1.87 PROJECT_NUMBER = 1.88 1.89 # Using the PROJECT_BRIEF tag one can provide an optional one line description 1.90 -# for a project that appears at the top of each page and should give viewer 1.91 -# a quick idea about the purpose of the project. Keep the description short. 1.92 +# for a project that appears at the top of each page and should give viewer a 1.93 +# quick idea about the purpose of the project. Keep the description short. 1.94 1.95 PROJECT_BRIEF = "UAP Common Extensions" 1.96 1.97 -# With the PROJECT_LOGO tag one can specify an logo or icon that is 1.98 -# included in the documentation. The maximum height of the logo should not 1.99 -# exceed 55 pixels and the maximum width should not exceed 200 pixels. 1.100 -# Doxygen will copy the logo to the output directory. 1.101 +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in 1.102 +# the documentation. The maximum height of the logo should not exceed 55 pixels 1.103 +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 1.104 +# to the output directory. 1.105 1.106 PROJECT_LOGO = ./uaplogo.png 1.107 1.108 -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 1.109 -# base path where the generated documentation will be put. 1.110 -# If a relative path is entered, it will be relative to the location 1.111 -# where doxygen was started. If left blank the current directory will be used. 1.112 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 1.113 +# into which the generated documentation will be written. If a relative path is 1.114 +# entered, it will be relative to the location where doxygen was started. If 1.115 +# left blank the current directory will be used. 1.116 1.117 OUTPUT_DIRECTORY = doc 1.118 1.119 -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 1.120 -# 4096 sub-directories (in 2 levels) under the output directory of each output 1.121 -# format and will distribute the generated files over these directories. 1.122 -# Enabling this option can be useful when feeding doxygen a huge amount of 1.123 -# source files, where putting all generated files in the same directory would 1.124 -# otherwise cause performance problems for the file system. 1.125 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 1.126 +# directories (in 2 levels) under the output directory of each output format and 1.127 +# will distribute the generated files over these directories. Enabling this 1.128 +# option can be useful when feeding doxygen a huge amount of source files, where 1.129 +# putting all generated files in the same directory would otherwise causes 1.130 +# performance problems for the file system. 1.131 +# The default value is: NO. 1.132 1.133 CREATE_SUBDIRS = NO 1.134 1.135 +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 1.136 +# characters to appear in the names of generated files. If set to NO, non-ASCII 1.137 +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 1.138 +# U+3044. 1.139 +# The default value is: NO. 1.140 + 1.141 +ALLOW_UNICODE_NAMES = NO 1.142 + 1.143 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 1.144 # documentation generated by doxygen is written. Doxygen will use this 1.145 # information to generate all constant output in the proper language. 1.146 -# The default language is English, other supported languages are: 1.147 -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 1.148 -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 1.149 -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 1.150 -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 1.151 -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 1.152 -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 1.153 +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 1.154 +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 1.155 +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 1.156 +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 1.157 +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 1.158 +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 1.159 +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 1.160 +# Ukrainian and Vietnamese. 1.161 +# The default value is: English. 1.162 1.163 OUTPUT_LANGUAGE = English 1.164 1.165 -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 1.166 -# include brief member descriptions after the members that are listed in 1.167 -# the file and class documentation (similar to JavaDoc). 1.168 -# Set to NO to disable this. 1.169 +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 1.170 +# descriptions after the members that are listed in the file and class 1.171 +# documentation (similar to Javadoc). Set to NO to disable this. 1.172 +# The default value is: YES. 1.173 1.174 BRIEF_MEMBER_DESC = YES 1.175 1.176 -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 1.177 -# the brief description of a member or function before the detailed description. 1.178 -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 1.179 +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 1.180 +# description of a member or function before the detailed description 1.181 +# 1.182 +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 1.183 # brief descriptions will be completely suppressed. 1.184 +# The default value is: YES. 1.185 1.186 REPEAT_BRIEF = YES 1.187 1.188 -# This tag implements a quasi-intelligent brief description abbreviator 1.189 -# that is used to form the text in various listings. Each string 1.190 -# in this list, if found as the leading text of the brief description, will be 1.191 -# stripped from the text and the result after processing the whole list, is 1.192 -# used as the annotated text. Otherwise, the brief description is used as-is. 1.193 -# If left blank, the following values are used ("$name" is automatically 1.194 -# replaced with the name of the entity): "The $name class" "The $name widget" 1.195 -# "The $name file" "is" "provides" "specifies" "contains" 1.196 -# "represents" "a" "an" "the" 1.197 +# This tag implements a quasi-intelligent brief description abbreviator that is 1.198 +# used to form the text in various listings. Each string in this list, if found 1.199 +# as the leading text of the brief description, will be stripped from the text 1.200 +# and the result, after processing the whole list, is used as the annotated 1.201 +# text. Otherwise, the brief description is used as-is. If left blank, the 1.202 +# following values are used ($name is automatically replaced with the name of 1.203 +# the entity):The $name class, The $name widget, The $name file, is, provides, 1.204 +# specifies, contains, represents, a, an and the. 1.205 1.206 ABBREVIATE_BRIEF = 1.207 1.208 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 1.209 -# Doxygen will generate a detailed section even if there is only a brief 1.210 +# doxygen will generate a detailed section even if there is only a brief 1.211 # description. 1.212 +# The default value is: NO. 1.213 1.214 ALWAYS_DETAILED_SEC = NO 1.215 1.216 @@ -138,160 +131,207 @@ 1.217 # inherited members of a class in the documentation of that class as if those 1.218 # members were ordinary class members. Constructors, destructors and assignment 1.219 # operators of the base classes will not be shown. 1.220 +# The default value is: NO. 1.221 1.222 INLINE_INHERITED_MEMB = NO 1.223 1.224 -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 1.225 -# path before files name in the file list and in the header files. If set 1.226 -# to NO the shortest path that makes the file name unique will be used. 1.227 +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 1.228 +# before files name in the file list and in the header files. If set to NO the 1.229 +# shortest path that makes the file name unique will be used 1.230 +# The default value is: YES. 1.231 1.232 FULL_PATH_NAMES = YES 1.233 1.234 -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 1.235 -# can be used to strip a user-defined part of the path. Stripping is 1.236 -# only done if one of the specified strings matches the left-hand part of 1.237 -# the path. The tag can be used to show relative paths in the file list. 1.238 -# If left blank the directory from which doxygen is run is used as the 1.239 -# path to strip. 1.240 +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 1.241 +# Stripping is only done if one of the specified strings matches the left-hand 1.242 +# part of the path. The tag can be used to show relative paths in the file list. 1.243 +# If left blank the directory from which doxygen is run is used as the path to 1.244 +# strip. 1.245 +# 1.246 +# Note that you can specify absolute paths here, but also relative paths, which 1.247 +# will be relative from the directory where doxygen is started. 1.248 +# This tag requires that the tag FULL_PATH_NAMES is set to YES. 1.249 1.250 STRIP_FROM_PATH = 1.251 1.252 -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 1.253 -# the path mentioned in the documentation of a class, which tells 1.254 -# the reader which header file to include in order to use a class. 1.255 -# If left blank only the name of the header file containing the class 1.256 -# definition is used. Otherwise one should specify the include paths that 1.257 -# are normally passed to the compiler using the -I flag. 1.258 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 1.259 +# path mentioned in the documentation of a class, which tells the reader which 1.260 +# header file to include in order to use a class. If left blank only the name of 1.261 +# the header file containing the class definition is used. Otherwise one should 1.262 +# specify the list of include paths that are normally passed to the compiler 1.263 +# using the -I flag. 1.264 1.265 STRIP_FROM_INC_PATH = 1.266 1.267 -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 1.268 -# (but less readable) file names. This can be useful if your file system 1.269 -# doesn't support long names like on DOS, Mac, or CD-ROM. 1.270 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 1.271 +# less readable) file names. This can be useful is your file systems doesn't 1.272 +# support long names like on DOS, Mac, or CD-ROM. 1.273 +# The default value is: NO. 1.274 1.275 SHORT_NAMES = NO 1.276 1.277 -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 1.278 -# will interpret the first line (until the first dot) of a JavaDoc-style 1.279 -# comment as the brief description. If set to NO, the JavaDoc 1.280 -# comments will behave just like regular Qt-style comments 1.281 -# (thus requiring an explicit @brief command for a brief description.) 1.282 +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 1.283 +# first line (until the first dot) of a Javadoc-style comment as the brief 1.284 +# description. If set to NO, the Javadoc-style will behave just like regular Qt- 1.285 +# style comments (thus requiring an explicit @brief command for a brief 1.286 +# description.) 1.287 +# The default value is: NO. 1.288 1.289 JAVADOC_AUTOBRIEF = YES 1.290 1.291 -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 1.292 -# interpret the first line (until the first dot) of a Qt-style 1.293 -# comment as the brief description. If set to NO, the comments 1.294 -# will behave just like regular Qt-style comments (thus requiring 1.295 -# an explicit \brief command for a brief description.) 1.296 +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 1.297 +# line (until the first dot) of a Qt-style comment as the brief description. If 1.298 +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus 1.299 +# requiring an explicit \brief command for a brief description.) 1.300 +# The default value is: NO. 1.301 1.302 QT_AUTOBRIEF = NO 1.303 1.304 -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 1.305 -# treat a multi-line C++ special comment block (i.e. a block of //! or /// 1.306 -# comments) as a brief description. This used to be the default behaviour. 1.307 -# The new default is to treat a multi-line C++ comment block as a detailed 1.308 -# description. Set this tag to YES if you prefer the old behaviour instead. 1.309 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 1.310 +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as 1.311 +# a brief description. This used to be the default behavior. The new default is 1.312 +# to treat a multi-line C++ comment block as a detailed description. Set this 1.313 +# tag to YES if you prefer the old behavior instead. 1.314 +# 1.315 +# Note that setting this tag to YES also means that rational rose comments are 1.316 +# not recognized any more. 1.317 +# The default value is: NO. 1.318 1.319 MULTILINE_CPP_IS_BRIEF = NO 1.320 1.321 -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 1.322 -# member inherits the documentation from any documented member that it 1.323 -# re-implements. 1.324 +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 1.325 +# documentation from any documented member that it re-implements. 1.326 +# The default value is: YES. 1.327 1.328 INHERIT_DOCS = YES 1.329 1.330 -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 1.331 -# a new page for each member. If set to NO, the documentation of a member will 1.332 -# be part of the file/class/namespace that contains it. 1.333 +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 1.334 +# new page for each member. If set to NO, the documentation of a member will be 1.335 +# part of the file/class/namespace that contains it. 1.336 +# The default value is: NO. 1.337 1.338 SEPARATE_MEMBER_PAGES = NO 1.339 1.340 -# The TAB_SIZE tag can be used to set the number of spaces in a tab. 1.341 -# Doxygen uses this value to replace tabs by spaces in code fragments. 1.342 +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 1.343 +# uses this value to replace tabs by spaces in code fragments. 1.344 +# Minimum value: 1, maximum value: 16, default value: 4. 1.345 1.346 TAB_SIZE = 4 1.347 1.348 -# This tag can be used to specify a number of aliases that acts 1.349 -# as commands in the documentation. An alias has the form "name=value". 1.350 -# For example adding "sideeffect=\par Side Effects:\n" will allow you to 1.351 -# put the command \sideeffect (or @sideeffect) in the documentation, which 1.352 -# will result in a user-defined paragraph with heading "Side Effects:". 1.353 -# You can put \n's in the value part of an alias to insert newlines. 1.354 +# This tag can be used to specify a number of aliases that act as commands in 1.355 +# the documentation. An alias has the form: 1.356 +# name=value 1.357 +# For example adding 1.358 +# "sideeffect=@par Side Effects:\n" 1.359 +# will allow you to put the command \sideeffect (or @sideeffect) in the 1.360 +# documentation, which will result in a user-defined paragraph with heading 1.361 +# "Side Effects:". You can put \n's in the value part of an alias to insert 1.362 +# newlines. 1.363 1.364 ALIASES = 1.365 1.366 # This tag can be used to specify a number of word-keyword mappings (TCL only). 1.367 -# A mapping has the form "name=value". For example adding 1.368 -# "class=itcl::class" will allow you to use the command class in the 1.369 -# itcl::class meaning. 1.370 +# A mapping has the form "name=value". For example adding "class=itcl::class" 1.371 +# will allow you to use the command class in the itcl::class meaning. 1.372 1.373 TCL_SUBST = 1.374 1.375 -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 1.376 -# sources only. Doxygen will then generate output that is more tailored for C. 1.377 -# For instance, some of the names that are used will be different. The list 1.378 -# of all members will be omitted, etc. 1.379 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 1.380 +# only. Doxygen will then generate output that is more tailored for C. For 1.381 +# instance, some of the names that are used will be different. The list of all 1.382 +# members will be omitted, etc. 1.383 +# The default value is: NO. 1.384 1.385 OPTIMIZE_OUTPUT_FOR_C = YES 1.386 1.387 -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 1.388 -# sources only. Doxygen will then generate output that is more tailored for 1.389 -# Java. For instance, namespaces will be presented as packages, qualified 1.390 -# scopes will look different, etc. 1.391 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 1.392 +# Python sources only. Doxygen will then generate output that is more tailored 1.393 +# for that language. For instance, namespaces will be presented as packages, 1.394 +# qualified scopes will look different, etc. 1.395 +# The default value is: NO. 1.396 1.397 OPTIMIZE_OUTPUT_JAVA = NO 1.398 1.399 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 1.400 -# sources only. Doxygen will then generate output that is more tailored for 1.401 -# Fortran. 1.402 +# sources. Doxygen will then generate output that is tailored for Fortran. 1.403 +# The default value is: NO. 1.404 1.405 OPTIMIZE_FOR_FORTRAN = NO 1.406 1.407 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 1.408 -# sources. Doxygen will then generate output that is tailored for 1.409 -# VHDL. 1.410 +# sources. Doxygen will then generate output that is tailored for VHDL. 1.411 +# The default value is: NO. 1.412 1.413 OPTIMIZE_OUTPUT_VHDL = NO 1.414 1.415 # Doxygen selects the parser to use depending on the extension of the files it 1.416 -# parses. With this tag you can assign which parser to use for a given extension. 1.417 -# Doxygen has a built-in mapping, but you can override or extend it using this 1.418 -# tag. The format is ext=language, where ext is a file extension, and language 1.419 -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 1.420 -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 1.421 -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 1.422 -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 1.423 -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 1.424 +# parses. With this tag you can assign which parser to use for a given 1.425 +# extension. Doxygen has a built-in mapping, but you can override or extend it 1.426 +# using this tag. The format is ext=language, where ext is a file extension, and 1.427 +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, 1.428 +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 1.429 +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 1.430 +# Fortran. In the later case the parser tries to guess whether the code is fixed 1.431 +# or free formatted code, this is the default for Fortran type files), VHDL. For 1.432 +# instance to make doxygen treat .inc files as Fortran files (default is PHP), 1.433 +# and .f files as C (default is Fortran), use: inc=Fortran f=C. 1.434 +# 1.435 +# Note For files without extension you can use no_extension as a placeholder. 1.436 +# 1.437 +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise 1.438 +# the files are not read by doxygen. 1.439 1.440 EXTENSION_MAPPING = 1.441 1.442 +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 1.443 +# according to the Markdown format, which allows for more readable 1.444 +# documentation. See http://daringfireball.net/projects/markdown/ for details. 1.445 +# The output of markdown processing is further processed by doxygen, so you can 1.446 +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 1.447 +# case of backward compatibilities issues. 1.448 +# The default value is: YES. 1.449 + 1.450 +MARKDOWN_SUPPORT = YES 1.451 + 1.452 +# When enabled doxygen tries to link words that correspond to documented 1.453 +# classes, or namespaces to their corresponding documentation. Such a link can 1.454 +# be prevented in individual cases by by putting a % sign in front of the word 1.455 +# or globally by setting AUTOLINK_SUPPORT to NO. 1.456 +# The default value is: YES. 1.457 + 1.458 +AUTOLINK_SUPPORT = YES 1.459 + 1.460 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 1.461 -# to include (a tag file for) the STL sources as input, then you should 1.462 -# set this tag to YES in order to let doxygen match functions declarations and 1.463 -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 1.464 -# func(std::string) {}). This also makes the inheritance and collaboration 1.465 +# to include (a tag file for) the STL sources as input, then you should set this 1.466 +# tag to YES in order to let doxygen match functions declarations and 1.467 +# definitions whose arguments contain STL classes (e.g. func(std::string); 1.468 +# versus func(std::string) {}). This also make the inheritance and collaboration 1.469 # diagrams that involve STL classes more complete and accurate. 1.470 +# The default value is: NO. 1.471 1.472 BUILTIN_STL_SUPPORT = NO 1.473 1.474 # If you use Microsoft's C++/CLI language, you should set this option to YES to 1.475 # enable parsing support. 1.476 +# The default value is: NO. 1.477 1.478 CPP_CLI_SUPPORT = NO 1.479 1.480 -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 1.481 -# Doxygen will parse them like normal C++ but will assume all classes use public 1.482 -# instead of private inheritance when no explicit protection keyword is present. 1.483 +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 1.484 +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 1.485 +# will parse them like normal C++ but will assume all classes use public instead 1.486 +# of private inheritance when no explicit protection keyword is present. 1.487 +# The default value is: NO. 1.488 1.489 SIP_SUPPORT = NO 1.490 1.491 -# For Microsoft's IDL there are propget and propput attributes to indicate getter 1.492 -# and setter methods for a property. Setting this option to YES (the default) 1.493 -# will make doxygen replace the get and set methods by a property in the 1.494 -# documentation. This will only work if the methods are indeed getting or 1.495 -# setting a simple type. If this is not the case, or you want to show the 1.496 -# methods anyway, you should set this option to NO. 1.497 +# For Microsoft's IDL there are propget and propput attributes to indicate 1.498 +# getter and setter methods for a property. Setting this option to YES will make 1.499 +# doxygen to replace the get and set methods by a property in the documentation. 1.500 +# This will only work if the methods are indeed getting or setting a simple 1.501 +# type. If this is not the case, or you want to show the methods anyway, you 1.502 +# should set this option to NO. 1.503 +# The default value is: YES. 1.504 1.505 IDL_PROPERTY_SUPPORT = YES 1.506 1.507 @@ -299,51 +339,61 @@ 1.508 # tag is set to YES, then doxygen will reuse the documentation of the first 1.509 # member in the group (if any) for the other members of the group. By default 1.510 # all members of a group must be documented explicitly. 1.511 +# The default value is: NO. 1.512 1.513 DISTRIBUTE_GROUP_DOC = NO 1.514 1.515 -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 1.516 -# the same type (for instance a group of public functions) to be put as a 1.517 -# subgroup of that type (e.g. under the Public Functions section). Set it to 1.518 -# NO to prevent subgrouping. Alternatively, this can be done per class using 1.519 -# the \nosubgrouping command. 1.520 +# Set the SUBGROUPING tag to YES to allow class member groups of the same type 1.521 +# (for instance a group of public functions) to be put as a subgroup of that 1.522 +# type (e.g. under the Public Functions section). Set it to NO to prevent 1.523 +# subgrouping. Alternatively, this can be done per class using the 1.524 +# \nosubgrouping command. 1.525 +# The default value is: YES. 1.526 1.527 SUBGROUPING = YES 1.528 1.529 -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 1.530 -# unions are shown inside the group in which they are included (e.g. using 1.531 -# @ingroup) instead of on a separate page (for HTML and Man pages) or 1.532 -# section (for LaTeX and RTF). 1.533 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 1.534 +# are shown inside the group in which they are included (e.g. using \ingroup) 1.535 +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX 1.536 +# and RTF). 1.537 +# 1.538 +# Note that this feature does not work in combination with 1.539 +# SEPARATE_MEMBER_PAGES. 1.540 +# The default value is: NO. 1.541 1.542 INLINE_GROUPED_CLASSES = NO 1.543 1.544 -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 1.545 -# unions with only public data fields will be shown inline in the documentation 1.546 -# of the scope in which they are defined (i.e. file, namespace, or group 1.547 -# documentation), provided this scope is documented. If set to NO (the default), 1.548 -# structs, classes, and unions are shown on a separate page (for HTML and Man 1.549 -# pages) or section (for LaTeX and RTF). 1.550 +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 1.551 +# with only public data fields or simple typedef fields will be shown inline in 1.552 +# the documentation of the scope in which they are defined (i.e. file, 1.553 +# namespace, or group documentation), provided this scope is documented. If set 1.554 +# to NO, structs, classes, and unions are shown on a separate page (for HTML and 1.555 +# Man pages) or section (for LaTeX and RTF). 1.556 +# The default value is: NO. 1.557 1.558 INLINE_SIMPLE_STRUCTS = NO 1.559 1.560 -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 1.561 -# is documented as struct, union, or enum with the name of the typedef. So 1.562 +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 1.563 +# enum is documented as struct, union, or enum with the name of the typedef. So 1.564 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 1.565 # with name TypeT. When disabled the typedef will appear as a member of a file, 1.566 -# namespace, or class. And the struct will be named TypeS. This can typically 1.567 -# be useful for C code in case the coding convention dictates that all compound 1.568 +# namespace, or class. And the struct will be named TypeS. This can typically be 1.569 +# useful for C code in case the coding convention dictates that all compound 1.570 # types are typedef'ed and only the typedef is referenced, never the tag name. 1.571 +# The default value is: NO. 1.572 1.573 TYPEDEF_HIDES_STRUCT = NO 1.574 1.575 -# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 1.576 -# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 1.577 -# their name and scope. Since this can be an expensive process and often the 1.578 -# same symbol appear multiple times in the code, doxygen keeps a cache of 1.579 -# pre-resolved symbols. If the cache is too small doxygen will become slower. 1.580 -# If the cache is too large, memory is wasted. The cache size is given by this 1.581 -# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 1.582 -# corresponding to a cache size of 2^16 = 65536 symbols. 1.583 +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 1.584 +# cache is used to resolve symbols given their name and scope. Since this can be 1.585 +# an expensive process and often the same symbol appears multiple times in the 1.586 +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 1.587 +# doxygen will become slower. If the cache is too large, memory is wasted. The 1.588 +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 1.589 +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 1.590 +# symbols. At the end of a run doxygen will report the cache usage and suggest 1.591 +# the optimal cache size from a speed point of view. 1.592 +# Minimum value: 0, maximum value: 9, default value: 0. 1.593 1.594 LOOKUP_CACHE_SIZE = 0 1.595 1.596 @@ -352,335 +402,390 @@ 1.597 #--------------------------------------------------------------------------- 1.598 1.599 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 1.600 -# documentation are documented, even if no documentation was available. 1.601 -# Private class members and static file members will be hidden unless 1.602 -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 1.603 +# documentation are documented, even if no documentation was available. Private 1.604 +# class members and static file members will be hidden unless the 1.605 +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 1.606 +# Note: This will also disable the warnings about undocumented members that are 1.607 +# normally produced when WARNINGS is set to YES. 1.608 +# The default value is: NO. 1.609 1.610 EXTRACT_ALL = NO 1.611 1.612 -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 1.613 -# will be included in the documentation. 1.614 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 1.615 +# be included in the documentation. 1.616 +# The default value is: NO. 1.617 1.618 EXTRACT_PRIVATE = NO 1.619 1.620 -# If the EXTRACT_STATIC tag is set to YES all static members of a file 1.621 -# will be included in the documentation. 1.622 +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 1.623 +# scope will be included in the documentation. 1.624 +# The default value is: NO. 1.625 + 1.626 +EXTRACT_PACKAGE = NO 1.627 + 1.628 +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be 1.629 +# included in the documentation. 1.630 +# The default value is: NO. 1.631 1.632 EXTRACT_STATIC = NO 1.633 1.634 -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 1.635 -# defined locally in source files will be included in the documentation. 1.636 -# If set to NO only classes defined in header files are included. 1.637 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 1.638 +# locally in source files will be included in the documentation. If set to NO 1.639 +# only classes defined in header files are included. Does not have any effect 1.640 +# for Java sources. 1.641 +# The default value is: YES. 1.642 1.643 EXTRACT_LOCAL_CLASSES = YES 1.644 1.645 -# This flag is only useful for Objective-C code. When set to YES local 1.646 -# methods, which are defined in the implementation section but not in 1.647 -# the interface are included in the documentation. 1.648 -# If set to NO (the default) only methods in the interface are included. 1.649 +# This flag is only useful for Objective-C code. When set to YES local methods, 1.650 +# which are defined in the implementation section but not in the interface are 1.651 +# included in the documentation. If set to NO only methods in the interface are 1.652 +# included. 1.653 +# The default value is: NO. 1.654 1.655 EXTRACT_LOCAL_METHODS = NO 1.656 1.657 # If this flag is set to YES, the members of anonymous namespaces will be 1.658 # extracted and appear in the documentation as a namespace called 1.659 -# 'anonymous_namespace{file}', where file will be replaced with the base 1.660 -# name of the file that contains the anonymous namespace. By default 1.661 -# anonymous namespaces are hidden. 1.662 +# 'anonymous_namespace{file}', where file will be replaced with the base name of 1.663 +# the file that contains the anonymous namespace. By default anonymous namespace 1.664 +# are hidden. 1.665 +# The default value is: NO. 1.666 1.667 EXTRACT_ANON_NSPACES = NO 1.668 1.669 -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 1.670 -# undocumented members of documented classes, files or namespaces. 1.671 -# If set to NO (the default) these members will be included in the 1.672 -# various overviews, but no documentation section is generated. 1.673 -# This option has no effect if EXTRACT_ALL is enabled. 1.674 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 1.675 +# undocumented members inside documented classes or files. If set to NO these 1.676 +# members will be included in the various overviews, but no documentation 1.677 +# section is generated. This option has no effect if EXTRACT_ALL is enabled. 1.678 +# The default value is: NO. 1.679 1.680 HIDE_UNDOC_MEMBERS = NO 1.681 1.682 -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 1.683 -# undocumented classes that are normally visible in the class hierarchy. 1.684 -# If set to NO (the default) these classes will be included in the various 1.685 -# overviews. This option has no effect if EXTRACT_ALL is enabled. 1.686 +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 1.687 +# undocumented classes that are normally visible in the class hierarchy. If set 1.688 +# to NO these classes will be included in the various overviews. This option has 1.689 +# no effect if EXTRACT_ALL is enabled. 1.690 +# The default value is: NO. 1.691 1.692 HIDE_UNDOC_CLASSES = NO 1.693 1.694 -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 1.695 -# friend (class|struct|union) declarations. 1.696 -# If set to NO (the default) these declarations will be included in the 1.697 -# documentation. 1.698 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 1.699 +# (class|struct|union) declarations. If set to NO these declarations will be 1.700 +# included in the documentation. 1.701 +# The default value is: NO. 1.702 1.703 HIDE_FRIEND_COMPOUNDS = NO 1.704 1.705 -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 1.706 -# documentation blocks found inside the body of a function. 1.707 -# If set to NO (the default) these blocks will be appended to the 1.708 -# function's detailed documentation block. 1.709 +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 1.710 +# documentation blocks found inside the body of a function. If set to NO these 1.711 +# blocks will be appended to the function's detailed documentation block. 1.712 +# The default value is: NO. 1.713 1.714 HIDE_IN_BODY_DOCS = NO 1.715 1.716 -# The INTERNAL_DOCS tag determines if documentation 1.717 -# that is typed after a \internal command is included. If the tag is set 1.718 -# to NO (the default) then the documentation will be excluded. 1.719 -# Set it to YES to include the internal documentation. 1.720 +# The INTERNAL_DOCS tag determines if documentation that is typed after a 1.721 +# \internal command is included. If the tag is set to NO then the documentation 1.722 +# will be excluded. Set it to YES to include the internal documentation. 1.723 +# The default value is: NO. 1.724 1.725 INTERNAL_DOCS = NO 1.726 1.727 -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 1.728 -# file names in lower-case letters. If set to YES upper-case letters are also 1.729 +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 1.730 +# names in lower-case letters. If set to YES upper-case letters are also 1.731 # allowed. This is useful if you have classes or files whose names only differ 1.732 # in case and if your file system supports case sensitive file names. Windows 1.733 # and Mac users are advised to set this option to NO. 1.734 +# The default value is: system dependent. 1.735 1.736 CASE_SENSE_NAMES = YES 1.737 1.738 -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 1.739 -# will show members with their full class and namespace scopes in the 1.740 -# documentation. If set to YES the scope will be hidden. 1.741 +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 1.742 +# their full class and namespace scopes in the documentation. If set to YES the 1.743 +# scope will be hidden. 1.744 +# The default value is: NO. 1.745 1.746 HIDE_SCOPE_NAMES = NO 1.747 1.748 -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 1.749 -# will put a list of the files that are included by a file in the documentation 1.750 -# of that file. 1.751 +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 1.752 +# the files that are included by a file in the documentation of that file. 1.753 +# The default value is: YES. 1.754 1.755 SHOW_INCLUDE_FILES = YES 1.756 1.757 -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 1.758 -# will list include files with double quotes in the documentation 1.759 -# rather than with sharp brackets. 1.760 +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 1.761 +# grouped member an include statement to the documentation, telling the reader 1.762 +# which file to include in order to use the member. 1.763 +# The default value is: NO. 1.764 + 1.765 +SHOW_GROUPED_MEMB_INC = NO 1.766 + 1.767 +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 1.768 +# files with double quotes in the documentation rather than with sharp brackets. 1.769 +# The default value is: NO. 1.770 1.771 FORCE_LOCAL_INCLUDES = NO 1.772 1.773 -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 1.774 -# is inserted in the documentation for inline members. 1.775 +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 1.776 +# documentation for inline members. 1.777 +# The default value is: YES. 1.778 1.779 INLINE_INFO = YES 1.780 1.781 -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 1.782 -# will sort the (detailed) documentation of file and class members 1.783 -# alphabetically by member name. If set to NO the members will appear in 1.784 -# declaration order. 1.785 +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 1.786 +# (detailed) documentation of file and class members alphabetically by member 1.787 +# name. If set to NO the members will appear in declaration order. 1.788 +# The default value is: YES. 1.789 1.790 SORT_MEMBER_DOCS = YES 1.791 1.792 -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 1.793 -# brief documentation of file, namespace and class members alphabetically 1.794 -# by member name. If set to NO (the default) the members will appear in 1.795 -# declaration order. 1.796 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 1.797 +# descriptions of file, namespace and class members alphabetically by member 1.798 +# name. If set to NO the members will appear in declaration order. Note that 1.799 +# this will also influence the order of the classes in the class list. 1.800 +# The default value is: NO. 1.801 1.802 SORT_BRIEF_DOCS = NO 1.803 1.804 -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 1.805 -# will sort the (brief and detailed) documentation of class members so that 1.806 -# constructors and destructors are listed first. If set to NO (the default) 1.807 -# the constructors will appear in the respective orders defined by 1.808 -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 1.809 -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 1.810 -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 1.811 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 1.812 +# (brief and detailed) documentation of class members so that constructors and 1.813 +# destructors are listed first. If set to NO the constructors will appear in the 1.814 +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 1.815 +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 1.816 +# member documentation. 1.817 +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 1.818 +# detailed member documentation. 1.819 +# The default value is: NO. 1.820 1.821 SORT_MEMBERS_CTORS_1ST = NO 1.822 1.823 -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 1.824 -# hierarchy of group names into alphabetical order. If set to NO (the default) 1.825 -# the group names will appear in their defined order. 1.826 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 1.827 +# of group names into alphabetical order. If set to NO the group names will 1.828 +# appear in their defined order. 1.829 +# The default value is: NO. 1.830 1.831 SORT_GROUP_NAMES = NO 1.832 1.833 -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 1.834 -# sorted by fully-qualified names, including namespaces. If set to 1.835 -# NO (the default), the class list will be sorted only by class name, 1.836 -# not including the namespace part. 1.837 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 1.838 +# fully-qualified names, including namespaces. If set to NO, the class list will 1.839 +# be sorted only by class name, not including the namespace part. 1.840 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 1.841 -# Note: This option applies only to the class list, not to the 1.842 -# alphabetical list. 1.843 +# Note: This option applies only to the class list, not to the alphabetical 1.844 +# list. 1.845 +# The default value is: NO. 1.846 1.847 SORT_BY_SCOPE_NAME = NO 1.848 1.849 -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 1.850 -# do proper type resolution of all parameters of a function it will reject a 1.851 -# match between the prototype and the implementation of a member function even 1.852 -# if there is only one candidate or it is obvious which candidate to choose 1.853 -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 1.854 -# will still accept a match between prototype and implementation in such cases. 1.855 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 1.856 +# type resolution of all parameters of a function it will reject a match between 1.857 +# the prototype and the implementation of a member function even if there is 1.858 +# only one candidate or it is obvious which candidate to choose by doing a 1.859 +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 1.860 +# accept a match between prototype and implementation in such cases. 1.861 +# The default value is: NO. 1.862 1.863 STRICT_PROTO_MATCHING = NO 1.864 1.865 -# The GENERATE_TODOLIST tag can be used to enable (YES) or 1.866 -# disable (NO) the todo list. This list is created by putting \todo 1.867 -# commands in the documentation. 1.868 +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 1.869 +# todo list. This list is created by putting \todo commands in the 1.870 +# documentation. 1.871 +# The default value is: YES. 1.872 1.873 GENERATE_TODOLIST = YES 1.874 1.875 -# The GENERATE_TESTLIST tag can be used to enable (YES) or 1.876 -# disable (NO) the test list. This list is created by putting \test 1.877 -# commands in the documentation. 1.878 +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 1.879 +# test list. This list is created by putting \test commands in the 1.880 +# documentation. 1.881 +# The default value is: YES. 1.882 1.883 GENERATE_TESTLIST = YES 1.884 1.885 -# The GENERATE_BUGLIST tag can be used to enable (YES) or 1.886 -# disable (NO) the bug list. This list is created by putting \bug 1.887 -# commands in the documentation. 1.888 +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 1.889 +# list. This list is created by putting \bug commands in the documentation. 1.890 +# The default value is: YES. 1.891 1.892 GENERATE_BUGLIST = YES 1.893 1.894 -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 1.895 -# disable (NO) the deprecated list. This list is created by putting 1.896 -# \deprecated commands in the documentation. 1.897 +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 1.898 +# the deprecated list. This list is created by putting \deprecated commands in 1.899 +# the documentation. 1.900 +# The default value is: YES. 1.901 1.902 GENERATE_DEPRECATEDLIST= YES 1.903 1.904 -# The ENABLED_SECTIONS tag can be used to enable conditional 1.905 -# documentation sections, marked by \if sectionname ... \endif. 1.906 +# The ENABLED_SECTIONS tag can be used to enable conditional documentation 1.907 +# sections, marked by \if <section_label> ... \endif and \cond <section_label> 1.908 +# ... \endcond blocks. 1.909 1.910 ENABLED_SECTIONS = 1.911 1.912 -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 1.913 -# the initial value of a variable or macro consists of for it to appear in 1.914 -# the documentation. If the initializer consists of more lines than specified 1.915 -# here it will be hidden. Use a value of 0 to hide initializers completely. 1.916 -# The appearance of the initializer of individual variables and macros in the 1.917 -# documentation can be controlled using \showinitializer or \hideinitializer 1.918 -# command in the documentation regardless of this setting. 1.919 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 1.920 +# initial value of a variable or macro / define can have for it to appear in the 1.921 +# documentation. If the initializer consists of more lines than specified here 1.922 +# it will be hidden. Use a value of 0 to hide initializers completely. The 1.923 +# appearance of the value of individual variables and macros / defines can be 1.924 +# controlled using \showinitializer or \hideinitializer command in the 1.925 +# documentation regardless of this setting. 1.926 +# Minimum value: 0, maximum value: 10000, default value: 30. 1.927 1.928 MAX_INITIALIZER_LINES = 30 1.929 1.930 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 1.931 -# at the bottom of the documentation of classes and structs. If set to YES the 1.932 -# list will mention the files that were used to generate the documentation. 1.933 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 1.934 +# the bottom of the documentation of classes and structs. If set to YES the list 1.935 +# will mention the files that were used to generate the documentation. 1.936 +# The default value is: YES. 1.937 1.938 SHOW_USED_FILES = YES 1.939 1.940 -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 1.941 -# This will remove the Files entry from the Quick Index and from the 1.942 -# Folder Tree View (if specified). The default is YES. 1.943 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 1.944 +# will remove the Files entry from the Quick Index and from the Folder Tree View 1.945 +# (if specified). 1.946 +# The default value is: YES. 1.947 1.948 SHOW_FILES = YES 1.949 1.950 -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 1.951 -# Namespaces page. 1.952 -# This will remove the Namespaces entry from the Quick Index 1.953 -# and from the Folder Tree View (if specified). The default is YES. 1.954 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 1.955 +# page. This will remove the Namespaces entry from the Quick Index and from the 1.956 +# Folder Tree View (if specified). 1.957 +# The default value is: YES. 1.958 1.959 SHOW_NAMESPACES = YES 1.960 1.961 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 1.962 # doxygen should invoke to get the current version for each file (typically from 1.963 # the version control system). Doxygen will invoke the program by executing (via 1.964 -# popen()) the command <command> <input-file>, where <command> is the value of 1.965 -# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 1.966 -# provided by doxygen. Whatever the program writes to standard output 1.967 -# is used as the file version. See the manual for examples. 1.968 +# popen()) the command command input-file, where command is the value of the 1.969 +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 1.970 +# by doxygen. Whatever the program writes to standard output is used as the file 1.971 +# version. For an example see the documentation. 1.972 1.973 FILE_VERSION_FILTER = 1.974 1.975 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 1.976 # by doxygen. The layout file controls the global structure of the generated 1.977 -# output files in an output format independent way. The create the layout file 1.978 -# that represents doxygen's defaults, run doxygen with the -l option. 1.979 -# You can optionally specify a file name after the option, if omitted 1.980 -# DoxygenLayout.xml will be used as the name of the layout file. 1.981 +# output files in an output format independent way. To create the layout file 1.982 +# that represents doxygen's defaults, run doxygen with the -l option. You can 1.983 +# optionally specify a file name after the option, if omitted DoxygenLayout.xml 1.984 +# will be used as the name of the layout file. 1.985 +# 1.986 +# Note that if you run doxygen from a directory containing a file called 1.987 +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 1.988 +# tag is left empty. 1.989 1.990 LAYOUT_FILE = 1.991 1.992 -# The CITE_BIB_FILES tag can be used to specify one or more bib files 1.993 -# containing the references data. This must be a list of .bib files. The 1.994 -# .bib extension is automatically appended if omitted. Using this command 1.995 -# requires the bibtex tool to be installed. See also 1.996 -# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 1.997 -# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 1.998 -# feature you need bibtex and perl available in the search path. 1.999 +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing 1.1000 +# the reference definitions. This must be a list of .bib files. The .bib 1.1001 +# extension is automatically appended if omitted. This requires the bibtex tool 1.1002 +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 1.1003 +# For LaTeX the style of the bibliography can be controlled using 1.1004 +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 1.1005 +# search path. Do not use file names with spaces, bibtex cannot handle them. See 1.1006 +# also \cite for info how to create references. 1.1007 1.1008 CITE_BIB_FILES = 1.1009 1.1010 #--------------------------------------------------------------------------- 1.1011 -# configuration options related to warning and progress messages 1.1012 +# Configuration options related to warning and progress messages 1.1013 #--------------------------------------------------------------------------- 1.1014 1.1015 -# The QUIET tag can be used to turn on/off the messages that are generated 1.1016 -# by doxygen. Possible values are YES and NO. If left blank NO is used. 1.1017 +# The QUIET tag can be used to turn on/off the messages that are generated to 1.1018 +# standard output by doxygen. If QUIET is set to YES this implies that the 1.1019 +# messages are off. 1.1020 +# The default value is: NO. 1.1021 1.1022 QUIET = NO 1.1023 1.1024 # The WARNINGS tag can be used to turn on/off the warning messages that are 1.1025 -# generated by doxygen. Possible values are YES and NO. If left blank 1.1026 -# NO is used. 1.1027 +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 1.1028 +# this implies that the warnings are on. 1.1029 +# 1.1030 +# Tip: Turn warnings on while writing the documentation. 1.1031 +# The default value is: YES. 1.1032 1.1033 WARNINGS = YES 1.1034 1.1035 -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 1.1036 -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 1.1037 -# automatically be disabled. 1.1038 +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 1.1039 +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 1.1040 +# will automatically be disabled. 1.1041 +# The default value is: YES. 1.1042 1.1043 WARN_IF_UNDOCUMENTED = YES 1.1044 1.1045 -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 1.1046 -# potential errors in the documentation, such as not documenting some 1.1047 -# parameters in a documented function, or documenting parameters that 1.1048 -# don't exist or using markup commands wrongly. 1.1049 +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 1.1050 +# potential errors in the documentation, such as not documenting some parameters 1.1051 +# in a documented function, or documenting parameters that don't exist or using 1.1052 +# markup commands wrongly. 1.1053 +# The default value is: YES. 1.1054 1.1055 WARN_IF_DOC_ERROR = YES 1.1056 1.1057 -# The WARN_NO_PARAMDOC option can be enabled to get warnings for 1.1058 -# functions that are documented, but have no documentation for their parameters 1.1059 -# or return value. If set to NO (the default) doxygen will only warn about 1.1060 -# wrong or incomplete parameter documentation, but not about the absence of 1.1061 -# documentation. 1.1062 +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 1.1063 +# are documented, but have no documentation for their parameters or return 1.1064 +# value. If set to NO doxygen will only warn about wrong or incomplete parameter 1.1065 +# documentation, but not about the absence of documentation. 1.1066 +# The default value is: NO. 1.1067 1.1068 WARN_NO_PARAMDOC = YES 1.1069 1.1070 -# The WARN_FORMAT tag determines the format of the warning messages that 1.1071 -# doxygen can produce. The string should contain the $file, $line, and $text 1.1072 -# tags, which will be replaced by the file and line number from which the 1.1073 -# warning originated and the warning text. Optionally the format may contain 1.1074 -# $version, which will be replaced by the version of the file (if it could 1.1075 -# be obtained via FILE_VERSION_FILTER) 1.1076 +# The WARN_FORMAT tag determines the format of the warning messages that doxygen 1.1077 +# can produce. The string should contain the $file, $line, and $text tags, which 1.1078 +# will be replaced by the file and line number from which the warning originated 1.1079 +# and the warning text. Optionally the format may contain $version, which will 1.1080 +# be replaced by the version of the file (if it could be obtained via 1.1081 +# FILE_VERSION_FILTER) 1.1082 +# The default value is: $file:$line: $text. 1.1083 1.1084 WARN_FORMAT = "$file:$line: $text" 1.1085 1.1086 -# The WARN_LOGFILE tag can be used to specify a file to which warning 1.1087 -# and error messages should be written. If left blank the output is written 1.1088 -# to stderr. 1.1089 +# The WARN_LOGFILE tag can be used to specify a file to which warning and error 1.1090 +# messages should be written. If left blank the output is written to standard 1.1091 +# error (stderr). 1.1092 1.1093 WARN_LOGFILE = 1.1094 1.1095 #--------------------------------------------------------------------------- 1.1096 -# configuration options related to the input files 1.1097 +# Configuration options related to the input files 1.1098 #--------------------------------------------------------------------------- 1.1099 1.1100 -# The INPUT tag can be used to specify the files and/or directories that contain 1.1101 -# documented source files. You may enter file names like "myfile.cpp" or 1.1102 -# directories like "/usr/src/myproject". Separate the files or directories 1.1103 -# with spaces. 1.1104 +# The INPUT tag is used to specify the files and/or directories that contain 1.1105 +# documented source files. You may enter file names like myfile.cpp or 1.1106 +# directories like /usr/src/myproject. Separate the files or directories with 1.1107 +# spaces. 1.1108 +# Note: If this tag is empty the current directory is searched. 1.1109 1.1110 INPUT = ./ucx 1.1111 1.1112 # This tag can be used to specify the character encoding of the source files 1.1113 -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 1.1114 -# also the default input encoding. Doxygen uses libiconv (or the iconv built 1.1115 -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 1.1116 -# the list of possible encodings. 1.1117 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 1.1118 +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 1.1119 +# documentation (see: http://www.gnu.org/software/libiconv) for the list of 1.1120 +# possible encodings. 1.1121 +# The default value is: UTF-8. 1.1122 1.1123 INPUT_ENCODING = UTF-8 1.1124 1.1125 # If the value of the INPUT tag contains directories, you can use the 1.1126 -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 1.1127 -# and *.h) to filter out the source-files in the directories. If left 1.1128 -# blank the following patterns are tested: 1.1129 -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 1.1130 -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 1.1131 -# *.f90 *.f *.for *.vhd *.vhdl 1.1132 +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 1.1133 +# *.h) to filter out the source-files in the directories. If left blank the 1.1134 +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 1.1135 +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 1.1136 +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 1.1137 +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 1.1138 +# *.qsf, *.as and *.js. 1.1139 1.1140 FILE_PATTERNS = 1.1141 1.1142 -# The RECURSIVE tag can be used to turn specify whether or not subdirectories 1.1143 -# should be searched for input files as well. Possible values are YES and NO. 1.1144 -# If left blank NO is used. 1.1145 +# The RECURSIVE tag can be used to specify whether or not subdirectories should 1.1146 +# be searched for input files as well. 1.1147 +# The default value is: NO. 1.1148 1.1149 RECURSIVE = YES 1.1150 1.1151 # The EXCLUDE tag can be used to specify files and/or directories that should be 1.1152 # excluded from the INPUT source files. This way you can easily exclude a 1.1153 # subdirectory from a directory tree whose root is specified with the INPUT tag. 1.1154 +# 1.1155 # Note that relative paths are relative to the directory from which doxygen is 1.1156 # run. 1.1157 1.1158 @@ -689,762 +794,1094 @@ 1.1159 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 1.1160 # directories that are symbolic links (a Unix file system feature) are excluded 1.1161 # from the input. 1.1162 +# The default value is: NO. 1.1163 1.1164 EXCLUDE_SYMLINKS = NO 1.1165 1.1166 # If the value of the INPUT tag contains directories, you can use the 1.1167 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 1.1168 -# certain files from those directories. Note that the wildcards are matched 1.1169 -# against the file with absolute path, so to exclude all test directories 1.1170 -# for example use the pattern */test/* 1.1171 - 1.1172 -EXCLUDE_PATTERNS = 1.1173 +# certain files from those directories. 1.1174 +# 1.1175 +# Note that the wildcards are matched against the file with absolute path, so to 1.1176 +# exclude all test directories for example use the pattern */test/* 1.1177 + 1.1178 +EXCLUDE_PATTERNS = 1.1179 1.1180 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 1.1181 # (namespaces, classes, functions, etc.) that should be excluded from the 1.1182 # output. The symbol name can be a fully qualified name, a word, or if the 1.1183 # wildcard * is used, a substring. Examples: ANamespace, AClass, 1.1184 # AClass::ANamespace, ANamespace::*Test 1.1185 +# 1.1186 +# Note that the wildcards are matched against the file with absolute path, so to 1.1187 +# exclude all test directories use the pattern */test/* 1.1188 1.1189 EXCLUDE_SYMBOLS = 1.1190 1.1191 -# The EXAMPLE_PATH tag can be used to specify one or more files or 1.1192 -# directories that contain example code fragments that are included (see 1.1193 -# the \include command). 1.1194 +# The EXAMPLE_PATH tag can be used to specify one or more files or directories 1.1195 +# that contain example code fragments that are included (see the \include 1.1196 +# command). 1.1197 1.1198 EXAMPLE_PATH = 1.1199 1.1200 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 1.1201 -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 1.1202 -# and *.h) to filter out the source-files in the directories. If left 1.1203 -# blank all files are included. 1.1204 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 1.1205 +# *.h) to filter out the source-files in the directories. If left blank all 1.1206 +# files are included. 1.1207 1.1208 EXAMPLE_PATTERNS = 1.1209 1.1210 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 1.1211 -# searched for input files to be used with the \include or \dontinclude 1.1212 -# commands irrespective of the value of the RECURSIVE tag. 1.1213 -# Possible values are YES and NO. If left blank NO is used. 1.1214 +# searched for input files to be used with the \include or \dontinclude commands 1.1215 +# irrespective of the value of the RECURSIVE tag. 1.1216 +# The default value is: NO. 1.1217 1.1218 EXAMPLE_RECURSIVE = NO 1.1219 1.1220 -# The IMAGE_PATH tag can be used to specify one or more files or 1.1221 -# directories that contain image that are included in the documentation (see 1.1222 -# the \image command). 1.1223 +# The IMAGE_PATH tag can be used to specify one or more files or directories 1.1224 +# that contain images that are to be included in the documentation (see the 1.1225 +# \image command). 1.1226 1.1227 IMAGE_PATH = 1.1228 1.1229 # The INPUT_FILTER tag can be used to specify a program that doxygen should 1.1230 # invoke to filter for each input file. Doxygen will invoke the filter program 1.1231 -# by executing (via popen()) the command <filter> <input-file>, where <filter> 1.1232 -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 1.1233 -# input file. Doxygen will then use the output that the filter program writes 1.1234 -# to standard output. 1.1235 -# If FILTER_PATTERNS is specified, this tag will be 1.1236 -# ignored. 1.1237 +# by executing (via popen()) the command: 1.1238 +# 1.1239 +# <filter> <input-file> 1.1240 +# 1.1241 +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 1.1242 +# name of an input file. Doxygen will then use the output that the filter 1.1243 +# program writes to standard output. If FILTER_PATTERNS is specified, this tag 1.1244 +# will be ignored. 1.1245 +# 1.1246 +# Note that the filter must not add or remove lines; it is applied before the 1.1247 +# code is scanned, but not when the output code is generated. If lines are added 1.1248 +# or removed, the anchors will not be placed correctly. 1.1249 1.1250 INPUT_FILTER = 1.1251 1.1252 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1.1253 -# basis. 1.1254 -# Doxygen will compare the file name with each pattern and apply the 1.1255 -# filter if there is a match. 1.1256 -# The filters are a list of the form: 1.1257 -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 1.1258 -# info on how filters are used. If FILTER_PATTERNS is empty or if 1.1259 -# non of the patterns match the file name, INPUT_FILTER is applied. 1.1260 +# basis. Doxygen will compare the file name with each pattern and apply the 1.1261 +# filter if there is a match. The filters are a list of the form: pattern=filter 1.1262 +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 1.1263 +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1.1264 +# patterns match the file name, INPUT_FILTER is applied. 1.1265 1.1266 FILTER_PATTERNS = 1.1267 1.1268 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1.1269 -# INPUT_FILTER) will be used to filter the input files when producing source 1.1270 -# files to browse (i.e. when SOURCE_BROWSER is set to YES). 1.1271 +# INPUT_FILTER ) will also be used to filter the input files that are used for 1.1272 +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1.1273 +# The default value is: NO. 1.1274 1.1275 FILTER_SOURCE_FILES = NO 1.1276 1.1277 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1.1278 -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 1.1279 -# and it is also possible to disable source filtering for a specific pattern 1.1280 -# using *.ext= (so without naming a filter). This option only has effect when 1.1281 -# FILTER_SOURCE_FILES is enabled. 1.1282 +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1.1283 +# it is also possible to disable source filtering for a specific pattern using 1.1284 +# *.ext= (so without naming a filter). 1.1285 +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1.1286 1.1287 FILTER_SOURCE_PATTERNS = 1.1288 1.1289 +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1.1290 +# is part of the input, its contents will be placed on the main page 1.1291 +# (index.html). This can be useful if you have a project on for instance GitHub 1.1292 +# and want to reuse the introduction page also for the doxygen output. 1.1293 + 1.1294 +USE_MDFILE_AS_MAINPAGE = 1.1295 + 1.1296 #--------------------------------------------------------------------------- 1.1297 -# configuration options related to source browsing 1.1298 +# Configuration options related to source browsing 1.1299 #--------------------------------------------------------------------------- 1.1300 1.1301 -# If the SOURCE_BROWSER tag is set to YES then a list of source files will 1.1302 -# be generated. Documented entities will be cross-referenced with these sources. 1.1303 -# Note: To get rid of all source code in the generated output, make sure also 1.1304 -# VERBATIM_HEADERS is set to NO. 1.1305 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1.1306 +# generated. Documented entities will be cross-referenced with these sources. 1.1307 +# 1.1308 +# Note: To get rid of all source code in the generated output, make sure that 1.1309 +# also VERBATIM_HEADERS is set to NO. 1.1310 +# The default value is: NO. 1.1311 1.1312 SOURCE_BROWSER = NO 1.1313 1.1314 -# Setting the INLINE_SOURCES tag to YES will include the body 1.1315 -# of functions and classes directly in the documentation. 1.1316 +# Setting the INLINE_SOURCES tag to YES will include the body of functions, 1.1317 +# classes and enums directly into the documentation. 1.1318 +# The default value is: NO. 1.1319 1.1320 INLINE_SOURCES = NO 1.1321 1.1322 -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 1.1323 -# doxygen to hide any special comment blocks from generated source code 1.1324 -# fragments. Normal C and C++ comments will always remain visible. 1.1325 +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1.1326 +# special comment blocks from generated source code fragments. Normal C, C++ and 1.1327 +# Fortran comments will always remain visible. 1.1328 +# The default value is: YES. 1.1329 1.1330 STRIP_CODE_COMMENTS = YES 1.1331 1.1332 -# If the REFERENCED_BY_RELATION tag is set to YES 1.1333 -# then for each documented function all documented 1.1334 -# functions referencing it will be listed. 1.1335 +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1.1336 +# function all documented functions referencing it will be listed. 1.1337 +# The default value is: NO. 1.1338 1.1339 REFERENCED_BY_RELATION = NO 1.1340 1.1341 -# If the REFERENCES_RELATION tag is set to YES 1.1342 -# then for each documented function all documented entities 1.1343 -# called/used by that function will be listed. 1.1344 +# If the REFERENCES_RELATION tag is set to YES then for each documented function 1.1345 +# all documented entities called/used by that function will be listed. 1.1346 +# The default value is: NO. 1.1347 1.1348 REFERENCES_RELATION = NO 1.1349 1.1350 -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 1.1351 -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 1.1352 -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 1.1353 -# link to the source code. 1.1354 -# Otherwise they will link to the documentation. 1.1355 +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1.1356 +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and 1.1357 +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1.1358 +# link to the documentation. 1.1359 +# The default value is: YES. 1.1360 1.1361 REFERENCES_LINK_SOURCE = YES 1.1362 1.1363 -# If the USE_HTAGS tag is set to YES then the references to source code 1.1364 -# will point to the HTML generated by the htags(1) tool instead of doxygen 1.1365 -# built-in source browser. The htags tool is part of GNU's global source 1.1366 -# tagging system (see http://www.gnu.org/software/global/global.html). You 1.1367 -# will need version 4.8.6 or higher. 1.1368 +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1.1369 +# source code will show a tooltip with additional information such as prototype, 1.1370 +# brief description and links to the definition and documentation. Since this 1.1371 +# will make the HTML file larger and loading of large files a bit slower, you 1.1372 +# can opt to disable this feature. 1.1373 +# The default value is: YES. 1.1374 +# This tag requires that the tag SOURCE_BROWSER is set to YES. 1.1375 + 1.1376 +SOURCE_TOOLTIPS = YES 1.1377 + 1.1378 +# If the USE_HTAGS tag is set to YES then the references to source code will 1.1379 +# point to the HTML generated by the htags(1) tool instead of doxygen built-in 1.1380 +# source browser. The htags tool is part of GNU's global source tagging system 1.1381 +# (see http://www.gnu.org/software/global/global.html). You will need version 1.1382 +# 4.8.6 or higher. 1.1383 +# 1.1384 +# To use it do the following: 1.1385 +# - Install the latest version of global 1.1386 +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1.1387 +# - Make sure the INPUT points to the root of the source tree 1.1388 +# - Run doxygen as normal 1.1389 +# 1.1390 +# Doxygen will invoke htags (and that will in turn invoke gtags), so these 1.1391 +# tools must be available from the command line (i.e. in the search path). 1.1392 +# 1.1393 +# The result: instead of the source browser generated by doxygen, the links to 1.1394 +# source code will now point to the output of htags. 1.1395 +# The default value is: NO. 1.1396 +# This tag requires that the tag SOURCE_BROWSER is set to YES. 1.1397 1.1398 USE_HTAGS = NO 1.1399 1.1400 -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 1.1401 -# will generate a verbatim copy of the header file for each class for 1.1402 -# which an include is specified. Set to NO to disable this. 1.1403 +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1.1404 +# verbatim copy of the header file for each class for which an include is 1.1405 +# specified. Set to NO to disable this. 1.1406 +# See also: Section \class. 1.1407 +# The default value is: YES. 1.1408 1.1409 VERBATIM_HEADERS = YES 1.1410 1.1411 #--------------------------------------------------------------------------- 1.1412 -# configuration options related to the alphabetical class index 1.1413 +# Configuration options related to the alphabetical class index 1.1414 #--------------------------------------------------------------------------- 1.1415 1.1416 -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 1.1417 -# of all compounds will be generated. Enable this if the project 1.1418 -# contains a lot of classes, structs, unions or interfaces. 1.1419 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1.1420 +# compounds will be generated. Enable this if the project contains a lot of 1.1421 +# classes, structs, unions or interfaces. 1.1422 +# The default value is: YES. 1.1423 1.1424 ALPHABETICAL_INDEX = YES 1.1425 1.1426 -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 1.1427 -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 1.1428 -# in which this list will be split (can be a number in the range [1..20]) 1.1429 +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1.1430 +# which the alphabetical index list will be split. 1.1431 +# Minimum value: 1, maximum value: 20, default value: 5. 1.1432 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1.1433 1.1434 COLS_IN_ALPHA_INDEX = 5 1.1435 1.1436 -# In case all classes in a project start with a common prefix, all 1.1437 -# classes will be put under the same header in the alphabetical index. 1.1438 -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 1.1439 -# should be ignored while generating the index headers. 1.1440 +# In case all classes in a project start with a common prefix, all classes will 1.1441 +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1.1442 +# can be used to specify a prefix (or a list of prefixes) that should be ignored 1.1443 +# while generating the index headers. 1.1444 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1.1445 1.1446 IGNORE_PREFIX = 1.1447 1.1448 #--------------------------------------------------------------------------- 1.1449 -# configuration options related to the HTML output 1.1450 +# Configuration options related to the HTML output 1.1451 #--------------------------------------------------------------------------- 1.1452 1.1453 -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 1.1454 -# generate HTML output. 1.1455 +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 1.1456 +# The default value is: YES. 1.1457 1.1458 GENERATE_HTML = YES 1.1459 1.1460 -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 1.1461 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1.1462 -# put in front of it. If left blank `html' will be used as the default path. 1.1463 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1.1464 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1.1465 +# it. 1.1466 +# The default directory is: html. 1.1467 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1468 1.1469 HTML_OUTPUT = html 1.1470 1.1471 -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 1.1472 -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 1.1473 -# doxygen will generate files with .html extension. 1.1474 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1.1475 +# generated HTML page (for example: .htm, .php, .asp). 1.1476 +# The default value is: .html. 1.1477 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1478 1.1479 HTML_FILE_EXTENSION = .html 1.1480 1.1481 -# The HTML_HEADER tag can be used to specify a personal HTML header for 1.1482 -# each generated HTML page. If it is left blank doxygen will generate a 1.1483 -# standard header. Note that when using a custom header you are responsible 1.1484 -# for the proper inclusion of any scripts and style sheets that doxygen 1.1485 -# needs, which is dependent on the configuration options used. 1.1486 -# It is advised to generate a default header using "doxygen -w html 1.1487 -# header.html footer.html stylesheet.css YourConfigFile" and then modify 1.1488 -# that header. Note that the header is subject to change so you typically 1.1489 -# have to redo this when upgrading to a newer version of doxygen or when 1.1490 -# changing the value of configuration settings such as GENERATE_TREEVIEW! 1.1491 +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1.1492 +# each generated HTML page. If the tag is left blank doxygen will generate a 1.1493 +# standard header. 1.1494 +# 1.1495 +# To get valid HTML the header file that includes any scripts and style sheets 1.1496 +# that doxygen needs, which is dependent on the configuration options used (e.g. 1.1497 +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1.1498 +# default header using 1.1499 +# doxygen -w html new_header.html new_footer.html new_stylesheet.css 1.1500 +# YourConfigFile 1.1501 +# and then modify the file new_header.html. See also section "Doxygen usage" 1.1502 +# for information on how to generate the default header that doxygen normally 1.1503 +# uses. 1.1504 +# Note: The header is subject to change so you typically have to regenerate the 1.1505 +# default header when upgrading to a newer version of doxygen. For a description 1.1506 +# of the possible markers and block names see the documentation. 1.1507 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1508 1.1509 HTML_HEADER = 1.1510 1.1511 -# The HTML_FOOTER tag can be used to specify a personal HTML footer for 1.1512 -# each generated HTML page. If it is left blank doxygen will generate a 1.1513 -# standard footer. 1.1514 +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1.1515 +# generated HTML page. If the tag is left blank doxygen will generate a standard 1.1516 +# footer. See HTML_HEADER for more information on how to generate a default 1.1517 +# footer and what special commands can be used inside the footer. See also 1.1518 +# section "Doxygen usage" for information on how to generate the default footer 1.1519 +# that doxygen normally uses. 1.1520 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1521 1.1522 HTML_FOOTER = 1.1523 1.1524 -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 1.1525 -# style sheet that is used by each HTML page. It can be used to 1.1526 -# fine-tune the look of the HTML output. If the tag is left blank doxygen 1.1527 -# will generate a default style sheet. Note that doxygen will try to copy 1.1528 -# the style sheet file to the HTML output directory, so don't put your own 1.1529 -# style sheet in the HTML output directory as well, or it will be erased! 1.1530 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1.1531 +# sheet that is used by each HTML page. It can be used to fine-tune the look of 1.1532 +# the HTML output. If left blank doxygen will generate a default style sheet. 1.1533 +# See also section "Doxygen usage" for information on how to generate the style 1.1534 +# sheet that doxygen normally uses. 1.1535 +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1.1536 +# it is more robust and this tag (HTML_STYLESHEET) will in the future become 1.1537 +# obsolete. 1.1538 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1539 1.1540 HTML_STYLESHEET = 1.1541 1.1542 +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- 1.1543 +# defined cascading style sheet that is included after the standard style sheets 1.1544 +# created by doxygen. Using this option one can overrule certain style aspects. 1.1545 +# This is preferred over using HTML_STYLESHEET since it does not replace the 1.1546 +# standard style sheet and is therefor more robust against future updates. 1.1547 +# Doxygen will copy the style sheet file to the output directory. For an example 1.1548 +# see the documentation. 1.1549 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1550 + 1.1551 +HTML_EXTRA_STYLESHEET = 1.1552 + 1.1553 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1.1554 # other source files which should be copied to the HTML output directory. Note 1.1555 # that these files will be copied to the base HTML output directory. Use the 1.1556 -# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1.1557 -# files. In the HTML_STYLESHEET file, use the file name only. Also note that 1.1558 -# the files will be copied as-is; there are no commands or markers available. 1.1559 +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1.1560 +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1.1561 +# files will be copied as-is; there are no commands or markers available. 1.1562 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1563 1.1564 HTML_EXTRA_FILES = 1.1565 1.1566 -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 1.1567 -# Doxygen will adjust the colors in the style sheet and background images 1.1568 -# according to this color. Hue is specified as an angle on a colorwheel, 1.1569 -# see http://en.wikipedia.org/wiki/Hue for more information. 1.1570 -# For instance the value 0 represents red, 60 is yellow, 120 is green, 1.1571 -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 1.1572 -# The allowed range is 0 to 359. 1.1573 +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1.1574 +# will adjust the colors in the stylesheet and background images according to 1.1575 +# this color. Hue is specified as an angle on a colorwheel, see 1.1576 +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1.1577 +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1.1578 +# purple, and 360 is red again. 1.1579 +# Minimum value: 0, maximum value: 359, default value: 220. 1.1580 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1581 1.1582 HTML_COLORSTYLE_HUE = 220 1.1583 1.1584 -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 1.1585 -# the colors in the HTML output. For a value of 0 the output will use 1.1586 -# grayscales only. A value of 255 will produce the most vivid colors. 1.1587 +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1.1588 +# in the HTML output. For a value of 0 the output will use grayscales only. A 1.1589 +# value of 255 will produce the most vivid colors. 1.1590 +# Minimum value: 0, maximum value: 255, default value: 100. 1.1591 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1592 1.1593 HTML_COLORSTYLE_SAT = 100 1.1594 1.1595 -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 1.1596 -# the luminance component of the colors in the HTML output. Values below 1.1597 -# 100 gradually make the output lighter, whereas values above 100 make 1.1598 -# the output darker. The value divided by 100 is the actual gamma applied, 1.1599 -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 1.1600 -# and 100 does not change the gamma. 1.1601 +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1.1602 +# luminance component of the colors in the HTML output. Values below 100 1.1603 +# gradually make the output lighter, whereas values above 100 make the output 1.1604 +# darker. The value divided by 100 is the actual gamma applied, so 80 represents 1.1605 +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1.1606 +# change the gamma. 1.1607 +# Minimum value: 40, maximum value: 240, default value: 80. 1.1608 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1609 1.1610 HTML_COLORSTYLE_GAMMA = 80 1.1611 1.1612 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1.1613 -# page will contain the date and time when the page was generated. Setting 1.1614 -# this to NO can help when comparing the output of multiple runs. 1.1615 +# page will contain the date and time when the page was generated. Setting this 1.1616 +# to NO can help when comparing the output of multiple runs. 1.1617 +# The default value is: YES. 1.1618 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1619 1.1620 HTML_TIMESTAMP = YES 1.1621 1.1622 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1.1623 # documentation will contain sections that can be hidden and shown after the 1.1624 -# page has loaded. For this to work a browser that supports 1.1625 -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 1.1626 -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 1.1627 +# page has loaded. 1.1628 +# The default value is: NO. 1.1629 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1630 1.1631 HTML_DYNAMIC_SECTIONS = NO 1.1632 1.1633 -# If the GENERATE_DOCSET tag is set to YES, additional index files 1.1634 -# will be generated that can be used as input for Apple's Xcode 3 1.1635 -# integrated development environment, introduced with OSX 10.5 (Leopard). 1.1636 -# To create a documentation set, doxygen will generate a Makefile in the 1.1637 -# HTML output directory. Running make will produce the docset in that 1.1638 -# directory and running "make install" will install the docset in 1.1639 -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 1.1640 -# it at startup. 1.1641 -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1.1642 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1.1643 +# shown in the various tree structured indices initially; the user can expand 1.1644 +# and collapse entries dynamically later on. Doxygen will expand the tree to 1.1645 +# such a level that at most the specified number of entries are visible (unless 1.1646 +# a fully collapsed tree already exceeds this amount). So setting the number of 1.1647 +# entries 1 will produce a full collapsed tree by default. 0 is a special value 1.1648 +# representing an infinite number of entries and will result in a full expanded 1.1649 +# tree by default. 1.1650 +# Minimum value: 0, maximum value: 9999, default value: 100. 1.1651 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1652 + 1.1653 +HTML_INDEX_NUM_ENTRIES = 100 1.1654 + 1.1655 +# If the GENERATE_DOCSET tag is set to YES, additional index files will be 1.1656 +# generated that can be used as input for Apple's Xcode 3 integrated development 1.1657 +# environment (see: http://developer.apple.com/tools/xcode/), introduced with 1.1658 +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1.1659 +# Makefile in the HTML output directory. Running make will produce the docset in 1.1660 +# that directory and running make install will install the docset in 1.1661 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1.1662 +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1.1663 # for more information. 1.1664 +# The default value is: NO. 1.1665 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1666 1.1667 GENERATE_DOCSET = NO 1.1668 1.1669 -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 1.1670 -# feed. A documentation feed provides an umbrella under which multiple 1.1671 -# documentation sets from a single provider (such as a company or product suite) 1.1672 -# can be grouped. 1.1673 +# This tag determines the name of the docset feed. A documentation feed provides 1.1674 +# an umbrella under which multiple documentation sets from a single provider 1.1675 +# (such as a company or product suite) can be grouped. 1.1676 +# The default value is: Doxygen generated docs. 1.1677 +# This tag requires that the tag GENERATE_DOCSET is set to YES. 1.1678 1.1679 DOCSET_FEEDNAME = "Doxygen generated docs" 1.1680 1.1681 -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 1.1682 -# should uniquely identify the documentation set bundle. This should be a 1.1683 -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 1.1684 -# will append .docset to the name. 1.1685 +# This tag specifies a string that should uniquely identify the documentation 1.1686 +# set bundle. This should be a reverse domain-name style string, e.g. 1.1687 +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1.1688 +# The default value is: org.doxygen.Project. 1.1689 +# This tag requires that the tag GENERATE_DOCSET is set to YES. 1.1690 1.1691 DOCSET_BUNDLE_ID = org.doxygen.Project 1.1692 1.1693 -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 1.1694 +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1.1695 # the documentation publisher. This should be a reverse domain-name style 1.1696 # string, e.g. com.mycompany.MyDocSet.documentation. 1.1697 +# The default value is: org.doxygen.Publisher. 1.1698 +# This tag requires that the tag GENERATE_DOCSET is set to YES. 1.1699 1.1700 DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1.1701 1.1702 -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1.1703 +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1.1704 +# The default value is: Publisher. 1.1705 +# This tag requires that the tag GENERATE_DOCSET is set to YES. 1.1706 1.1707 DOCSET_PUBLISHER_NAME = Publisher 1.1708 1.1709 -# If the GENERATE_HTMLHELP tag is set to YES, additional index files 1.1710 -# will be generated that can be used as input for tools like the 1.1711 -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1.1712 -# of the generated HTML documentation. 1.1713 +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1.1714 +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1.1715 +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1.1716 +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1.1717 +# Windows. 1.1718 +# 1.1719 +# The HTML Help Workshop contains a compiler that can convert all HTML output 1.1720 +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1.1721 +# files are now used as the Windows 98 help format, and will replace the old 1.1722 +# Windows help format (.hlp) on all Windows platforms in the future. Compressed 1.1723 +# HTML files also contain an index, a table of contents, and you can search for 1.1724 +# words in the documentation. The HTML workshop also contains a viewer for 1.1725 +# compressed HTML files. 1.1726 +# The default value is: NO. 1.1727 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1728 1.1729 GENERATE_HTMLHELP = NO 1.1730 1.1731 -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1.1732 -# be used to specify the file name of the resulting .chm file. You 1.1733 -# can add a path in front of the file if the result should not be 1.1734 +# The CHM_FILE tag can be used to specify the file name of the resulting .chm 1.1735 +# file. You can add a path in front of the file if the result should not be 1.1736 # written to the html output directory. 1.1737 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1.1738 1.1739 CHM_FILE = 1.1740 1.1741 -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1.1742 -# be used to specify the location (absolute path including file name) of 1.1743 -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1.1744 -# the HTML help compiler on the generated index.hhp. 1.1745 +# The HHC_LOCATION tag can be used to specify the location (absolute path 1.1746 +# including file name) of the HTML help compiler ( hhc.exe). If non-empty 1.1747 +# doxygen will try to run the HTML help compiler on the generated index.hhp. 1.1748 +# The file has to be specified with full path. 1.1749 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1.1750 1.1751 HHC_LOCATION = 1.1752 1.1753 -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1.1754 -# controls if a separate .chi index file is generated (YES) or that 1.1755 -# it should be included in the master .chm file (NO). 1.1756 +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( 1.1757 +# YES) or that it should be included in the master .chm file ( NO). 1.1758 +# The default value is: NO. 1.1759 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1.1760 1.1761 GENERATE_CHI = NO 1.1762 1.1763 -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1.1764 -# is used to encode HtmlHelp index (hhk), content (hhc) and project file 1.1765 -# content. 1.1766 +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) 1.1767 +# and project file content. 1.1768 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1.1769 1.1770 CHM_INDEX_ENCODING = 1.1771 1.1772 -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1.1773 -# controls whether a binary table of contents is generated (YES) or a 1.1774 -# normal table of contents (NO) in the .chm file. 1.1775 +# The BINARY_TOC flag controls whether a binary table of contents is generated ( 1.1776 +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it 1.1777 +# enables the Previous and Next buttons. 1.1778 +# The default value is: NO. 1.1779 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1.1780 1.1781 BINARY_TOC = NO 1.1782 1.1783 -# The TOC_EXPAND flag can be set to YES to add extra items for group members 1.1784 -# to the contents of the HTML help documentation and to the tree view. 1.1785 +# The TOC_EXPAND flag can be set to YES to add extra items for group members to 1.1786 +# the table of contents of the HTML help documentation and to the tree view. 1.1787 +# The default value is: NO. 1.1788 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1.1789 1.1790 TOC_EXPAND = NO 1.1791 1.1792 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1.1793 -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1.1794 -# that can be used as input for Qt's qhelpgenerator to generate a 1.1795 -# Qt Compressed Help (.qch) of the generated HTML documentation. 1.1796 +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1.1797 +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1.1798 +# (.qch) of the generated HTML documentation. 1.1799 +# The default value is: NO. 1.1800 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1801 1.1802 GENERATE_QHP = NO 1.1803 1.1804 -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1.1805 -# be used to specify the file name of the resulting .qch file. 1.1806 -# The path specified is relative to the HTML output folder. 1.1807 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1.1808 +# the file name of the resulting .qch file. The path specified is relative to 1.1809 +# the HTML output folder. 1.1810 +# This tag requires that the tag GENERATE_QHP is set to YES. 1.1811 1.1812 QCH_FILE = 1.1813 1.1814 -# The QHP_NAMESPACE tag specifies the namespace to use when generating 1.1815 -# Qt Help Project output. For more information please see 1.1816 -# http://doc.trolltech.com/qthelpproject.html#namespace 1.1817 +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1.1818 +# Project output. For more information please see Qt Help Project / Namespace 1.1819 +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1.1820 +# The default value is: org.doxygen.Project. 1.1821 +# This tag requires that the tag GENERATE_QHP is set to YES. 1.1822 1.1823 QHP_NAMESPACE = org.doxygen.Project 1.1824 1.1825 -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1.1826 -# Qt Help Project output. For more information please see 1.1827 -# http://doc.trolltech.com/qthelpproject.html#virtual-folders 1.1828 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1.1829 +# Help Project output. For more information please see Qt Help Project / Virtual 1.1830 +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1.1831 +# folders). 1.1832 +# The default value is: doc. 1.1833 +# This tag requires that the tag GENERATE_QHP is set to YES. 1.1834 1.1835 QHP_VIRTUAL_FOLDER = doc 1.1836 1.1837 -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1.1838 -# add. For more information please see 1.1839 -# http://doc.trolltech.com/qthelpproject.html#custom-filters 1.1840 +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1.1841 +# filter to add. For more information please see Qt Help Project / Custom 1.1842 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1.1843 +# filters). 1.1844 +# This tag requires that the tag GENERATE_QHP is set to YES. 1.1845 1.1846 QHP_CUST_FILTER_NAME = 1.1847 1.1848 -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1.1849 -# custom filter to add. For more information please see 1.1850 -# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1.1851 -# Qt Help Project / Custom Filters</a>. 1.1852 +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1.1853 +# custom filter to add. For more information please see Qt Help Project / Custom 1.1854 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1.1855 +# filters). 1.1856 +# This tag requires that the tag GENERATE_QHP is set to YES. 1.1857 1.1858 QHP_CUST_FILTER_ATTRS = 1.1859 1.1860 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1.1861 -# project's 1.1862 -# filter section matches. 1.1863 -# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1.1864 -# Qt Help Project / Filter Attributes</a>. 1.1865 +# project's filter section matches. Qt Help Project / Filter Attributes (see: 1.1866 +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1.1867 +# This tag requires that the tag GENERATE_QHP is set to YES. 1.1868 1.1869 QHP_SECT_FILTER_ATTRS = 1.1870 1.1871 -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1.1872 -# be used to specify the location of Qt's qhelpgenerator. 1.1873 -# If non-empty doxygen will try to run qhelpgenerator on the generated 1.1874 -# .qhp file. 1.1875 +# The QHG_LOCATION tag can be used to specify the location of Qt's 1.1876 +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1.1877 +# generated .qhp file. 1.1878 +# This tag requires that the tag GENERATE_QHP is set to YES. 1.1879 1.1880 QHG_LOCATION = 1.1881 1.1882 -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1.1883 -# will be generated, which together with the HTML files, form an Eclipse help 1.1884 -# plugin. To install this plugin and make it available under the help contents 1.1885 -# menu in Eclipse, the contents of the directory containing the HTML and XML 1.1886 -# files needs to be copied into the plugins directory of eclipse. The name of 1.1887 -# the directory within the plugins directory should be the same as 1.1888 -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1.1889 -# the help appears. 1.1890 +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1.1891 +# generated, together with the HTML files, they form an Eclipse help plugin. To 1.1892 +# install this plugin and make it available under the help contents menu in 1.1893 +# Eclipse, the contents of the directory containing the HTML and XML files needs 1.1894 +# to be copied into the plugins directory of eclipse. The name of the directory 1.1895 +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1.1896 +# After copying Eclipse needs to be restarted before the help appears. 1.1897 +# The default value is: NO. 1.1898 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1899 1.1900 GENERATE_ECLIPSEHELP = NO 1.1901 1.1902 -# A unique identifier for the eclipse help plugin. When installing the plugin 1.1903 -# the directory name containing the HTML and XML files should also have 1.1904 -# this name. 1.1905 +# A unique identifier for the Eclipse help plugin. When installing the plugin 1.1906 +# the directory name containing the HTML and XML files should also have this 1.1907 +# name. Each documentation set should have its own identifier. 1.1908 +# The default value is: org.doxygen.Project. 1.1909 +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1.1910 1.1911 ECLIPSE_DOC_ID = org.doxygen.Project 1.1912 1.1913 -# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1.1914 -# at top of each HTML page. The value NO (the default) enables the index and 1.1915 -# the value YES disables it. Since the tabs have the same information as the 1.1916 -# navigation tree you can set this option to NO if you already set 1.1917 -# GENERATE_TREEVIEW to YES. 1.1918 +# If you want full control over the layout of the generated HTML pages it might 1.1919 +# be necessary to disable the index and replace it with your own. The 1.1920 +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1.1921 +# of each HTML page. A value of NO enables the index and the value YES disables 1.1922 +# it. Since the tabs in the index contain the same information as the navigation 1.1923 +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1.1924 +# The default value is: NO. 1.1925 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1926 1.1927 DISABLE_INDEX = NO 1.1928 1.1929 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1.1930 -# structure should be generated to display hierarchical information. 1.1931 -# If the tag value is set to YES, a side panel will be generated 1.1932 -# containing a tree-like index structure (just like the one that 1.1933 -# is generated for HTML Help). For this to work a browser that supports 1.1934 -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1.1935 -# Windows users are probably better off using the HTML help feature. 1.1936 -# Since the tree basically has the same information as the tab index you 1.1937 -# could consider to set DISABLE_INDEX to NO when enabling this option. 1.1938 +# structure should be generated to display hierarchical information. If the tag 1.1939 +# value is set to YES, a side panel will be generated containing a tree-like 1.1940 +# index structure (just like the one that is generated for HTML Help). For this 1.1941 +# to work a browser that supports JavaScript, DHTML, CSS and frames is required 1.1942 +# (i.e. any modern browser). Windows users are probably better off using the 1.1943 +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can 1.1944 +# further fine-tune the look of the index. As an example, the default style 1.1945 +# sheet generated by doxygen has an example that shows how to put an image at 1.1946 +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1.1947 +# the same information as the tab index, you could consider setting 1.1948 +# DISABLE_INDEX to YES when enabling this option. 1.1949 +# The default value is: NO. 1.1950 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1951 1.1952 GENERATE_TREEVIEW = NO 1.1953 1.1954 -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1.1955 -# (range [0,1..20]) that doxygen will group on one line in the generated HTML 1.1956 -# documentation. Note that a value of 0 will completely suppress the enum 1.1957 -# values from appearing in the overview section. 1.1958 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1.1959 +# doxygen will group on one line in the generated HTML documentation. 1.1960 +# 1.1961 +# Note that a value of 0 will completely suppress the enum values from appearing 1.1962 +# in the overview section. 1.1963 +# Minimum value: 0, maximum value: 20, default value: 4. 1.1964 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1965 1.1966 ENUM_VALUES_PER_LINE = 4 1.1967 1.1968 - 1.1969 -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1.1970 -# used to set the initial width (in pixels) of the frame in which the tree 1.1971 -# is shown. 1.1972 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1.1973 +# to set the initial width (in pixels) of the frame in which the tree is shown. 1.1974 +# Minimum value: 0, maximum value: 1500, default value: 250. 1.1975 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1976 1.1977 TREEVIEW_WIDTH = 250 1.1978 1.1979 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1.1980 -# links to external symbols imported via tag files in a separate window. 1.1981 +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to 1.1982 +# external symbols imported via tag files in a separate window. 1.1983 +# The default value is: NO. 1.1984 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1985 1.1986 EXT_LINKS_IN_WINDOW = NO 1.1987 1.1988 -# Use this tag to change the font size of Latex formulas included 1.1989 -# as images in the HTML documentation. The default is 10. Note that 1.1990 -# when you change the font size after a successful doxygen run you need 1.1991 -# to manually remove any form_*.png images from the HTML output directory 1.1992 -# to force them to be regenerated. 1.1993 +# Use this tag to change the font size of LaTeX formulas included as images in 1.1994 +# the HTML documentation. When you change the font size after a successful 1.1995 +# doxygen run you need to manually remove any form_*.png images from the HTML 1.1996 +# output directory to force them to be regenerated. 1.1997 +# Minimum value: 8, maximum value: 50, default value: 10. 1.1998 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.1999 1.2000 FORMULA_FONTSIZE = 10 1.2001 1.2002 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1.2003 -# generated for formulas are transparent PNGs. Transparent PNGs are 1.2004 -# not supported properly for IE 6.0, but are supported on all modern browsers. 1.2005 -# Note that when changing this option you need to delete any form_*.png files 1.2006 -# in the HTML output before the changes have effect. 1.2007 +# generated for formulas are transparent PNGs. Transparent PNGs are not 1.2008 +# supported properly for IE 6.0, but are supported on all modern browsers. 1.2009 +# 1.2010 +# Note that when changing this option you need to delete any form_*.png files in 1.2011 +# the HTML output directory before the changes have effect. 1.2012 +# The default value is: YES. 1.2013 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.2014 1.2015 FORMULA_TRANSPARENT = YES 1.2016 1.2017 -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1.2018 -# (see http://www.mathjax.org) which uses client side Javascript for the 1.2019 -# rendering instead of using prerendered bitmaps. Use this if you do not 1.2020 -# have LaTeX installed or if you want to formulas look prettier in the HTML 1.2021 -# output. When enabled you also need to install MathJax separately and 1.2022 -# configure the path to it using the MATHJAX_RELPATH option. 1.2023 +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1.2024 +# http://www.mathjax.org) which uses client side Javascript for the rendering 1.2025 +# instead of using prerendered bitmaps. Use this if you do not have LaTeX 1.2026 +# installed or if you want to formulas look prettier in the HTML output. When 1.2027 +# enabled you may also need to install MathJax separately and configure the path 1.2028 +# to it using the MATHJAX_RELPATH option. 1.2029 +# The default value is: NO. 1.2030 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.2031 1.2032 USE_MATHJAX = NO 1.2033 1.2034 -# When MathJax is enabled you need to specify the location relative to the 1.2035 -# HTML output directory using the MATHJAX_RELPATH option. The destination 1.2036 -# directory should contain the MathJax.js script. For instance, if the mathjax 1.2037 -# directory is located at the same level as the HTML output directory, then 1.2038 -# MATHJAX_RELPATH should be ../mathjax. The default value points to the 1.2039 -# mathjax.org site, so you can quickly see the result without installing 1.2040 -# MathJax, but it is strongly recommended to install a local copy of MathJax 1.2041 -# before deployment. 1.2042 +# When MathJax is enabled you can set the default output format to be used for 1.2043 +# the MathJax output. See the MathJax site (see: 1.2044 +# http://docs.mathjax.org/en/latest/output.html) for more details. 1.2045 +# Possible values are: HTML-CSS (which is slower, but has the best 1.2046 +# compatibility), NativeMML (i.e. MathML) and SVG. 1.2047 +# The default value is: HTML-CSS. 1.2048 +# This tag requires that the tag USE_MATHJAX is set to YES. 1.2049 + 1.2050 +MATHJAX_FORMAT = HTML-CSS 1.2051 + 1.2052 +# When MathJax is enabled you need to specify the location relative to the HTML 1.2053 +# output directory using the MATHJAX_RELPATH option. The destination directory 1.2054 +# should contain the MathJax.js script. For instance, if the mathjax directory 1.2055 +# is located at the same level as the HTML output directory, then 1.2056 +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1.2057 +# Content Delivery Network so you can quickly see the result without installing 1.2058 +# MathJax. However, it is strongly recommended to install a local copy of 1.2059 +# MathJax from http://www.mathjax.org before deployment. 1.2060 +# The default value is: http://cdn.mathjax.org/mathjax/latest. 1.2061 +# This tag requires that the tag USE_MATHJAX is set to YES. 1.2062 1.2063 MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1.2064 1.2065 -# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1.2066 -# names that should be enabled during MathJax rendering. 1.2067 +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1.2068 +# extension names that should be enabled during MathJax rendering. For example 1.2069 +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1.2070 +# This tag requires that the tag USE_MATHJAX is set to YES. 1.2071 1.2072 MATHJAX_EXTENSIONS = 1.2073 1.2074 -# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1.2075 -# for the HTML output. The underlying search engine uses javascript 1.2076 -# and DHTML and should work on any modern browser. Note that when using 1.2077 -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1.2078 -# (GENERATE_DOCSET) there is already a search function so this one should 1.2079 -# typically be disabled. For large projects the javascript based search engine 1.2080 -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1.2081 +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1.2082 +# of code that will be used on startup of the MathJax code. See the MathJax site 1.2083 +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1.2084 +# example see the documentation. 1.2085 +# This tag requires that the tag USE_MATHJAX is set to YES. 1.2086 + 1.2087 +MATHJAX_CODEFILE = 1.2088 + 1.2089 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1.2090 +# the HTML output. The underlying search engine uses javascript and DHTML and 1.2091 +# should work on any modern browser. Note that when using HTML help 1.2092 +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1.2093 +# there is already a search function so this one should typically be disabled. 1.2094 +# For large projects the javascript based search engine can be slow, then 1.2095 +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1.2096 +# search using the keyboard; to jump to the search box use <access key> + S 1.2097 +# (what the <access key> is depends on the OS and browser, but it is typically 1.2098 +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1.2099 +# key> to jump into the search results window, the results can be navigated 1.2100 +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1.2101 +# the search. The filter options can be selected when the cursor is inside the 1.2102 +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1.2103 +# to select a filter and <Enter> or <escape> to activate or cancel the filter 1.2104 +# option. 1.2105 +# The default value is: YES. 1.2106 +# This tag requires that the tag GENERATE_HTML is set to YES. 1.2107 1.2108 SEARCHENGINE = YES 1.2109 1.2110 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1.2111 -# implemented using a PHP enabled web server instead of at the web client 1.2112 -# using Javascript. Doxygen will generate the search PHP script and index 1.2113 -# file to put on the web server. The advantage of the server 1.2114 -# based approach is that it scales better to large projects and allows 1.2115 -# full text search. The disadvantages are that it is more difficult to setup 1.2116 -# and does not have live searching capabilities. 1.2117 +# implemented using a web server instead of a web client using Javascript. There 1.2118 +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1.2119 +# setting. When disabled, doxygen will generate a PHP script for searching and 1.2120 +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1.2121 +# and searching needs to be provided by external tools. See the section 1.2122 +# "External Indexing and Searching" for details. 1.2123 +# The default value is: NO. 1.2124 +# This tag requires that the tag SEARCHENGINE is set to YES. 1.2125 1.2126 SERVER_BASED_SEARCH = NO 1.2127 1.2128 +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1.2129 +# script for searching. Instead the search results are written to an XML file 1.2130 +# which needs to be processed by an external indexer. Doxygen will invoke an 1.2131 +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1.2132 +# search results. 1.2133 +# 1.2134 +# Doxygen ships with an example indexer ( doxyindexer) and search engine 1.2135 +# (doxysearch.cgi) which are based on the open source search engine library 1.2136 +# Xapian (see: http://xapian.org/). 1.2137 +# 1.2138 +# See the section "External Indexing and Searching" for details. 1.2139 +# The default value is: NO. 1.2140 +# This tag requires that the tag SEARCHENGINE is set to YES. 1.2141 + 1.2142 +EXTERNAL_SEARCH = NO 1.2143 + 1.2144 +# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1.2145 +# which will return the search results when EXTERNAL_SEARCH is enabled. 1.2146 +# 1.2147 +# Doxygen ships with an example indexer ( doxyindexer) and search engine 1.2148 +# (doxysearch.cgi) which are based on the open source search engine library 1.2149 +# Xapian (see: http://xapian.org/). See the section "External Indexing and 1.2150 +# Searching" for details. 1.2151 +# This tag requires that the tag SEARCHENGINE is set to YES. 1.2152 + 1.2153 +SEARCHENGINE_URL = 1.2154 + 1.2155 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1.2156 +# search data is written to a file for indexing by an external tool. With the 1.2157 +# SEARCHDATA_FILE tag the name of this file can be specified. 1.2158 +# The default file is: searchdata.xml. 1.2159 +# This tag requires that the tag SEARCHENGINE is set to YES. 1.2160 + 1.2161 +SEARCHDATA_FILE = searchdata.xml 1.2162 + 1.2163 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1.2164 +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1.2165 +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1.2166 +# projects and redirect the results back to the right project. 1.2167 +# This tag requires that the tag SEARCHENGINE is set to YES. 1.2168 + 1.2169 +EXTERNAL_SEARCH_ID = 1.2170 + 1.2171 +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1.2172 +# projects other than the one defined by this configuration file, but that are 1.2173 +# all added to the same external search index. Each project needs to have a 1.2174 +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1.2175 +# to a relative location where the documentation can be found. The format is: 1.2176 +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1.2177 +# This tag requires that the tag SEARCHENGINE is set to YES. 1.2178 + 1.2179 +EXTRA_SEARCH_MAPPINGS = 1.2180 + 1.2181 #--------------------------------------------------------------------------- 1.2182 -# configuration options related to the LaTeX output 1.2183 +# Configuration options related to the LaTeX output 1.2184 #--------------------------------------------------------------------------- 1.2185 1.2186 -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1.2187 -# generate Latex output. 1.2188 +# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. 1.2189 +# The default value is: YES. 1.2190 1.2191 GENERATE_LATEX = NO 1.2192 1.2193 -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1.2194 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1.2195 -# put in front of it. If left blank `latex' will be used as the default path. 1.2196 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1.2197 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1.2198 +# it. 1.2199 +# The default directory is: latex. 1.2200 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2201 1.2202 LATEX_OUTPUT = latex 1.2203 1.2204 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1.2205 -# invoked. If left blank `latex' will be used as the default command name. 1.2206 -# Note that when enabling USE_PDFLATEX this option is only used for 1.2207 -# generating bitmaps for formulas in the HTML output, but not in the 1.2208 -# Makefile that is written to the output directory. 1.2209 +# invoked. 1.2210 +# 1.2211 +# Note that when enabling USE_PDFLATEX this option is only used for generating 1.2212 +# bitmaps for formulas in the HTML output, but not in the Makefile that is 1.2213 +# written to the output directory. 1.2214 +# The default file is: latex. 1.2215 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2216 1.2217 LATEX_CMD_NAME = latex 1.2218 1.2219 -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1.2220 -# generate index for LaTeX. If left blank `makeindex' will be used as the 1.2221 -# default command name. 1.2222 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1.2223 +# index for LaTeX. 1.2224 +# The default file is: makeindex. 1.2225 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2226 1.2227 MAKEINDEX_CMD_NAME = makeindex 1.2228 1.2229 -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1.2230 -# LaTeX documents. This may be useful for small projects and may help to 1.2231 -# save some trees in general. 1.2232 +# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX 1.2233 +# documents. This may be useful for small projects and may help to save some 1.2234 +# trees in general. 1.2235 +# The default value is: NO. 1.2236 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2237 1.2238 COMPACT_LATEX = NO 1.2239 1.2240 -# The PAPER_TYPE tag can be used to set the paper type that is used 1.2241 -# by the printer. Possible values are: a4, letter, legal and 1.2242 -# executive. If left blank a4wide will be used. 1.2243 +# The PAPER_TYPE tag can be used to set the paper type that is used by the 1.2244 +# printer. 1.2245 +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1.2246 +# 14 inches) and executive (7.25 x 10.5 inches). 1.2247 +# The default value is: a4. 1.2248 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2249 1.2250 PAPER_TYPE = a4 1.2251 1.2252 -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1.2253 -# packages that should be included in the LaTeX output. 1.2254 +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1.2255 +# that should be included in the LaTeX output. To get the times font for 1.2256 +# instance you can specify 1.2257 +# EXTRA_PACKAGES=times 1.2258 +# If left blank no extra packages will be included. 1.2259 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2260 1.2261 EXTRA_PACKAGES = 1.2262 1.2263 -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1.2264 -# the generated latex document. The header should contain everything until 1.2265 -# the first chapter. If it is left blank doxygen will generate a 1.2266 -# standard header. Notice: only use this tag if you know what you are doing! 1.2267 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1.2268 +# generated LaTeX document. The header should contain everything until the first 1.2269 +# chapter. If it is left blank doxygen will generate a standard header. See 1.2270 +# section "Doxygen usage" for information on how to let doxygen write the 1.2271 +# default header to a separate file. 1.2272 +# 1.2273 +# Note: Only use a user-defined header if you know what you are doing! The 1.2274 +# following commands have a special meaning inside the header: $title, 1.2275 +# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will 1.2276 +# replace them by respectively the title of the page, the current date and time, 1.2277 +# only the current date, the version number of doxygen, the project name (see 1.2278 +# PROJECT_NAME), or the project number (see PROJECT_NUMBER). 1.2279 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2280 1.2281 LATEX_HEADER = 1.2282 1.2283 -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1.2284 -# the generated latex document. The footer should contain everything after 1.2285 -# the last chapter. If it is left blank doxygen will generate a 1.2286 -# standard footer. Notice: only use this tag if you know what you are doing! 1.2287 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1.2288 +# generated LaTeX document. The footer should contain everything after the last 1.2289 +# chapter. If it is left blank doxygen will generate a standard footer. 1.2290 +# 1.2291 +# Note: Only use a user-defined footer if you know what you are doing! 1.2292 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2293 1.2294 LATEX_FOOTER = 1.2295 1.2296 -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1.2297 -# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1.2298 -# contain links (just like the HTML output) instead of page references 1.2299 -# This makes the output suitable for online browsing using a pdf viewer. 1.2300 +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1.2301 +# other source files which should be copied to the LATEX_OUTPUT output 1.2302 +# directory. Note that the files will be copied as-is; there are no commands or 1.2303 +# markers available. 1.2304 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2305 + 1.2306 +LATEX_EXTRA_FILES = 1.2307 + 1.2308 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1.2309 +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1.2310 +# contain links (just like the HTML output) instead of page references. This 1.2311 +# makes the output suitable for online browsing using a PDF viewer. 1.2312 +# The default value is: YES. 1.2313 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2314 1.2315 PDF_HYPERLINKS = YES 1.2316 1.2317 -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1.2318 -# plain latex in the generated Makefile. Set this option to YES to get a 1.2319 +# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1.2320 +# the PDF file directly from the LaTeX files. Set this option to YES to get a 1.2321 # higher quality PDF documentation. 1.2322 +# The default value is: YES. 1.2323 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2324 1.2325 USE_PDFLATEX = YES 1.2326 1.2327 -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1.2328 -# command to the generated LaTeX files. This will instruct LaTeX to keep 1.2329 -# running if errors occur, instead of asking the user for help. 1.2330 -# This option is also used when generating formulas in HTML. 1.2331 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1.2332 +# command to the generated LaTeX files. This will instruct LaTeX to keep running 1.2333 +# if errors occur, instead of asking the user for help. This option is also used 1.2334 +# when generating formulas in HTML. 1.2335 +# The default value is: NO. 1.2336 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2337 1.2338 LATEX_BATCHMODE = NO 1.2339 1.2340 -# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1.2341 -# include the index chapters (such as File Index, Compound Index, etc.) 1.2342 -# in the output. 1.2343 +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1.2344 +# index chapters (such as File Index, Compound Index, etc.) in the output. 1.2345 +# The default value is: NO. 1.2346 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2347 1.2348 LATEX_HIDE_INDICES = NO 1.2349 1.2350 -# If LATEX_SOURCE_CODE is set to YES then doxygen will include 1.2351 -# source code with syntax highlighting in the LaTeX output. 1.2352 -# Note that which sources are shown also depends on other settings 1.2353 -# such as SOURCE_BROWSER. 1.2354 +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1.2355 +# code with syntax highlighting in the LaTeX output. 1.2356 +# 1.2357 +# Note that which sources are shown also depends on other settings such as 1.2358 +# SOURCE_BROWSER. 1.2359 +# The default value is: NO. 1.2360 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2361 1.2362 LATEX_SOURCE_CODE = NO 1.2363 1.2364 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1.2365 -# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1.2366 -# http://en.wikipedia.org/wiki/BibTeX for more info. 1.2367 +# bibliography, e.g. plainnat, or ieeetr. See 1.2368 +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1.2369 +# The default value is: plain. 1.2370 +# This tag requires that the tag GENERATE_LATEX is set to YES. 1.2371 1.2372 LATEX_BIB_STYLE = plain 1.2373 1.2374 #--------------------------------------------------------------------------- 1.2375 -# configuration options related to the RTF output 1.2376 +# Configuration options related to the RTF output 1.2377 #--------------------------------------------------------------------------- 1.2378 1.2379 -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1.2380 -# The RTF output is optimized for Word 97 and may not look very pretty with 1.2381 -# other RTF readers or editors. 1.2382 +# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The 1.2383 +# RTF output is optimized for Word 97 and may not look too pretty with other RTF 1.2384 +# readers/editors. 1.2385 +# The default value is: NO. 1.2386 1.2387 GENERATE_RTF = NO 1.2388 1.2389 -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1.2390 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1.2391 -# put in front of it. If left blank `rtf' will be used as the default path. 1.2392 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1.2393 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1.2394 +# it. 1.2395 +# The default directory is: rtf. 1.2396 +# This tag requires that the tag GENERATE_RTF is set to YES. 1.2397 1.2398 RTF_OUTPUT = rtf 1.2399 1.2400 -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1.2401 -# RTF documents. This may be useful for small projects and may help to 1.2402 -# save some trees in general. 1.2403 +# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF 1.2404 +# documents. This may be useful for small projects and may help to save some 1.2405 +# trees in general. 1.2406 +# The default value is: NO. 1.2407 +# This tag requires that the tag GENERATE_RTF is set to YES. 1.2408 1.2409 COMPACT_RTF = NO 1.2410 1.2411 -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1.2412 -# will contain hyperlink fields. The RTF file will 1.2413 -# contain links (just like the HTML output) instead of page references. 1.2414 -# This makes the output suitable for online browsing using WORD or other 1.2415 -# programs which support those fields. 1.2416 -# Note: wordpad (write) and others do not support links. 1.2417 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1.2418 +# contain hyperlink fields. The RTF file will contain links (just like the HTML 1.2419 +# output) instead of page references. This makes the output suitable for online 1.2420 +# browsing using Word or some other Word compatible readers that support those 1.2421 +# fields. 1.2422 +# 1.2423 +# Note: WordPad (write) and others do not support links. 1.2424 +# The default value is: NO. 1.2425 +# This tag requires that the tag GENERATE_RTF is set to YES. 1.2426 1.2427 RTF_HYPERLINKS = NO 1.2428 1.2429 -# Load style sheet definitions from file. Syntax is similar to doxygen's 1.2430 -# config file, i.e. a series of assignments. You only have to provide 1.2431 -# replacements, missing definitions are set to their default value. 1.2432 +# Load stylesheet definitions from file. Syntax is similar to doxygen's config 1.2433 +# file, i.e. a series of assignments. You only have to provide replacements, 1.2434 +# missing definitions are set to their default value. 1.2435 +# 1.2436 +# See also section "Doxygen usage" for information on how to generate the 1.2437 +# default style sheet that doxygen normally uses. 1.2438 +# This tag requires that the tag GENERATE_RTF is set to YES. 1.2439 1.2440 RTF_STYLESHEET_FILE = 1.2441 1.2442 -# Set optional variables used in the generation of an rtf document. 1.2443 -# Syntax is similar to doxygen's config file. 1.2444 +# Set optional variables used in the generation of an RTF document. Syntax is 1.2445 +# similar to doxygen's config file. A template extensions file can be generated 1.2446 +# using doxygen -e rtf extensionFile. 1.2447 +# This tag requires that the tag GENERATE_RTF is set to YES. 1.2448 1.2449 RTF_EXTENSIONS_FILE = 1.2450 1.2451 #--------------------------------------------------------------------------- 1.2452 -# configuration options related to the man page output 1.2453 +# Configuration options related to the man page output 1.2454 #--------------------------------------------------------------------------- 1.2455 1.2456 -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1.2457 -# generate man pages 1.2458 +# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for 1.2459 +# classes and files. 1.2460 +# The default value is: NO. 1.2461 1.2462 GENERATE_MAN = YES 1.2463 1.2464 -# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1.2465 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1.2466 -# put in front of it. If left blank `man' will be used as the default path. 1.2467 +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 1.2468 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1.2469 +# it. A directory man3 will be created inside the directory specified by 1.2470 +# MAN_OUTPUT. 1.2471 +# The default directory is: man. 1.2472 +# This tag requires that the tag GENERATE_MAN is set to YES. 1.2473 1.2474 MAN_OUTPUT = man 1.2475 1.2476 -# The MAN_EXTENSION tag determines the extension that is added to 1.2477 -# the generated man pages (default is the subroutine's section .3) 1.2478 +# The MAN_EXTENSION tag determines the extension that is added to the generated 1.2479 +# man pages. In case the manual section does not start with a number, the number 1.2480 +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 1.2481 +# optional. 1.2482 +# The default value is: .3. 1.2483 +# This tag requires that the tag GENERATE_MAN is set to YES. 1.2484 1.2485 MAN_EXTENSION = .3 1.2486 1.2487 -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1.2488 -# then it will generate one additional man file for each entity 1.2489 -# documented in the real man page(s). These additional files 1.2490 -# only source the real man page, but without them the man command 1.2491 -# would be unable to find the correct page. The default is NO. 1.2492 +# The MAN_SUBDIR tag determines the name of the directory created within 1.2493 +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 1.2494 +# MAN_EXTENSION with the initial . removed. 1.2495 +# This tag requires that the tag GENERATE_MAN is set to YES. 1.2496 + 1.2497 +MAN_SUBDIR = 1.2498 + 1.2499 +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1.2500 +# will generate one additional man file for each entity documented in the real 1.2501 +# man page(s). These additional files only source the real man page, but without 1.2502 +# them the man command would be unable to find the correct page. 1.2503 +# The default value is: NO. 1.2504 +# This tag requires that the tag GENERATE_MAN is set to YES. 1.2505 1.2506 MAN_LINKS = NO 1.2507 1.2508 #--------------------------------------------------------------------------- 1.2509 -# configuration options related to the XML output 1.2510 +# Configuration options related to the XML output 1.2511 #--------------------------------------------------------------------------- 1.2512 1.2513 -# If the GENERATE_XML tag is set to YES Doxygen will 1.2514 -# generate an XML file that captures the structure of 1.2515 -# the code including all documentation. 1.2516 +# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that 1.2517 +# captures the structure of the code including all documentation. 1.2518 +# The default value is: NO. 1.2519 1.2520 GENERATE_XML = NO 1.2521 1.2522 -# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1.2523 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1.2524 -# put in front of it. If left blank `xml' will be used as the default path. 1.2525 +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 1.2526 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1.2527 +# it. 1.2528 +# The default directory is: xml. 1.2529 +# This tag requires that the tag GENERATE_XML is set to YES. 1.2530 1.2531 XML_OUTPUT = xml 1.2532 1.2533 -# The XML_SCHEMA tag can be used to specify an XML schema, 1.2534 -# which can be used by a validating XML parser to check the 1.2535 -# syntax of the XML files. 1.2536 - 1.2537 -XML_SCHEMA = 1.2538 - 1.2539 -# The XML_DTD tag can be used to specify an XML DTD, 1.2540 -# which can be used by a validating XML parser to check the 1.2541 -# syntax of the XML files. 1.2542 - 1.2543 -XML_DTD = 1.2544 - 1.2545 -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1.2546 -# dump the program listings (including syntax highlighting 1.2547 -# and cross-referencing information) to the XML output. Note that 1.2548 -# enabling this will significantly increase the size of the XML output. 1.2549 +# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program 1.2550 +# listings (including syntax highlighting and cross-referencing information) to 1.2551 +# the XML output. Note that enabling this will significantly increase the size 1.2552 +# of the XML output. 1.2553 +# The default value is: YES. 1.2554 +# This tag requires that the tag GENERATE_XML is set to YES. 1.2555 1.2556 XML_PROGRAMLISTING = YES 1.2557 1.2558 #--------------------------------------------------------------------------- 1.2559 -# configuration options for the AutoGen Definitions output 1.2560 +# Configuration options related to the DOCBOOK output 1.2561 #--------------------------------------------------------------------------- 1.2562 1.2563 -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1.2564 -# generate an AutoGen Definitions (see autogen.sf.net) file 1.2565 -# that captures the structure of the code including all 1.2566 -# documentation. Note that this feature is still experimental 1.2567 -# and incomplete at the moment. 1.2568 +# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files 1.2569 +# that can be used to generate PDF. 1.2570 +# The default value is: NO. 1.2571 + 1.2572 +GENERATE_DOCBOOK = NO 1.2573 + 1.2574 +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 1.2575 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 1.2576 +# front of it. 1.2577 +# The default directory is: docbook. 1.2578 +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1.2579 + 1.2580 +DOCBOOK_OUTPUT = docbook 1.2581 + 1.2582 +#--------------------------------------------------------------------------- 1.2583 +# Configuration options for the AutoGen Definitions output 1.2584 +#--------------------------------------------------------------------------- 1.2585 + 1.2586 +# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen 1.2587 +# Definitions (see http://autogen.sf.net) file that captures the structure of 1.2588 +# the code including all documentation. Note that this feature is still 1.2589 +# experimental and incomplete at the moment. 1.2590 +# The default value is: NO. 1.2591 1.2592 GENERATE_AUTOGEN_DEF = NO 1.2593 1.2594 #--------------------------------------------------------------------------- 1.2595 -# configuration options related to the Perl module output 1.2596 +# Configuration options related to the Perl module output 1.2597 #--------------------------------------------------------------------------- 1.2598 1.2599 -# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1.2600 -# generate a Perl module file that captures the structure of 1.2601 -# the code including all documentation. Note that this 1.2602 -# feature is still experimental and incomplete at the 1.2603 -# moment. 1.2604 +# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module 1.2605 +# file that captures the structure of the code including all documentation. 1.2606 +# 1.2607 +# Note that this feature is still experimental and incomplete at the moment. 1.2608 +# The default value is: NO. 1.2609 1.2610 GENERATE_PERLMOD = NO 1.2611 1.2612 -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1.2613 -# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1.2614 -# to generate PDF and DVI output from the Perl module output. 1.2615 +# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary 1.2616 +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 1.2617 +# output from the Perl module output. 1.2618 +# The default value is: NO. 1.2619 +# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1.2620 1.2621 PERLMOD_LATEX = NO 1.2622 1.2623 -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1.2624 -# nicely formatted so it can be parsed by a human reader. 1.2625 -# This is useful 1.2626 -# if you want to understand what is going on. 1.2627 -# On the other hand, if this 1.2628 -# tag is set to NO the size of the Perl module output will be much smaller 1.2629 -# and Perl will parse it just the same. 1.2630 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely 1.2631 +# formatted so it can be parsed by a human reader. This is useful if you want to 1.2632 +# understand what is going on. On the other hand, if this tag is set to NO the 1.2633 +# size of the Perl module output will be much smaller and Perl will parse it 1.2634 +# just the same. 1.2635 +# The default value is: YES. 1.2636 +# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1.2637 1.2638 PERLMOD_PRETTY = YES 1.2639 1.2640 -# The names of the make variables in the generated doxyrules.make file 1.2641 -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1.2642 -# This is useful so different doxyrules.make files included by the same 1.2643 -# Makefile don't overwrite each other's variables. 1.2644 +# The names of the make variables in the generated doxyrules.make file are 1.2645 +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 1.2646 +# so different doxyrules.make files included by the same Makefile don't 1.2647 +# overwrite each other's variables. 1.2648 +# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1.2649 1.2650 PERLMOD_MAKEVAR_PREFIX = 1.2651 1.2652 @@ -1452,110 +1889,128 @@ 1.2653 # Configuration options related to the preprocessor 1.2654 #--------------------------------------------------------------------------- 1.2655 1.2656 -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1.2657 -# evaluate all C-preprocessor directives found in the sources and include 1.2658 -# files. 1.2659 +# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all 1.2660 +# C-preprocessor directives found in the sources and include files. 1.2661 +# The default value is: YES. 1.2662 1.2663 ENABLE_PREPROCESSING = YES 1.2664 1.2665 -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1.2666 -# names in the source code. If set to NO (the default) only conditional 1.2667 -# compilation will be performed. Macro expansion can be done in a controlled 1.2668 -# way by setting EXPAND_ONLY_PREDEF to YES. 1.2669 +# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names 1.2670 +# in the source code. If set to NO only conditional compilation will be 1.2671 +# performed. Macro expansion can be done in a controlled way by setting 1.2672 +# EXPAND_ONLY_PREDEF to YES. 1.2673 +# The default value is: NO. 1.2674 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1.2675 1.2676 MACRO_EXPANSION = NO 1.2677 1.2678 -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1.2679 -# then the macro expansion is limited to the macros specified with the 1.2680 -# PREDEFINED and EXPAND_AS_DEFINED tags. 1.2681 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 1.2682 +# the macro expansion is limited to the macros specified with the PREDEFINED and 1.2683 +# EXPAND_AS_DEFINED tags. 1.2684 +# The default value is: NO. 1.2685 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1.2686 1.2687 EXPAND_ONLY_PREDEF = NO 1.2688 1.2689 -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1.2690 -# pointed to by INCLUDE_PATH will be searched when a #include is found. 1.2691 +# If the SEARCH_INCLUDES tag is set to YES the includes files in the 1.2692 +# INCLUDE_PATH will be searched if a #include is found. 1.2693 +# The default value is: YES. 1.2694 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1.2695 1.2696 SEARCH_INCLUDES = YES 1.2697 1.2698 # The INCLUDE_PATH tag can be used to specify one or more directories that 1.2699 -# contain include files that are not input files but should be processed by 1.2700 -# the preprocessor. 1.2701 +# contain include files that are not input files but should be processed by the 1.2702 +# preprocessor. 1.2703 +# This tag requires that the tag SEARCH_INCLUDES is set to YES. 1.2704 1.2705 INCLUDE_PATH = 1.2706 1.2707 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1.2708 # patterns (like *.h and *.hpp) to filter out the header-files in the 1.2709 -# directories. If left blank, the patterns specified with FILE_PATTERNS will 1.2710 -# be used. 1.2711 +# directories. If left blank, the patterns specified with FILE_PATTERNS will be 1.2712 +# used. 1.2713 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1.2714 1.2715 INCLUDE_FILE_PATTERNS = 1.2716 1.2717 -# The PREDEFINED tag can be used to specify one or more macro names that 1.2718 -# are defined before the preprocessor is started (similar to the -D option of 1.2719 -# gcc). The argument of the tag is a list of macros of the form: name 1.2720 -# or name=definition (no spaces). If the definition and the = are 1.2721 -# omitted =1 is assumed. To prevent a macro definition from being 1.2722 -# undefined via #undef or recursively expanded use the := operator 1.2723 -# instead of the = operator. 1.2724 +# The PREDEFINED tag can be used to specify one or more macro names that are 1.2725 +# defined before the preprocessor is started (similar to the -D option of e.g. 1.2726 +# gcc). The argument of the tag is a list of macros of the form: name or 1.2727 +# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 1.2728 +# is assumed. To prevent a macro definition from being undefined via #undef or 1.2729 +# recursively expanded use the := operator instead of the = operator. 1.2730 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1.2731 1.2732 PREDEFINED = 1.2733 1.2734 -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1.2735 -# this tag can be used to specify a list of macro names that should be expanded. 1.2736 -# The macro definition that is found in the sources will be used. 1.2737 -# Use the PREDEFINED tag if you want to use a different macro definition that 1.2738 -# overrules the definition found in the source code. 1.2739 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 1.2740 +# tag can be used to specify a list of macro names that should be expanded. The 1.2741 +# macro definition that is found in the sources will be used. Use the PREDEFINED 1.2742 +# tag if you want to use a different macro definition that overrules the 1.2743 +# definition found in the source code. 1.2744 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1.2745 1.2746 EXPAND_AS_DEFINED = 1.2747 1.2748 -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1.2749 -# doxygen's preprocessor will remove all references to function-like macros 1.2750 -# that are alone on a line, have an all uppercase name, and do not end with a 1.2751 -# semicolon, because these will confuse the parser if not removed. 1.2752 +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 1.2753 +# remove all references to function-like macros that are alone on a line, have 1.2754 +# an all uppercase name, and do not end with a semicolon. Such function macros 1.2755 +# are typically used for boiler-plate code, and will confuse the parser if not 1.2756 +# removed. 1.2757 +# The default value is: YES. 1.2758 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1.2759 1.2760 SKIP_FUNCTION_MACROS = YES 1.2761 1.2762 #--------------------------------------------------------------------------- 1.2763 -# Configuration::additions related to external references 1.2764 +# Configuration options related to external references 1.2765 #--------------------------------------------------------------------------- 1.2766 1.2767 -# The TAGFILES option can be used to specify one or more tagfiles. 1.2768 -# Optionally an initial location of the external documentation 1.2769 -# can be added for each tagfile. The format of a tag file without 1.2770 -# this location is as follows: 1.2771 -# 1.2772 +# The TAGFILES tag can be used to specify one or more tag files. For each tag 1.2773 +# file the location of the external documentation should be added. The format of 1.2774 +# a tag file without this location is as follows: 1.2775 # TAGFILES = file1 file2 ... 1.2776 # Adding location for the tag files is done as follows: 1.2777 -# 1.2778 # TAGFILES = file1=loc1 "file2 = loc2" ... 1.2779 -# where "loc1" and "loc2" can be relative or absolute paths or 1.2780 -# URLs. If a location is present for each tag, the installdox tool 1.2781 -# does not have to be run to correct the links. 1.2782 -# Note that each tag file must have a unique name 1.2783 -# (where the name does NOT include the path) 1.2784 -# If a tag file is not located in the directory in which doxygen 1.2785 -# is run, you must also specify the path to the tagfile here. 1.2786 +# where loc1 and loc2 can be relative or absolute paths or URLs. See the 1.2787 +# section "Linking to external documentation" for more information about the use 1.2788 +# of tag files. 1.2789 +# Note: Each tag file must have a unique name (where the name does NOT include 1.2790 +# the path). If a tag file is not located in the directory in which doxygen is 1.2791 +# run, you must also specify the path to the tagfile here. 1.2792 1.2793 TAGFILES = 1.2794 1.2795 -# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1.2796 -# a tag file that is based on the input files it reads. 1.2797 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 1.2798 +# tag file that is based on the input files it reads. See section "Linking to 1.2799 +# external documentation" for more information about the usage of tag files. 1.2800 1.2801 GENERATE_TAGFILE = 1.2802 1.2803 -# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1.2804 -# in the class index. If set to NO only the inherited external classes 1.2805 -# will be listed. 1.2806 +# If the ALLEXTERNALS tag is set to YES all external class will be listed in the 1.2807 +# class index. If set to NO only the inherited external classes will be listed. 1.2808 +# The default value is: NO. 1.2809 1.2810 ALLEXTERNALS = NO 1.2811 1.2812 -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1.2813 -# in the modules index. If set to NO, only the current project's groups will 1.2814 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in 1.2815 +# the modules index. If set to NO, only the current project's groups will be 1.2816 +# listed. 1.2817 +# The default value is: YES. 1.2818 + 1.2819 +EXTERNAL_GROUPS = YES 1.2820 + 1.2821 +# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in 1.2822 +# the related pages index. If set to NO, only the current project's pages will 1.2823 # be listed. 1.2824 - 1.2825 -EXTERNAL_GROUPS = YES 1.2826 +# The default value is: YES. 1.2827 + 1.2828 +EXTERNAL_PAGES = YES 1.2829 1.2830 # The PERL_PATH should be the absolute path and name of the perl script 1.2831 -# interpreter (i.e. the result of `which perl'). 1.2832 +# interpreter (i.e. the result of 'which perl'). 1.2833 +# The default file (with absolute path) is: /usr/bin/perl. 1.2834 1.2835 PERL_PATH = /usr/bin/perl 1.2836 1.2837 @@ -1563,213 +2018,295 @@ 1.2838 # Configuration options related to the dot tool 1.2839 #--------------------------------------------------------------------------- 1.2840 1.2841 -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1.2842 -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1.2843 -# or super classes. Setting the tag to NO turns the diagrams off. Note that 1.2844 -# this option also works with HAVE_DOT disabled, but it is recommended to 1.2845 -# install and use dot, since it yields more powerful graphs. 1.2846 +# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram 1.2847 +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 1.2848 +# NO turns the diagrams off. Note that this option also works with HAVE_DOT 1.2849 +# disabled, but it is recommended to install and use dot, since it yields more 1.2850 +# powerful graphs. 1.2851 +# The default value is: YES. 1.2852 1.2853 CLASS_DIAGRAMS = YES 1.2854 1.2855 # You can define message sequence charts within doxygen comments using the \msc 1.2856 -# command. Doxygen will then run the mscgen tool (see 1.2857 -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1.2858 +# command. Doxygen will then run the mscgen tool (see: 1.2859 +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 1.2860 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1.2861 # the mscgen tool resides. If left empty the tool is assumed to be found in the 1.2862 # default search path. 1.2863 1.2864 MSCGEN_PATH = 1.2865 1.2866 -# If set to YES, the inheritance and collaboration graphs will hide 1.2867 -# inheritance and usage relations if the target is undocumented 1.2868 -# or is not a class. 1.2869 +# You can include diagrams made with dia in doxygen documentation. Doxygen will 1.2870 +# then run dia to produce the diagram and insert it in the documentation. The 1.2871 +# DIA_PATH tag allows you to specify the directory where the dia binary resides. 1.2872 +# If left empty dia is assumed to be found in the default search path. 1.2873 + 1.2874 +DIA_PATH = 1.2875 + 1.2876 +# If set to YES, the inheritance and collaboration graphs will hide inheritance 1.2877 +# and usage relations if the target is undocumented or is not a class. 1.2878 +# The default value is: YES. 1.2879 1.2880 HIDE_UNDOC_RELATIONS = YES 1.2881 1.2882 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1.2883 -# available from the path. This tool is part of Graphviz, a graph visualization 1.2884 -# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1.2885 -# have no effect if this option is set to NO (the default) 1.2886 +# available from the path. This tool is part of Graphviz (see: 1.2887 +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 1.2888 +# Bell Labs. The other options in this section have no effect if this option is 1.2889 +# set to NO 1.2890 +# The default value is: YES. 1.2891 1.2892 HAVE_DOT = NO 1.2893 1.2894 -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1.2895 -# allowed to run in parallel. When set to 0 (the default) doxygen will 1.2896 -# base this on the number of processors available in the system. You can set it 1.2897 -# explicitly to a value larger than 0 to get control over the balance 1.2898 -# between CPU load and processing speed. 1.2899 +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 1.2900 +# to run in parallel. When set to 0 doxygen will base this on the number of 1.2901 +# processors available in the system. You can set it explicitly to a value 1.2902 +# larger than 0 to get control over the balance between CPU load and processing 1.2903 +# speed. 1.2904 +# Minimum value: 0, maximum value: 32, default value: 0. 1.2905 +# This tag requires that the tag HAVE_DOT is set to YES. 1.2906 1.2907 DOT_NUM_THREADS = 0 1.2908 1.2909 -# By default doxygen will use the Helvetica font for all dot files that 1.2910 -# doxygen generates. When you want a differently looking font you can specify 1.2911 -# the font name using DOT_FONTNAME. You need to make sure dot is able to find 1.2912 -# the font, which can be done by putting it in a standard location or by setting 1.2913 -# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1.2914 -# directory containing the font. 1.2915 +# When you want a differently looking font n the dot files that doxygen 1.2916 +# generates you can specify the font name using DOT_FONTNAME. You need to make 1.2917 +# sure dot is able to find the font, which can be done by putting it in a 1.2918 +# standard location or by setting the DOTFONTPATH environment variable or by 1.2919 +# setting DOT_FONTPATH to the directory containing the font. 1.2920 +# The default value is: Helvetica. 1.2921 +# This tag requires that the tag HAVE_DOT is set to YES. 1.2922 1.2923 DOT_FONTNAME = Helvetica 1.2924 1.2925 -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1.2926 -# The default size is 10pt. 1.2927 +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 1.2928 +# dot graphs. 1.2929 +# Minimum value: 4, maximum value: 24, default value: 10. 1.2930 +# This tag requires that the tag HAVE_DOT is set to YES. 1.2931 1.2932 DOT_FONTSIZE = 10 1.2933 1.2934 -# By default doxygen will tell dot to use the Helvetica font. 1.2935 -# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1.2936 -# set the path where dot can find it. 1.2937 +# By default doxygen will tell dot to use the default font as specified with 1.2938 +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 1.2939 +# the path where dot can find it using this tag. 1.2940 +# This tag requires that the tag HAVE_DOT is set to YES. 1.2941 1.2942 DOT_FONTPATH = 1.2943 1.2944 -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1.2945 -# will generate a graph for each documented class showing the direct and 1.2946 -# indirect inheritance relations. Setting this tag to YES will force the 1.2947 -# CLASS_DIAGRAMS tag to NO. 1.2948 +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 1.2949 +# each documented class showing the direct and indirect inheritance relations. 1.2950 +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 1.2951 +# The default value is: YES. 1.2952 +# This tag requires that the tag HAVE_DOT is set to YES. 1.2953 1.2954 CLASS_GRAPH = YES 1.2955 1.2956 -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1.2957 -# will generate a graph for each documented class showing the direct and 1.2958 -# indirect implementation dependencies (inheritance, containment, and 1.2959 -# class references variables) of the class with other documented classes. 1.2960 +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 1.2961 +# graph for each documented class showing the direct and indirect implementation 1.2962 +# dependencies (inheritance, containment, and class references variables) of the 1.2963 +# class with other documented classes. 1.2964 +# The default value is: YES. 1.2965 +# This tag requires that the tag HAVE_DOT is set to YES. 1.2966 1.2967 COLLABORATION_GRAPH = YES 1.2968 1.2969 -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1.2970 -# will generate a graph for groups, showing the direct groups dependencies 1.2971 +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 1.2972 +# groups, showing the direct groups dependencies. 1.2973 +# The default value is: YES. 1.2974 +# This tag requires that the tag HAVE_DOT is set to YES. 1.2975 1.2976 GROUP_GRAPHS = YES 1.2977 1.2978 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1.2979 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1.2980 # Language. 1.2981 +# The default value is: NO. 1.2982 +# This tag requires that the tag HAVE_DOT is set to YES. 1.2983 1.2984 UML_LOOK = NO 1.2985 1.2986 -# If set to YES, the inheritance and collaboration graphs will show the 1.2987 -# relations between templates and their instances. 1.2988 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 1.2989 +# class node. If there are many fields or methods and many nodes the graph may 1.2990 +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 1.2991 +# number of items for each type to make the size more manageable. Set this to 0 1.2992 +# for no limit. Note that the threshold may be exceeded by 50% before the limit 1.2993 +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 1.2994 +# but if the number exceeds 15, the total amount of fields shown is limited to 1.2995 +# 10. 1.2996 +# Minimum value: 0, maximum value: 100, default value: 10. 1.2997 +# This tag requires that the tag HAVE_DOT is set to YES. 1.2998 + 1.2999 +UML_LIMIT_NUM_FIELDS = 10 1.3000 + 1.3001 +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 1.3002 +# collaboration graphs will show the relations between templates and their 1.3003 +# instances. 1.3004 +# The default value is: NO. 1.3005 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3006 1.3007 TEMPLATE_RELATIONS = NO 1.3008 1.3009 -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1.3010 -# tags are set to YES then doxygen will generate a graph for each documented 1.3011 -# file showing the direct and indirect include dependencies of the file with 1.3012 -# other documented files. 1.3013 +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 1.3014 +# YES then doxygen will generate a graph for each documented file showing the 1.3015 +# direct and indirect include dependencies of the file with other documented 1.3016 +# files. 1.3017 +# The default value is: YES. 1.3018 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3019 1.3020 INCLUDE_GRAPH = YES 1.3021 1.3022 -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1.3023 -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1.3024 -# documented header file showing the documented files that directly or 1.3025 -# indirectly include this file. 1.3026 +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 1.3027 +# set to YES then doxygen will generate a graph for each documented file showing 1.3028 +# the direct and indirect include dependencies of the file with other documented 1.3029 +# files. 1.3030 +# The default value is: YES. 1.3031 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3032 1.3033 INCLUDED_BY_GRAPH = YES 1.3034 1.3035 -# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1.3036 -# doxygen will generate a call dependency graph for every global function 1.3037 -# or class method. Note that enabling this option will significantly increase 1.3038 -# the time of a run. So in most cases it will be better to enable call graphs 1.3039 -# for selected functions only using the \callgraph command. 1.3040 +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 1.3041 +# dependency graph for every global function or class method. 1.3042 +# 1.3043 +# Note that enabling this option will significantly increase the time of a run. 1.3044 +# So in most cases it will be better to enable call graphs for selected 1.3045 +# functions only using the \callgraph command. 1.3046 +# The default value is: NO. 1.3047 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3048 1.3049 CALL_GRAPH = NO 1.3050 1.3051 -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1.3052 -# doxygen will generate a caller dependency graph for every global function 1.3053 -# or class method. Note that enabling this option will significantly increase 1.3054 -# the time of a run. So in most cases it will be better to enable caller 1.3055 -# graphs for selected functions only using the \callergraph command. 1.3056 +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 1.3057 +# dependency graph for every global function or class method. 1.3058 +# 1.3059 +# Note that enabling this option will significantly increase the time of a run. 1.3060 +# So in most cases it will be better to enable caller graphs for selected 1.3061 +# functions only using the \callergraph command. 1.3062 +# The default value is: NO. 1.3063 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3064 1.3065 CALLER_GRAPH = NO 1.3066 1.3067 -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1.3068 -# will generate a graphical hierarchy of all classes instead of a textual one. 1.3069 +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 1.3070 +# hierarchy of all classes instead of a textual one. 1.3071 +# The default value is: YES. 1.3072 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3073 1.3074 GRAPHICAL_HIERARCHY = YES 1.3075 1.3076 -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1.3077 -# then doxygen will show the dependencies a directory has on other directories 1.3078 -# in a graphical way. The dependency relations are determined by the #include 1.3079 -# relations between the files in the directories. 1.3080 +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 1.3081 +# dependencies a directory has on other directories in a graphical way. The 1.3082 +# dependency relations are determined by the #include relations between the 1.3083 +# files in the directories. 1.3084 +# The default value is: YES. 1.3085 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3086 1.3087 DIRECTORY_GRAPH = YES 1.3088 1.3089 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1.3090 -# generated by dot. Possible values are svg, png, jpg, or gif. 1.3091 -# If left blank png will be used. If you choose svg you need to set 1.3092 -# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1.3093 -# visible in IE 9+ (other browsers do not have this requirement). 1.3094 +# generated by dot. 1.3095 +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 1.3096 +# to make the SVG files visible in IE 9+ (other browsers do not have this 1.3097 +# requirement). 1.3098 +# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, 1.3099 +# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, 1.3100 +# gif:cairo:gd, gif:gd, gif:gd:gd and svg. 1.3101 +# The default value is: png. 1.3102 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3103 1.3104 DOT_IMAGE_FORMAT = png 1.3105 1.3106 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1.3107 # enable generation of interactive SVG images that allow zooming and panning. 1.3108 -# Note that this requires a modern browser other than Internet Explorer. 1.3109 -# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1.3110 -# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1.3111 -# visible. Older versions of IE do not have SVG support. 1.3112 +# 1.3113 +# Note that this requires a modern browser other than Internet Explorer. Tested 1.3114 +# and working are Firefox, Chrome, Safari, and Opera. 1.3115 +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 1.3116 +# the SVG files visible. Older versions of IE do not have SVG support. 1.3117 +# The default value is: NO. 1.3118 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3119 1.3120 INTERACTIVE_SVG = NO 1.3121 1.3122 -# The tag DOT_PATH can be used to specify the path where the dot tool can be 1.3123 +# The DOT_PATH tag can be used to specify the path where the dot tool can be 1.3124 # found. If left blank, it is assumed the dot tool can be found in the path. 1.3125 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3126 1.3127 DOT_PATH = 1.3128 1.3129 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1.3130 -# contain dot files that are included in the documentation (see the 1.3131 -# \dotfile command). 1.3132 +# contain dot files that are included in the documentation (see the \dotfile 1.3133 +# command). 1.3134 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3135 1.3136 DOTFILE_DIRS = 1.3137 1.3138 # The MSCFILE_DIRS tag can be used to specify one or more directories that 1.3139 -# contain msc files that are included in the documentation (see the 1.3140 -# \mscfile command). 1.3141 +# contain msc files that are included in the documentation (see the \mscfile 1.3142 +# command). 1.3143 1.3144 MSCFILE_DIRS = 1.3145 1.3146 -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1.3147 -# nodes that will be shown in the graph. If the number of nodes in a graph 1.3148 -# becomes larger than this value, doxygen will truncate the graph, which is 1.3149 -# visualized by representing a node as a red box. Note that doxygen if the 1.3150 -# number of direct children of the root node in a graph is already larger than 1.3151 -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1.3152 -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1.3153 +# The DIAFILE_DIRS tag can be used to specify one or more directories that 1.3154 +# contain dia files that are included in the documentation (see the \diafile 1.3155 +# command). 1.3156 + 1.3157 +DIAFILE_DIRS = 1.3158 + 1.3159 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 1.3160 +# that will be shown in the graph. If the number of nodes in a graph becomes 1.3161 +# larger than this value, doxygen will truncate the graph, which is visualized 1.3162 +# by representing a node as a red box. Note that doxygen if the number of direct 1.3163 +# children of the root node in a graph is already larger than 1.3164 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 1.3165 +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1.3166 +# Minimum value: 0, maximum value: 10000, default value: 50. 1.3167 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3168 1.3169 DOT_GRAPH_MAX_NODES = 50 1.3170 1.3171 -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1.3172 -# graphs generated by dot. A depth value of 3 means that only nodes reachable 1.3173 -# from the root by following a path via at most 3 edges will be shown. Nodes 1.3174 -# that lay further from the root node will be omitted. Note that setting this 1.3175 -# option to 1 or 2 may greatly reduce the computation time needed for large 1.3176 -# code bases. Also note that the size of a graph can be further restricted by 1.3177 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 1.3178 +# generated by dot. A depth value of 3 means that only nodes reachable from the 1.3179 +# root by following a path via at most 3 edges will be shown. Nodes that lay 1.3180 +# further from the root node will be omitted. Note that setting this option to 1 1.3181 +# or 2 may greatly reduce the computation time needed for large code bases. Also 1.3182 +# note that the size of a graph can be further restricted by 1.3183 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1.3184 +# Minimum value: 0, maximum value: 1000, default value: 0. 1.3185 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3186 1.3187 MAX_DOT_GRAPH_DEPTH = 0 1.3188 1.3189 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1.3190 -# background. This is disabled by default, because dot on Windows does not 1.3191 -# seem to support this out of the box. Warning: Depending on the platform used, 1.3192 -# enabling this option may lead to badly anti-aliased labels on the edges of 1.3193 -# a graph (i.e. they become hard to read). 1.3194 +# background. This is disabled by default, because dot on Windows does not seem 1.3195 +# to support this out of the box. 1.3196 +# 1.3197 +# Warning: Depending on the platform used, enabling this option may lead to 1.3198 +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1.3199 +# read). 1.3200 +# The default value is: NO. 1.3201 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3202 1.3203 DOT_TRANSPARENT = NO 1.3204 1.3205 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1.3206 # files in one run (i.e. multiple -o and -T options on the command line). This 1.3207 -# makes dot run faster, but since only newer versions of dot (>1.8.10) 1.3208 -# support this, this feature is disabled by default. 1.3209 +# makes dot run faster, but since only newer versions of dot (>1.8.10) support 1.3210 +# this, this feature is disabled by default. 1.3211 +# The default value is: NO. 1.3212 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3213 1.3214 DOT_MULTI_TARGETS = YES 1.3215 1.3216 -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1.3217 -# generate a legend page explaining the meaning of the various boxes and 1.3218 -# arrows in the dot generated graphs. 1.3219 +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 1.3220 +# explaining the meaning of the various boxes and arrows in the dot generated 1.3221 +# graphs. 1.3222 +# The default value is: YES. 1.3223 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3224 1.3225 GENERATE_LEGEND = YES 1.3226 1.3227 -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1.3228 -# remove the intermediate dot files that are used to generate 1.3229 -# the various graphs. 1.3230 +# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot 1.3231 +# files that are used to generate the various graphs. 1.3232 +# The default value is: YES. 1.3233 +# This tag requires that the tag HAVE_DOT is set to YES. 1.3234 1.3235 DOT_CLEANUP = YES