Wed, 18 Oct 2023 21:07:02 +0200
add an uwproj based install target
Makefile | file | annotate | diff | comparison | revisions | |
cmake_infile.doxygen | file | annotate | diff | comparison | revisions | |
configure | file | annotate | diff | comparison | revisions | |
docs/Makefile | file | annotate | diff | comparison | revisions | |
make/clang.mk | file | annotate | diff | comparison | revisions | |
make/gcc.mk | file | annotate | diff | comparison | revisions | |
make/project.xml | file | annotate | diff | comparison | revisions | |
src/Makefile | file | annotate | diff | comparison | revisions | |
tests/Makefile | file | annotate | diff | comparison | revisions |
1.1 --- a/Makefile Thu Oct 12 00:00:35 2023 +0200 1.2 +++ b/Makefile Wed Oct 18 21:07:02 2023 +0200 1.3 @@ -26,25 +26,25 @@ 1.4 all: compile 1.5 1.6 install: 1.7 - @cd src && $(MAKE) -s install 1.8 + @cd src && $(MAKE) install 1.9 1.10 dist: FORCE 1.11 - $(MKDIR) $(DIST_DIR)/libucx 1.12 + $(MKDIR) $(dist_dir)/libucx 1.13 $(COPYALL) CHANGELOG configure COPYING Doxyfile Makefile README \ 1.14 - uaplogo.png docs make src tests $(DIST_DIR)/libucx/ 1.15 - @cd $(DIST_DIR) && tar -czf libucx-src-$(VERSION).tar.gz -Hustar libucx 1.16 - @echo "[ Dist created: $(DIST_DIR)/libucx-src-$(VERSION).tar.gz ]" 1.17 + uaplogo.png docs make src tests $(dist_dir)/libucx/ 1.18 + @cd $(dist_dir) && tar -czf libucx-src-$(VERSION).tar.gz -Hustar libucx 1.19 + @echo "[ Dist created: $(dist_dir)/libucx-src-$(VERSION).tar.gz ]" 1.20 1.21 clean: 1.22 - $(RMDIR) $(BUILD_DIR) 1.23 + $(RMDIR) $(build_dir) 1.24 1.25 dist-clean: 1.26 - $(RMDIR) $(DIST_DIR) 1.27 - $(RMDIR) $(BUILD_DIR) 1.28 + $(RMDIR) $(dist_dir) 1.29 + $(RMDIR) $(build_dir) 1.30 1.31 -compile: $(BUILD_DIR) static shared 1.32 +compile: $(build_dir) static shared 1.33 1.34 -$(BUILD_DIR): 1.35 +$(build_dir): 1.36 $(MKDIR) $@ 1.37 1.38 shared: FORCE 1.39 @@ -57,7 +57,7 @@ 1.40 @cd src && $(MAKE) static 1.41 1.42 check: test-compile FORCE 1.43 - $(BUILD_DIR)/tests/ucxtest 1.44 + $(build_dir)/tests/ucxtest 1.45 1.46 test-compile: 1.47 @(test "$(WITH_TESTS)" = "yes" && cd tests && $(MAKE)) \
2.1 --- a/cmake_infile.doxygen Thu Oct 12 00:00:35 2023 +0200 2.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 2.3 @@ -1,2721 +0,0 @@ 2.4 -# Doxyfile 1.9.6 2.5 - 2.6 -# This file describes the settings to be used by the documentation system 2.7 -# doxygen (www.doxygen.org) for a project. 2.8 -# 2.9 -# All text after a double hash (##) is considered a comment and is placed in 2.10 -# front of the TAG it is preceding. 2.11 -# 2.12 -# All text after a single hash (#) is considered a comment and will be ignored. 2.13 -# The format is: 2.14 -# TAG = value [value, ...] 2.15 -# For lists, items can also be appended using: 2.16 -# TAG += value [value, ...] 2.17 -# Values that contain spaces should be placed between quotes (\" \"). 2.18 -# 2.19 -# Note: 2.20 -# 2.21 -# Use doxygen to compare the used configuration file with the template 2.22 -# configuration file: 2.23 -# doxygen -x [configFile] 2.24 -# Use doxygen to compare the used configuration file with the template 2.25 -# configuration file without replacing the environment variables or CMake type 2.26 -# replacement variables: 2.27 -# doxygen -x_noenv [configFile] 2.28 - 2.29 -#--------------------------------------------------------------------------- 2.30 -# Project related configuration options 2.31 -#--------------------------------------------------------------------------- 2.32 - 2.33 -# This tag specifies the encoding used for all characters in the configuration 2.34 -# file that follow. The default is UTF-8 which is also the encoding used for all 2.35 -# text before the first occurrence of this tag. Doxygen uses libiconv (or the 2.36 -# iconv built into libc) for the transcoding. See 2.37 -# https://www.gnu.org/software/libiconv/ for the list of possible encodings. 2.38 -# The default value is: UTF-8. 2.39 - 2.40 -DOXYFILE_ENCODING = UTF-8 2.41 - 2.42 -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 2.43 -# double-quotes, unless you are using Doxywizard) that should identify the 2.44 -# project for which the documentation is generated. This name is used in the 2.45 -# title of most generated pages and in a few other places. 2.46 -# The default value is: My Project. 2.47 - 2.48 -PROJECT_NAME = ucx 2.49 - 2.50 -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This 2.51 -# could be handy for archiving the generated documentation or if some version 2.52 -# control system is used. 2.53 - 2.54 -PROJECT_NUMBER = 2.55 - 2.56 -# Using the PROJECT_BRIEF tag one can provide an optional one line description 2.57 -# for a project that appears at the top of each page and should give viewer a 2.58 -# quick idea about the purpose of the project. Keep the description short. 2.59 - 2.60 -PROJECT_BRIEF = "UAP Common Extensions" 2.61 - 2.62 -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included 2.63 -# in the documentation. The maximum height of the logo should not exceed 55 2.64 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 2.65 -# the logo to the output directory. 2.66 - 2.67 -PROJECT_LOGO = @DOXY_PROJECT_LOGO@ 2.68 - 2.69 -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 2.70 -# into which the generated documentation will be written. If a relative path is 2.71 -# entered, it will be relative to the location where doxygen was started. If 2.72 -# left blank the current directory will be used. 2.73 - 2.74 -OUTPUT_DIRECTORY = @DOXY_OUTPUT_DIRECTORY@ 2.75 - 2.76 -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 2.77 -# sub-directories (in 2 levels) under the output directory of each output format 2.78 -# and will distribute the generated files over these directories. Enabling this 2.79 -# option can be useful when feeding doxygen a huge amount of source files, where 2.80 -# putting all generated files in the same directory would otherwise causes 2.81 -# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to 2.82 -# control the number of sub-directories. 2.83 -# The default value is: NO. 2.84 - 2.85 -CREATE_SUBDIRS = NO 2.86 - 2.87 -# Controls the number of sub-directories that will be created when 2.88 -# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every 2.89 -# level increment doubles the number of directories, resulting in 4096 2.90 -# directories at level 8 which is the default and also the maximum value. The 2.91 -# sub-directories are organized in 2 levels, the first level always has a fixed 2.92 -# number of 16 directories. 2.93 -# Minimum value: 0, maximum value: 8, default value: 8. 2.94 -# This tag requires that the tag CREATE_SUBDIRS is set to YES. 2.95 - 2.96 -CREATE_SUBDIRS_LEVEL = 8 2.97 - 2.98 -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 2.99 -# characters to appear in the names of generated files. If set to NO, non-ASCII 2.100 -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 2.101 -# U+3044. 2.102 -# The default value is: NO. 2.103 - 2.104 -ALLOW_UNICODE_NAMES = NO 2.105 - 2.106 -# The OUTPUT_LANGUAGE tag is used to specify the language in which all 2.107 -# documentation generated by doxygen is written. Doxygen will use this 2.108 -# information to generate all constant output in the proper language. 2.109 -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, 2.110 -# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English 2.111 -# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, 2.112 -# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with 2.113 -# English messages), Korean, Korean-en (Korean with English messages), Latvian, 2.114 -# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, 2.115 -# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, 2.116 -# Swedish, Turkish, Ukrainian and Vietnamese. 2.117 -# The default value is: English. 2.118 - 2.119 -OUTPUT_LANGUAGE = English 2.120 - 2.121 -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 2.122 -# descriptions after the members that are listed in the file and class 2.123 -# documentation (similar to Javadoc). Set to NO to disable this. 2.124 -# The default value is: YES. 2.125 - 2.126 -BRIEF_MEMBER_DESC = YES 2.127 - 2.128 -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 2.129 -# description of a member or function before the detailed description 2.130 -# 2.131 -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 2.132 -# brief descriptions will be completely suppressed. 2.133 -# The default value is: YES. 2.134 - 2.135 -REPEAT_BRIEF = YES 2.136 - 2.137 -# This tag implements a quasi-intelligent brief description abbreviator that is 2.138 -# used to form the text in various listings. Each string in this list, if found 2.139 -# as the leading text of the brief description, will be stripped from the text 2.140 -# and the result, after processing the whole list, is used as the annotated 2.141 -# text. Otherwise, the brief description is used as-is. If left blank, the 2.142 -# following values are used ($name is automatically replaced with the name of 2.143 -# the entity):The $name class, The $name widget, The $name file, is, provides, 2.144 -# specifies, contains, represents, a, an and the. 2.145 - 2.146 -ABBREVIATE_BRIEF = 2.147 - 2.148 -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 2.149 -# doxygen will generate a detailed section even if there is only a brief 2.150 -# description. 2.151 -# The default value is: NO. 2.152 - 2.153 -ALWAYS_DETAILED_SEC = NO 2.154 - 2.155 -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 2.156 -# inherited members of a class in the documentation of that class as if those 2.157 -# members were ordinary class members. Constructors, destructors and assignment 2.158 -# operators of the base classes will not be shown. 2.159 -# The default value is: NO. 2.160 - 2.161 -INLINE_INHERITED_MEMB = NO 2.162 - 2.163 -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 2.164 -# before files name in the file list and in the header files. If set to NO the 2.165 -# shortest path that makes the file name unique will be used 2.166 -# The default value is: YES. 2.167 - 2.168 -FULL_PATH_NAMES = YES 2.169 - 2.170 -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 2.171 -# Stripping is only done if one of the specified strings matches the left-hand 2.172 -# part of the path. The tag can be used to show relative paths in the file list. 2.173 -# If left blank the directory from which doxygen is run is used as the path to 2.174 -# strip. 2.175 -# 2.176 -# Note that you can specify absolute paths here, but also relative paths, which 2.177 -# will be relative from the directory where doxygen is started. 2.178 -# This tag requires that the tag FULL_PATH_NAMES is set to YES. 2.179 - 2.180 -STRIP_FROM_PATH = 2.181 - 2.182 -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 2.183 -# path mentioned in the documentation of a class, which tells the reader which 2.184 -# header file to include in order to use a class. If left blank only the name of 2.185 -# the header file containing the class definition is used. Otherwise one should 2.186 -# specify the list of include paths that are normally passed to the compiler 2.187 -# using the -I flag. 2.188 - 2.189 -STRIP_FROM_INC_PATH = 2.190 - 2.191 -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 2.192 -# less readable) file names. This can be useful is your file systems doesn't 2.193 -# support long names like on DOS, Mac, or CD-ROM. 2.194 -# The default value is: NO. 2.195 - 2.196 -SHORT_NAMES = NO 2.197 - 2.198 -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 2.199 -# first line (until the first dot) of a Javadoc-style comment as the brief 2.200 -# description. If set to NO, the Javadoc-style will behave just like regular Qt- 2.201 -# style comments (thus requiring an explicit @brief command for a brief 2.202 -# description.) 2.203 -# The default value is: NO. 2.204 - 2.205 -JAVADOC_AUTOBRIEF = YES 2.206 - 2.207 -# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 2.208 -# such as 2.209 -# /*************** 2.210 -# as being the beginning of a Javadoc-style comment "banner". If set to NO, the 2.211 -# Javadoc-style will behave just like regular comments and it will not be 2.212 -# interpreted by doxygen. 2.213 -# The default value is: NO. 2.214 - 2.215 -JAVADOC_BANNER = NO 2.216 - 2.217 -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 2.218 -# line (until the first dot) of a Qt-style comment as the brief description. If 2.219 -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus 2.220 -# requiring an explicit \brief command for a brief description.) 2.221 -# The default value is: NO. 2.222 - 2.223 -QT_AUTOBRIEF = NO 2.224 - 2.225 -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 2.226 -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as 2.227 -# a brief description. This used to be the default behavior. The new default is 2.228 -# to treat a multi-line C++ comment block as a detailed description. Set this 2.229 -# tag to YES if you prefer the old behavior instead. 2.230 -# 2.231 -# Note that setting this tag to YES also means that rational rose comments are 2.232 -# not recognized any more. 2.233 -# The default value is: NO. 2.234 - 2.235 -MULTILINE_CPP_IS_BRIEF = NO 2.236 - 2.237 -# By default Python docstrings are displayed as preformatted text and doxygen's 2.238 -# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 2.239 -# doxygen's special commands can be used and the contents of the docstring 2.240 -# documentation blocks is shown as doxygen documentation. 2.241 -# The default value is: YES. 2.242 - 2.243 -PYTHON_DOCSTRING = YES 2.244 - 2.245 -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 2.246 -# documentation from any documented member that it re-implements. 2.247 -# The default value is: YES. 2.248 - 2.249 -INHERIT_DOCS = YES 2.250 - 2.251 -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 2.252 -# page for each member. If set to NO, the documentation of a member will be part 2.253 -# of the file/class/namespace that contains it. 2.254 -# The default value is: NO. 2.255 - 2.256 -SEPARATE_MEMBER_PAGES = NO 2.257 - 2.258 -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 2.259 -# uses this value to replace tabs by spaces in code fragments. 2.260 -# Minimum value: 1, maximum value: 16, default value: 4. 2.261 - 2.262 -TAB_SIZE = 4 2.263 - 2.264 -# This tag can be used to specify a number of aliases that act as commands in 2.265 -# the documentation. An alias has the form: 2.266 -# name=value 2.267 -# For example adding 2.268 -# "sideeffect=@par Side Effects:^^" 2.269 -# will allow you to put the command \sideeffect (or @sideeffect) in the 2.270 -# documentation, which will result in a user-defined paragraph with heading 2.271 -# "Side Effects:". Note that you cannot put \n's in the value part of an alias 2.272 -# to insert newlines (in the resulting output). You can put ^^ in the value part 2.273 -# of an alias to insert a newline as if a physical newline was in the original 2.274 -# file. When you need a literal { or } or , in the value part of an alias you 2.275 -# have to escape them by means of a backslash (\), this can lead to conflicts 2.276 -# with the commands \{ and \} for these it is advised to use the version @{ and 2.277 -# @} or use a double escape (\\{ and \\}) 2.278 - 2.279 -ALIASES = 2.280 - 2.281 -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 2.282 -# only. Doxygen will then generate output that is more tailored for C. For 2.283 -# instance, some of the names that are used will be different. The list of all 2.284 -# members will be omitted, etc. 2.285 -# The default value is: NO. 2.286 - 2.287 -OPTIMIZE_OUTPUT_FOR_C = YES 2.288 - 2.289 -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 2.290 -# Python sources only. Doxygen will then generate output that is more tailored 2.291 -# for that language. For instance, namespaces will be presented as packages, 2.292 -# qualified scopes will look different, etc. 2.293 -# The default value is: NO. 2.294 - 2.295 -OPTIMIZE_OUTPUT_JAVA = NO 2.296 - 2.297 -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 2.298 -# sources. Doxygen will then generate output that is tailored for Fortran. 2.299 -# The default value is: NO. 2.300 - 2.301 -OPTIMIZE_FOR_FORTRAN = NO 2.302 - 2.303 -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 2.304 -# sources. Doxygen will then generate output that is tailored for VHDL. 2.305 -# The default value is: NO. 2.306 - 2.307 -OPTIMIZE_OUTPUT_VHDL = NO 2.308 - 2.309 -# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 2.310 -# sources only. Doxygen will then generate output that is more tailored for that 2.311 -# language. For instance, namespaces will be presented as modules, types will be 2.312 -# separated into more groups, etc. 2.313 -# The default value is: NO. 2.314 - 2.315 -OPTIMIZE_OUTPUT_SLICE = NO 2.316 - 2.317 -# Doxygen selects the parser to use depending on the extension of the files it 2.318 -# parses. With this tag you can assign which parser to use for a given 2.319 -# extension. Doxygen has a built-in mapping, but you can override or extend it 2.320 -# using this tag. The format is ext=language, where ext is a file extension, and 2.321 -# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 2.322 -# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, 2.323 -# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 2.324 -# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 2.325 -# tries to guess whether the code is fixed or free formatted code, this is the 2.326 -# default for Fortran type files). For instance to make doxygen treat .inc files 2.327 -# as Fortran files (default is PHP), and .f files as C (default is Fortran), 2.328 -# use: inc=Fortran f=C. 2.329 -# 2.330 -# Note: For files without extension you can use no_extension as a placeholder. 2.331 -# 2.332 -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise 2.333 -# the files are not read by doxygen. When specifying no_extension you should add 2.334 -# * to the FILE_PATTERNS. 2.335 -# 2.336 -# Note see also the list of default file extension mappings. 2.337 - 2.338 -EXTENSION_MAPPING = 2.339 - 2.340 -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 2.341 -# according to the Markdown format, which allows for more readable 2.342 -# documentation. See https://daringfireball.net/projects/markdown/ for details. 2.343 -# The output of markdown processing is further processed by doxygen, so you can 2.344 -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 2.345 -# case of backward compatibilities issues. 2.346 -# The default value is: YES. 2.347 - 2.348 -MARKDOWN_SUPPORT = YES 2.349 - 2.350 -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 2.351 -# to that level are automatically included in the table of contents, even if 2.352 -# they do not have an id attribute. 2.353 -# Note: This feature currently applies only to Markdown headings. 2.354 -# Minimum value: 0, maximum value: 99, default value: 5. 2.355 -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 2.356 - 2.357 -TOC_INCLUDE_HEADINGS = 5 2.358 - 2.359 -# When enabled doxygen tries to link words that correspond to documented 2.360 -# classes, or namespaces to their corresponding documentation. Such a link can 2.361 -# be prevented in individual cases by putting a % sign in front of the word or 2.362 -# globally by setting AUTOLINK_SUPPORT to NO. 2.363 -# The default value is: YES. 2.364 - 2.365 -AUTOLINK_SUPPORT = YES 2.366 - 2.367 -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 2.368 -# to include (a tag file for) the STL sources as input, then you should set this 2.369 -# tag to YES in order to let doxygen match functions declarations and 2.370 -# definitions whose arguments contain STL classes (e.g. func(std::string); 2.371 -# versus func(std::string) {}). This also make the inheritance and collaboration 2.372 -# diagrams that involve STL classes more complete and accurate. 2.373 -# The default value is: NO. 2.374 - 2.375 -BUILTIN_STL_SUPPORT = NO 2.376 - 2.377 -# If you use Microsoft's C++/CLI language, you should set this option to YES to 2.378 -# enable parsing support. 2.379 -# The default value is: NO. 2.380 - 2.381 -CPP_CLI_SUPPORT = NO 2.382 - 2.383 -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 2.384 -# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 2.385 -# will parse them like normal C++ but will assume all classes use public instead 2.386 -# of private inheritance when no explicit protection keyword is present. 2.387 -# The default value is: NO. 2.388 - 2.389 -SIP_SUPPORT = NO 2.390 - 2.391 -# For Microsoft's IDL there are propget and propput attributes to indicate 2.392 -# getter and setter methods for a property. Setting this option to YES will make 2.393 -# doxygen to replace the get and set methods by a property in the documentation. 2.394 -# This will only work if the methods are indeed getting or setting a simple 2.395 -# type. If this is not the case, or you want to show the methods anyway, you 2.396 -# should set this option to NO. 2.397 -# The default value is: YES. 2.398 - 2.399 -IDL_PROPERTY_SUPPORT = YES 2.400 - 2.401 -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 2.402 -# tag is set to YES then doxygen will reuse the documentation of the first 2.403 -# member in the group (if any) for the other members of the group. By default 2.404 -# all members of a group must be documented explicitly. 2.405 -# The default value is: NO. 2.406 - 2.407 -DISTRIBUTE_GROUP_DOC = NO 2.408 - 2.409 -# If one adds a struct or class to a group and this option is enabled, then also 2.410 -# any nested class or struct is added to the same group. By default this option 2.411 -# is disabled and one has to add nested compounds explicitly via \ingroup. 2.412 -# The default value is: NO. 2.413 - 2.414 -GROUP_NESTED_COMPOUNDS = NO 2.415 - 2.416 -# Set the SUBGROUPING tag to YES to allow class member groups of the same type 2.417 -# (for instance a group of public functions) to be put as a subgroup of that 2.418 -# type (e.g. under the Public Functions section). Set it to NO to prevent 2.419 -# subgrouping. Alternatively, this can be done per class using the 2.420 -# \nosubgrouping command. 2.421 -# The default value is: YES. 2.422 - 2.423 -SUBGROUPING = YES 2.424 - 2.425 -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 2.426 -# are shown inside the group in which they are included (e.g. using \ingroup) 2.427 -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX 2.428 -# and RTF). 2.429 -# 2.430 -# Note that this feature does not work in combination with 2.431 -# SEPARATE_MEMBER_PAGES. 2.432 -# The default value is: NO. 2.433 - 2.434 -INLINE_GROUPED_CLASSES = NO 2.435 - 2.436 -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 2.437 -# with only public data fields or simple typedef fields will be shown inline in 2.438 -# the documentation of the scope in which they are defined (i.e. file, 2.439 -# namespace, or group documentation), provided this scope is documented. If set 2.440 -# to NO, structs, classes, and unions are shown on a separate page (for HTML and 2.441 -# Man pages) or section (for LaTeX and RTF). 2.442 -# The default value is: NO. 2.443 - 2.444 -INLINE_SIMPLE_STRUCTS = NO 2.445 - 2.446 -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 2.447 -# enum is documented as struct, union, or enum with the name of the typedef. So 2.448 -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 2.449 -# with name TypeT. When disabled the typedef will appear as a member of a file, 2.450 -# namespace, or class. And the struct will be named TypeS. This can typically be 2.451 -# useful for C code in case the coding convention dictates that all compound 2.452 -# types are typedef'ed and only the typedef is referenced, never the tag name. 2.453 -# The default value is: NO. 2.454 - 2.455 -TYPEDEF_HIDES_STRUCT = NO 2.456 - 2.457 -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 2.458 -# cache is used to resolve symbols given their name and scope. Since this can be 2.459 -# an expensive process and often the same symbol appears multiple times in the 2.460 -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 2.461 -# doxygen will become slower. If the cache is too large, memory is wasted. The 2.462 -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 2.463 -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 2.464 -# symbols. At the end of a run doxygen will report the cache usage and suggest 2.465 -# the optimal cache size from a speed point of view. 2.466 -# Minimum value: 0, maximum value: 9, default value: 0. 2.467 - 2.468 -LOOKUP_CACHE_SIZE = 0 2.469 - 2.470 -# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use 2.471 -# during processing. When set to 0 doxygen will based this on the number of 2.472 -# cores available in the system. You can set it explicitly to a value larger 2.473 -# than 0 to get more control over the balance between CPU load and processing 2.474 -# speed. At this moment only the input processing can be done using multiple 2.475 -# threads. Since this is still an experimental feature the default is set to 1, 2.476 -# which effectively disables parallel processing. Please report any issues you 2.477 -# encounter. Generating dot graphs in parallel is controlled by the 2.478 -# DOT_NUM_THREADS setting. 2.479 -# Minimum value: 0, maximum value: 32, default value: 1. 2.480 - 2.481 -NUM_PROC_THREADS = 1 2.482 - 2.483 -#--------------------------------------------------------------------------- 2.484 -# Build related configuration options 2.485 -#--------------------------------------------------------------------------- 2.486 - 2.487 -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 2.488 -# documentation are documented, even if no documentation was available. Private 2.489 -# class members and static file members will be hidden unless the 2.490 -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 2.491 -# Note: This will also disable the warnings about undocumented members that are 2.492 -# normally produced when WARNINGS is set to YES. 2.493 -# The default value is: NO. 2.494 - 2.495 -EXTRACT_ALL = NO 2.496 - 2.497 -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 2.498 -# be included in the documentation. 2.499 -# The default value is: NO. 2.500 - 2.501 -EXTRACT_PRIVATE = NO 2.502 - 2.503 -# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 2.504 -# methods of a class will be included in the documentation. 2.505 -# The default value is: NO. 2.506 - 2.507 -EXTRACT_PRIV_VIRTUAL = NO 2.508 - 2.509 -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 2.510 -# scope will be included in the documentation. 2.511 -# The default value is: NO. 2.512 - 2.513 -EXTRACT_PACKAGE = NO 2.514 - 2.515 -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 2.516 -# included in the documentation. 2.517 -# The default value is: NO. 2.518 - 2.519 -EXTRACT_STATIC = YES 2.520 - 2.521 -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 2.522 -# locally in source files will be included in the documentation. If set to NO, 2.523 -# only classes defined in header files are included. Does not have any effect 2.524 -# for Java sources. 2.525 -# The default value is: YES. 2.526 - 2.527 -EXTRACT_LOCAL_CLASSES = YES 2.528 - 2.529 -# This flag is only useful for Objective-C code. If set to YES, local methods, 2.530 -# which are defined in the implementation section but not in the interface are 2.531 -# included in the documentation. If set to NO, only methods in the interface are 2.532 -# included. 2.533 -# The default value is: NO. 2.534 - 2.535 -EXTRACT_LOCAL_METHODS = NO 2.536 - 2.537 -# If this flag is set to YES, the members of anonymous namespaces will be 2.538 -# extracted and appear in the documentation as a namespace called 2.539 -# 'anonymous_namespace{file}', where file will be replaced with the base name of 2.540 -# the file that contains the anonymous namespace. By default anonymous namespace 2.541 -# are hidden. 2.542 -# The default value is: NO. 2.543 - 2.544 -EXTRACT_ANON_NSPACES = NO 2.545 - 2.546 -# If this flag is set to YES, the name of an unnamed parameter in a declaration 2.547 -# will be determined by the corresponding definition. By default unnamed 2.548 -# parameters remain unnamed in the output. 2.549 -# The default value is: YES. 2.550 - 2.551 -RESOLVE_UNNAMED_PARAMS = YES 2.552 - 2.553 -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 2.554 -# undocumented members inside documented classes or files. If set to NO these 2.555 -# members will be included in the various overviews, but no documentation 2.556 -# section is generated. This option has no effect if EXTRACT_ALL is enabled. 2.557 -# The default value is: NO. 2.558 - 2.559 -HIDE_UNDOC_MEMBERS = NO 2.560 - 2.561 -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 2.562 -# undocumented classes that are normally visible in the class hierarchy. If set 2.563 -# to NO, these classes will be included in the various overviews. This option 2.564 -# will also hide undocumented C++ concepts if enabled. This option has no effect 2.565 -# if EXTRACT_ALL is enabled. 2.566 -# The default value is: NO. 2.567 - 2.568 -HIDE_UNDOC_CLASSES = NO 2.569 - 2.570 -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 2.571 -# declarations. If set to NO, these declarations will be included in the 2.572 -# documentation. 2.573 -# The default value is: NO. 2.574 - 2.575 -HIDE_FRIEND_COMPOUNDS = NO 2.576 - 2.577 -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 2.578 -# documentation blocks found inside the body of a function. If set to NO, these 2.579 -# blocks will be appended to the function's detailed documentation block. 2.580 -# The default value is: NO. 2.581 - 2.582 -HIDE_IN_BODY_DOCS = NO 2.583 - 2.584 -# The INTERNAL_DOCS tag determines if documentation that is typed after a 2.585 -# \internal command is included. If the tag is set to NO then the documentation 2.586 -# will be excluded. Set it to YES to include the internal documentation. 2.587 -# The default value is: NO. 2.588 - 2.589 -INTERNAL_DOCS = NO 2.590 - 2.591 -# With the correct setting of option CASE_SENSE_NAMES doxygen will better be 2.592 -# able to match the capabilities of the underlying filesystem. In case the 2.593 -# filesystem is case sensitive (i.e. it supports files in the same directory 2.594 -# whose names only differ in casing), the option must be set to YES to properly 2.595 -# deal with such files in case they appear in the input. For filesystems that 2.596 -# are not case sensitive the option should be set to NO to properly deal with 2.597 -# output files written for symbols that only differ in casing, such as for two 2.598 -# classes, one named CLASS and the other named Class, and to also support 2.599 -# references to files without having to specify the exact matching casing. On 2.600 -# Windows (including Cygwin) and MacOS, users should typically set this option 2.601 -# to NO, whereas on Linux or other Unix flavors it should typically be set to 2.602 -# YES. 2.603 -# Possible values are: SYSTEM, NO and YES. 2.604 -# The default value is: SYSTEM. 2.605 - 2.606 -CASE_SENSE_NAMES = YES 2.607 - 2.608 -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 2.609 -# their full class and namespace scopes in the documentation. If set to YES, the 2.610 -# scope will be hidden. 2.611 -# The default value is: NO. 2.612 - 2.613 -HIDE_SCOPE_NAMES = NO 2.614 - 2.615 -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 2.616 -# append additional text to a page's title, such as Class Reference. If set to 2.617 -# YES the compound reference will be hidden. 2.618 -# The default value is: NO. 2.619 - 2.620 -HIDE_COMPOUND_REFERENCE= NO 2.621 - 2.622 -# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class 2.623 -# will show which file needs to be included to use the class. 2.624 -# The default value is: YES. 2.625 - 2.626 -SHOW_HEADERFILE = YES 2.627 - 2.628 -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 2.629 -# the files that are included by a file in the documentation of that file. 2.630 -# The default value is: YES. 2.631 - 2.632 -SHOW_INCLUDE_FILES = YES 2.633 - 2.634 -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 2.635 -# grouped member an include statement to the documentation, telling the reader 2.636 -# which file to include in order to use the member. 2.637 -# The default value is: NO. 2.638 - 2.639 -SHOW_GROUPED_MEMB_INC = NO 2.640 - 2.641 -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 2.642 -# files with double quotes in the documentation rather than with sharp brackets. 2.643 -# The default value is: NO. 2.644 - 2.645 -FORCE_LOCAL_INCLUDES = NO 2.646 - 2.647 -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 2.648 -# documentation for inline members. 2.649 -# The default value is: YES. 2.650 - 2.651 -INLINE_INFO = YES 2.652 - 2.653 -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 2.654 -# (detailed) documentation of file and class members alphabetically by member 2.655 -# name. If set to NO, the members will appear in declaration order. 2.656 -# The default value is: YES. 2.657 - 2.658 -SORT_MEMBER_DOCS = YES 2.659 - 2.660 -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 2.661 -# descriptions of file, namespace and class members alphabetically by member 2.662 -# name. If set to NO, the members will appear in declaration order. Note that 2.663 -# this will also influence the order of the classes in the class list. 2.664 -# The default value is: NO. 2.665 - 2.666 -SORT_BRIEF_DOCS = NO 2.667 - 2.668 -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 2.669 -# (brief and detailed) documentation of class members so that constructors and 2.670 -# destructors are listed first. If set to NO the constructors will appear in the 2.671 -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 2.672 -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 2.673 -# member documentation. 2.674 -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 2.675 -# detailed member documentation. 2.676 -# The default value is: NO. 2.677 - 2.678 -SORT_MEMBERS_CTORS_1ST = NO 2.679 - 2.680 -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 2.681 -# of group names into alphabetical order. If set to NO the group names will 2.682 -# appear in their defined order. 2.683 -# The default value is: NO. 2.684 - 2.685 -SORT_GROUP_NAMES = NO 2.686 - 2.687 -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 2.688 -# fully-qualified names, including namespaces. If set to NO, the class list will 2.689 -# be sorted only by class name, not including the namespace part. 2.690 -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 2.691 -# Note: This option applies only to the class list, not to the alphabetical 2.692 -# list. 2.693 -# The default value is: NO. 2.694 - 2.695 -SORT_BY_SCOPE_NAME = NO 2.696 - 2.697 -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 2.698 -# type resolution of all parameters of a function it will reject a match between 2.699 -# the prototype and the implementation of a member function even if there is 2.700 -# only one candidate or it is obvious which candidate to choose by doing a 2.701 -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 2.702 -# accept a match between prototype and implementation in such cases. 2.703 -# The default value is: NO. 2.704 - 2.705 -STRICT_PROTO_MATCHING = NO 2.706 - 2.707 -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 2.708 -# list. This list is created by putting \todo commands in the documentation. 2.709 -# The default value is: YES. 2.710 - 2.711 -GENERATE_TODOLIST = YES 2.712 - 2.713 -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 2.714 -# list. This list is created by putting \test commands in the documentation. 2.715 -# The default value is: YES. 2.716 - 2.717 -GENERATE_TESTLIST = YES 2.718 - 2.719 -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 2.720 -# list. This list is created by putting \bug commands in the documentation. 2.721 -# The default value is: YES. 2.722 - 2.723 -GENERATE_BUGLIST = YES 2.724 - 2.725 -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 2.726 -# the deprecated list. This list is created by putting \deprecated commands in 2.727 -# the documentation. 2.728 -# The default value is: YES. 2.729 - 2.730 -GENERATE_DEPRECATEDLIST= YES 2.731 - 2.732 -# The ENABLED_SECTIONS tag can be used to enable conditional documentation 2.733 -# sections, marked by \if <section_label> ... \endif and \cond <section_label> 2.734 -# ... \endcond blocks. 2.735 - 2.736 -ENABLED_SECTIONS = 2.737 - 2.738 -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 2.739 -# initial value of a variable or macro / define can have for it to appear in the 2.740 -# documentation. If the initializer consists of more lines than specified here 2.741 -# it will be hidden. Use a value of 0 to hide initializers completely. The 2.742 -# appearance of the value of individual variables and macros / defines can be 2.743 -# controlled using \showinitializer or \hideinitializer command in the 2.744 -# documentation regardless of this setting. 2.745 -# Minimum value: 0, maximum value: 10000, default value: 30. 2.746 - 2.747 -MAX_INITIALIZER_LINES = 30 2.748 - 2.749 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 2.750 -# the bottom of the documentation of classes and structs. If set to YES, the 2.751 -# list will mention the files that were used to generate the documentation. 2.752 -# The default value is: YES. 2.753 - 2.754 -SHOW_USED_FILES = YES 2.755 - 2.756 -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 2.757 -# will remove the Files entry from the Quick Index and from the Folder Tree View 2.758 -# (if specified). 2.759 -# The default value is: YES. 2.760 - 2.761 -SHOW_FILES = YES 2.762 - 2.763 -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 2.764 -# page. This will remove the Namespaces entry from the Quick Index and from the 2.765 -# Folder Tree View (if specified). 2.766 -# The default value is: YES. 2.767 - 2.768 -SHOW_NAMESPACES = YES 2.769 - 2.770 -# The FILE_VERSION_FILTER tag can be used to specify a program or script that 2.771 -# doxygen should invoke to get the current version for each file (typically from 2.772 -# the version control system). Doxygen will invoke the program by executing (via 2.773 -# popen()) the command command input-file, where command is the value of the 2.774 -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 2.775 -# by doxygen. Whatever the program writes to standard output is used as the file 2.776 -# version. For an example see the documentation. 2.777 - 2.778 -FILE_VERSION_FILTER = 2.779 - 2.780 -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 2.781 -# by doxygen. The layout file controls the global structure of the generated 2.782 -# output files in an output format independent way. To create the layout file 2.783 -# that represents doxygen's defaults, run doxygen with the -l option. You can 2.784 -# optionally specify a file name after the option, if omitted DoxygenLayout.xml 2.785 -# will be used as the name of the layout file. See also section "Changing the 2.786 -# layout of pages" for information. 2.787 -# 2.788 -# Note that if you run doxygen from a directory containing a file called 2.789 -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 2.790 -# tag is left empty. 2.791 - 2.792 -LAYOUT_FILE = 2.793 - 2.794 -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing 2.795 -# the reference definitions. This must be a list of .bib files. The .bib 2.796 -# extension is automatically appended if omitted. This requires the bibtex tool 2.797 -# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 2.798 -# For LaTeX the style of the bibliography can be controlled using 2.799 -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 2.800 -# search path. See also \cite for info how to create references. 2.801 - 2.802 -CITE_BIB_FILES = 2.803 - 2.804 -#--------------------------------------------------------------------------- 2.805 -# Configuration options related to warning and progress messages 2.806 -#--------------------------------------------------------------------------- 2.807 - 2.808 -# The QUIET tag can be used to turn on/off the messages that are generated to 2.809 -# standard output by doxygen. If QUIET is set to YES this implies that the 2.810 -# messages are off. 2.811 -# The default value is: NO. 2.812 - 2.813 -QUIET = NO 2.814 - 2.815 -# The WARNINGS tag can be used to turn on/off the warning messages that are 2.816 -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 2.817 -# this implies that the warnings are on. 2.818 -# 2.819 -# Tip: Turn warnings on while writing the documentation. 2.820 -# The default value is: YES. 2.821 - 2.822 -WARNINGS = YES 2.823 - 2.824 -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 2.825 -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 2.826 -# will automatically be disabled. 2.827 -# The default value is: YES. 2.828 - 2.829 -WARN_IF_UNDOCUMENTED = YES 2.830 - 2.831 -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 2.832 -# potential errors in the documentation, such as documenting some parameters in 2.833 -# a documented function twice, or documenting parameters that don't exist or 2.834 -# using markup commands wrongly. 2.835 -# The default value is: YES. 2.836 - 2.837 -WARN_IF_DOC_ERROR = YES 2.838 - 2.839 -# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete 2.840 -# function parameter documentation. If set to NO, doxygen will accept that some 2.841 -# parameters have no documentation without warning. 2.842 -# The default value is: YES. 2.843 - 2.844 -WARN_IF_INCOMPLETE_DOC = YES 2.845 - 2.846 -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 2.847 -# are documented, but have no documentation for their parameters or return 2.848 -# value. If set to NO, doxygen will only warn about wrong parameter 2.849 -# documentation, but not about the absence of documentation. If EXTRACT_ALL is 2.850 -# set to YES then this flag will automatically be disabled. See also 2.851 -# WARN_IF_INCOMPLETE_DOC 2.852 -# The default value is: NO. 2.853 - 2.854 -WARN_NO_PARAMDOC = YES 2.855 - 2.856 -# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about 2.857 -# undocumented enumeration values. If set to NO, doxygen will accept 2.858 -# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag 2.859 -# will automatically be disabled. 2.860 -# The default value is: NO. 2.861 - 2.862 -WARN_IF_UNDOC_ENUM_VAL = NO 2.863 - 2.864 -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 2.865 -# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 2.866 -# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 2.867 -# at the end of the doxygen process doxygen will return with a non-zero status. 2.868 -# Possible values are: NO, YES and FAIL_ON_WARNINGS. 2.869 -# The default value is: NO. 2.870 - 2.871 -WARN_AS_ERROR = NO 2.872 - 2.873 -# The WARN_FORMAT tag determines the format of the warning messages that doxygen 2.874 -# can produce. The string should contain the $file, $line, and $text tags, which 2.875 -# will be replaced by the file and line number from which the warning originated 2.876 -# and the warning text. Optionally the format may contain $version, which will 2.877 -# be replaced by the version of the file (if it could be obtained via 2.878 -# FILE_VERSION_FILTER) 2.879 -# See also: WARN_LINE_FORMAT 2.880 -# The default value is: $file:$line: $text. 2.881 - 2.882 -WARN_FORMAT = "$file:$line: $text" 2.883 - 2.884 -# In the $text part of the WARN_FORMAT command it is possible that a reference 2.885 -# to a more specific place is given. To make it easier to jump to this place 2.886 -# (outside of doxygen) the user can define a custom "cut" / "paste" string. 2.887 -# Example: 2.888 -# WARN_LINE_FORMAT = "'vi $file +$line'" 2.889 -# See also: WARN_FORMAT 2.890 -# The default value is: at line $line of file $file. 2.891 - 2.892 -WARN_LINE_FORMAT = "at line $line of file $file" 2.893 - 2.894 -# The WARN_LOGFILE tag can be used to specify a file to which warning and error 2.895 -# messages should be written. If left blank the output is written to standard 2.896 -# error (stderr). In case the file specified cannot be opened for writing the 2.897 -# warning and error messages are written to standard error. When as file - is 2.898 -# specified the warning and error messages are written to standard output 2.899 -# (stdout). 2.900 - 2.901 -WARN_LOGFILE = 2.902 - 2.903 -#--------------------------------------------------------------------------- 2.904 -# Configuration options related to the input files 2.905 -#--------------------------------------------------------------------------- 2.906 - 2.907 -# The INPUT tag is used to specify the files and/or directories that contain 2.908 -# documented source files. You may enter file names like myfile.cpp or 2.909 -# directories like /usr/src/myproject. Separate the files or directories with 2.910 -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 2.911 -# Note: If this tag is empty the current directory is searched. 2.912 - 2.913 -INPUT = @DOXY_INPUT@ 2.914 - 2.915 -# This tag can be used to specify the character encoding of the source files 2.916 -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 2.917 -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 2.918 -# documentation (see: 2.919 -# https://www.gnu.org/software/libiconv/) for the list of possible encodings. 2.920 -# See also: INPUT_FILE_ENCODING 2.921 -# The default value is: UTF-8. 2.922 - 2.923 -INPUT_ENCODING = UTF-8 2.924 - 2.925 -# This tag can be used to specify the character encoding of the source files 2.926 -# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify 2.927 -# character encoding on a per file pattern basis. Doxygen will compare the file 2.928 -# name with each pattern and apply the encoding instead of the default 2.929 -# INPUT_ENCODING) if there is a match. The character encodings are a list of the 2.930 -# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding 2.931 -# "INPUT_ENCODING" for further information on supported encodings. 2.932 - 2.933 -INPUT_FILE_ENCODING = 2.934 - 2.935 -# If the value of the INPUT tag contains directories, you can use the 2.936 -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 2.937 -# *.h) to filter out the source-files in the directories. 2.938 -# 2.939 -# Note that for custom extensions or not directly supported extensions you also 2.940 -# need to set EXTENSION_MAPPING for the extension otherwise the files are not 2.941 -# read by doxygen. 2.942 -# 2.943 -# Note the list of default checked file patterns might differ from the list of 2.944 -# default file extension mappings. 2.945 -# 2.946 -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 2.947 -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 2.948 -# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, 2.949 -# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C 2.950 -# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, 2.951 -# *.vhdl, *.ucf, *.qsf and *.ice. 2.952 - 2.953 -FILE_PATTERNS = 2.954 - 2.955 -# The RECURSIVE tag can be used to specify whether or not subdirectories should 2.956 -# be searched for input files as well. 2.957 -# The default value is: NO. 2.958 - 2.959 -RECURSIVE = YES 2.960 - 2.961 -# The EXCLUDE tag can be used to specify files and/or directories that should be 2.962 -# excluded from the INPUT source files. This way you can easily exclude a 2.963 -# subdirectory from a directory tree whose root is specified with the INPUT tag. 2.964 -# 2.965 -# Note that relative paths are relative to the directory from which doxygen is 2.966 -# run. 2.967 - 2.968 -EXCLUDE = 2.969 - 2.970 -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 2.971 -# directories that are symbolic links (a Unix file system feature) are excluded 2.972 -# from the input. 2.973 -# The default value is: NO. 2.974 - 2.975 -EXCLUDE_SYMLINKS = NO 2.976 - 2.977 -# If the value of the INPUT tag contains directories, you can use the 2.978 -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 2.979 -# certain files from those directories. 2.980 -# 2.981 -# Note that the wildcards are matched against the file with absolute path, so to 2.982 -# exclude all test directories for example use the pattern */test/* 2.983 - 2.984 -EXCLUDE_PATTERNS = 2.985 - 2.986 -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 2.987 -# (namespaces, classes, functions, etc.) that should be excluded from the 2.988 -# output. The symbol name can be a fully qualified name, a word, or if the 2.989 -# wildcard * is used, a substring. Examples: ANamespace, AClass, 2.990 -# ANamespace::AClass, ANamespace::*Test 2.991 -# 2.992 -# Note that the wildcards are matched against the file with absolute path, so to 2.993 -# exclude all test directories use the pattern */test/* 2.994 - 2.995 -EXCLUDE_SYMBOLS = 2.996 - 2.997 -# The EXAMPLE_PATH tag can be used to specify one or more files or directories 2.998 -# that contain example code fragments that are included (see the \include 2.999 -# command). 2.1000 - 2.1001 -EXAMPLE_PATH = 2.1002 - 2.1003 -# If the value of the EXAMPLE_PATH tag contains directories, you can use the 2.1004 -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 2.1005 -# *.h) to filter out the source-files in the directories. If left blank all 2.1006 -# files are included. 2.1007 - 2.1008 -EXAMPLE_PATTERNS = 2.1009 - 2.1010 -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 2.1011 -# searched for input files to be used with the \include or \dontinclude commands 2.1012 -# irrespective of the value of the RECURSIVE tag. 2.1013 -# The default value is: NO. 2.1014 - 2.1015 -EXAMPLE_RECURSIVE = NO 2.1016 - 2.1017 -# The IMAGE_PATH tag can be used to specify one or more files or directories 2.1018 -# that contain images that are to be included in the documentation (see the 2.1019 -# \image command). 2.1020 - 2.1021 -IMAGE_PATH = 2.1022 - 2.1023 -# The INPUT_FILTER tag can be used to specify a program that doxygen should 2.1024 -# invoke to filter for each input file. Doxygen will invoke the filter program 2.1025 -# by executing (via popen()) the command: 2.1026 -# 2.1027 -# <filter> <input-file> 2.1028 -# 2.1029 -# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 2.1030 -# name of an input file. Doxygen will then use the output that the filter 2.1031 -# program writes to standard output. If FILTER_PATTERNS is specified, this tag 2.1032 -# will be ignored. 2.1033 -# 2.1034 -# Note that the filter must not add or remove lines; it is applied before the 2.1035 -# code is scanned, but not when the output code is generated. If lines are added 2.1036 -# or removed, the anchors will not be placed correctly. 2.1037 -# 2.1038 -# Note that doxygen will use the data processed and written to standard output 2.1039 -# for further processing, therefore nothing else, like debug statements or used 2.1040 -# commands (so in case of a Windows batch file always use @echo OFF), should be 2.1041 -# written to standard output. 2.1042 -# 2.1043 -# Note that for custom extensions or not directly supported extensions you also 2.1044 -# need to set EXTENSION_MAPPING for the extension otherwise the files are not 2.1045 -# properly processed by doxygen. 2.1046 - 2.1047 -INPUT_FILTER = 2.1048 - 2.1049 -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 2.1050 -# basis. Doxygen will compare the file name with each pattern and apply the 2.1051 -# filter if there is a match. The filters are a list of the form: pattern=filter 2.1052 -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 2.1053 -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 2.1054 -# patterns match the file name, INPUT_FILTER is applied. 2.1055 -# 2.1056 -# Note that for custom extensions or not directly supported extensions you also 2.1057 -# need to set EXTENSION_MAPPING for the extension otherwise the files are not 2.1058 -# properly processed by doxygen. 2.1059 - 2.1060 -FILTER_PATTERNS = 2.1061 - 2.1062 -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 2.1063 -# INPUT_FILTER) will also be used to filter the input files that are used for 2.1064 -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 2.1065 -# The default value is: NO. 2.1066 - 2.1067 -FILTER_SOURCE_FILES = NO 2.1068 - 2.1069 -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 2.1070 -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 2.1071 -# it is also possible to disable source filtering for a specific pattern using 2.1072 -# *.ext= (so without naming a filter). 2.1073 -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 2.1074 - 2.1075 -FILTER_SOURCE_PATTERNS = 2.1076 - 2.1077 -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 2.1078 -# is part of the input, its contents will be placed on the main page 2.1079 -# (index.html). This can be useful if you have a project on for instance GitHub 2.1080 -# and want to reuse the introduction page also for the doxygen output. 2.1081 - 2.1082 -USE_MDFILE_AS_MAINPAGE = 2.1083 - 2.1084 -# The Fortran standard specifies that for fixed formatted Fortran code all 2.1085 -# characters from position 72 are to be considered as comment. A common 2.1086 -# extension is to allow longer lines before the automatic comment starts. The 2.1087 -# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can 2.1088 -# be processed before the automatic comment starts. 2.1089 -# Minimum value: 7, maximum value: 10000, default value: 72. 2.1090 - 2.1091 -FORTRAN_COMMENT_AFTER = 72 2.1092 - 2.1093 -#--------------------------------------------------------------------------- 2.1094 -# Configuration options related to source browsing 2.1095 -#--------------------------------------------------------------------------- 2.1096 - 2.1097 -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 2.1098 -# generated. Documented entities will be cross-referenced with these sources. 2.1099 -# 2.1100 -# Note: To get rid of all source code in the generated output, make sure that 2.1101 -# also VERBATIM_HEADERS is set to NO. 2.1102 -# The default value is: NO. 2.1103 - 2.1104 -SOURCE_BROWSER = NO 2.1105 - 2.1106 -# Setting the INLINE_SOURCES tag to YES will include the body of functions, 2.1107 -# classes and enums directly into the documentation. 2.1108 -# The default value is: NO. 2.1109 - 2.1110 -INLINE_SOURCES = NO 2.1111 - 2.1112 -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 2.1113 -# special comment blocks from generated source code fragments. Normal C, C++ and 2.1114 -# Fortran comments will always remain visible. 2.1115 -# The default value is: YES. 2.1116 - 2.1117 -STRIP_CODE_COMMENTS = YES 2.1118 - 2.1119 -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 2.1120 -# entity all documented functions referencing it will be listed. 2.1121 -# The default value is: NO. 2.1122 - 2.1123 -REFERENCED_BY_RELATION = NO 2.1124 - 2.1125 -# If the REFERENCES_RELATION tag is set to YES then for each documented function 2.1126 -# all documented entities called/used by that function will be listed. 2.1127 -# The default value is: NO. 2.1128 - 2.1129 -REFERENCES_RELATION = NO 2.1130 - 2.1131 -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 2.1132 -# to YES then the hyperlinks from functions in REFERENCES_RELATION and 2.1133 -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 2.1134 -# link to the documentation. 2.1135 -# The default value is: YES. 2.1136 - 2.1137 -REFERENCES_LINK_SOURCE = YES 2.1138 - 2.1139 -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 2.1140 -# source code will show a tooltip with additional information such as prototype, 2.1141 -# brief description and links to the definition and documentation. Since this 2.1142 -# will make the HTML file larger and loading of large files a bit slower, you 2.1143 -# can opt to disable this feature. 2.1144 -# The default value is: YES. 2.1145 -# This tag requires that the tag SOURCE_BROWSER is set to YES. 2.1146 - 2.1147 -SOURCE_TOOLTIPS = YES 2.1148 - 2.1149 -# If the USE_HTAGS tag is set to YES then the references to source code will 2.1150 -# point to the HTML generated by the htags(1) tool instead of doxygen built-in 2.1151 -# source browser. The htags tool is part of GNU's global source tagging system 2.1152 -# (see https://www.gnu.org/software/global/global.html). You will need version 2.1153 -# 4.8.6 or higher. 2.1154 -# 2.1155 -# To use it do the following: 2.1156 -# - Install the latest version of global 2.1157 -# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 2.1158 -# - Make sure the INPUT points to the root of the source tree 2.1159 -# - Run doxygen as normal 2.1160 -# 2.1161 -# Doxygen will invoke htags (and that will in turn invoke gtags), so these 2.1162 -# tools must be available from the command line (i.e. in the search path). 2.1163 -# 2.1164 -# The result: instead of the source browser generated by doxygen, the links to 2.1165 -# source code will now point to the output of htags. 2.1166 -# The default value is: NO. 2.1167 -# This tag requires that the tag SOURCE_BROWSER is set to YES. 2.1168 - 2.1169 -USE_HTAGS = NO 2.1170 - 2.1171 -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 2.1172 -# verbatim copy of the header file for each class for which an include is 2.1173 -# specified. Set to NO to disable this. 2.1174 -# See also: Section \class. 2.1175 -# The default value is: YES. 2.1176 - 2.1177 -VERBATIM_HEADERS = YES 2.1178 - 2.1179 -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 2.1180 -# clang parser (see: 2.1181 -# http://clang.llvm.org/) for more accurate parsing at the cost of reduced 2.1182 -# performance. This can be particularly helpful with template rich C++ code for 2.1183 -# which doxygen's built-in parser lacks the necessary type information. 2.1184 -# Note: The availability of this option depends on whether or not doxygen was 2.1185 -# generated with the -Duse_libclang=ON option for CMake. 2.1186 -# The default value is: NO. 2.1187 - 2.1188 -CLANG_ASSISTED_PARSING = NO 2.1189 - 2.1190 -# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS 2.1191 -# tag is set to YES then doxygen will add the directory of each input to the 2.1192 -# include path. 2.1193 -# The default value is: YES. 2.1194 -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 2.1195 - 2.1196 -CLANG_ADD_INC_PATHS = YES 2.1197 - 2.1198 -# If clang assisted parsing is enabled you can provide the compiler with command 2.1199 -# line options that you would normally use when invoking the compiler. Note that 2.1200 -# the include paths will already be set by doxygen for the files and directories 2.1201 -# specified with INPUT and INCLUDE_PATH. 2.1202 -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 2.1203 - 2.1204 -CLANG_OPTIONS = 2.1205 - 2.1206 -# If clang assisted parsing is enabled you can provide the clang parser with the 2.1207 -# path to the directory containing a file called compile_commands.json. This 2.1208 -# file is the compilation database (see: 2.1209 -# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the 2.1210 -# options used when the source files were built. This is equivalent to 2.1211 -# specifying the -p option to a clang tool, such as clang-check. These options 2.1212 -# will then be passed to the parser. Any options specified with CLANG_OPTIONS 2.1213 -# will be added as well. 2.1214 -# Note: The availability of this option depends on whether or not doxygen was 2.1215 -# generated with the -Duse_libclang=ON option for CMake. 2.1216 - 2.1217 -CLANG_DATABASE_PATH = 2.1218 - 2.1219 -#--------------------------------------------------------------------------- 2.1220 -# Configuration options related to the alphabetical class index 2.1221 -#--------------------------------------------------------------------------- 2.1222 - 2.1223 -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 2.1224 -# compounds will be generated. Enable this if the project contains a lot of 2.1225 -# classes, structs, unions or interfaces. 2.1226 -# The default value is: YES. 2.1227 - 2.1228 -ALPHABETICAL_INDEX = YES 2.1229 - 2.1230 -# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) 2.1231 -# that should be ignored while generating the index headers. The IGNORE_PREFIX 2.1232 -# tag works for classes, function and member names. The entity will be placed in 2.1233 -# the alphabetical list under the first letter of the entity name that remains 2.1234 -# after removing the prefix. 2.1235 -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 2.1236 - 2.1237 -IGNORE_PREFIX = 2.1238 - 2.1239 -#--------------------------------------------------------------------------- 2.1240 -# Configuration options related to the HTML output 2.1241 -#--------------------------------------------------------------------------- 2.1242 - 2.1243 -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 2.1244 -# The default value is: YES. 2.1245 - 2.1246 -GENERATE_HTML = YES 2.1247 - 2.1248 -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 2.1249 -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2.1250 -# it. 2.1251 -# The default directory is: html. 2.1252 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1253 - 2.1254 -HTML_OUTPUT = web/api 2.1255 - 2.1256 -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 2.1257 -# generated HTML page (for example: .htm, .php, .asp). 2.1258 -# The default value is: .html. 2.1259 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1260 - 2.1261 -HTML_FILE_EXTENSION = .html 2.1262 - 2.1263 -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 2.1264 -# each generated HTML page. If the tag is left blank doxygen will generate a 2.1265 -# standard header. 2.1266 -# 2.1267 -# To get valid HTML the header file that includes any scripts and style sheets 2.1268 -# that doxygen needs, which is dependent on the configuration options used (e.g. 2.1269 -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 2.1270 -# default header using 2.1271 -# doxygen -w html new_header.html new_footer.html new_stylesheet.css 2.1272 -# YourConfigFile 2.1273 -# and then modify the file new_header.html. See also section "Doxygen usage" 2.1274 -# for information on how to generate the default header that doxygen normally 2.1275 -# uses. 2.1276 -# Note: The header is subject to change so you typically have to regenerate the 2.1277 -# default header when upgrading to a newer version of doxygen. For a description 2.1278 -# of the possible markers and block names see the documentation. 2.1279 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1280 - 2.1281 -HTML_HEADER = 2.1282 - 2.1283 -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 2.1284 -# generated HTML page. If the tag is left blank doxygen will generate a standard 2.1285 -# footer. See HTML_HEADER for more information on how to generate a default 2.1286 -# footer and what special commands can be used inside the footer. See also 2.1287 -# section "Doxygen usage" for information on how to generate the default footer 2.1288 -# that doxygen normally uses. 2.1289 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1290 - 2.1291 -HTML_FOOTER = 2.1292 - 2.1293 -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 2.1294 -# sheet that is used by each HTML page. It can be used to fine-tune the look of 2.1295 -# the HTML output. If left blank doxygen will generate a default style sheet. 2.1296 -# See also section "Doxygen usage" for information on how to generate the style 2.1297 -# sheet that doxygen normally uses. 2.1298 -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 2.1299 -# it is more robust and this tag (HTML_STYLESHEET) will in the future become 2.1300 -# obsolete. 2.1301 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1302 - 2.1303 -HTML_STYLESHEET = 2.1304 - 2.1305 -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 2.1306 -# cascading style sheets that are included after the standard style sheets 2.1307 -# created by doxygen. Using this option one can overrule certain style aspects. 2.1308 -# This is preferred over using HTML_STYLESHEET since it does not replace the 2.1309 -# standard style sheet and is therefore more robust against future updates. 2.1310 -# Doxygen will copy the style sheet files to the output directory. 2.1311 -# Note: The order of the extra style sheet files is of importance (e.g. the last 2.1312 -# style sheet in the list overrules the setting of the previous ones in the 2.1313 -# list). 2.1314 -# Note: Since the styling of scrollbars can currently not be overruled in 2.1315 -# Webkit/Chromium, the styling will be left out of the default doxygen.css if 2.1316 -# one or more extra stylesheets have been specified. So if scrollbar 2.1317 -# customization is desired it has to be added explicitly. For an example see the 2.1318 -# documentation. 2.1319 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1320 - 2.1321 -HTML_EXTRA_STYLESHEET = 2.1322 - 2.1323 -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 2.1324 -# other source files which should be copied to the HTML output directory. Note 2.1325 -# that these files will be copied to the base HTML output directory. Use the 2.1326 -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 2.1327 -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 2.1328 -# files will be copied as-is; there are no commands or markers available. 2.1329 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1330 - 2.1331 -HTML_EXTRA_FILES = 2.1332 - 2.1333 -# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output 2.1334 -# should be rendered with a dark or light theme. 2.1335 -# Possible values are: LIGHT always generate light mode output, DARK always 2.1336 -# generate dark mode output, AUTO_LIGHT automatically set the mode according to 2.1337 -# the user preference, use light mode if no preference is set (the default), 2.1338 -# AUTO_DARK automatically set the mode according to the user preference, use 2.1339 -# dark mode if no preference is set and TOGGLE allow to user to switch between 2.1340 -# light and dark mode via a button. 2.1341 -# The default value is: AUTO_LIGHT. 2.1342 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1343 - 2.1344 -HTML_COLORSTYLE = AUTO_LIGHT 2.1345 - 2.1346 -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 2.1347 -# will adjust the colors in the style sheet and background images according to 2.1348 -# this color. Hue is specified as an angle on a color-wheel, see 2.1349 -# https://en.wikipedia.org/wiki/Hue for more information. For instance the value 2.1350 -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 2.1351 -# purple, and 360 is red again. 2.1352 -# Minimum value: 0, maximum value: 359, default value: 220. 2.1353 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1354 - 2.1355 -HTML_COLORSTYLE_HUE = 220 2.1356 - 2.1357 -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 2.1358 -# in the HTML output. For a value of 0 the output will use gray-scales only. A 2.1359 -# value of 255 will produce the most vivid colors. 2.1360 -# Minimum value: 0, maximum value: 255, default value: 100. 2.1361 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1362 - 2.1363 -HTML_COLORSTYLE_SAT = 100 2.1364 - 2.1365 -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 2.1366 -# luminance component of the colors in the HTML output. Values below 100 2.1367 -# gradually make the output lighter, whereas values above 100 make the output 2.1368 -# darker. The value divided by 100 is the actual gamma applied, so 80 represents 2.1369 -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 2.1370 -# change the gamma. 2.1371 -# Minimum value: 40, maximum value: 240, default value: 80. 2.1372 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1373 - 2.1374 -HTML_COLORSTYLE_GAMMA = 80 2.1375 - 2.1376 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 2.1377 -# page will contain the date and time when the page was generated. Setting this 2.1378 -# to YES can help to show when doxygen was last run and thus if the 2.1379 -# documentation is up to date. 2.1380 -# The default value is: NO. 2.1381 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1382 - 2.1383 -HTML_TIMESTAMP = YES 2.1384 - 2.1385 -# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 2.1386 -# documentation will contain a main index with vertical navigation menus that 2.1387 -# are dynamically created via JavaScript. If disabled, the navigation index will 2.1388 -# consists of multiple levels of tabs that are statically embedded in every HTML 2.1389 -# page. Disable this option to support browsers that do not have JavaScript, 2.1390 -# like the Qt help browser. 2.1391 -# The default value is: YES. 2.1392 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1393 - 2.1394 -HTML_DYNAMIC_MENUS = YES 2.1395 - 2.1396 -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 2.1397 -# documentation will contain sections that can be hidden and shown after the 2.1398 -# page has loaded. 2.1399 -# The default value is: NO. 2.1400 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1401 - 2.1402 -HTML_DYNAMIC_SECTIONS = NO 2.1403 - 2.1404 -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 2.1405 -# shown in the various tree structured indices initially; the user can expand 2.1406 -# and collapse entries dynamically later on. Doxygen will expand the tree to 2.1407 -# such a level that at most the specified number of entries are visible (unless 2.1408 -# a fully collapsed tree already exceeds this amount). So setting the number of 2.1409 -# entries 1 will produce a full collapsed tree by default. 0 is a special value 2.1410 -# representing an infinite number of entries and will result in a full expanded 2.1411 -# tree by default. 2.1412 -# Minimum value: 0, maximum value: 9999, default value: 100. 2.1413 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1414 - 2.1415 -HTML_INDEX_NUM_ENTRIES = 100 2.1416 - 2.1417 -# If the GENERATE_DOCSET tag is set to YES, additional index files will be 2.1418 -# generated that can be used as input for Apple's Xcode 3 integrated development 2.1419 -# environment (see: 2.1420 -# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 2.1421 -# create a documentation set, doxygen will generate a Makefile in the HTML 2.1422 -# output directory. Running make will produce the docset in that directory and 2.1423 -# running make install will install the docset in 2.1424 -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 2.1425 -# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 2.1426 -# genXcode/_index.html for more information. 2.1427 -# The default value is: NO. 2.1428 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1429 - 2.1430 -GENERATE_DOCSET = NO 2.1431 - 2.1432 -# This tag determines the name of the docset feed. A documentation feed provides 2.1433 -# an umbrella under which multiple documentation sets from a single provider 2.1434 -# (such as a company or product suite) can be grouped. 2.1435 -# The default value is: Doxygen generated docs. 2.1436 -# This tag requires that the tag GENERATE_DOCSET is set to YES. 2.1437 - 2.1438 -DOCSET_FEEDNAME = "Doxygen generated docs" 2.1439 - 2.1440 -# This tag determines the URL of the docset feed. A documentation feed provides 2.1441 -# an umbrella under which multiple documentation sets from a single provider 2.1442 -# (such as a company or product suite) can be grouped. 2.1443 -# This tag requires that the tag GENERATE_DOCSET is set to YES. 2.1444 - 2.1445 -DOCSET_FEEDURL = 2.1446 - 2.1447 -# This tag specifies a string that should uniquely identify the documentation 2.1448 -# set bundle. This should be a reverse domain-name style string, e.g. 2.1449 -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 2.1450 -# The default value is: org.doxygen.Project. 2.1451 -# This tag requires that the tag GENERATE_DOCSET is set to YES. 2.1452 - 2.1453 -DOCSET_BUNDLE_ID = org.doxygen.Project 2.1454 - 2.1455 -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 2.1456 -# the documentation publisher. This should be a reverse domain-name style 2.1457 -# string, e.g. com.mycompany.MyDocSet.documentation. 2.1458 -# The default value is: org.doxygen.Publisher. 2.1459 -# This tag requires that the tag GENERATE_DOCSET is set to YES. 2.1460 - 2.1461 -DOCSET_PUBLISHER_ID = org.doxygen.Publisher 2.1462 - 2.1463 -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 2.1464 -# The default value is: Publisher. 2.1465 -# This tag requires that the tag GENERATE_DOCSET is set to YES. 2.1466 - 2.1467 -DOCSET_PUBLISHER_NAME = Publisher 2.1468 - 2.1469 -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 2.1470 -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 2.1471 -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 2.1472 -# on Windows. In the beginning of 2021 Microsoft took the original page, with 2.1473 -# a.o. the download links, offline the HTML help workshop was already many years 2.1474 -# in maintenance mode). You can download the HTML help workshop from the web 2.1475 -# archives at Installation executable (see: 2.1476 -# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo 2.1477 -# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). 2.1478 -# 2.1479 -# The HTML Help Workshop contains a compiler that can convert all HTML output 2.1480 -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 2.1481 -# files are now used as the Windows 98 help format, and will replace the old 2.1482 -# Windows help format (.hlp) on all Windows platforms in the future. Compressed 2.1483 -# HTML files also contain an index, a table of contents, and you can search for 2.1484 -# words in the documentation. The HTML workshop also contains a viewer for 2.1485 -# compressed HTML files. 2.1486 -# The default value is: NO. 2.1487 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1488 - 2.1489 -GENERATE_HTMLHELP = NO 2.1490 - 2.1491 -# The CHM_FILE tag can be used to specify the file name of the resulting .chm 2.1492 -# file. You can add a path in front of the file if the result should not be 2.1493 -# written to the html output directory. 2.1494 -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 2.1495 - 2.1496 -CHM_FILE = 2.1497 - 2.1498 -# The HHC_LOCATION tag can be used to specify the location (absolute path 2.1499 -# including file name) of the HTML help compiler (hhc.exe). If non-empty, 2.1500 -# doxygen will try to run the HTML help compiler on the generated index.hhp. 2.1501 -# The file has to be specified with full path. 2.1502 -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 2.1503 - 2.1504 -HHC_LOCATION = 2.1505 - 2.1506 -# The GENERATE_CHI flag controls if a separate .chi index file is generated 2.1507 -# (YES) or that it should be included in the main .chm file (NO). 2.1508 -# The default value is: NO. 2.1509 -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 2.1510 - 2.1511 -GENERATE_CHI = NO 2.1512 - 2.1513 -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 2.1514 -# and project file content. 2.1515 -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 2.1516 - 2.1517 -CHM_INDEX_ENCODING = 2.1518 - 2.1519 -# The BINARY_TOC flag controls whether a binary table of contents is generated 2.1520 -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 2.1521 -# enables the Previous and Next buttons. 2.1522 -# The default value is: NO. 2.1523 -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 2.1524 - 2.1525 -BINARY_TOC = NO 2.1526 - 2.1527 -# The TOC_EXPAND flag can be set to YES to add extra items for group members to 2.1528 -# the table of contents of the HTML help documentation and to the tree view. 2.1529 -# The default value is: NO. 2.1530 -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 2.1531 - 2.1532 -TOC_EXPAND = NO 2.1533 - 2.1534 -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 2.1535 -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 2.1536 -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 2.1537 -# (.qch) of the generated HTML documentation. 2.1538 -# The default value is: NO. 2.1539 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1540 - 2.1541 -GENERATE_QHP = NO 2.1542 - 2.1543 -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 2.1544 -# the file name of the resulting .qch file. The path specified is relative to 2.1545 -# the HTML output folder. 2.1546 -# This tag requires that the tag GENERATE_QHP is set to YES. 2.1547 - 2.1548 -QCH_FILE = 2.1549 - 2.1550 -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 2.1551 -# Project output. For more information please see Qt Help Project / Namespace 2.1552 -# (see: 2.1553 -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 2.1554 -# The default value is: org.doxygen.Project. 2.1555 -# This tag requires that the tag GENERATE_QHP is set to YES. 2.1556 - 2.1557 -QHP_NAMESPACE = org.doxygen.Project 2.1558 - 2.1559 -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 2.1560 -# Help Project output. For more information please see Qt Help Project / Virtual 2.1561 -# Folders (see: 2.1562 -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 2.1563 -# The default value is: doc. 2.1564 -# This tag requires that the tag GENERATE_QHP is set to YES. 2.1565 - 2.1566 -QHP_VIRTUAL_FOLDER = doc 2.1567 - 2.1568 -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 2.1569 -# filter to add. For more information please see Qt Help Project / Custom 2.1570 -# Filters (see: 2.1571 -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 2.1572 -# This tag requires that the tag GENERATE_QHP is set to YES. 2.1573 - 2.1574 -QHP_CUST_FILTER_NAME = 2.1575 - 2.1576 -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 2.1577 -# custom filter to add. For more information please see Qt Help Project / Custom 2.1578 -# Filters (see: 2.1579 -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 2.1580 -# This tag requires that the tag GENERATE_QHP is set to YES. 2.1581 - 2.1582 -QHP_CUST_FILTER_ATTRS = 2.1583 - 2.1584 -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 2.1585 -# project's filter section matches. Qt Help Project / Filter Attributes (see: 2.1586 -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 2.1587 -# This tag requires that the tag GENERATE_QHP is set to YES. 2.1588 - 2.1589 -QHP_SECT_FILTER_ATTRS = 2.1590 - 2.1591 -# The QHG_LOCATION tag can be used to specify the location (absolute path 2.1592 -# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 2.1593 -# run qhelpgenerator on the generated .qhp file. 2.1594 -# This tag requires that the tag GENERATE_QHP is set to YES. 2.1595 - 2.1596 -QHG_LOCATION = 2.1597 - 2.1598 -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 2.1599 -# generated, together with the HTML files, they form an Eclipse help plugin. To 2.1600 -# install this plugin and make it available under the help contents menu in 2.1601 -# Eclipse, the contents of the directory containing the HTML and XML files needs 2.1602 -# to be copied into the plugins directory of eclipse. The name of the directory 2.1603 -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 2.1604 -# After copying Eclipse needs to be restarted before the help appears. 2.1605 -# The default value is: NO. 2.1606 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1607 - 2.1608 -GENERATE_ECLIPSEHELP = NO 2.1609 - 2.1610 -# A unique identifier for the Eclipse help plugin. When installing the plugin 2.1611 -# the directory name containing the HTML and XML files should also have this 2.1612 -# name. Each documentation set should have its own identifier. 2.1613 -# The default value is: org.doxygen.Project. 2.1614 -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 2.1615 - 2.1616 -ECLIPSE_DOC_ID = org.doxygen.Project 2.1617 - 2.1618 -# If you want full control over the layout of the generated HTML pages it might 2.1619 -# be necessary to disable the index and replace it with your own. The 2.1620 -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 2.1621 -# of each HTML page. A value of NO enables the index and the value YES disables 2.1622 -# it. Since the tabs in the index contain the same information as the navigation 2.1623 -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 2.1624 -# The default value is: NO. 2.1625 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1626 - 2.1627 -DISABLE_INDEX = NO 2.1628 - 2.1629 -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 2.1630 -# structure should be generated to display hierarchical information. If the tag 2.1631 -# value is set to YES, a side panel will be generated containing a tree-like 2.1632 -# index structure (just like the one that is generated for HTML Help). For this 2.1633 -# to work a browser that supports JavaScript, DHTML, CSS and frames is required 2.1634 -# (i.e. any modern browser). Windows users are probably better off using the 2.1635 -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 2.1636 -# further fine tune the look of the index (see "Fine-tuning the output"). As an 2.1637 -# example, the default style sheet generated by doxygen has an example that 2.1638 -# shows how to put an image at the root of the tree instead of the PROJECT_NAME. 2.1639 -# Since the tree basically has the same information as the tab index, you could 2.1640 -# consider setting DISABLE_INDEX to YES when enabling this option. 2.1641 -# The default value is: NO. 2.1642 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1643 - 2.1644 -GENERATE_TREEVIEW = NO 2.1645 - 2.1646 -# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the 2.1647 -# FULL_SIDEBAR option determines if the side bar is limited to only the treeview 2.1648 -# area (value NO) or if it should extend to the full height of the window (value 2.1649 -# YES). Setting this to YES gives a layout similar to 2.1650 -# https://docs.readthedocs.io with more room for contents, but less room for the 2.1651 -# project logo, title, and description. If either GENERATE_TREEVIEW or 2.1652 -# DISABLE_INDEX is set to NO, this option has no effect. 2.1653 -# The default value is: NO. 2.1654 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1655 - 2.1656 -FULL_SIDEBAR = NO 2.1657 - 2.1658 -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 2.1659 -# doxygen will group on one line in the generated HTML documentation. 2.1660 -# 2.1661 -# Note that a value of 0 will completely suppress the enum values from appearing 2.1662 -# in the overview section. 2.1663 -# Minimum value: 0, maximum value: 20, default value: 4. 2.1664 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1665 - 2.1666 -ENUM_VALUES_PER_LINE = 4 2.1667 - 2.1668 -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 2.1669 -# to set the initial width (in pixels) of the frame in which the tree is shown. 2.1670 -# Minimum value: 0, maximum value: 1500, default value: 250. 2.1671 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1672 - 2.1673 -TREEVIEW_WIDTH = 250 2.1674 - 2.1675 -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 2.1676 -# external symbols imported via tag files in a separate window. 2.1677 -# The default value is: NO. 2.1678 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1679 - 2.1680 -EXT_LINKS_IN_WINDOW = NO 2.1681 - 2.1682 -# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email 2.1683 -# addresses. 2.1684 -# The default value is: YES. 2.1685 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1686 - 2.1687 -OBFUSCATE_EMAILS = YES 2.1688 - 2.1689 -# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 2.1690 -# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 2.1691 -# https://inkscape.org) to generate formulas as SVG images instead of PNGs for 2.1692 -# the HTML output. These images will generally look nicer at scaled resolutions. 2.1693 -# Possible values are: png (the default) and svg (looks nicer but requires the 2.1694 -# pdf2svg or inkscape tool). 2.1695 -# The default value is: png. 2.1696 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1697 - 2.1698 -HTML_FORMULA_FORMAT = png 2.1699 - 2.1700 -# Use this tag to change the font size of LaTeX formulas included as images in 2.1701 -# the HTML documentation. When you change the font size after a successful 2.1702 -# doxygen run you need to manually remove any form_*.png images from the HTML 2.1703 -# output directory to force them to be regenerated. 2.1704 -# Minimum value: 8, maximum value: 50, default value: 10. 2.1705 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1706 - 2.1707 -FORMULA_FONTSIZE = 10 2.1708 - 2.1709 -# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 2.1710 -# to create new LaTeX commands to be used in formulas as building blocks. See 2.1711 -# the section "Including formulas" for details. 2.1712 - 2.1713 -FORMULA_MACROFILE = 2.1714 - 2.1715 -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 2.1716 -# https://www.mathjax.org) which uses client side JavaScript for the rendering 2.1717 -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 2.1718 -# installed or if you want to formulas look prettier in the HTML output. When 2.1719 -# enabled you may also need to install MathJax separately and configure the path 2.1720 -# to it using the MATHJAX_RELPATH option. 2.1721 -# The default value is: NO. 2.1722 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1723 - 2.1724 -USE_MATHJAX = NO 2.1725 - 2.1726 -# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. 2.1727 -# Note that the different versions of MathJax have different requirements with 2.1728 -# regards to the different settings, so it is possible that also other MathJax 2.1729 -# settings have to be changed when switching between the different MathJax 2.1730 -# versions. 2.1731 -# Possible values are: MathJax_2 and MathJax_3. 2.1732 -# The default value is: MathJax_2. 2.1733 -# This tag requires that the tag USE_MATHJAX is set to YES. 2.1734 - 2.1735 -MATHJAX_VERSION = MathJax_2 2.1736 - 2.1737 -# When MathJax is enabled you can set the default output format to be used for 2.1738 -# the MathJax output. For more details about the output format see MathJax 2.1739 -# version 2 (see: 2.1740 -# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 2.1741 -# (see: 2.1742 -# http://docs.mathjax.org/en/latest/web/components/output.html). 2.1743 -# Possible values are: HTML-CSS (which is slower, but has the best 2.1744 -# compatibility. This is the name for Mathjax version 2, for MathJax version 3 2.1745 -# this will be translated into chtml), NativeMML (i.e. MathML. Only supported 2.1746 -# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This 2.1747 -# is the name for Mathjax version 3, for MathJax version 2 this will be 2.1748 -# translated into HTML-CSS) and SVG. 2.1749 -# The default value is: HTML-CSS. 2.1750 -# This tag requires that the tag USE_MATHJAX is set to YES. 2.1751 - 2.1752 -MATHJAX_FORMAT = HTML-CSS 2.1753 - 2.1754 -# When MathJax is enabled you need to specify the location relative to the HTML 2.1755 -# output directory using the MATHJAX_RELPATH option. The destination directory 2.1756 -# should contain the MathJax.js script. For instance, if the mathjax directory 2.1757 -# is located at the same level as the HTML output directory, then 2.1758 -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 2.1759 -# Content Delivery Network so you can quickly see the result without installing 2.1760 -# MathJax. However, it is strongly recommended to install a local copy of 2.1761 -# MathJax from https://www.mathjax.org before deployment. The default value is: 2.1762 -# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 2.1763 -# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 2.1764 -# This tag requires that the tag USE_MATHJAX is set to YES. 2.1765 - 2.1766 -MATHJAX_RELPATH = http://www.mathjax.org/mathjax 2.1767 - 2.1768 -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 2.1769 -# extension names that should be enabled during MathJax rendering. For example 2.1770 -# for MathJax version 2 (see 2.1771 -# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): 2.1772 -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 2.1773 -# For example for MathJax version 3 (see 2.1774 -# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): 2.1775 -# MATHJAX_EXTENSIONS = ams 2.1776 -# This tag requires that the tag USE_MATHJAX is set to YES. 2.1777 - 2.1778 -MATHJAX_EXTENSIONS = 2.1779 - 2.1780 -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 2.1781 -# of code that will be used on startup of the MathJax code. See the MathJax site 2.1782 -# (see: 2.1783 -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 2.1784 -# example see the documentation. 2.1785 -# This tag requires that the tag USE_MATHJAX is set to YES. 2.1786 - 2.1787 -MATHJAX_CODEFILE = 2.1788 - 2.1789 -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 2.1790 -# the HTML output. The underlying search engine uses javascript and DHTML and 2.1791 -# should work on any modern browser. Note that when using HTML help 2.1792 -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 2.1793 -# there is already a search function so this one should typically be disabled. 2.1794 -# For large projects the javascript based search engine can be slow, then 2.1795 -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 2.1796 -# search using the keyboard; to jump to the search box use <access key> + S 2.1797 -# (what the <access key> is depends on the OS and browser, but it is typically 2.1798 -# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 2.1799 -# key> to jump into the search results window, the results can be navigated 2.1800 -# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 2.1801 -# the search. The filter options can be selected when the cursor is inside the 2.1802 -# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 2.1803 -# to select a filter and <Enter> or <escape> to activate or cancel the filter 2.1804 -# option. 2.1805 -# The default value is: YES. 2.1806 -# This tag requires that the tag GENERATE_HTML is set to YES. 2.1807 - 2.1808 -SEARCHENGINE = YES 2.1809 - 2.1810 -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 2.1811 -# implemented using a web server instead of a web client using JavaScript. There 2.1812 -# are two flavors of web server based searching depending on the EXTERNAL_SEARCH 2.1813 -# setting. When disabled, doxygen will generate a PHP script for searching and 2.1814 -# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 2.1815 -# and searching needs to be provided by external tools. See the section 2.1816 -# "External Indexing and Searching" for details. 2.1817 -# The default value is: NO. 2.1818 -# This tag requires that the tag SEARCHENGINE is set to YES. 2.1819 - 2.1820 -SERVER_BASED_SEARCH = NO 2.1821 - 2.1822 -# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 2.1823 -# script for searching. Instead the search results are written to an XML file 2.1824 -# which needs to be processed by an external indexer. Doxygen will invoke an 2.1825 -# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 2.1826 -# search results. 2.1827 -# 2.1828 -# Doxygen ships with an example indexer (doxyindexer) and search engine 2.1829 -# (doxysearch.cgi) which are based on the open source search engine library 2.1830 -# Xapian (see: 2.1831 -# https://xapian.org/). 2.1832 -# 2.1833 -# See the section "External Indexing and Searching" for details. 2.1834 -# The default value is: NO. 2.1835 -# This tag requires that the tag SEARCHENGINE is set to YES. 2.1836 - 2.1837 -EXTERNAL_SEARCH = NO 2.1838 - 2.1839 -# The SEARCHENGINE_URL should point to a search engine hosted by a web server 2.1840 -# which will return the search results when EXTERNAL_SEARCH is enabled. 2.1841 -# 2.1842 -# Doxygen ships with an example indexer (doxyindexer) and search engine 2.1843 -# (doxysearch.cgi) which are based on the open source search engine library 2.1844 -# Xapian (see: 2.1845 -# https://xapian.org/). See the section "External Indexing and Searching" for 2.1846 -# details. 2.1847 -# This tag requires that the tag SEARCHENGINE is set to YES. 2.1848 - 2.1849 -SEARCHENGINE_URL = 2.1850 - 2.1851 -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 2.1852 -# search data is written to a file for indexing by an external tool. With the 2.1853 -# SEARCHDATA_FILE tag the name of this file can be specified. 2.1854 -# The default file is: searchdata.xml. 2.1855 -# This tag requires that the tag SEARCHENGINE is set to YES. 2.1856 - 2.1857 -SEARCHDATA_FILE = searchdata.xml 2.1858 - 2.1859 -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 2.1860 -# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 2.1861 -# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 2.1862 -# projects and redirect the results back to the right project. 2.1863 -# This tag requires that the tag SEARCHENGINE is set to YES. 2.1864 - 2.1865 -EXTERNAL_SEARCH_ID = 2.1866 - 2.1867 -# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 2.1868 -# projects other than the one defined by this configuration file, but that are 2.1869 -# all added to the same external search index. Each project needs to have a 2.1870 -# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 2.1871 -# to a relative location where the documentation can be found. The format is: 2.1872 -# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 2.1873 -# This tag requires that the tag SEARCHENGINE is set to YES. 2.1874 - 2.1875 -EXTRA_SEARCH_MAPPINGS = 2.1876 - 2.1877 -#--------------------------------------------------------------------------- 2.1878 -# Configuration options related to the LaTeX output 2.1879 -#--------------------------------------------------------------------------- 2.1880 - 2.1881 -# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 2.1882 -# The default value is: YES. 2.1883 - 2.1884 -GENERATE_LATEX = NO 2.1885 - 2.1886 -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 2.1887 -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2.1888 -# it. 2.1889 -# The default directory is: latex. 2.1890 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.1891 - 2.1892 -LATEX_OUTPUT = latex 2.1893 - 2.1894 -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 2.1895 -# invoked. 2.1896 -# 2.1897 -# Note that when not enabling USE_PDFLATEX the default is latex when enabling 2.1898 -# USE_PDFLATEX the default is pdflatex and when in the later case latex is 2.1899 -# chosen this is overwritten by pdflatex. For specific output languages the 2.1900 -# default can have been set differently, this depends on the implementation of 2.1901 -# the output language. 2.1902 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.1903 - 2.1904 -LATEX_CMD_NAME = latex 2.1905 - 2.1906 -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 2.1907 -# index for LaTeX. 2.1908 -# Note: This tag is used in the Makefile / make.bat. 2.1909 -# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file 2.1910 -# (.tex). 2.1911 -# The default file is: makeindex. 2.1912 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.1913 - 2.1914 -MAKEINDEX_CMD_NAME = makeindex 2.1915 - 2.1916 -# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to 2.1917 -# generate index for LaTeX. In case there is no backslash (\) as first character 2.1918 -# it will be automatically added in the LaTeX code. 2.1919 -# Note: This tag is used in the generated output file (.tex). 2.1920 -# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. 2.1921 -# The default value is: makeindex. 2.1922 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.1923 - 2.1924 -LATEX_MAKEINDEX_CMD = makeindex 2.1925 - 2.1926 -# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 2.1927 -# documents. This may be useful for small projects and may help to save some 2.1928 -# trees in general. 2.1929 -# The default value is: NO. 2.1930 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.1931 - 2.1932 -COMPACT_LATEX = NO 2.1933 - 2.1934 -# The PAPER_TYPE tag can be used to set the paper type that is used by the 2.1935 -# printer. 2.1936 -# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 2.1937 -# 14 inches) and executive (7.25 x 10.5 inches). 2.1938 -# The default value is: a4. 2.1939 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.1940 - 2.1941 -PAPER_TYPE = a4 2.1942 - 2.1943 -# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 2.1944 -# that should be included in the LaTeX output. The package can be specified just 2.1945 -# by its name or with the correct syntax as to be used with the LaTeX 2.1946 -# \usepackage command. To get the times font for instance you can specify : 2.1947 -# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} 2.1948 -# To use the option intlimits with the amsmath package you can specify: 2.1949 -# EXTRA_PACKAGES=[intlimits]{amsmath} 2.1950 -# If left blank no extra packages will be included. 2.1951 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.1952 - 2.1953 -EXTRA_PACKAGES = 2.1954 - 2.1955 -# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for 2.1956 -# the generated LaTeX document. The header should contain everything until the 2.1957 -# first chapter. If it is left blank doxygen will generate a standard header. It 2.1958 -# is highly recommended to start with a default header using 2.1959 -# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty 2.1960 -# and then modify the file new_header.tex. See also section "Doxygen usage" for 2.1961 -# information on how to generate the default header that doxygen normally uses. 2.1962 -# 2.1963 -# Note: Only use a user-defined header if you know what you are doing! 2.1964 -# Note: The header is subject to change so you typically have to regenerate the 2.1965 -# default header when upgrading to a newer version of doxygen. The following 2.1966 -# commands have a special meaning inside the header (and footer): For a 2.1967 -# description of the possible markers and block names see the documentation. 2.1968 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.1969 - 2.1970 -LATEX_HEADER = 2.1971 - 2.1972 -# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for 2.1973 -# the generated LaTeX document. The footer should contain everything after the 2.1974 -# last chapter. If it is left blank doxygen will generate a standard footer. See 2.1975 -# LATEX_HEADER for more information on how to generate a default footer and what 2.1976 -# special commands can be used inside the footer. See also section "Doxygen 2.1977 -# usage" for information on how to generate the default footer that doxygen 2.1978 -# normally uses. Note: Only use a user-defined footer if you know what you are 2.1979 -# doing! 2.1980 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.1981 - 2.1982 -LATEX_FOOTER = 2.1983 - 2.1984 -# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 2.1985 -# LaTeX style sheets that are included after the standard style sheets created 2.1986 -# by doxygen. Using this option one can overrule certain style aspects. Doxygen 2.1987 -# will copy the style sheet files to the output directory. 2.1988 -# Note: The order of the extra style sheet files is of importance (e.g. the last 2.1989 -# style sheet in the list overrules the setting of the previous ones in the 2.1990 -# list). 2.1991 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.1992 - 2.1993 -LATEX_EXTRA_STYLESHEET = 2.1994 - 2.1995 -# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 2.1996 -# other source files which should be copied to the LATEX_OUTPUT output 2.1997 -# directory. Note that the files will be copied as-is; there are no commands or 2.1998 -# markers available. 2.1999 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.2000 - 2.2001 -LATEX_EXTRA_FILES = 2.2002 - 2.2003 -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 2.2004 -# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 2.2005 -# contain links (just like the HTML output) instead of page references. This 2.2006 -# makes the output suitable for online browsing using a PDF viewer. 2.2007 -# The default value is: YES. 2.2008 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.2009 - 2.2010 -PDF_HYPERLINKS = YES 2.2011 - 2.2012 -# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as 2.2013 -# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX 2.2014 -# files. Set this option to YES, to get a higher quality PDF documentation. 2.2015 -# 2.2016 -# See also section LATEX_CMD_NAME for selecting the engine. 2.2017 -# The default value is: YES. 2.2018 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.2019 - 2.2020 -USE_PDFLATEX = YES 2.2021 - 2.2022 -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 2.2023 -# command to the generated LaTeX files. This will instruct LaTeX to keep running 2.2024 -# if errors occur, instead of asking the user for help. 2.2025 -# The default value is: NO. 2.2026 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.2027 - 2.2028 -LATEX_BATCHMODE = NO 2.2029 - 2.2030 -# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 2.2031 -# index chapters (such as File Index, Compound Index, etc.) in the output. 2.2032 -# The default value is: NO. 2.2033 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.2034 - 2.2035 -LATEX_HIDE_INDICES = NO 2.2036 - 2.2037 -# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 2.2038 -# bibliography, e.g. plainnat, or ieeetr. See 2.2039 -# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. 2.2040 -# The default value is: plain. 2.2041 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.2042 - 2.2043 -LATEX_BIB_STYLE = plain 2.2044 - 2.2045 -# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated 2.2046 -# page will contain the date and time when the page was generated. Setting this 2.2047 -# to NO can help when comparing the output of multiple runs. 2.2048 -# The default value is: NO. 2.2049 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.2050 - 2.2051 -LATEX_TIMESTAMP = NO 2.2052 - 2.2053 -# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) 2.2054 -# path from which the emoji images will be read. If a relative path is entered, 2.2055 -# it will be relative to the LATEX_OUTPUT directory. If left blank the 2.2056 -# LATEX_OUTPUT directory will be used. 2.2057 -# This tag requires that the tag GENERATE_LATEX is set to YES. 2.2058 - 2.2059 -LATEX_EMOJI_DIRECTORY = 2.2060 - 2.2061 -#--------------------------------------------------------------------------- 2.2062 -# Configuration options related to the RTF output 2.2063 -#--------------------------------------------------------------------------- 2.2064 - 2.2065 -# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 2.2066 -# RTF output is optimized for Word 97 and may not look too pretty with other RTF 2.2067 -# readers/editors. 2.2068 -# The default value is: NO. 2.2069 - 2.2070 -GENERATE_RTF = NO 2.2071 - 2.2072 -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 2.2073 -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2.2074 -# it. 2.2075 -# The default directory is: rtf. 2.2076 -# This tag requires that the tag GENERATE_RTF is set to YES. 2.2077 - 2.2078 -RTF_OUTPUT = rtf 2.2079 - 2.2080 -# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 2.2081 -# documents. This may be useful for small projects and may help to save some 2.2082 -# trees in general. 2.2083 -# The default value is: NO. 2.2084 -# This tag requires that the tag GENERATE_RTF is set to YES. 2.2085 - 2.2086 -COMPACT_RTF = NO 2.2087 - 2.2088 -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 2.2089 -# contain hyperlink fields. The RTF file will contain links (just like the HTML 2.2090 -# output) instead of page references. This makes the output suitable for online 2.2091 -# browsing using Word or some other Word compatible readers that support those 2.2092 -# fields. 2.2093 -# 2.2094 -# Note: WordPad (write) and others do not support links. 2.2095 -# The default value is: NO. 2.2096 -# This tag requires that the tag GENERATE_RTF is set to YES. 2.2097 - 2.2098 -RTF_HYPERLINKS = NO 2.2099 - 2.2100 -# Load stylesheet definitions from file. Syntax is similar to doxygen's 2.2101 -# configuration file, i.e. a series of assignments. You only have to provide 2.2102 -# replacements, missing definitions are set to their default value. 2.2103 -# 2.2104 -# See also section "Doxygen usage" for information on how to generate the 2.2105 -# default style sheet that doxygen normally uses. 2.2106 -# This tag requires that the tag GENERATE_RTF is set to YES. 2.2107 - 2.2108 -RTF_STYLESHEET_FILE = 2.2109 - 2.2110 -# Set optional variables used in the generation of an RTF document. Syntax is 2.2111 -# similar to doxygen's configuration file. A template extensions file can be 2.2112 -# generated using doxygen -e rtf extensionFile. 2.2113 -# This tag requires that the tag GENERATE_RTF is set to YES. 2.2114 - 2.2115 -RTF_EXTENSIONS_FILE = 2.2116 - 2.2117 -#--------------------------------------------------------------------------- 2.2118 -# Configuration options related to the man page output 2.2119 -#--------------------------------------------------------------------------- 2.2120 - 2.2121 -# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 2.2122 -# classes and files. 2.2123 -# The default value is: NO. 2.2124 - 2.2125 -GENERATE_MAN = NO 2.2126 - 2.2127 -# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 2.2128 -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2.2129 -# it. A directory man3 will be created inside the directory specified by 2.2130 -# MAN_OUTPUT. 2.2131 -# The default directory is: man. 2.2132 -# This tag requires that the tag GENERATE_MAN is set to YES. 2.2133 - 2.2134 -MAN_OUTPUT = man 2.2135 - 2.2136 -# The MAN_EXTENSION tag determines the extension that is added to the generated 2.2137 -# man pages. In case the manual section does not start with a number, the number 2.2138 -# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 2.2139 -# optional. 2.2140 -# The default value is: .3. 2.2141 -# This tag requires that the tag GENERATE_MAN is set to YES. 2.2142 - 2.2143 -MAN_EXTENSION = .3 2.2144 - 2.2145 -# The MAN_SUBDIR tag determines the name of the directory created within 2.2146 -# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 2.2147 -# MAN_EXTENSION with the initial . removed. 2.2148 -# This tag requires that the tag GENERATE_MAN is set to YES. 2.2149 - 2.2150 -MAN_SUBDIR = 2.2151 - 2.2152 -# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 2.2153 -# will generate one additional man file for each entity documented in the real 2.2154 -# man page(s). These additional files only source the real man page, but without 2.2155 -# them the man command would be unable to find the correct page. 2.2156 -# The default value is: NO. 2.2157 -# This tag requires that the tag GENERATE_MAN is set to YES. 2.2158 - 2.2159 -MAN_LINKS = NO 2.2160 - 2.2161 -#--------------------------------------------------------------------------- 2.2162 -# Configuration options related to the XML output 2.2163 -#--------------------------------------------------------------------------- 2.2164 - 2.2165 -# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 2.2166 -# captures the structure of the code including all documentation. 2.2167 -# The default value is: NO. 2.2168 - 2.2169 -GENERATE_XML = NO 2.2170 - 2.2171 -# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 2.2172 -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2.2173 -# it. 2.2174 -# The default directory is: xml. 2.2175 -# This tag requires that the tag GENERATE_XML is set to YES. 2.2176 - 2.2177 -XML_OUTPUT = xml 2.2178 - 2.2179 -# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 2.2180 -# listings (including syntax highlighting and cross-referencing information) to 2.2181 -# the XML output. Note that enabling this will significantly increase the size 2.2182 -# of the XML output. 2.2183 -# The default value is: YES. 2.2184 -# This tag requires that the tag GENERATE_XML is set to YES. 2.2185 - 2.2186 -XML_PROGRAMLISTING = YES 2.2187 - 2.2188 -# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include 2.2189 -# namespace members in file scope as well, matching the HTML output. 2.2190 -# The default value is: NO. 2.2191 -# This tag requires that the tag GENERATE_XML is set to YES. 2.2192 - 2.2193 -XML_NS_MEMB_FILE_SCOPE = NO 2.2194 - 2.2195 -#--------------------------------------------------------------------------- 2.2196 -# Configuration options related to the DOCBOOK output 2.2197 -#--------------------------------------------------------------------------- 2.2198 - 2.2199 -# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 2.2200 -# that can be used to generate PDF. 2.2201 -# The default value is: NO. 2.2202 - 2.2203 -GENERATE_DOCBOOK = NO 2.2204 - 2.2205 -# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 2.2206 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 2.2207 -# front of it. 2.2208 -# The default directory is: docbook. 2.2209 -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 2.2210 - 2.2211 -DOCBOOK_OUTPUT = docbook 2.2212 - 2.2213 -#--------------------------------------------------------------------------- 2.2214 -# Configuration options for the AutoGen Definitions output 2.2215 -#--------------------------------------------------------------------------- 2.2216 - 2.2217 -# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 2.2218 -# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures 2.2219 -# the structure of the code including all documentation. Note that this feature 2.2220 -# is still experimental and incomplete at the moment. 2.2221 -# The default value is: NO. 2.2222 - 2.2223 -GENERATE_AUTOGEN_DEF = NO 2.2224 - 2.2225 -#--------------------------------------------------------------------------- 2.2226 -# Configuration options related to the Perl module output 2.2227 -#--------------------------------------------------------------------------- 2.2228 - 2.2229 -# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 2.2230 -# file that captures the structure of the code including all documentation. 2.2231 -# 2.2232 -# Note that this feature is still experimental and incomplete at the moment. 2.2233 -# The default value is: NO. 2.2234 - 2.2235 -GENERATE_PERLMOD = NO 2.2236 - 2.2237 -# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 2.2238 -# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 2.2239 -# output from the Perl module output. 2.2240 -# The default value is: NO. 2.2241 -# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2.2242 - 2.2243 -PERLMOD_LATEX = NO 2.2244 - 2.2245 -# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 2.2246 -# formatted so it can be parsed by a human reader. This is useful if you want to 2.2247 -# understand what is going on. On the other hand, if this tag is set to NO, the 2.2248 -# size of the Perl module output will be much smaller and Perl will parse it 2.2249 -# just the same. 2.2250 -# The default value is: YES. 2.2251 -# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2.2252 - 2.2253 -PERLMOD_PRETTY = YES 2.2254 - 2.2255 -# The names of the make variables in the generated doxyrules.make file are 2.2256 -# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 2.2257 -# so different doxyrules.make files included by the same Makefile don't 2.2258 -# overwrite each other's variables. 2.2259 -# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2.2260 - 2.2261 -PERLMOD_MAKEVAR_PREFIX = 2.2262 - 2.2263 -#--------------------------------------------------------------------------- 2.2264 -# Configuration options related to the preprocessor 2.2265 -#--------------------------------------------------------------------------- 2.2266 - 2.2267 -# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 2.2268 -# C-preprocessor directives found in the sources and include files. 2.2269 -# The default value is: YES. 2.2270 - 2.2271 -ENABLE_PREPROCESSING = YES 2.2272 - 2.2273 -# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 2.2274 -# in the source code. If set to NO, only conditional compilation will be 2.2275 -# performed. Macro expansion can be done in a controlled way by setting 2.2276 -# EXPAND_ONLY_PREDEF to YES. 2.2277 -# The default value is: NO. 2.2278 -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2.2279 - 2.2280 -MACRO_EXPANSION = YES 2.2281 - 2.2282 -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 2.2283 -# the macro expansion is limited to the macros specified with the PREDEFINED and 2.2284 -# EXPAND_AS_DEFINED tags. 2.2285 -# The default value is: NO. 2.2286 -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2.2287 - 2.2288 -EXPAND_ONLY_PREDEF = YES 2.2289 - 2.2290 -# If the SEARCH_INCLUDES tag is set to YES, the include files in the 2.2291 -# INCLUDE_PATH will be searched if a #include is found. 2.2292 -# The default value is: YES. 2.2293 -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2.2294 - 2.2295 -SEARCH_INCLUDES = YES 2.2296 - 2.2297 -# The INCLUDE_PATH tag can be used to specify one or more directories that 2.2298 -# contain include files that are not input files but should be processed by the 2.2299 -# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of 2.2300 -# RECURSIVE has no effect here. 2.2301 -# This tag requires that the tag SEARCH_INCLUDES is set to YES. 2.2302 - 2.2303 -INCLUDE_PATH = 2.2304 - 2.2305 -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2.2306 -# patterns (like *.h and *.hpp) to filter out the header-files in the 2.2307 -# directories. If left blank, the patterns specified with FILE_PATTERNS will be 2.2308 -# used. 2.2309 -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2.2310 - 2.2311 -INCLUDE_FILE_PATTERNS = 2.2312 - 2.2313 -# The PREDEFINED tag can be used to specify one or more macro names that are 2.2314 -# defined before the preprocessor is started (similar to the -D option of e.g. 2.2315 -# gcc). The argument of the tag is a list of macros of the form: name or 2.2316 -# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 2.2317 -# is assumed. To prevent a macro definition from being undefined via #undef or 2.2318 -# recursively expanded use the := operator instead of the = operator. 2.2319 -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2.2320 - 2.2321 -PREDEFINED = __attribute__(x)= 2.2322 - 2.2323 -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2.2324 -# tag can be used to specify a list of macro names that should be expanded. The 2.2325 -# macro definition that is found in the sources will be used. Use the PREDEFINED 2.2326 -# tag if you want to use a different macro definition that overrules the 2.2327 -# definition found in the source code. 2.2328 -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2.2329 - 2.2330 -EXPAND_AS_DEFINED = 2.2331 - 2.2332 -# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2.2333 -# remove all references to function-like macros that are alone on a line, have 2.2334 -# an all uppercase name, and do not end with a semicolon. Such function macros 2.2335 -# are typically used for boiler-plate code, and will confuse the parser if not 2.2336 -# removed. 2.2337 -# The default value is: YES. 2.2338 -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2.2339 - 2.2340 -SKIP_FUNCTION_MACROS = YES 2.2341 - 2.2342 -#--------------------------------------------------------------------------- 2.2343 -# Configuration options related to external references 2.2344 -#--------------------------------------------------------------------------- 2.2345 - 2.2346 -# The TAGFILES tag can be used to specify one or more tag files. For each tag 2.2347 -# file the location of the external documentation should be added. The format of 2.2348 -# a tag file without this location is as follows: 2.2349 -# TAGFILES = file1 file2 ... 2.2350 -# Adding location for the tag files is done as follows: 2.2351 -# TAGFILES = file1=loc1 "file2 = loc2" ... 2.2352 -# where loc1 and loc2 can be relative or absolute paths or URLs. See the 2.2353 -# section "Linking to external documentation" for more information about the use 2.2354 -# of tag files. 2.2355 -# Note: Each tag file must have a unique name (where the name does NOT include 2.2356 -# the path). If a tag file is not located in the directory in which doxygen is 2.2357 -# run, you must also specify the path to the tagfile here. 2.2358 - 2.2359 -TAGFILES = 2.2360 - 2.2361 -# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2.2362 -# tag file that is based on the input files it reads. See section "Linking to 2.2363 -# external documentation" for more information about the usage of tag files. 2.2364 - 2.2365 -GENERATE_TAGFILE = 2.2366 - 2.2367 -# If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2.2368 -# the class index. If set to NO, only the inherited external classes will be 2.2369 -# listed. 2.2370 -# The default value is: NO. 2.2371 - 2.2372 -ALLEXTERNALS = NO 2.2373 - 2.2374 -# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2.2375 -# in the modules index. If set to NO, only the current project's groups will be 2.2376 -# listed. 2.2377 -# The default value is: YES. 2.2378 - 2.2379 -EXTERNAL_GROUPS = YES 2.2380 - 2.2381 -# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2.2382 -# the related pages index. If set to NO, only the current project's pages will 2.2383 -# be listed. 2.2384 -# The default value is: YES. 2.2385 - 2.2386 -EXTERNAL_PAGES = YES 2.2387 - 2.2388 -#--------------------------------------------------------------------------- 2.2389 -# Configuration options related to the dot tool 2.2390 -#--------------------------------------------------------------------------- 2.2391 - 2.2392 -# You can include diagrams made with dia in doxygen documentation. Doxygen will 2.2393 -# then run dia to produce the diagram and insert it in the documentation. The 2.2394 -# DIA_PATH tag allows you to specify the directory where the dia binary resides. 2.2395 -# If left empty dia is assumed to be found in the default search path. 2.2396 - 2.2397 -DIA_PATH = 2.2398 - 2.2399 -# If set to YES the inheritance and collaboration graphs will hide inheritance 2.2400 -# and usage relations if the target is undocumented or is not a class. 2.2401 -# The default value is: YES. 2.2402 - 2.2403 -HIDE_UNDOC_RELATIONS = YES 2.2404 - 2.2405 -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2.2406 -# available from the path. This tool is part of Graphviz (see: 2.2407 -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2.2408 -# Bell Labs. The other options in this section have no effect if this option is 2.2409 -# set to NO 2.2410 -# The default value is: NO. 2.2411 - 2.2412 -HAVE_DOT = NO 2.2413 - 2.2414 -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2.2415 -# to run in parallel. When set to 0 doxygen will base this on the number of 2.2416 -# processors available in the system. You can set it explicitly to a value 2.2417 -# larger than 0 to get control over the balance between CPU load and processing 2.2418 -# speed. 2.2419 -# Minimum value: 0, maximum value: 32, default value: 0. 2.2420 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2421 - 2.2422 -DOT_NUM_THREADS = 0 2.2423 - 2.2424 -# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of 2.2425 -# subgraphs. When you want a differently looking font in the dot files that 2.2426 -# doxygen generates you can specify fontname, fontcolor and fontsize attributes. 2.2427 -# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node, 2.2428 -# Edge and Graph Attributes specification</a> You need to make sure dot is able 2.2429 -# to find the font, which can be done by putting it in a standard location or by 2.2430 -# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 2.2431 -# directory containing the font. Default graphviz fontsize is 14. 2.2432 -# The default value is: fontname=Helvetica,fontsize=10. 2.2433 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2434 - 2.2435 -DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" 2.2436 - 2.2437 -# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can 2.2438 -# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a 2.2439 -# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about 2.2440 -# arrows shapes.</a> 2.2441 -# The default value is: labelfontname=Helvetica,labelfontsize=10. 2.2442 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2443 - 2.2444 -DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" 2.2445 - 2.2446 -# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes 2.2447 -# around nodes set 'shape=plain' or 'shape=plaintext' <a 2.2448 -# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a> 2.2449 -# The default value is: shape=box,height=0.2,width=0.4. 2.2450 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2451 - 2.2452 -DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" 2.2453 - 2.2454 -# You can set the path where dot can find font specified with fontname in 2.2455 -# DOT_COMMON_ATTR and others dot attributes. 2.2456 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2457 - 2.2458 -DOT_FONTPATH = 2.2459 - 2.2460 -# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a 2.2461 -# graph for each documented class showing the direct and indirect inheritance 2.2462 -# relations. In case HAVE_DOT is set as well dot will be used to draw the graph, 2.2463 -# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set 2.2464 -# to TEXT the direct and indirect inheritance relations will be shown as texts / 2.2465 -# links. 2.2466 -# Possible values are: NO, YES, TEXT and GRAPH. 2.2467 -# The default value is: YES. 2.2468 - 2.2469 -CLASS_GRAPH = YES 2.2470 - 2.2471 -# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2.2472 -# graph for each documented class showing the direct and indirect implementation 2.2473 -# dependencies (inheritance, containment, and class references variables) of the 2.2474 -# class with other documented classes. 2.2475 -# The default value is: YES. 2.2476 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2477 - 2.2478 -COLLABORATION_GRAPH = YES 2.2479 - 2.2480 -# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2.2481 -# groups, showing the direct groups dependencies. See also the chapter Grouping 2.2482 -# in the manual. 2.2483 -# The default value is: YES. 2.2484 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2485 - 2.2486 -GROUP_GRAPHS = YES 2.2487 - 2.2488 -# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2.2489 -# collaboration diagrams in a style similar to the OMG's Unified Modeling 2.2490 -# Language. 2.2491 -# The default value is: NO. 2.2492 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2493 - 2.2494 -UML_LOOK = NO 2.2495 - 2.2496 -# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2.2497 -# class node. If there are many fields or methods and many nodes the graph may 2.2498 -# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2.2499 -# number of items for each type to make the size more manageable. Set this to 0 2.2500 -# for no limit. Note that the threshold may be exceeded by 50% before the limit 2.2501 -# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2.2502 -# but if the number exceeds 15, the total amount of fields shown is limited to 2.2503 -# 10. 2.2504 -# Minimum value: 0, maximum value: 100, default value: 10. 2.2505 -# This tag requires that the tag UML_LOOK is set to YES. 2.2506 - 2.2507 -UML_LIMIT_NUM_FIELDS = 10 2.2508 - 2.2509 -# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and 2.2510 -# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS 2.2511 -# tag is set to YES, doxygen will add type and arguments for attributes and 2.2512 -# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen 2.2513 -# will not generate fields with class member information in the UML graphs. The 2.2514 -# class diagrams will look similar to the default class diagrams but using UML 2.2515 -# notation for the relationships. 2.2516 -# Possible values are: NO, YES and NONE. 2.2517 -# The default value is: NO. 2.2518 -# This tag requires that the tag UML_LOOK is set to YES. 2.2519 - 2.2520 -DOT_UML_DETAILS = NO 2.2521 - 2.2522 -# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters 2.2523 -# to display on a single line. If the actual line length exceeds this threshold 2.2524 -# significantly it will wrapped across multiple lines. Some heuristics are apply 2.2525 -# to avoid ugly line breaks. 2.2526 -# Minimum value: 0, maximum value: 1000, default value: 17. 2.2527 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2528 - 2.2529 -DOT_WRAP_THRESHOLD = 17 2.2530 - 2.2531 -# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2.2532 -# collaboration graphs will show the relations between templates and their 2.2533 -# instances. 2.2534 -# The default value is: NO. 2.2535 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2536 - 2.2537 -TEMPLATE_RELATIONS = NO 2.2538 - 2.2539 -# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2.2540 -# YES then doxygen will generate a graph for each documented file showing the 2.2541 -# direct and indirect include dependencies of the file with other documented 2.2542 -# files. 2.2543 -# The default value is: YES. 2.2544 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2545 - 2.2546 -INCLUDE_GRAPH = YES 2.2547 - 2.2548 -# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2.2549 -# set to YES then doxygen will generate a graph for each documented file showing 2.2550 -# the direct and indirect include dependencies of the file with other documented 2.2551 -# files. 2.2552 -# The default value is: YES. 2.2553 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2554 - 2.2555 -INCLUDED_BY_GRAPH = YES 2.2556 - 2.2557 -# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2.2558 -# dependency graph for every global function or class method. 2.2559 -# 2.2560 -# Note that enabling this option will significantly increase the time of a run. 2.2561 -# So in most cases it will be better to enable call graphs for selected 2.2562 -# functions only using the \callgraph command. Disabling a call graph can be 2.2563 -# accomplished by means of the command \hidecallgraph. 2.2564 -# The default value is: NO. 2.2565 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2566 - 2.2567 -CALL_GRAPH = NO 2.2568 - 2.2569 -# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2.2570 -# dependency graph for every global function or class method. 2.2571 -# 2.2572 -# Note that enabling this option will significantly increase the time of a run. 2.2573 -# So in most cases it will be better to enable caller graphs for selected 2.2574 -# functions only using the \callergraph command. Disabling a caller graph can be 2.2575 -# accomplished by means of the command \hidecallergraph. 2.2576 -# The default value is: NO. 2.2577 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2578 - 2.2579 -CALLER_GRAPH = NO 2.2580 - 2.2581 -# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2.2582 -# hierarchy of all classes instead of a textual one. 2.2583 -# The default value is: YES. 2.2584 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2585 - 2.2586 -GRAPHICAL_HIERARCHY = YES 2.2587 - 2.2588 -# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2.2589 -# dependencies a directory has on other directories in a graphical way. The 2.2590 -# dependency relations are determined by the #include relations between the 2.2591 -# files in the directories. 2.2592 -# The default value is: YES. 2.2593 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2594 - 2.2595 -DIRECTORY_GRAPH = YES 2.2596 - 2.2597 -# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels 2.2598 -# of child directories generated in directory dependency graphs by dot. 2.2599 -# Minimum value: 1, maximum value: 25, default value: 1. 2.2600 -# This tag requires that the tag DIRECTORY_GRAPH is set to YES. 2.2601 - 2.2602 -DIR_GRAPH_MAX_DEPTH = 1 2.2603 - 2.2604 -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2.2605 -# generated by dot. For an explanation of the image formats see the section 2.2606 -# output formats in the documentation of the dot tool (Graphviz (see: 2.2607 -# http://www.graphviz.org/)). 2.2608 -# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2.2609 -# to make the SVG files visible in IE 9+ (other browsers do not have this 2.2610 -# requirement). 2.2611 -# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, 2.2612 -# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2.2613 -# png:gdiplus:gdiplus. 2.2614 -# The default value is: png. 2.2615 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2616 - 2.2617 -DOT_IMAGE_FORMAT = png 2.2618 - 2.2619 -# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2.2620 -# enable generation of interactive SVG images that allow zooming and panning. 2.2621 -# 2.2622 -# Note that this requires a modern browser other than Internet Explorer. Tested 2.2623 -# and working are Firefox, Chrome, Safari, and Opera. 2.2624 -# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2.2625 -# the SVG files visible. Older versions of IE do not have SVG support. 2.2626 -# The default value is: NO. 2.2627 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2628 - 2.2629 -INTERACTIVE_SVG = NO 2.2630 - 2.2631 -# The DOT_PATH tag can be used to specify the path where the dot tool can be 2.2632 -# found. If left blank, it is assumed the dot tool can be found in the path. 2.2633 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2634 - 2.2635 -DOT_PATH = 2.2636 - 2.2637 -# The DOTFILE_DIRS tag can be used to specify one or more directories that 2.2638 -# contain dot files that are included in the documentation (see the \dotfile 2.2639 -# command). 2.2640 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2641 - 2.2642 -DOTFILE_DIRS = 2.2643 - 2.2644 -# The MSCFILE_DIRS tag can be used to specify one or more directories that 2.2645 -# contain msc files that are included in the documentation (see the \mscfile 2.2646 -# command). 2.2647 - 2.2648 -MSCFILE_DIRS = 2.2649 - 2.2650 -# The DIAFILE_DIRS tag can be used to specify one or more directories that 2.2651 -# contain dia files that are included in the documentation (see the \diafile 2.2652 -# command). 2.2653 - 2.2654 -DIAFILE_DIRS = 2.2655 - 2.2656 -# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2.2657 -# path where java can find the plantuml.jar file or to the filename of jar file 2.2658 -# to be used. If left blank, it is assumed PlantUML is not used or called during 2.2659 -# a preprocessing step. Doxygen will generate a warning when it encounters a 2.2660 -# \startuml command in this case and will not generate output for the diagram. 2.2661 - 2.2662 -PLANTUML_JAR_PATH = 2.2663 - 2.2664 -# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a 2.2665 -# configuration file for plantuml. 2.2666 - 2.2667 -PLANTUML_CFG_FILE = 2.2668 - 2.2669 -# When using plantuml, the specified paths are searched for files specified by 2.2670 -# the !include statement in a plantuml block. 2.2671 - 2.2672 -PLANTUML_INCLUDE_PATH = 2.2673 - 2.2674 -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2.2675 -# that will be shown in the graph. If the number of nodes in a graph becomes 2.2676 -# larger than this value, doxygen will truncate the graph, which is visualized 2.2677 -# by representing a node as a red box. Note that doxygen if the number of direct 2.2678 -# children of the root node in a graph is already larger than 2.2679 -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2.2680 -# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2.2681 -# Minimum value: 0, maximum value: 10000, default value: 50. 2.2682 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2683 - 2.2684 -DOT_GRAPH_MAX_NODES = 50 2.2685 - 2.2686 -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2.2687 -# generated by dot. A depth value of 3 means that only nodes reachable from the 2.2688 -# root by following a path via at most 3 edges will be shown. Nodes that lay 2.2689 -# further from the root node will be omitted. Note that setting this option to 1 2.2690 -# or 2 may greatly reduce the computation time needed for large code bases. Also 2.2691 -# note that the size of a graph can be further restricted by 2.2692 -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2.2693 -# Minimum value: 0, maximum value: 1000, default value: 0. 2.2694 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2695 - 2.2696 -MAX_DOT_GRAPH_DEPTH = 0 2.2697 - 2.2698 -# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2.2699 -# files in one run (i.e. multiple -o and -T options on the command line). This 2.2700 -# makes dot run faster, but since only newer versions of dot (>1.8.10) support 2.2701 -# this, this feature is disabled by default. 2.2702 -# The default value is: NO. 2.2703 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2704 - 2.2705 -DOT_MULTI_TARGETS = YES 2.2706 - 2.2707 -# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2.2708 -# explaining the meaning of the various boxes and arrows in the dot generated 2.2709 -# graphs. 2.2710 -# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal 2.2711 -# graphical representation for inheritance and collaboration diagrams is used. 2.2712 -# The default value is: YES. 2.2713 -# This tag requires that the tag HAVE_DOT is set to YES. 2.2714 - 2.2715 -GENERATE_LEGEND = YES 2.2716 - 2.2717 -# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate 2.2718 -# files that are used to generate the various graphs. 2.2719 -# 2.2720 -# Note: This setting is not only used for dot files but also for msc temporary 2.2721 -# files. 2.2722 -# The default value is: YES. 2.2723 - 2.2724 -DOT_CLEANUP = YES
3.1 --- a/configure Thu Oct 12 00:00:35 2023 +0200 3.2 +++ b/configure Wed Oct 18 21:07:02 2023 +0200 3.3 @@ -369,10 +369,12 @@ 3.4 do 3.5 cat >> $TEMP_DIR/make.mk << __EOF__ 3.6 # Dependency: file-tools 3.7 -MKDIR=mkdir -p 3.8 -RMDIR=rm -f -R 3.9 -COPYFILE=cp 3.10 -COPYALL=cp -R 3.11 +MKDIR=/bin/mkdir -p 3.12 +RMFILE=/bin/rm -f 3.13 +RMDIR=/bin/rm -f -R 3.14 +COPYFILE=/bin/cp -f 3.15 +COPYALL=/bin/cp -f -R 3.16 +SYMLINK=/bin/ln -s 3.17 3.18 __EOF__ 3.19 echo yes 3.20 @@ -438,12 +440,14 @@ 3.21 3.22 cat >> "$TEMP_DIR/make.mk" << __EOF__ 3.23 # library version 3.24 -VERSION="3.0.0" 3.25 +VERSION=3.0.0 3.26 +LIBVERSION=4.0.0 3.27 +LIBVERSION_MAJOR=4 3.28 3.29 # build directory structure !! do not change or override !! 3.30 -BUILD_DIR=${src_dir}/build 3.31 -DOCS_DIR=${src_dir}/build/docs 3.32 -DIST_DIR=${src_dir}/dist 3.33 +build_dir=${src_dir}/build 3.34 +docs_dir=${src_dir}/build/docs 3.35 +dist_dir=${src_dir}/dist 3.36 3.37 __EOF__ 3.38 break
4.1 --- a/docs/Makefile Thu Oct 12 00:00:35 2023 +0200 4.2 +++ b/docs/Makefile Wed Oct 18 21:07:02 2023 +0200 4.3 @@ -24,34 +24,34 @@ 4.4 include ../config.mk 4.5 4.6 PAGES = index features install license modules-ucx2 4.7 -DOCS_HTML = $(PAGES:%=$(DOCS_DIR)/web/%.html) 4.8 -DOCS_CSS = $(DOCS_DIR)/web/ucx.css 4.9 +DOCS_HTML = $(PAGES:%=$(docs_dir)/web/%.html) 4.10 +DOCS_CSS = $(docs_dir)/web/ucx.css 4.11 4.12 all: all-html all-api 4.13 4.14 -all-html: $(DOCS_DIR)/web $(DOCS_HTML) $(DOCS_CSS) FORCE 4.15 +all-html: $(docs_dir)/web $(DOCS_HTML) $(DOCS_CSS) FORCE 4.16 @echo "[ HTML Docs Generated ]" 4.17 4.18 -all-api: $(DOCS_DIR)/web $(DOCS_DIR)/web/api-2.1 $(DOCS_DIR)/web/api FORCE 4.19 +all-api: $(docs_dir)/web $(docs_dir)/web/api-2.1 $(docs_dir)/web/api FORCE 4.20 @echo "[ API Docs Generated ]" 4.21 4.22 -$(DOCS_DIR)/web/api-2.1: api-2.1 FORCE 4.23 +$(docs_dir)/web/api-2.1: api-2.1 FORCE 4.24 $(COPYALL) $< $@ 4.25 4.26 -$(DOCS_DIR)/web/api: FORCE 4.27 +$(docs_dir)/web/api: FORCE 4.28 cd $(src_dir); $(DOXYGEN) 4.29 4.30 -$(DOCS_DIR)/web: 4.31 +$(docs_dir)/web: 4.32 $(MKDIR) $@ 4.33 4.34 $(DOCS_CSS): src/ucx.css 4.35 $(COPYFILE) $< $@ 4.36 4.37 -$(DOCS_DIR)/web/modules-ucx2.html: src/modules-ucx2.md 4.38 +$(docs_dir)/web/modules-ucx2.html: src/modules-ucx2.md 4.39 $(PANDOC) -c ucx.css -B src/header-ucx2.html -A src/footer.html \ 4.40 -T 'UAP Common Extensions' -o $@ $< 4.41 4.42 -$(DOCS_DIR)/web/%.html: src/%.md 4.43 +$(docs_dir)/web/%.html: src/%.md 4.44 $(PANDOC) -c ucx.css -B src/header.html -A src/footer.html \ 4.45 -T 'UAP Common Extensions' -o $@ $< 4.46
5.1 --- a/make/clang.mk Thu Oct 12 00:00:35 2023 +0200 5.2 +++ b/make/clang.mk Wed Oct 18 21:07:02 2023 +0200 5.3 @@ -1,5 +1,5 @@ 5.4 # 5.5 -# gcc toolchain config 5.6 +# clang toolchain config 5.7 # 5.8 5.9 CFLAGS = 5.10 @@ -11,4 +11,4 @@ 5.11 LDFLAGS = 5.12 5.13 SHLIB_CFLAGS = -fPIC 5.14 -SHLIB_LDFLAGS = -shared 5.15 \ No newline at end of file 5.16 +SHLIB_LDFLAGS = -shared
6.1 --- a/make/gcc.mk Thu Oct 12 00:00:35 2023 +0200 6.2 +++ b/make/gcc.mk Wed Oct 18 21:07:02 2023 +0200 6.3 @@ -11,4 +11,4 @@ 6.4 LDFLAGS = 6.5 6.6 SHLIB_CFLAGS = -fPIC 6.7 -SHLIB_LDFLAGS = -shared 6.8 \ No newline at end of file 6.9 +SHLIB_LDFLAGS = -shared
7.1 --- a/make/project.xml Thu Oct 12 00:00:35 2023 +0200 7.2 +++ b/make/project.xml Wed Oct 18 21:07:02 2023 +0200 7.3 @@ -10,21 +10,25 @@ 7.4 <dependency> 7.5 <make> 7.6 # library version 7.7 -VERSION="3.0.0" 7.8 +VERSION=3.0.0 7.9 +LIBVERSION=4.0.0 7.10 +LIBVERSION_MAJOR=4 7.11 7.12 # build directory structure !! do not change or override !! 7.13 -BUILD_DIR=${src_dir}/build 7.14 -DOCS_DIR=${src_dir}/build/docs 7.15 -DIST_DIR=${src_dir}/dist 7.16 +build_dir=${src_dir}/build 7.17 +docs_dir=${src_dir}/build/docs 7.18 +dist_dir=${src_dir}/dist 7.19 </make> 7.20 </dependency> 7.21 7.22 <dependency name="file-tools"> 7.23 <make> 7.24 -MKDIR=mkdir -p 7.25 -RMDIR=rm -f -R 7.26 -COPYFILE=cp 7.27 -COPYALL=cp -R 7.28 +MKDIR=/bin/mkdir -p 7.29 +RMFILE=/bin/rm -f 7.30 +RMDIR=/bin/rm -f -R 7.31 +COPYFILE=/bin/cp -f 7.32 +COPYALL=/bin/cp -f -R 7.33 +SYMLINK=/bin/ln -s 7.34 </make> 7.35 </dependency> 7.36
8.1 --- a/src/Makefile Thu Oct 12 00:00:35 2023 +0200 8.2 +++ b/src/Makefile Wed Oct 18 21:07:02 2023 +0200 8.3 @@ -27,81 +27,87 @@ 8.4 linked_list.c list.c map.c mempool.c printf.c string.c utils.c 8.5 8.6 OBJ_EXT=.o 8.7 -OBJ=$(SRC:%.c=$(BUILD_DIR)/%$(OBJ_EXT)) 8.8 +OBJ=$(SRC:%.c=$(build_dir)/%$(OBJ_EXT)) 8.9 8.10 -static: $(BUILD_DIR)/libucx$(STLIB_EXT) 8.11 +static: $(build_dir)/libucx_static$(STLIB_EXT) 8.12 8.13 -shared: $(BUILD_DIR)/libucx$(SHLIB_EXT) 8.14 +shared: $(build_dir)/libucx$(SHLIB_EXT) 8.15 8.16 -$(BUILD_DIR)/libucx$(STLIB_EXT): $(OBJ) 8.17 +$(build_dir)/libucx_static$(STLIB_EXT): $(OBJ) 8.18 $(AR) $(ARFLAGS) $@ $^ 8.19 8.20 -$(BUILD_DIR)/libucx$(SHLIB_EXT): $(OBJ) 8.21 +$(build_dir)/libucx$(SHLIB_EXT): $(OBJ) 8.22 $(CC) $(LDFLAGS) -o $@ $^ 8.23 8.24 -install: 8.25 - @echo "[ not supported yet ]" 8.26 +install: $(build_dir)/libucx_static$(STLIB_EXT) $(build_dir)/libucx$(SHLIB_EXT) 8.27 + $(MKDIR) $(libdir) $(includedir) 8.28 + $(RMFILE) $(libdir)/libucx$(SHLIB_EXT).$(LIBVERSION_MAJOR) 8.29 + $(RMFILE) $(libdir)/libucx$(SHLIB_EXT) 8.30 + $(COPYFILE) $(build_dir)/libucx_static$(STLIB_EXT) $(libdir)/libucx_static$(STLIB_EXT) 8.31 + $(COPYFILE) $(build_dir)/libucx$(SHLIB_EXT) $(libdir)/libucx$(SHLIB_EXT).$(LIBVERSION) 8.32 + $(COPYALL) $(src_dir)/src/cx $(includedir)/cx 8.33 + $(SYMLINK) $(libdir)/libucx$(SHLIB_EXT).$(LIBVERSION) $(libdir)/libucx$(SHLIB_EXT).$(LIBVERSION_MAJOR) 8.34 + $(SYMLINK) $(libdir)/libucx$(SHLIB_EXT).$(LIBVERSION_MAJOR) $(libdir)/libucx$(SHLIB_EXT) 8.35 8.36 - 8.37 -$(BUILD_DIR)/allocator$(OBJ_EXT): allocator.c cx/allocator.h cx/common.h 8.38 +$(build_dir)/allocator$(OBJ_EXT): allocator.c cx/allocator.h cx/common.h 8.39 echo "Compiling $<" 8.40 $(CC) -o $@ $(CFLAGS) -c $< 8.41 8.42 -$(BUILD_DIR)/array_list$(OBJ_EXT): array_list.c cx/array_list.h cx/list.h \ 8.43 +$(build_dir)/array_list$(OBJ_EXT): array_list.c cx/array_list.h cx/list.h \ 8.44 cx/common.h cx/collection.h cx/allocator.h cx/iterator.h 8.45 echo "Compiling $<" 8.46 $(CC) -o $@ $(CFLAGS) -c $< 8.47 8.48 -$(BUILD_DIR)/buffer$(OBJ_EXT): buffer.c cx/buffer.h cx/common.h cx/allocator.h \ 8.49 +$(build_dir)/buffer$(OBJ_EXT): buffer.c cx/buffer.h cx/common.h cx/allocator.h \ 8.50 cx/utils.h 8.51 echo "Compiling $<" 8.52 $(CC) -o $@ $(CFLAGS) -c $< 8.53 8.54 -$(BUILD_DIR)/compare$(OBJ_EXT): compare.c cx/compare.h cx/common.h 8.55 +$(build_dir)/compare$(OBJ_EXT): compare.c cx/compare.h cx/common.h 8.56 echo "Compiling $<" 8.57 $(CC) -o $@ $(CFLAGS) -c $< 8.58 8.59 -$(BUILD_DIR)/hash_key$(OBJ_EXT): hash_key.c cx/hash_key.h cx/common.h 8.60 +$(build_dir)/hash_key$(OBJ_EXT): hash_key.c cx/hash_key.h cx/common.h 8.61 echo "Compiling $<" 8.62 $(CC) -o $@ $(CFLAGS) -c $< 8.63 8.64 -$(BUILD_DIR)/hash_map$(OBJ_EXT): hash_map.c cx/hash_map.h cx/map.h cx/common.h \ 8.65 +$(build_dir)/hash_map$(OBJ_EXT): hash_map.c cx/hash_map.h cx/map.h cx/common.h \ 8.66 cx/collection.h cx/allocator.h cx/iterator.h cx/string.h cx/hash_key.h \ 8.67 cx/utils.h 8.68 echo "Compiling $<" 8.69 $(CC) -o $@ $(CFLAGS) -c $< 8.70 8.71 -$(BUILD_DIR)/linked_list$(OBJ_EXT): linked_list.c cx/linked_list.h cx/common.h \ 8.72 +$(build_dir)/linked_list$(OBJ_EXT): linked_list.c cx/linked_list.h cx/common.h \ 8.73 cx/list.h cx/collection.h cx/allocator.h cx/iterator.h cx/utils.h 8.74 echo "Compiling $<" 8.75 $(CC) -o $@ $(CFLAGS) -c $< 8.76 8.77 -$(BUILD_DIR)/list$(OBJ_EXT): list.c cx/list.h cx/common.h cx/collection.h \ 8.78 +$(build_dir)/list$(OBJ_EXT): list.c cx/list.h cx/common.h cx/collection.h \ 8.79 cx/allocator.h cx/iterator.h 8.80 echo "Compiling $<" 8.81 $(CC) -o $@ $(CFLAGS) -c $< 8.82 8.83 -$(BUILD_DIR)/map$(OBJ_EXT): map.c cx/map.h cx/common.h cx/collection.h \ 8.84 +$(build_dir)/map$(OBJ_EXT): map.c cx/map.h cx/common.h cx/collection.h \ 8.85 cx/allocator.h cx/iterator.h cx/string.h cx/hash_key.h 8.86 echo "Compiling $<" 8.87 $(CC) -o $@ $(CFLAGS) -c $< 8.88 8.89 -$(BUILD_DIR)/mempool$(OBJ_EXT): mempool.c cx/mempool.h cx/common.h cx/allocator.h \ 8.90 +$(build_dir)/mempool$(OBJ_EXT): mempool.c cx/mempool.h cx/common.h cx/allocator.h \ 8.91 cx/utils.h 8.92 echo "Compiling $<" 8.93 $(CC) -o $@ $(CFLAGS) -c $< 8.94 8.95 -$(BUILD_DIR)/printf$(OBJ_EXT): printf.c cx/printf.h cx/common.h cx/string.h \ 8.96 +$(build_dir)/printf$(OBJ_EXT): printf.c cx/printf.h cx/common.h cx/string.h \ 8.97 cx/allocator.h 8.98 echo "Compiling $<" 8.99 $(CC) -o $@ $(CFLAGS) -c $< 8.100 8.101 -$(BUILD_DIR)/string$(OBJ_EXT): string.c cx/string.h cx/common.h cx/allocator.h \ 8.102 +$(build_dir)/string$(OBJ_EXT): string.c cx/string.h cx/common.h cx/allocator.h \ 8.103 cx/utils.h 8.104 echo "Compiling $<" 8.105 $(CC) -o $@ $(CFLAGS) -c $< 8.106 8.107 -$(BUILD_DIR)/utils$(OBJ_EXT): utils.c cx/utils.h cx/common.h 8.108 +$(build_dir)/utils$(OBJ_EXT): utils.c cx/utils.h cx/common.h 8.109 echo "Compiling $<" 8.110 $(CC) -o $@ $(CFLAGS) -c $< 8.111
9.1 --- a/tests/Makefile Thu Oct 12 00:00:35 2023 +0200 9.2 +++ b/tests/Makefile Wed Oct 18 21:07:02 2023 +0200 9.3 @@ -23,9 +23,9 @@ 9.4 9.5 include ../config.mk 9.6 9.7 -TEST_DIR=$(BUILD_DIR)/tests 9.8 +TEST_DIR=$(build_dir)/tests 9.9 9.10 -all: $(TEST_DIR) $(BUILD_DIR)/libucx.a 9.11 +all: $(TEST_DIR) $(build_dir)/libucx.a 9.12 cd $(TEST_DIR) && $(CMAKE) -DSTLIB_EXT="$(STLIB_EXT)" "$(src_dir)/tests" && $(CMAKE) --build . 9.13 @echo "[ Tests complete ]" 9.14