Mercurial > Math
changeset 18:f9fb659509e1
Doxygen docs for Vector classes.
author | Eris Caffee <discordia@eldalin.com> |
---|---|
date | Mon, 27 May 2013 16:59:04 -0500 |
parents | f49d8ba063ca |
children | 4634ca3fc308 |
files | CMakeLists.txt docs/Doxyfile.in docs/mainpage.dox docs/namespaces.dox include/Vector.h |
diffstat | 5 files changed, 1985 insertions(+), 94 deletions(-) [+] |
line diff
1.1 --- a/CMakeLists.txt Mon May 27 00:53:55 2013 -0500 1.2 +++ b/CMakeLists.txt Mon May 27 16:59:04 2013 -0500 1.3 @@ -75,6 +75,11 @@ 1.4 project (${App_Name}) 1.5 1.6 1.7 +# You may specify an application description, too. This will be passed to 1.8 +# Doxygen, if you use that. 1.9 +set (App_Description "3D math library for games.") 1.10 + 1.11 + 1.12 ################################################################################ 1.13 # Special options 1.14 1.15 @@ -199,3 +204,39 @@ 1.16 # ${App_Name} 1.17 ) 1.18 1.19 +################################################################################ 1.20 +# Doxygen documentation 1.21 +# 1.22 +# - Create a directory named docs to hold your Doxygen config and standalone 1.23 +# (.dox) files. 1.24 +# - Name your Doxyfile config as "docs/Doxyfile.in". 1.25 +# - In that file, set the following variables as shown, adjusting INPUT as 1.26 +# needed to reflect the actual location of the fiels you wnat processed. 1.27 +# 1.28 +# PROJECT_NAME = "@App_Name@" 1.29 +# PROJECT_BRIEF = "@App_Description@" 1.30 +# STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@ 1.31 +# INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/ @CMAKE_CURRENT_SOURCE_DIR@/include/ @CMAKE_CURRENT_SOURCE_DIR@/docs/ 1.32 +# 1.33 +# Then you can generate the docs with "make docs" and this will create a "docs" directory under your build directory. 1.34 +# 1.35 + 1.36 +option(Option_Doxygen "Generate Doxygen documentation." ON) 1.37 + 1.38 +if (Option_Doxygen) 1.39 + 1.40 + find_package(Doxygen) 1.41 + if (NOT DOXYGEN_FOUND) 1.42 + message (FATAL_ERROR "Doxygen not found!") 1.43 + endif () 1.44 + 1.45 + configure_file (${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/docs/Doxyfile @ONLY) 1.46 + 1.47 + add_custom_target(docs 1.48 + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/docs/Doxyfile 1.49 + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} 1.50 + COMMENT "Generating API documentation with Doxygen" VERBATIM 1.51 + ) 1.52 + 1.53 +endif () 1.54 +
2.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 2.2 +++ b/docs/Doxyfile.in Mon May 27 16:59:04 2013 -0500 2.3 @@ -0,0 +1,1792 @@ 2.4 +# Doxyfile 1.8.1.1 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 hash (#) is considered a comment and will be ignored. 2.10 +# The format is: 2.11 +# TAG = value [value, ...] 2.12 +# For lists items can also be appended using: 2.13 +# TAG += value [value, ...] 2.14 +# Values that contain spaces should be placed between quotes (" "). 2.15 + 2.16 +#--------------------------------------------------------------------------- 2.17 +# Project related configuration options 2.18 +#--------------------------------------------------------------------------- 2.19 + 2.20 +# This tag specifies the encoding used for all characters in the config file 2.21 +# that follow. The default is UTF-8 which is also the encoding used for all 2.22 +# text before the first occurrence of this tag. Doxygen uses libiconv (or the 2.23 +# iconv built into libc) for the transcoding. See 2.24 +# http://www.gnu.org/software/libiconv for the list of possible encodings. 2.25 + 2.26 +DOXYFILE_ENCODING = UTF-8 2.27 + 2.28 +# The PROJECT_NAME tag is a single word (or sequence of words) that should 2.29 +# identify the project. Note that if you do not use Doxywizard you need 2.30 +# to put quotes around the project name if it contains spaces. 2.31 + 2.32 +PROJECT_NAME = "@App_Name@" 2.33 + 2.34 +# The PROJECT_NUMBER tag can be used to enter a project or revision number. 2.35 +# This could be handy for archiving the generated documentation or 2.36 +# if some version control system is used. 2.37 + 2.38 +PROJECT_NUMBER = 2.39 + 2.40 +# Using the PROJECT_BRIEF tag one can provide an optional one line description 2.41 +# for a project that appears at the top of each page and should give viewer 2.42 +# a quick idea about the purpose of the project. Keep the description short. 2.43 + 2.44 +PROJECT_BRIEF = "@App_Description@" 2.45 + 2.46 +# With the PROJECT_LOGO tag one can specify an logo or icon that is 2.47 +# included in the documentation. The maximum height of the logo should not 2.48 +# exceed 55 pixels and the maximum width should not exceed 200 pixels. 2.49 +# Doxygen will copy the logo to the output directory. 2.50 + 2.51 +PROJECT_LOGO = 2.52 + 2.53 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 2.54 +# base path where the generated documentation will be put. 2.55 +# If a relative path is entered, it will be relative to the location 2.56 +# where doxygen was started. If left blank the current directory will be used. 2.57 + 2.58 +OUTPUT_DIRECTORY = "docs" 2.59 + 2.60 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 2.61 +# 4096 sub-directories (in 2 levels) under the output directory of each output 2.62 +# format and will distribute the generated files over these directories. 2.63 +# Enabling this option can be useful when feeding doxygen a huge amount of 2.64 +# source files, where putting all generated files in the same directory would 2.65 +# otherwise cause performance problems for the file system. 2.66 + 2.67 +CREATE_SUBDIRS = NO 2.68 + 2.69 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all 2.70 +# documentation generated by doxygen is written. Doxygen will use this 2.71 +# information to generate all constant output in the proper language. 2.72 +# The default language is English, other supported languages are: 2.73 +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 2.74 +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 2.75 +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 2.76 +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 2.77 +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 2.78 +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 2.79 + 2.80 +OUTPUT_LANGUAGE = English 2.81 + 2.82 +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 2.83 +# include brief member descriptions after the members that are listed in 2.84 +# the file and class documentation (similar to JavaDoc). 2.85 +# Set to NO to disable this. 2.86 + 2.87 +BRIEF_MEMBER_DESC = YES 2.88 + 2.89 +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 2.90 +# the brief description of a member or function before the detailed description. 2.91 +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 2.92 +# brief descriptions will be completely suppressed. 2.93 + 2.94 +REPEAT_BRIEF = YES 2.95 + 2.96 +# This tag implements a quasi-intelligent brief description abbreviator 2.97 +# that is used to form the text in various listings. Each string 2.98 +# in this list, if found as the leading text of the brief description, will be 2.99 +# stripped from the text and the result after processing the whole list, is 2.100 +# used as the annotated text. Otherwise, the brief description is used as-is. 2.101 +# If left blank, the following values are used ("$name" is automatically 2.102 +# replaced with the name of the entity): "The $name class" "The $name widget" 2.103 +# "The $name file" "is" "provides" "specifies" "contains" 2.104 +# "represents" "a" "an" "the" 2.105 + 2.106 +ABBREVIATE_BRIEF = 2.107 + 2.108 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 2.109 +# Doxygen will generate a detailed section even if there is only a brief 2.110 +# description. 2.111 + 2.112 +ALWAYS_DETAILED_SEC = NO 2.113 + 2.114 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 2.115 +# inherited members of a class in the documentation of that class as if those 2.116 +# members were ordinary class members. Constructors, destructors and assignment 2.117 +# operators of the base classes will not be shown. 2.118 + 2.119 +INLINE_INHERITED_MEMB = NO 2.120 + 2.121 +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 2.122 +# path before files name in the file list and in the header files. If set 2.123 +# to NO the shortest path that makes the file name unique will be used. 2.124 + 2.125 +FULL_PATH_NAMES = YES 2.126 + 2.127 +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 2.128 +# can be used to strip a user-defined part of the path. Stripping is 2.129 +# only done if one of the specified strings matches the left-hand part of 2.130 +# the path. The tag can be used to show relative paths in the file list. 2.131 +# If left blank the directory from which doxygen is run is used as the 2.132 +# path to strip. 2.133 + 2.134 +STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@ 2.135 + 2.136 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 2.137 +# the path mentioned in the documentation of a class, which tells 2.138 +# the reader which header file to include in order to use a class. 2.139 +# If left blank only the name of the header file containing the class 2.140 +# definition is used. Otherwise one should specify the include paths that 2.141 +# are normally passed to the compiler using the -I flag. 2.142 + 2.143 +STRIP_FROM_INC_PATH = 2.144 + 2.145 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 2.146 +# (but less readable) file names. This can be useful if your file system 2.147 +# doesn't support long names like on DOS, Mac, or CD-ROM. 2.148 + 2.149 +SHORT_NAMES = NO 2.150 + 2.151 +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 2.152 +# will interpret the first line (until the first dot) of a JavaDoc-style 2.153 +# comment as the brief description. If set to NO, the JavaDoc 2.154 +# comments will behave just like regular Qt-style comments 2.155 +# (thus requiring an explicit @brief command for a brief description.) 2.156 + 2.157 +JAVADOC_AUTOBRIEF = NO 2.158 + 2.159 +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 2.160 +# interpret the first line (until the first dot) of a Qt-style 2.161 +# comment as the brief description. If set to NO, the comments 2.162 +# will behave just like regular Qt-style comments (thus requiring 2.163 +# an explicit \brief command for a brief description.) 2.164 + 2.165 +QT_AUTOBRIEF = NO 2.166 + 2.167 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 2.168 +# treat a multi-line C++ special comment block (i.e. a block of //! or /// 2.169 +# comments) as a brief description. This used to be the default behaviour. 2.170 +# The new default is to treat a multi-line C++ comment block as a detailed 2.171 +# description. Set this tag to YES if you prefer the old behaviour instead. 2.172 + 2.173 +MULTILINE_CPP_IS_BRIEF = NO 2.174 + 2.175 +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 2.176 +# member inherits the documentation from any documented member that it 2.177 +# re-implements. 2.178 + 2.179 +INHERIT_DOCS = YES 2.180 + 2.181 +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 2.182 +# a new page for each member. If set to NO, the documentation of a member will 2.183 +# be part of the file/class/namespace that contains it. 2.184 + 2.185 +SEPARATE_MEMBER_PAGES = NO 2.186 + 2.187 +# The TAB_SIZE tag can be used to set the number of spaces in a tab. 2.188 +# Doxygen uses this value to replace tabs by spaces in code fragments. 2.189 + 2.190 +TAB_SIZE = 8 2.191 + 2.192 +# This tag can be used to specify a number of aliases that acts 2.193 +# as commands in the documentation. An alias has the form "name=value". 2.194 +# For example adding "sideeffect=\par Side Effects:\n" will allow you to 2.195 +# put the command \sideeffect (or @sideeffect) in the documentation, which 2.196 +# will result in a user-defined paragraph with heading "Side Effects:". 2.197 +# You can put \n's in the value part of an alias to insert newlines. 2.198 + 2.199 +ALIASES = 2.200 + 2.201 +# This tag can be used to specify a number of word-keyword mappings (TCL only). 2.202 +# A mapping has the form "name=value". For example adding 2.203 +# "class=itcl::class" will allow you to use the command class in the 2.204 +# itcl::class meaning. 2.205 + 2.206 +TCL_SUBST = 2.207 + 2.208 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 2.209 +# sources only. Doxygen will then generate output that is more tailored for C. 2.210 +# For instance, some of the names that are used will be different. The list 2.211 +# of all members will be omitted, etc. 2.212 + 2.213 +OPTIMIZE_OUTPUT_FOR_C = NO 2.214 + 2.215 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 2.216 +# sources only. Doxygen will then generate output that is more tailored for 2.217 +# Java. For instance, namespaces will be presented as packages, qualified 2.218 +# scopes will look different, etc. 2.219 + 2.220 +OPTIMIZE_OUTPUT_JAVA = NO 2.221 + 2.222 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 2.223 +# sources only. Doxygen will then generate output that is more tailored for 2.224 +# Fortran. 2.225 + 2.226 +OPTIMIZE_FOR_FORTRAN = NO 2.227 + 2.228 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 2.229 +# sources. Doxygen will then generate output that is tailored for 2.230 +# VHDL. 2.231 + 2.232 +OPTIMIZE_OUTPUT_VHDL = NO 2.233 + 2.234 +# Doxygen selects the parser to use depending on the extension of the files it 2.235 +# parses. With this tag you can assign which parser to use for a given extension. 2.236 +# Doxygen has a built-in mapping, but you can override or extend it using this 2.237 +# tag. The format is ext=language, where ext is a file extension, and language 2.238 +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 2.239 +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 2.240 +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 2.241 +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 2.242 +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 2.243 + 2.244 +EXTENSION_MAPPING = 2.245 + 2.246 +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 2.247 +# comments according to the Markdown format, which allows for more readable 2.248 +# documentation. See http://daringfireball.net/projects/markdown/ for details. 2.249 +# The output of markdown processing is further processed by doxygen, so you 2.250 +# can mix doxygen, HTML, and XML commands with Markdown formatting. 2.251 +# Disable only in case of backward compatibilities issues. 2.252 + 2.253 +MARKDOWN_SUPPORT = YES 2.254 + 2.255 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 2.256 +# to include (a tag file for) the STL sources as input, then you should 2.257 +# set this tag to YES in order to let doxygen match functions declarations and 2.258 +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 2.259 +# func(std::string) {}). This also makes the inheritance and collaboration 2.260 +# diagrams that involve STL classes more complete and accurate. 2.261 + 2.262 +BUILTIN_STL_SUPPORT = NO 2.263 + 2.264 +# If you use Microsoft's C++/CLI language, you should set this option to YES to 2.265 +# enable parsing support. 2.266 + 2.267 +CPP_CLI_SUPPORT = NO 2.268 + 2.269 +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 2.270 +# Doxygen will parse them like normal C++ but will assume all classes use public 2.271 +# instead of private inheritance when no explicit protection keyword is present. 2.272 + 2.273 +SIP_SUPPORT = NO 2.274 + 2.275 +# For Microsoft's IDL there are propget and propput attributes to indicate getter 2.276 +# and setter methods for a property. Setting this option to YES (the default) 2.277 +# will make doxygen replace the get and set methods by a property in the 2.278 +# documentation. This will only work if the methods are indeed getting or 2.279 +# setting a simple type. If this is not the case, or you want to show the 2.280 +# methods anyway, you should set this option to NO. 2.281 + 2.282 +IDL_PROPERTY_SUPPORT = YES 2.283 + 2.284 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 2.285 +# tag is set to YES, then doxygen will reuse the documentation of the first 2.286 +# member in the group (if any) for the other members of the group. By default 2.287 +# all members of a group must be documented explicitly. 2.288 + 2.289 +DISTRIBUTE_GROUP_DOC = NO 2.290 + 2.291 +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 2.292 +# the same type (for instance a group of public functions) to be put as a 2.293 +# subgroup of that type (e.g. under the Public Functions section). Set it to 2.294 +# NO to prevent subgrouping. Alternatively, this can be done per class using 2.295 +# the \nosubgrouping command. 2.296 + 2.297 +SUBGROUPING = YES 2.298 + 2.299 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 2.300 +# unions are shown inside the group in which they are included (e.g. using 2.301 +# @ingroup) instead of on a separate page (for HTML and Man pages) or 2.302 +# section (for LaTeX and RTF). 2.303 + 2.304 +INLINE_GROUPED_CLASSES = NO 2.305 + 2.306 +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 2.307 +# unions with only public data fields will be shown inline in the documentation 2.308 +# of the scope in which they are defined (i.e. file, namespace, or group 2.309 +# documentation), provided this scope is documented. If set to NO (the default), 2.310 +# structs, classes, and unions are shown on a separate page (for HTML and Man 2.311 +# pages) or section (for LaTeX and RTF). 2.312 + 2.313 +INLINE_SIMPLE_STRUCTS = NO 2.314 + 2.315 +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 2.316 +# is documented as struct, union, or enum with the name of the typedef. So 2.317 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 2.318 +# with name TypeT. When disabled the typedef will appear as a member of a file, 2.319 +# namespace, or class. And the struct will be named TypeS. This can typically 2.320 +# be useful for C code in case the coding convention dictates that all compound 2.321 +# types are typedef'ed and only the typedef is referenced, never the tag name. 2.322 + 2.323 +TYPEDEF_HIDES_STRUCT = NO 2.324 + 2.325 +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 2.326 +# determine which symbols to keep in memory and which to flush to disk. 2.327 +# When the cache is full, less often used symbols will be written to disk. 2.328 +# For small to medium size projects (<1000 input files) the default value is 2.329 +# probably good enough. For larger projects a too small cache size can cause 2.330 +# doxygen to be busy swapping symbols to and from disk most of the time 2.331 +# causing a significant performance penalty. 2.332 +# If the system has enough physical memory increasing the cache will improve the 2.333 +# performance by keeping more symbols in memory. Note that the value works on 2.334 +# a logarithmic scale so increasing the size by one will roughly double the 2.335 +# memory usage. The cache size is given by this formula: 2.336 +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 2.337 +# corresponding to a cache size of 2^16 = 65536 symbols. 2.338 + 2.339 +SYMBOL_CACHE_SIZE = 0 2.340 + 2.341 +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 2.342 +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 2.343 +# their name and scope. Since this can be an expensive process and often the 2.344 +# same symbol appear multiple times in the code, doxygen keeps a cache of 2.345 +# pre-resolved symbols. If the cache is too small doxygen will become slower. 2.346 +# If the cache is too large, memory is wasted. The cache size is given by this 2.347 +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 2.348 +# corresponding to a cache size of 2^16 = 65536 symbols. 2.349 + 2.350 +LOOKUP_CACHE_SIZE = 0 2.351 + 2.352 +#--------------------------------------------------------------------------- 2.353 +# Build related configuration options 2.354 +#--------------------------------------------------------------------------- 2.355 + 2.356 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 2.357 +# documentation are documented, even if no documentation was available. 2.358 +# Private class members and static file members will be hidden unless 2.359 +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 2.360 + 2.361 +EXTRACT_ALL = NO 2.362 + 2.363 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 2.364 +# will be included in the documentation. 2.365 + 2.366 +EXTRACT_PRIVATE = NO 2.367 + 2.368 +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. 2.369 + 2.370 +EXTRACT_PACKAGE = NO 2.371 + 2.372 +# If the EXTRACT_STATIC tag is set to YES all static members of a file 2.373 +# will be included in the documentation. 2.374 + 2.375 +EXTRACT_STATIC = NO 2.376 + 2.377 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 2.378 +# defined locally in source files will be included in the documentation. 2.379 +# If set to NO only classes defined in header files are included. 2.380 + 2.381 +EXTRACT_LOCAL_CLASSES = YES 2.382 + 2.383 +# This flag is only useful for Objective-C code. When set to YES local 2.384 +# methods, which are defined in the implementation section but not in 2.385 +# the interface are included in the documentation. 2.386 +# If set to NO (the default) only methods in the interface are included. 2.387 + 2.388 +EXTRACT_LOCAL_METHODS = NO 2.389 + 2.390 +# If this flag is set to YES, the members of anonymous namespaces will be 2.391 +# extracted and appear in the documentation as a namespace called 2.392 +# 'anonymous_namespace{file}', where file will be replaced with the base 2.393 +# name of the file that contains the anonymous namespace. By default 2.394 +# anonymous namespaces are hidden. 2.395 + 2.396 +EXTRACT_ANON_NSPACES = NO 2.397 + 2.398 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 2.399 +# undocumented members of documented classes, files or namespaces. 2.400 +# If set to NO (the default) these members will be included in the 2.401 +# various overviews, but no documentation section is generated. 2.402 +# This option has no effect if EXTRACT_ALL is enabled. 2.403 + 2.404 +HIDE_UNDOC_MEMBERS = NO 2.405 + 2.406 +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 2.407 +# undocumented classes that are normally visible in the class hierarchy. 2.408 +# If set to NO (the default) these classes will be included in the various 2.409 +# overviews. This option has no effect if EXTRACT_ALL is enabled. 2.410 + 2.411 +HIDE_UNDOC_CLASSES = NO 2.412 + 2.413 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 2.414 +# friend (class|struct|union) declarations. 2.415 +# If set to NO (the default) these declarations will be included in the 2.416 +# documentation. 2.417 + 2.418 +HIDE_FRIEND_COMPOUNDS = NO 2.419 + 2.420 +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 2.421 +# documentation blocks found inside the body of a function. 2.422 +# If set to NO (the default) these blocks will be appended to the 2.423 +# function's detailed documentation block. 2.424 + 2.425 +HIDE_IN_BODY_DOCS = NO 2.426 + 2.427 +# The INTERNAL_DOCS tag determines if documentation 2.428 +# that is typed after a \internal command is included. If the tag is set 2.429 +# to NO (the default) then the documentation will be excluded. 2.430 +# Set it to YES to include the internal documentation. 2.431 + 2.432 +INTERNAL_DOCS = NO 2.433 + 2.434 +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 2.435 +# file names in lower-case letters. If set to YES upper-case letters are also 2.436 +# allowed. This is useful if you have classes or files whose names only differ 2.437 +# in case and if your file system supports case sensitive file names. Windows 2.438 +# and Mac users are advised to set this option to NO. 2.439 + 2.440 +CASE_SENSE_NAMES = YES 2.441 + 2.442 +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 2.443 +# will show members with their full class and namespace scopes in the 2.444 +# documentation. If set to YES the scope will be hidden. 2.445 + 2.446 +HIDE_SCOPE_NAMES = NO 2.447 + 2.448 +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 2.449 +# will put a list of the files that are included by a file in the documentation 2.450 +# of that file. 2.451 + 2.452 +SHOW_INCLUDE_FILES = YES 2.453 + 2.454 +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 2.455 +# will list include files with double quotes in the documentation 2.456 +# rather than with sharp brackets. 2.457 + 2.458 +FORCE_LOCAL_INCLUDES = NO 2.459 + 2.460 +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 2.461 +# is inserted in the documentation for inline members. 2.462 + 2.463 +INLINE_INFO = YES 2.464 + 2.465 +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 2.466 +# will sort the (detailed) documentation of file and class members 2.467 +# alphabetically by member name. If set to NO the members will appear in 2.468 +# declaration order. 2.469 + 2.470 +SORT_MEMBER_DOCS = YES 2.471 + 2.472 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 2.473 +# brief documentation of file, namespace and class members alphabetically 2.474 +# by member name. If set to NO (the default) the members will appear in 2.475 +# declaration order. 2.476 + 2.477 +SORT_BRIEF_DOCS = NO 2.478 + 2.479 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 2.480 +# will sort the (brief and detailed) documentation of class members so that 2.481 +# constructors and destructors are listed first. If set to NO (the default) 2.482 +# the constructors will appear in the respective orders defined by 2.483 +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 2.484 +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 2.485 +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 2.486 + 2.487 +SORT_MEMBERS_CTORS_1ST = NO 2.488 + 2.489 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 2.490 +# hierarchy of group names into alphabetical order. If set to NO (the default) 2.491 +# the group names will appear in their defined order. 2.492 + 2.493 +SORT_GROUP_NAMES = NO 2.494 + 2.495 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 2.496 +# sorted by fully-qualified names, including namespaces. If set to 2.497 +# NO (the default), the class list will be sorted only by class name, 2.498 +# not including the namespace part. 2.499 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 2.500 +# Note: This option applies only to the class list, not to the 2.501 +# alphabetical list. 2.502 + 2.503 +SORT_BY_SCOPE_NAME = NO 2.504 + 2.505 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 2.506 +# do proper type resolution of all parameters of a function it will reject a 2.507 +# match between the prototype and the implementation of a member function even 2.508 +# if there is only one candidate or it is obvious which candidate to choose 2.509 +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 2.510 +# will still accept a match between prototype and implementation in such cases. 2.511 + 2.512 +STRICT_PROTO_MATCHING = NO 2.513 + 2.514 +# The GENERATE_TODOLIST tag can be used to enable (YES) or 2.515 +# disable (NO) the todo list. This list is created by putting \todo 2.516 +# commands in the documentation. 2.517 + 2.518 +GENERATE_TODOLIST = YES 2.519 + 2.520 +# The GENERATE_TESTLIST tag can be used to enable (YES) or 2.521 +# disable (NO) the test list. This list is created by putting \test 2.522 +# commands in the documentation. 2.523 + 2.524 +GENERATE_TESTLIST = YES 2.525 + 2.526 +# The GENERATE_BUGLIST tag can be used to enable (YES) or 2.527 +# disable (NO) the bug list. This list is created by putting \bug 2.528 +# commands in the documentation. 2.529 + 2.530 +GENERATE_BUGLIST = YES 2.531 + 2.532 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 2.533 +# disable (NO) the deprecated list. This list is created by putting 2.534 +# \deprecated commands in the documentation. 2.535 + 2.536 +GENERATE_DEPRECATEDLIST= YES 2.537 + 2.538 +# The ENABLED_SECTIONS tag can be used to enable conditional 2.539 +# documentation sections, marked by \if sectionname ... \endif. 2.540 + 2.541 +ENABLED_SECTIONS = 2.542 + 2.543 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 2.544 +# the initial value of a variable or macro consists of for it to appear in 2.545 +# the documentation. If the initializer consists of more lines than specified 2.546 +# here it will be hidden. Use a value of 0 to hide initializers completely. 2.547 +# The appearance of the initializer of individual variables and macros in the 2.548 +# documentation can be controlled using \showinitializer or \hideinitializer 2.549 +# command in the documentation regardless of this setting. 2.550 + 2.551 +MAX_INITIALIZER_LINES = 30 2.552 + 2.553 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 2.554 +# at the bottom of the documentation of classes and structs. If set to YES the 2.555 +# list will mention the files that were used to generate the documentation. 2.556 + 2.557 +SHOW_USED_FILES = YES 2.558 + 2.559 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 2.560 +# This will remove the Files entry from the Quick Index and from the 2.561 +# Folder Tree View (if specified). The default is YES. 2.562 + 2.563 +SHOW_FILES = YES 2.564 + 2.565 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 2.566 +# Namespaces page. 2.567 +# This will remove the Namespaces entry from the Quick Index 2.568 +# and from the Folder Tree View (if specified). The default is YES. 2.569 + 2.570 +SHOW_NAMESPACES = YES 2.571 + 2.572 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that 2.573 +# doxygen should invoke to get the current version for each file (typically from 2.574 +# the version control system). Doxygen will invoke the program by executing (via 2.575 +# popen()) the command <command> <input-file>, where <command> is the value of 2.576 +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 2.577 +# provided by doxygen. Whatever the program writes to standard output 2.578 +# is used as the file version. See the manual for examples. 2.579 + 2.580 +FILE_VERSION_FILTER = 2.581 + 2.582 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 2.583 +# by doxygen. The layout file controls the global structure of the generated 2.584 +# output files in an output format independent way. To create the layout file 2.585 +# that represents doxygen's defaults, run doxygen with the -l option. 2.586 +# You can optionally specify a file name after the option, if omitted 2.587 +# DoxygenLayout.xml will be used as the name of the layout file. 2.588 + 2.589 +LAYOUT_FILE = 2.590 + 2.591 +# The CITE_BIB_FILES tag can be used to specify one or more bib files 2.592 +# containing the references data. This must be a list of .bib files. The 2.593 +# .bib extension is automatically appended if omitted. Using this command 2.594 +# requires the bibtex tool to be installed. See also 2.595 +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 2.596 +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 2.597 +# feature you need bibtex and perl available in the search path. 2.598 + 2.599 +CITE_BIB_FILES = 2.600 + 2.601 +#--------------------------------------------------------------------------- 2.602 +# configuration options related to warning and progress messages 2.603 +#--------------------------------------------------------------------------- 2.604 + 2.605 +# The QUIET tag can be used to turn on/off the messages that are generated 2.606 +# by doxygen. Possible values are YES and NO. If left blank NO is used. 2.607 + 2.608 +QUIET = NO 2.609 + 2.610 +# The WARNINGS tag can be used to turn on/off the warning messages that are 2.611 +# generated by doxygen. Possible values are YES and NO. If left blank 2.612 +# NO is used. 2.613 + 2.614 +WARNINGS = YES 2.615 + 2.616 +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 2.617 +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 2.618 +# automatically be disabled. 2.619 + 2.620 +WARN_IF_UNDOCUMENTED = YES 2.621 + 2.622 +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 2.623 +# potential errors in the documentation, such as not documenting some 2.624 +# parameters in a documented function, or documenting parameters that 2.625 +# don't exist or using markup commands wrongly. 2.626 + 2.627 +WARN_IF_DOC_ERROR = YES 2.628 + 2.629 +# The WARN_NO_PARAMDOC option can be enabled to get warnings for 2.630 +# functions that are documented, but have no documentation for their parameters 2.631 +# or return value. If set to NO (the default) doxygen will only warn about 2.632 +# wrong or incomplete parameter documentation, but not about the absence of 2.633 +# documentation. 2.634 + 2.635 +WARN_NO_PARAMDOC = NO 2.636 + 2.637 +# The WARN_FORMAT tag determines the format of the warning messages that 2.638 +# doxygen can produce. The string should contain the $file, $line, and $text 2.639 +# tags, which will be replaced by the file and line number from which the 2.640 +# warning originated and the warning text. Optionally the format may contain 2.641 +# $version, which will be replaced by the version of the file (if it could 2.642 +# be obtained via FILE_VERSION_FILTER) 2.643 + 2.644 +WARN_FORMAT = "$file:$line: $text" 2.645 + 2.646 +# The WARN_LOGFILE tag can be used to specify a file to which warning 2.647 +# and error messages should be written. If left blank the output is written 2.648 +# to stderr. 2.649 + 2.650 +WARN_LOGFILE = 2.651 + 2.652 +#--------------------------------------------------------------------------- 2.653 +# configuration options related to the input files 2.654 +#--------------------------------------------------------------------------- 2.655 + 2.656 +# The INPUT tag can be used to specify the files and/or directories that contain 2.657 +# documented source files. You may enter file names like "myfile.cpp" or 2.658 +# directories like "/usr/src/myproject". Separate the files or directories 2.659 +# with spaces. 2.660 + 2.661 +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/ @CMAKE_CURRENT_SOURCE_DIR@/include/ @CMAKE_CURRENT_SOURCE_DIR@/docs/ 2.662 + 2.663 +# This tag can be used to specify the character encoding of the source files 2.664 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 2.665 +# also the default input encoding. Doxygen uses libiconv (or the iconv built 2.666 +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 2.667 +# the list of possible encodings. 2.668 + 2.669 +INPUT_ENCODING = UTF-8 2.670 + 2.671 +# If the value of the INPUT tag contains directories, you can use the 2.672 +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 2.673 +# and *.h) to filter out the source-files in the directories. If left 2.674 +# blank the following patterns are tested: 2.675 +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 2.676 +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 2.677 +# *.f90 *.f *.for *.vhd *.vhdl 2.678 + 2.679 +FILE_PATTERNS = 2.680 + 2.681 +# The RECURSIVE tag can be used to turn specify whether or not subdirectories 2.682 +# should be searched for input files as well. Possible values are YES and NO. 2.683 +# If left blank NO is used. 2.684 + 2.685 +RECURSIVE = NO 2.686 + 2.687 +# The EXCLUDE tag can be used to specify files and/or directories that should be 2.688 +# excluded from the INPUT source files. This way you can easily exclude a 2.689 +# subdirectory from a directory tree whose root is specified with the INPUT tag. 2.690 +# Note that relative paths are relative to the directory from which doxygen is 2.691 +# run. 2.692 + 2.693 +EXCLUDE = 2.694 + 2.695 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 2.696 +# directories that are symbolic links (a Unix file system feature) are excluded 2.697 +# from the input. 2.698 + 2.699 +EXCLUDE_SYMLINKS = NO 2.700 + 2.701 +# If the value of the INPUT tag contains directories, you can use the 2.702 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 2.703 +# certain files from those directories. Note that the wildcards are matched 2.704 +# against the file with absolute path, so to exclude all test directories 2.705 +# for example use the pattern */test/* 2.706 + 2.707 +EXCLUDE_PATTERNS = 2.708 + 2.709 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 2.710 +# (namespaces, classes, functions, etc.) that should be excluded from the 2.711 +# output. The symbol name can be a fully qualified name, a word, or if the 2.712 +# wildcard * is used, a substring. Examples: ANamespace, AClass, 2.713 +# AClass::ANamespace, ANamespace::*Test 2.714 + 2.715 +EXCLUDE_SYMBOLS = 2.716 + 2.717 +# The EXAMPLE_PATH tag can be used to specify one or more files or 2.718 +# directories that contain example code fragments that are included (see 2.719 +# the \include command). 2.720 + 2.721 +EXAMPLE_PATH = 2.722 + 2.723 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the 2.724 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 2.725 +# and *.h) to filter out the source-files in the directories. If left 2.726 +# blank all files are included. 2.727 + 2.728 +EXAMPLE_PATTERNS = 2.729 + 2.730 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 2.731 +# searched for input files to be used with the \include or \dontinclude 2.732 +# commands irrespective of the value of the RECURSIVE tag. 2.733 +# Possible values are YES and NO. If left blank NO is used. 2.734 + 2.735 +EXAMPLE_RECURSIVE = NO 2.736 + 2.737 +# The IMAGE_PATH tag can be used to specify one or more files or 2.738 +# directories that contain image that are included in the documentation (see 2.739 +# the \image command). 2.740 + 2.741 +IMAGE_PATH = 2.742 + 2.743 +# The INPUT_FILTER tag can be used to specify a program that doxygen should 2.744 +# invoke to filter for each input file. Doxygen will invoke the filter program 2.745 +# by executing (via popen()) the command <filter> <input-file>, where <filter> 2.746 +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 2.747 +# input file. Doxygen will then use the output that the filter program writes 2.748 +# to standard output. 2.749 +# If FILTER_PATTERNS is specified, this tag will be 2.750 +# ignored. 2.751 + 2.752 +INPUT_FILTER = 2.753 + 2.754 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 2.755 +# basis. 2.756 +# Doxygen will compare the file name with each pattern and apply the 2.757 +# filter if there is a match. 2.758 +# The filters are a list of the form: 2.759 +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 2.760 +# info on how filters are used. If FILTER_PATTERNS is empty or if 2.761 +# non of the patterns match the file name, INPUT_FILTER is applied. 2.762 + 2.763 +FILTER_PATTERNS = 2.764 + 2.765 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 2.766 +# INPUT_FILTER) will be used to filter the input files when producing source 2.767 +# files to browse (i.e. when SOURCE_BROWSER is set to YES). 2.768 + 2.769 +FILTER_SOURCE_FILES = NO 2.770 + 2.771 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 2.772 +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 2.773 +# and it is also possible to disable source filtering for a specific pattern 2.774 +# using *.ext= (so without naming a filter). This option only has effect when 2.775 +# FILTER_SOURCE_FILES is enabled. 2.776 + 2.777 +FILTER_SOURCE_PATTERNS = 2.778 + 2.779 +#--------------------------------------------------------------------------- 2.780 +# configuration options related to source browsing 2.781 +#--------------------------------------------------------------------------- 2.782 + 2.783 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will 2.784 +# be generated. Documented entities will be cross-referenced with these sources. 2.785 +# Note: To get rid of all source code in the generated output, make sure also 2.786 +# VERBATIM_HEADERS is set to NO. 2.787 + 2.788 +SOURCE_BROWSER = NO 2.789 + 2.790 +# Setting the INLINE_SOURCES tag to YES will include the body 2.791 +# of functions and classes directly in the documentation. 2.792 + 2.793 +INLINE_SOURCES = NO 2.794 + 2.795 +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 2.796 +# doxygen to hide any special comment blocks from generated source code 2.797 +# fragments. Normal C, C++ and Fortran comments will always remain visible. 2.798 + 2.799 +STRIP_CODE_COMMENTS = YES 2.800 + 2.801 +# If the REFERENCED_BY_RELATION tag is set to YES 2.802 +# then for each documented function all documented 2.803 +# functions referencing it will be listed. 2.804 + 2.805 +REFERENCED_BY_RELATION = NO 2.806 + 2.807 +# If the REFERENCES_RELATION tag is set to YES 2.808 +# then for each documented function all documented entities 2.809 +# called/used by that function will be listed. 2.810 + 2.811 +REFERENCES_RELATION = NO 2.812 + 2.813 +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 2.814 +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 2.815 +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 2.816 +# link to the source code. 2.817 +# Otherwise they will link to the documentation. 2.818 + 2.819 +REFERENCES_LINK_SOURCE = YES 2.820 + 2.821 +# If the USE_HTAGS tag is set to YES then the references to source code 2.822 +# will point to the HTML generated by the htags(1) tool instead of doxygen 2.823 +# built-in source browser. The htags tool is part of GNU's global source 2.824 +# tagging system (see http://www.gnu.org/software/global/global.html). You 2.825 +# will need version 4.8.6 or higher. 2.826 + 2.827 +USE_HTAGS = NO 2.828 + 2.829 +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 2.830 +# will generate a verbatim copy of the header file for each class for 2.831 +# which an include is specified. Set to NO to disable this. 2.832 + 2.833 +VERBATIM_HEADERS = YES 2.834 + 2.835 +#--------------------------------------------------------------------------- 2.836 +# configuration options related to the alphabetical class index 2.837 +#--------------------------------------------------------------------------- 2.838 + 2.839 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 2.840 +# of all compounds will be generated. Enable this if the project 2.841 +# contains a lot of classes, structs, unions or interfaces. 2.842 + 2.843 +ALPHABETICAL_INDEX = YES 2.844 + 2.845 +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 2.846 +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 2.847 +# in which this list will be split (can be a number in the range [1..20]) 2.848 + 2.849 +COLS_IN_ALPHA_INDEX = 5 2.850 + 2.851 +# In case all classes in a project start with a common prefix, all 2.852 +# classes will be put under the same header in the alphabetical index. 2.853 +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 2.854 +# should be ignored while generating the index headers. 2.855 + 2.856 +IGNORE_PREFIX = 2.857 + 2.858 +#--------------------------------------------------------------------------- 2.859 +# configuration options related to the HTML output 2.860 +#--------------------------------------------------------------------------- 2.861 + 2.862 +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 2.863 +# generate HTML output. 2.864 + 2.865 +GENERATE_HTML = YES 2.866 + 2.867 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 2.868 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be 2.869 +# put in front of it. If left blank `html' will be used as the default path. 2.870 + 2.871 +HTML_OUTPUT = html 2.872 + 2.873 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 2.874 +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 2.875 +# doxygen will generate files with .html extension. 2.876 + 2.877 +HTML_FILE_EXTENSION = .html 2.878 + 2.879 +# The HTML_HEADER tag can be used to specify a personal HTML header for 2.880 +# each generated HTML page. If it is left blank doxygen will generate a 2.881 +# standard header. Note that when using a custom header you are responsible 2.882 +# for the proper inclusion of any scripts and style sheets that doxygen 2.883 +# needs, which is dependent on the configuration options used. 2.884 +# It is advised to generate a default header using "doxygen -w html 2.885 +# header.html footer.html stylesheet.css YourConfigFile" and then modify 2.886 +# that header. Note that the header is subject to change so you typically 2.887 +# have to redo this when upgrading to a newer version of doxygen or when 2.888 +# changing the value of configuration settings such as GENERATE_TREEVIEW! 2.889 + 2.890 +HTML_HEADER = 2.891 + 2.892 +# The HTML_FOOTER tag can be used to specify a personal HTML footer for 2.893 +# each generated HTML page. If it is left blank doxygen will generate a 2.894 +# standard footer. 2.895 + 2.896 +HTML_FOOTER = 2.897 + 2.898 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 2.899 +# style sheet that is used by each HTML page. It can be used to 2.900 +# fine-tune the look of the HTML output. If the tag is left blank doxygen 2.901 +# will generate a default style sheet. Note that doxygen will try to copy 2.902 +# the style sheet file to the HTML output directory, so don't put your own 2.903 +# style sheet in the HTML output directory as well, or it will be erased! 2.904 + 2.905 +HTML_STYLESHEET = 2.906 + 2.907 +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 2.908 +# other source files which should be copied to the HTML output directory. Note 2.909 +# that these files will be copied to the base HTML output directory. Use the 2.910 +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 2.911 +# files. In the HTML_STYLESHEET file, use the file name only. Also note that 2.912 +# the files will be copied as-is; there are no commands or markers available. 2.913 + 2.914 +HTML_EXTRA_FILES = 2.915 + 2.916 +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 2.917 +# Doxygen will adjust the colors in the style sheet and background images 2.918 +# according to this color. Hue is specified as an angle on a colorwheel, 2.919 +# see http://en.wikipedia.org/wiki/Hue for more information. 2.920 +# For instance the value 0 represents red, 60 is yellow, 120 is green, 2.921 +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 2.922 +# The allowed range is 0 to 359. 2.923 + 2.924 +HTML_COLORSTYLE_HUE = 220 2.925 + 2.926 +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 2.927 +# the colors in the HTML output. For a value of 0 the output will use 2.928 +# grayscales only. A value of 255 will produce the most vivid colors. 2.929 + 2.930 +HTML_COLORSTYLE_SAT = 100 2.931 + 2.932 +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 2.933 +# the luminance component of the colors in the HTML output. Values below 2.934 +# 100 gradually make the output lighter, whereas values above 100 make 2.935 +# the output darker. The value divided by 100 is the actual gamma applied, 2.936 +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 2.937 +# and 100 does not change the gamma. 2.938 + 2.939 +HTML_COLORSTYLE_GAMMA = 80 2.940 + 2.941 +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 2.942 +# page will contain the date and time when the page was generated. Setting 2.943 +# this to NO can help when comparing the output of multiple runs. 2.944 + 2.945 +HTML_TIMESTAMP = YES 2.946 + 2.947 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 2.948 +# documentation will contain sections that can be hidden and shown after the 2.949 +# page has loaded. 2.950 + 2.951 +HTML_DYNAMIC_SECTIONS = NO 2.952 + 2.953 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 2.954 +# entries shown in the various tree structured indices initially; the user 2.955 +# can expand and collapse entries dynamically later on. Doxygen will expand 2.956 +# the tree to such a level that at most the specified number of entries are 2.957 +# visible (unless a fully collapsed tree already exceeds this amount). 2.958 +# So setting the number of entries 1 will produce a full collapsed tree by 2.959 +# default. 0 is a special value representing an infinite number of entries 2.960 +# and will result in a full expanded tree by default. 2.961 + 2.962 +HTML_INDEX_NUM_ENTRIES = 100 2.963 + 2.964 +# If the GENERATE_DOCSET tag is set to YES, additional index files 2.965 +# will be generated that can be used as input for Apple's Xcode 3 2.966 +# integrated development environment, introduced with OSX 10.5 (Leopard). 2.967 +# To create a documentation set, doxygen will generate a Makefile in the 2.968 +# HTML output directory. Running make will produce the docset in that 2.969 +# directory and running "make install" will install the docset in 2.970 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 2.971 +# it at startup. 2.972 +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 2.973 +# for more information. 2.974 + 2.975 +GENERATE_DOCSET = NO 2.976 + 2.977 +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 2.978 +# feed. A documentation feed provides an umbrella under which multiple 2.979 +# documentation sets from a single provider (such as a company or product suite) 2.980 +# can be grouped. 2.981 + 2.982 +DOCSET_FEEDNAME = "Doxygen generated docs" 2.983 + 2.984 +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 2.985 +# should uniquely identify the documentation set bundle. This should be a 2.986 +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 2.987 +# will append .docset to the name. 2.988 + 2.989 +DOCSET_BUNDLE_ID = org.doxygen.Project 2.990 + 2.991 +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 2.992 +# the documentation publisher. This should be a reverse domain-name style 2.993 +# string, e.g. com.mycompany.MyDocSet.documentation. 2.994 + 2.995 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher 2.996 + 2.997 +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 2.998 + 2.999 +DOCSET_PUBLISHER_NAME = Publisher 2.1000 + 2.1001 +# If the GENERATE_HTMLHELP tag is set to YES, additional index files 2.1002 +# will be generated that can be used as input for tools like the 2.1003 +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 2.1004 +# of the generated HTML documentation. 2.1005 + 2.1006 +GENERATE_HTMLHELP = NO 2.1007 + 2.1008 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 2.1009 +# be used to specify the file name of the resulting .chm file. You 2.1010 +# can add a path in front of the file if the result should not be 2.1011 +# written to the html output directory. 2.1012 + 2.1013 +CHM_FILE = 2.1014 + 2.1015 +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 2.1016 +# be used to specify the location (absolute path including file name) of 2.1017 +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 2.1018 +# the HTML help compiler on the generated index.hhp. 2.1019 + 2.1020 +HHC_LOCATION = 2.1021 + 2.1022 +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 2.1023 +# controls if a separate .chi index file is generated (YES) or that 2.1024 +# it should be included in the master .chm file (NO). 2.1025 + 2.1026 +GENERATE_CHI = NO 2.1027 + 2.1028 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 2.1029 +# is used to encode HtmlHelp index (hhk), content (hhc) and project file 2.1030 +# content. 2.1031 + 2.1032 +CHM_INDEX_ENCODING = 2.1033 + 2.1034 +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 2.1035 +# controls whether a binary table of contents is generated (YES) or a 2.1036 +# normal table of contents (NO) in the .chm file. 2.1037 + 2.1038 +BINARY_TOC = NO 2.1039 + 2.1040 +# The TOC_EXPAND flag can be set to YES to add extra items for group members 2.1041 +# to the contents of the HTML help documentation and to the tree view. 2.1042 + 2.1043 +TOC_EXPAND = NO 2.1044 + 2.1045 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 2.1046 +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 2.1047 +# that can be used as input for Qt's qhelpgenerator to generate a 2.1048 +# Qt Compressed Help (.qch) of the generated HTML documentation. 2.1049 + 2.1050 +GENERATE_QHP = NO 2.1051 + 2.1052 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 2.1053 +# be used to specify the file name of the resulting .qch file. 2.1054 +# The path specified is relative to the HTML output folder. 2.1055 + 2.1056 +QCH_FILE = 2.1057 + 2.1058 +# The QHP_NAMESPACE tag specifies the namespace to use when generating 2.1059 +# Qt Help Project output. For more information please see 2.1060 +# http://doc.trolltech.com/qthelpproject.html#namespace 2.1061 + 2.1062 +QHP_NAMESPACE = org.doxygen.Project 2.1063 + 2.1064 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 2.1065 +# Qt Help Project output. For more information please see 2.1066 +# http://doc.trolltech.com/qthelpproject.html#virtual-folders 2.1067 + 2.1068 +QHP_VIRTUAL_FOLDER = doc 2.1069 + 2.1070 +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 2.1071 +# add. For more information please see 2.1072 +# http://doc.trolltech.com/qthelpproject.html#custom-filters 2.1073 + 2.1074 +QHP_CUST_FILTER_NAME = 2.1075 + 2.1076 +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 2.1077 +# custom filter to add. For more information please see 2.1078 +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 2.1079 +# Qt Help Project / Custom Filters</a>. 2.1080 + 2.1081 +QHP_CUST_FILTER_ATTRS = 2.1082 + 2.1083 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 2.1084 +# project's 2.1085 +# filter section matches. 2.1086 +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 2.1087 +# Qt Help Project / Filter Attributes</a>. 2.1088 + 2.1089 +QHP_SECT_FILTER_ATTRS = 2.1090 + 2.1091 +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 2.1092 +# be used to specify the location of Qt's qhelpgenerator. 2.1093 +# If non-empty doxygen will try to run qhelpgenerator on the generated 2.1094 +# .qhp file. 2.1095 + 2.1096 +QHG_LOCATION = 2.1097 + 2.1098 +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 2.1099 +# will be generated, which together with the HTML files, form an Eclipse help 2.1100 +# plugin. To install this plugin and make it available under the help contents 2.1101 +# menu in Eclipse, the contents of the directory containing the HTML and XML 2.1102 +# files needs to be copied into the plugins directory of eclipse. The name of 2.1103 +# the directory within the plugins directory should be the same as 2.1104 +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 2.1105 +# the help appears. 2.1106 + 2.1107 +GENERATE_ECLIPSEHELP = NO 2.1108 + 2.1109 +# A unique identifier for the eclipse help plugin. When installing the plugin 2.1110 +# the directory name containing the HTML and XML files should also have 2.1111 +# this name. 2.1112 + 2.1113 +ECLIPSE_DOC_ID = org.doxygen.Project 2.1114 + 2.1115 +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 2.1116 +# at top of each HTML page. The value NO (the default) enables the index and 2.1117 +# the value YES disables it. Since the tabs have the same information as the 2.1118 +# navigation tree you can set this option to NO if you already set 2.1119 +# GENERATE_TREEVIEW to YES. 2.1120 + 2.1121 +DISABLE_INDEX = NO 2.1122 + 2.1123 +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 2.1124 +# structure should be generated to display hierarchical information. 2.1125 +# If the tag value is set to YES, a side panel will be generated 2.1126 +# containing a tree-like index structure (just like the one that 2.1127 +# is generated for HTML Help). For this to work a browser that supports 2.1128 +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 2.1129 +# Windows users are probably better off using the HTML help feature. 2.1130 +# Since the tree basically has the same information as the tab index you 2.1131 +# could consider to set DISABLE_INDEX to NO when enabling this option. 2.1132 + 2.1133 +GENERATE_TREEVIEW = NO 2.1134 + 2.1135 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 2.1136 +# (range [0,1..20]) that doxygen will group on one line in the generated HTML 2.1137 +# documentation. Note that a value of 0 will completely suppress the enum 2.1138 +# values from appearing in the overview section. 2.1139 + 2.1140 +ENUM_VALUES_PER_LINE = 4 2.1141 + 2.1142 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 2.1143 +# used to set the initial width (in pixels) of the frame in which the tree 2.1144 +# is shown. 2.1145 + 2.1146 +TREEVIEW_WIDTH = 250 2.1147 + 2.1148 +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 2.1149 +# links to external symbols imported via tag files in a separate window. 2.1150 + 2.1151 +EXT_LINKS_IN_WINDOW = NO 2.1152 + 2.1153 +# Use this tag to change the font size of Latex formulas included 2.1154 +# as images in the HTML documentation. The default is 10. Note that 2.1155 +# when you change the font size after a successful doxygen run you need 2.1156 +# to manually remove any form_*.png images from the HTML output directory 2.1157 +# to force them to be regenerated. 2.1158 + 2.1159 +FORMULA_FONTSIZE = 10 2.1160 + 2.1161 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images 2.1162 +# generated for formulas are transparent PNGs. Transparent PNGs are 2.1163 +# not supported properly for IE 6.0, but are supported on all modern browsers. 2.1164 +# Note that when changing this option you need to delete any form_*.png files 2.1165 +# in the HTML output before the changes have effect. 2.1166 + 2.1167 +FORMULA_TRANSPARENT = YES 2.1168 + 2.1169 +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 2.1170 +# (see http://www.mathjax.org) which uses client side Javascript for the 2.1171 +# rendering instead of using prerendered bitmaps. Use this if you do not 2.1172 +# have LaTeX installed or if you want to formulas look prettier in the HTML 2.1173 +# output. When enabled you may also need to install MathJax separately and 2.1174 +# configure the path to it using the MATHJAX_RELPATH option. 2.1175 + 2.1176 +USE_MATHJAX = NO 2.1177 + 2.1178 +# When MathJax is enabled you need to specify the location relative to the 2.1179 +# HTML output directory using the MATHJAX_RELPATH option. The destination 2.1180 +# directory should contain the MathJax.js script. For instance, if the mathjax 2.1181 +# directory is located at the same level as the HTML output directory, then 2.1182 +# MATHJAX_RELPATH should be ../mathjax. The default value points to 2.1183 +# the MathJax Content Delivery Network so you can quickly see the result without 2.1184 +# installing MathJax. 2.1185 +# However, it is strongly recommended to install a local 2.1186 +# copy of MathJax from http://www.mathjax.org before deployment. 2.1187 + 2.1188 +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 2.1189 + 2.1190 +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 2.1191 +# names that should be enabled during MathJax rendering. 2.1192 + 2.1193 +MATHJAX_EXTENSIONS = 2.1194 + 2.1195 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box 2.1196 +# for the HTML output. The underlying search engine uses javascript 2.1197 +# and DHTML and should work on any modern browser. Note that when using 2.1198 +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 2.1199 +# (GENERATE_DOCSET) there is already a search function so this one should 2.1200 +# typically be disabled. For large projects the javascript based search engine 2.1201 +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 2.1202 + 2.1203 +SEARCHENGINE = YES 2.1204 + 2.1205 +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 2.1206 +# implemented using a PHP enabled web server instead of at the web client 2.1207 +# using Javascript. Doxygen will generate the search PHP script and index 2.1208 +# file to put on the web server. The advantage of the server 2.1209 +# based approach is that it scales better to large projects and allows 2.1210 +# full text search. The disadvantages are that it is more difficult to setup 2.1211 +# and does not have live searching capabilities. 2.1212 + 2.1213 +SERVER_BASED_SEARCH = NO 2.1214 + 2.1215 +#--------------------------------------------------------------------------- 2.1216 +# configuration options related to the LaTeX output 2.1217 +#--------------------------------------------------------------------------- 2.1218 + 2.1219 +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 2.1220 +# generate Latex output. 2.1221 + 2.1222 +GENERATE_LATEX = YES 2.1223 + 2.1224 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 2.1225 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be 2.1226 +# put in front of it. If left blank `latex' will be used as the default path. 2.1227 + 2.1228 +LATEX_OUTPUT = latex 2.1229 + 2.1230 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 2.1231 +# invoked. If left blank `latex' will be used as the default command name. 2.1232 +# Note that when enabling USE_PDFLATEX this option is only used for 2.1233 +# generating bitmaps for formulas in the HTML output, but not in the 2.1234 +# Makefile that is written to the output directory. 2.1235 + 2.1236 +LATEX_CMD_NAME = latex 2.1237 + 2.1238 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 2.1239 +# generate index for LaTeX. If left blank `makeindex' will be used as the 2.1240 +# default command name. 2.1241 + 2.1242 +MAKEINDEX_CMD_NAME = makeindex 2.1243 + 2.1244 +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 2.1245 +# LaTeX documents. This may be useful for small projects and may help to 2.1246 +# save some trees in general. 2.1247 + 2.1248 +COMPACT_LATEX = NO 2.1249 + 2.1250 +# The PAPER_TYPE tag can be used to set the paper type that is used 2.1251 +# by the printer. Possible values are: a4, letter, legal and 2.1252 +# executive. If left blank a4wide will be used. 2.1253 + 2.1254 +PAPER_TYPE = a4 2.1255 + 2.1256 +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 2.1257 +# packages that should be included in the LaTeX output. 2.1258 + 2.1259 +EXTRA_PACKAGES = 2.1260 + 2.1261 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 2.1262 +# the generated latex document. The header should contain everything until 2.1263 +# the first chapter. If it is left blank doxygen will generate a 2.1264 +# standard header. Notice: only use this tag if you know what you are doing! 2.1265 + 2.1266 +LATEX_HEADER = 2.1267 + 2.1268 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 2.1269 +# the generated latex document. The footer should contain everything after 2.1270 +# the last chapter. If it is left blank doxygen will generate a 2.1271 +# standard footer. Notice: only use this tag if you know what you are doing! 2.1272 + 2.1273 +LATEX_FOOTER = 2.1274 + 2.1275 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 2.1276 +# is prepared for conversion to pdf (using ps2pdf). The pdf file will 2.1277 +# contain links (just like the HTML output) instead of page references 2.1278 +# This makes the output suitable for online browsing using a pdf viewer. 2.1279 + 2.1280 +PDF_HYPERLINKS = YES 2.1281 + 2.1282 +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 2.1283 +# plain latex in the generated Makefile. Set this option to YES to get a 2.1284 +# higher quality PDF documentation. 2.1285 + 2.1286 +USE_PDFLATEX = YES 2.1287 + 2.1288 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 2.1289 +# command to the generated LaTeX files. This will instruct LaTeX to keep 2.1290 +# running if errors occur, instead of asking the user for help. 2.1291 +# This option is also used when generating formulas in HTML. 2.1292 + 2.1293 +LATEX_BATCHMODE = NO 2.1294 + 2.1295 +# If LATEX_HIDE_INDICES is set to YES then doxygen will not 2.1296 +# include the index chapters (such as File Index, Compound Index, etc.) 2.1297 +# in the output. 2.1298 + 2.1299 +LATEX_HIDE_INDICES = NO 2.1300 + 2.1301 +# If LATEX_SOURCE_CODE is set to YES then doxygen will include 2.1302 +# source code with syntax highlighting in the LaTeX output. 2.1303 +# Note that which sources are shown also depends on other settings 2.1304 +# such as SOURCE_BROWSER. 2.1305 + 2.1306 +LATEX_SOURCE_CODE = NO 2.1307 + 2.1308 +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 2.1309 +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 2.1310 +# http://en.wikipedia.org/wiki/BibTeX for more info. 2.1311 + 2.1312 +LATEX_BIB_STYLE = plain 2.1313 + 2.1314 +#--------------------------------------------------------------------------- 2.1315 +# configuration options related to the RTF output 2.1316 +#--------------------------------------------------------------------------- 2.1317 + 2.1318 +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 2.1319 +# The RTF output is optimized for Word 97 and may not look very pretty with 2.1320 +# other RTF readers or editors. 2.1321 + 2.1322 +GENERATE_RTF = NO 2.1323 + 2.1324 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 2.1325 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be 2.1326 +# put in front of it. If left blank `rtf' will be used as the default path. 2.1327 + 2.1328 +RTF_OUTPUT = rtf 2.1329 + 2.1330 +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 2.1331 +# RTF documents. This may be useful for small projects and may help to 2.1332 +# save some trees in general. 2.1333 + 2.1334 +COMPACT_RTF = NO 2.1335 + 2.1336 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 2.1337 +# will contain hyperlink fields. The RTF file will 2.1338 +# contain links (just like the HTML output) instead of page references. 2.1339 +# This makes the output suitable for online browsing using WORD or other 2.1340 +# programs which support those fields. 2.1341 +# Note: wordpad (write) and others do not support links. 2.1342 + 2.1343 +RTF_HYPERLINKS = NO 2.1344 + 2.1345 +# Load style sheet definitions from file. Syntax is similar to doxygen's 2.1346 +# config file, i.e. a series of assignments. You only have to provide 2.1347 +# replacements, missing definitions are set to their default value. 2.1348 + 2.1349 +RTF_STYLESHEET_FILE = 2.1350 + 2.1351 +# Set optional variables used in the generation of an rtf document. 2.1352 +# Syntax is similar to doxygen's config file. 2.1353 + 2.1354 +RTF_EXTENSIONS_FILE = 2.1355 + 2.1356 +#--------------------------------------------------------------------------- 2.1357 +# configuration options related to the man page output 2.1358 +#--------------------------------------------------------------------------- 2.1359 + 2.1360 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 2.1361 +# generate man pages 2.1362 + 2.1363 +GENERATE_MAN = NO 2.1364 + 2.1365 +# The MAN_OUTPUT tag is used to specify where the man pages will be put. 2.1366 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be 2.1367 +# put in front of it. If left blank `man' will be used as the default path. 2.1368 + 2.1369 +MAN_OUTPUT = man 2.1370 + 2.1371 +# The MAN_EXTENSION tag determines the extension that is added to 2.1372 +# the generated man pages (default is the subroutine's section .3) 2.1373 + 2.1374 +MAN_EXTENSION = .3 2.1375 + 2.1376 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 2.1377 +# then it will generate one additional man file for each entity 2.1378 +# documented in the real man page(s). These additional files 2.1379 +# only source the real man page, but without them the man command 2.1380 +# would be unable to find the correct page. The default is NO. 2.1381 + 2.1382 +MAN_LINKS = NO 2.1383 + 2.1384 +#--------------------------------------------------------------------------- 2.1385 +# configuration options related to the XML output 2.1386 +#--------------------------------------------------------------------------- 2.1387 + 2.1388 +# If the GENERATE_XML tag is set to YES Doxygen will 2.1389 +# generate an XML file that captures the structure of 2.1390 +# the code including all documentation. 2.1391 + 2.1392 +GENERATE_XML = NO 2.1393 + 2.1394 +# The XML_OUTPUT tag is used to specify where the XML pages will be put. 2.1395 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be 2.1396 +# put in front of it. If left blank `xml' will be used as the default path. 2.1397 + 2.1398 +XML_OUTPUT = xml 2.1399 + 2.1400 +# The XML_SCHEMA tag can be used to specify an XML schema, 2.1401 +# which can be used by a validating XML parser to check the 2.1402 +# syntax of the XML files. 2.1403 + 2.1404 +XML_SCHEMA = 2.1405 + 2.1406 +# The XML_DTD tag can be used to specify an XML DTD, 2.1407 +# which can be used by a validating XML parser to check the 2.1408 +# syntax of the XML files. 2.1409 + 2.1410 +XML_DTD = 2.1411 + 2.1412 +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 2.1413 +# dump the program listings (including syntax highlighting 2.1414 +# and cross-referencing information) to the XML output. Note that 2.1415 +# enabling this will significantly increase the size of the XML output. 2.1416 + 2.1417 +XML_PROGRAMLISTING = YES 2.1418 + 2.1419 +#--------------------------------------------------------------------------- 2.1420 +# configuration options for the AutoGen Definitions output 2.1421 +#--------------------------------------------------------------------------- 2.1422 + 2.1423 +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 2.1424 +# generate an AutoGen Definitions (see autogen.sf.net) file 2.1425 +# that captures the structure of the code including all 2.1426 +# documentation. Note that this feature is still experimental 2.1427 +# and incomplete at the moment. 2.1428 + 2.1429 +GENERATE_AUTOGEN_DEF = NO 2.1430 + 2.1431 +#--------------------------------------------------------------------------- 2.1432 +# configuration options related to the Perl module output 2.1433 +#--------------------------------------------------------------------------- 2.1434 + 2.1435 +# If the GENERATE_PERLMOD tag is set to YES Doxygen will 2.1436 +# generate a Perl module file that captures the structure of 2.1437 +# the code including all documentation. Note that this 2.1438 +# feature is still experimental and incomplete at the 2.1439 +# moment. 2.1440 + 2.1441 +GENERATE_PERLMOD = NO 2.1442 + 2.1443 +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 2.1444 +# the necessary Makefile rules, Perl scripts and LaTeX code to be able 2.1445 +# to generate PDF and DVI output from the Perl module output. 2.1446 + 2.1447 +PERLMOD_LATEX = NO 2.1448 + 2.1449 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 2.1450 +# nicely formatted so it can be parsed by a human reader. 2.1451 +# This is useful 2.1452 +# if you want to understand what is going on. 2.1453 +# On the other hand, if this 2.1454 +# tag is set to NO the size of the Perl module output will be much smaller 2.1455 +# and Perl will parse it just the same. 2.1456 + 2.1457 +PERLMOD_PRETTY = YES 2.1458 + 2.1459 +# The names of the make variables in the generated doxyrules.make file 2.1460 +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 2.1461 +# This is useful so different doxyrules.make files included by the same 2.1462 +# Makefile don't overwrite each other's variables. 2.1463 + 2.1464 +PERLMOD_MAKEVAR_PREFIX = 2.1465 + 2.1466 +#--------------------------------------------------------------------------- 2.1467 +# Configuration options related to the preprocessor 2.1468 +#--------------------------------------------------------------------------- 2.1469 + 2.1470 +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 2.1471 +# evaluate all C-preprocessor directives found in the sources and include 2.1472 +# files. 2.1473 + 2.1474 +ENABLE_PREPROCESSING = YES 2.1475 + 2.1476 +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 2.1477 +# names in the source code. If set to NO (the default) only conditional 2.1478 +# compilation will be performed. Macro expansion can be done in a controlled 2.1479 +# way by setting EXPAND_ONLY_PREDEF to YES. 2.1480 + 2.1481 +MACRO_EXPANSION = NO 2.1482 + 2.1483 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 2.1484 +# then the macro expansion is limited to the macros specified with the 2.1485 +# PREDEFINED and EXPAND_AS_DEFINED tags. 2.1486 + 2.1487 +EXPAND_ONLY_PREDEF = NO 2.1488 + 2.1489 +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 2.1490 +# pointed to by INCLUDE_PATH will be searched when a #include is found. 2.1491 + 2.1492 +SEARCH_INCLUDES = YES 2.1493 + 2.1494 +# The INCLUDE_PATH tag can be used to specify one or more directories that 2.1495 +# contain include files that are not input files but should be processed by 2.1496 +# the preprocessor. 2.1497 + 2.1498 +INCLUDE_PATH = 2.1499 + 2.1500 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2.1501 +# patterns (like *.h and *.hpp) to filter out the header-files in the 2.1502 +# directories. If left blank, the patterns specified with FILE_PATTERNS will 2.1503 +# be used. 2.1504 + 2.1505 +INCLUDE_FILE_PATTERNS = 2.1506 + 2.1507 +# The PREDEFINED tag can be used to specify one or more macro names that 2.1508 +# are defined before the preprocessor is started (similar to the -D option of 2.1509 +# gcc). The argument of the tag is a list of macros of the form: name 2.1510 +# or name=definition (no spaces). If the definition and the = are 2.1511 +# omitted =1 is assumed. To prevent a macro definition from being 2.1512 +# undefined via #undef or recursively expanded use the := operator 2.1513 +# instead of the = operator. 2.1514 + 2.1515 +PREDEFINED = 2.1516 + 2.1517 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 2.1518 +# this tag can be used to specify a list of macro names that should be expanded. 2.1519 +# The macro definition that is found in the sources will be used. 2.1520 +# Use the PREDEFINED tag if you want to use a different macro definition that 2.1521 +# overrules the definition found in the source code. 2.1522 + 2.1523 +EXPAND_AS_DEFINED = 2.1524 + 2.1525 +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 2.1526 +# doxygen's preprocessor will remove all references to function-like macros 2.1527 +# that are alone on a line, have an all uppercase name, and do not end with a 2.1528 +# semicolon, because these will confuse the parser if not removed. 2.1529 + 2.1530 +SKIP_FUNCTION_MACROS = YES 2.1531 + 2.1532 +#--------------------------------------------------------------------------- 2.1533 +# Configuration::additions related to external references 2.1534 +#--------------------------------------------------------------------------- 2.1535 + 2.1536 +# The TAGFILES option can be used to specify one or more tagfiles. For each 2.1537 +# tag file the location of the external documentation should be added. The 2.1538 +# format of a tag file without this location is as follows: 2.1539 +# 2.1540 +# TAGFILES = file1 file2 ... 2.1541 +# Adding location for the tag files is done as follows: 2.1542 +# 2.1543 +# TAGFILES = file1=loc1 "file2 = loc2" ... 2.1544 +# where "loc1" and "loc2" can be relative or absolute paths 2.1545 +# or URLs. Note that each tag file must have a unique name (where the name does 2.1546 +# NOT include the path). If a tag file is not located in the directory in which 2.1547 +# doxygen is run, you must also specify the path to the tagfile here. 2.1548 + 2.1549 +TAGFILES = 2.1550 + 2.1551 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create 2.1552 +# a tag file that is based on the input files it reads. 2.1553 + 2.1554 +GENERATE_TAGFILE = 2.1555 + 2.1556 +# If the ALLEXTERNALS tag is set to YES all external classes will be listed 2.1557 +# in the class index. If set to NO only the inherited external classes 2.1558 +# will be listed. 2.1559 + 2.1560 +ALLEXTERNALS = NO 2.1561 + 2.1562 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 2.1563 +# in the modules index. If set to NO, only the current project's groups will 2.1564 +# be listed. 2.1565 + 2.1566 +EXTERNAL_GROUPS = YES 2.1567 + 2.1568 +# The PERL_PATH should be the absolute path and name of the perl script 2.1569 +# interpreter (i.e. the result of `which perl'). 2.1570 + 2.1571 +PERL_PATH = /usr/bin/perl 2.1572 + 2.1573 +#--------------------------------------------------------------------------- 2.1574 +# Configuration options related to the dot tool 2.1575 +#--------------------------------------------------------------------------- 2.1576 + 2.1577 +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 2.1578 +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 2.1579 +# or super classes. Setting the tag to NO turns the diagrams off. Note that 2.1580 +# this option also works with HAVE_DOT disabled, but it is recommended to 2.1581 +# install and use dot, since it yields more powerful graphs. 2.1582 + 2.1583 +CLASS_DIAGRAMS = YES 2.1584 + 2.1585 +# You can define message sequence charts within doxygen comments using the \msc 2.1586 +# command. Doxygen will then run the mscgen tool (see 2.1587 +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 2.1588 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where 2.1589 +# the mscgen tool resides. If left empty the tool is assumed to be found in the 2.1590 +# default search path. 2.1591 + 2.1592 +MSCGEN_PATH = 2.1593 + 2.1594 +# If set to YES, the inheritance and collaboration graphs will hide 2.1595 +# inheritance and usage relations if the target is undocumented 2.1596 +# or is not a class. 2.1597 + 2.1598 +HIDE_UNDOC_RELATIONS = YES 2.1599 + 2.1600 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2.1601 +# available from the path. This tool is part of Graphviz, a graph visualization 2.1602 +# toolkit from AT&T and Lucent Bell Labs. The other options in this section 2.1603 +# have no effect if this option is set to NO (the default) 2.1604 + 2.1605 +HAVE_DOT = NO 2.1606 + 2.1607 +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 2.1608 +# allowed to run in parallel. When set to 0 (the default) doxygen will 2.1609 +# base this on the number of processors available in the system. You can set it 2.1610 +# explicitly to a value larger than 0 to get control over the balance 2.1611 +# between CPU load and processing speed. 2.1612 + 2.1613 +DOT_NUM_THREADS = 0 2.1614 + 2.1615 +# By default doxygen will use the Helvetica font for all dot files that 2.1616 +# doxygen generates. When you want a differently looking font you can specify 2.1617 +# the font name using DOT_FONTNAME. You need to make sure dot is able to find 2.1618 +# the font, which can be done by putting it in a standard location or by setting 2.1619 +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 2.1620 +# directory containing the font. 2.1621 + 2.1622 +DOT_FONTNAME = Helvetica 2.1623 + 2.1624 +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 2.1625 +# The default size is 10pt. 2.1626 + 2.1627 +DOT_FONTSIZE = 10 2.1628 + 2.1629 +# By default doxygen will tell dot to use the Helvetica font. 2.1630 +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 2.1631 +# set the path where dot can find it. 2.1632 + 2.1633 +DOT_FONTPATH = 2.1634 + 2.1635 +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 2.1636 +# will generate a graph for each documented class showing the direct and 2.1637 +# indirect inheritance relations. Setting this tag to YES will force the 2.1638 +# CLASS_DIAGRAMS tag to NO. 2.1639 + 2.1640 +CLASS_GRAPH = YES 2.1641 + 2.1642 +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 2.1643 +# will generate a graph for each documented class showing the direct and 2.1644 +# indirect implementation dependencies (inheritance, containment, and 2.1645 +# class references variables) of the class with other documented classes. 2.1646 + 2.1647 +COLLABORATION_GRAPH = YES 2.1648 + 2.1649 +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 2.1650 +# will generate a graph for groups, showing the direct groups dependencies 2.1651 + 2.1652 +GROUP_GRAPHS = YES 2.1653 + 2.1654 +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 2.1655 +# collaboration diagrams in a style similar to the OMG's Unified Modeling 2.1656 +# Language. 2.1657 + 2.1658 +UML_LOOK = NO 2.1659 + 2.1660 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside 2.1661 +# the class node. If there are many fields or methods and many nodes the 2.1662 +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 2.1663 +# threshold limits the number of items for each type to make the size more 2.1664 +# managable. Set this to 0 for no limit. Note that the threshold may be 2.1665 +# exceeded by 50% before the limit is enforced. 2.1666 + 2.1667 +UML_LIMIT_NUM_FIELDS = 10 2.1668 + 2.1669 +# If set to YES, the inheritance and collaboration graphs will show the 2.1670 +# relations between templates and their instances. 2.1671 + 2.1672 +TEMPLATE_RELATIONS = NO 2.1673 + 2.1674 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 2.1675 +# tags are set to YES then doxygen will generate a graph for each documented 2.1676 +# file showing the direct and indirect include dependencies of the file with 2.1677 +# other documented files. 2.1678 + 2.1679 +INCLUDE_GRAPH = YES 2.1680 + 2.1681 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 2.1682 +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 2.1683 +# documented header file showing the documented files that directly or 2.1684 +# indirectly include this file. 2.1685 + 2.1686 +INCLUDED_BY_GRAPH = YES 2.1687 + 2.1688 +# If the CALL_GRAPH and HAVE_DOT options are set to YES then 2.1689 +# doxygen will generate a call dependency graph for every global function 2.1690 +# or class method. Note that enabling this option will significantly increase 2.1691 +# the time of a run. So in most cases it will be better to enable call graphs 2.1692 +# for selected functions only using the \callgraph command. 2.1693 + 2.1694 +CALL_GRAPH = NO 2.1695 + 2.1696 +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 2.1697 +# doxygen will generate a caller dependency graph for every global function 2.1698 +# or class method. Note that enabling this option will significantly increase 2.1699 +# the time of a run. So in most cases it will be better to enable caller 2.1700 +# graphs for selected functions only using the \callergraph command. 2.1701 + 2.1702 +CALLER_GRAPH = NO 2.1703 + 2.1704 +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 2.1705 +# will generate a graphical hierarchy of all classes instead of a textual one. 2.1706 + 2.1707 +GRAPHICAL_HIERARCHY = YES 2.1708 + 2.1709 +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 2.1710 +# then doxygen will show the dependencies a directory has on other directories 2.1711 +# in a graphical way. The dependency relations are determined by the #include 2.1712 +# relations between the files in the directories. 2.1713 + 2.1714 +DIRECTORY_GRAPH = YES 2.1715 + 2.1716 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2.1717 +# generated by dot. Possible values are svg, png, jpg, or gif. 2.1718 +# If left blank png will be used. If you choose svg you need to set 2.1719 +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 2.1720 +# visible in IE 9+ (other browsers do not have this requirement). 2.1721 + 2.1722 +DOT_IMAGE_FORMAT = png 2.1723 + 2.1724 +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2.1725 +# enable generation of interactive SVG images that allow zooming and panning. 2.1726 +# Note that this requires a modern browser other than Internet Explorer. 2.1727 +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 2.1728 +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 2.1729 +# visible. Older versions of IE do not have SVG support. 2.1730 + 2.1731 +INTERACTIVE_SVG = NO 2.1732 + 2.1733 +# The tag DOT_PATH can be used to specify the path where the dot tool can be 2.1734 +# found. If left blank, it is assumed the dot tool can be found in the path. 2.1735 + 2.1736 +DOT_PATH = 2.1737 + 2.1738 +# The DOTFILE_DIRS tag can be used to specify one or more directories that 2.1739 +# contain dot files that are included in the documentation (see the 2.1740 +# \dotfile command). 2.1741 + 2.1742 +DOTFILE_DIRS = 2.1743 + 2.1744 +# The MSCFILE_DIRS tag can be used to specify one or more directories that 2.1745 +# contain msc files that are included in the documentation (see the 2.1746 +# \mscfile command). 2.1747 + 2.1748 +MSCFILE_DIRS = 2.1749 + 2.1750 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 2.1751 +# nodes that will be shown in the graph. If the number of nodes in a graph 2.1752 +# becomes larger than this value, doxygen will truncate the graph, which is 2.1753 +# visualized by representing a node as a red box. Note that doxygen if the 2.1754 +# number of direct children of the root node in a graph is already larger than 2.1755 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 2.1756 +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2.1757 + 2.1758 +DOT_GRAPH_MAX_NODES = 50 2.1759 + 2.1760 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 2.1761 +# graphs generated by dot. A depth value of 3 means that only nodes reachable 2.1762 +# from the root by following a path via at most 3 edges will be shown. Nodes 2.1763 +# that lay further from the root node will be omitted. Note that setting this 2.1764 +# option to 1 or 2 may greatly reduce the computation time needed for large 2.1765 +# code bases. Also note that the size of a graph can be further restricted by 2.1766 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2.1767 + 2.1768 +MAX_DOT_GRAPH_DEPTH = 0 2.1769 + 2.1770 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2.1771 +# background. This is disabled by default, because dot on Windows does not 2.1772 +# seem to support this out of the box. Warning: Depending on the platform used, 2.1773 +# enabling this option may lead to badly anti-aliased labels on the edges of 2.1774 +# a graph (i.e. they become hard to read). 2.1775 + 2.1776 +DOT_TRANSPARENT = NO 2.1777 + 2.1778 +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 2.1779 +# files in one run (i.e. multiple -o and -T options on the command line). This 2.1780 +# makes dot run faster, but since only newer versions of dot (>1.8.10) 2.1781 +# support this, this feature is disabled by default. 2.1782 + 2.1783 +DOT_MULTI_TARGETS = NO 2.1784 + 2.1785 +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 2.1786 +# generate a legend page explaining the meaning of the various boxes and 2.1787 +# arrows in the dot generated graphs. 2.1788 + 2.1789 +GENERATE_LEGEND = YES 2.1790 + 2.1791 +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 2.1792 +# remove the intermediate dot files that are used to generate 2.1793 +# the various graphs. 2.1794 + 2.1795 +DOT_CLEANUP = YES
3.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 3.2 +++ b/docs/mainpage.dox Mon May 27 16:59:04 2013 -0500 3.3 @@ -0,0 +1,13 @@ 3.4 +/** 3.5 + \mainpage arda::Math 3.6 + 3.7 + \section Overview 3.8 + 3.9 + A 3D math library for games. 3.10 + 3.11 + This library is not (yet?) trying to be a highly optimized system. Rather it is inteded to be simple to understandf an use. Design goals include 3.12 + 3.13 + - Mimicing the standard mathematical notation as closely as possible. 3.14 + - Using templates to keep generated code size to a minimum. 3.15 + 3.16 +*/
4.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 4.2 +++ b/docs/namespaces.dox Mon May 27 16:59:04 2013 -0500 4.3 @@ -0,0 +1,10 @@ 4.4 +/** \namespace arda 4.5 + * 4.6 + * General purpose namespace containing all aspects of the4 Arda engine. 4.7 + */ 4.8 + 4.9 +/** \namespace arda::Math 4.10 + * 4.11 + * All math related code lives here. 4.12 + */ 4.13 +
5.1 --- a/include/Vector.h Mon May 27 00:53:55 2013 -0500 5.2 +++ b/include/Vector.h Mon May 27 16:59:04 2013 -0500 5.3 @@ -13,99 +13,70 @@ 5.4 namespace Math 5.5 { 5.6 //////////////////////////////////////////////////////////////////////////////// 5.7 - // Vectors 5.8 - // 5.9 - // Templated classes for 2, 3, and 4 dimensional vectors of any type, 5.10 - // although these types are really intended to be int, float, and double 5.11 - // only. (i.e. if you roll your own base type, it had better act like 5.12 - // a numeric scalar.) 5.13 - // 5.14 - // Supported operations on vectors 5.15 - // 5.16 - // Construction 5.17 - // Vector v; // Default zero vector. 5.18 - // Vector v2(v); // Construct from other vector. 5.19 - // T a, b; 5.20 - // Vector v(a, b) // Construct from values. 5.21 - // [] 5.22 - // If you have a Vector named v you can access it's member elements as 5.23 - // v[0], v[1], v[2], and v[3]. in addtion to v.x, v.y, v.z, and v.w 5.24 - // == != + += - -= 5.25 - // Defined for operations on two vectors of the same type. 5.26 - // TODO Is there a better way to do this? With integer types this is fine, 5.27 - // but with floating point types this == and != are really worthless. Is it possible to 5.28 - // create variant methods in a template class that vary by the type? Or do I just have 5.29 - // to suck it up and create type specific external functions for comparing vectors? 5.30 - // * *= / /= 5.31 - // Defined for scalar multiplication/division with int, float, and double. 5.32 - // * is defined as a standalone template operator for the scalar * Vector form. 5.33 - // assign(T a, T b [, T b [, T d]]) 5.34 - // Directly assign values to the vector. 5.35 - // cross(Vector3& v2) 5.36 - // cross(Vector3& v2, Vector3& vres) 5.37 - // Cross product of the vector with v2. Only defined for Vector3 types. 5.38 - // The version that takes two arguments stores the result in the second 5.39 - // argument. This may be faster since no temporary object is created 5.40 - // during the operation. 5.41 - // dot(Vector& v2) 5.42 - // The dot product of the vector with v2. 5.43 - // get_angle(Vector& v2) 5.44 - // Returns the angle (in radians) between the vector and v2. 5.45 - // Not meaningful for int vectors. 5.46 - // get_anglen(Vector& v2) 5.47 - // Like get_angle(), but the vectors must already be normalized. 5.48 - // Not meaningful for int vectors. 5.49 - // to_string(std::string & s) 5.50 - // Returns a C string representation of the vector. 5.51 - // This is one of the few non-inline Vector functions. 5.52 - // length() 5.53 - // Get the length of a vector. 5.54 - // Returns a double for all vector types. 5.55 - // normalize() 5.56 - // Normalizes the vector. 5.57 - // Not meaningful for int vectors. 5.58 - // proj(Vector& v2, Vector& vres) 5.59 - // Calculates the projection of the vector onto v2 and returns the result 5.60 - // in vres. 5.61 - // Not meaningful for int vectors. 5.62 - // Returns vres. 5.63 - // 5.64 - // 5.65 - // Note that the following typedefs are defined for convenience: 5.66 - // 5.67 - // typedef Vector2<int> Vector2i; 5.68 - // typedef Vector2<float> Vector2f; 5.69 - // typedef Vector2<double> Vector2d; 5.70 - // typedef Vector3<int> Vector3i; 5.71 - // typedef Vector3<float> Vector3f; 5.72 - // typedef Vector3<double> Vector3d; 5.73 - // typedef Vector4<int> Vector4i; 5.74 - // typedef Vector4<float> Vector4f; 5.75 - // typedef Vector4<double> Vector4d; 5.76 - // 5.77 - // 5.78 - // 5.79 - // Scalar multiplication and division are overloaded. Why? 5.80 - // I'm not sure I need this. The idea is to support all likely scalar 5.81 - // types without having to rely on implicit or explicit type conversion, 5.82 - // especially not a conversion that might result in loss of precision. 5.83 - // Multiplying a float Vector by a double scalar, for example. 5.84 - // 5.85 - // Is there a better way to do this? Am I worrying about nothing? 5.86 - // 5.87 - // 5.88 - // 5.89 - // I suppose I could make this into a single Vector template on two parameters 5.90 - // template <typename T, unsigned int N> class Vector 5.91 - // { 5.92 - // T v[N]; 5.93 - // 5.94 - // etc... 5.95 - // 5.96 - // This might buy perfect generality, but it would come at the expense of 5.97 - // loops in all of the code, so I don't think it would really be worth it. 5.98 - 5.99 - 5.100 + /** \class arda::Math::Vector2 5.101 + * 5.102 + * \brief Templated classes for 2, 3, and 4 dimensional vectors. 5.103 + * 5.104 + * \tparam T Type is intended to be int, float, and double only. (i.e. if you roll your own base type, it had better act like a numeric scalar.) 5.105 + * 5.106 + * \verbatim 5.107 + * Supported operations on vectors 5.108 + * 5.109 + * Construction 5.110 + * Vector v; * Default zero vector. 5.111 + * Vector v2(v); * Construct from other vector. 5.112 + * T a, b; 5.113 + * Vector v(a, b) * Construct from values. 5.114 + * [] 5.115 + * If you have a Vector named v you can access it's member elements as 5.116 + * v[0], v[1], v[2], and v[3]. in addtion to v.x, v.y, v.z, and v.w 5.117 + * == != + += - -= 5.118 + * Defined for operations on two vectors of the same type. 5.119 + * TODO Is there a better way to do this? With integer types this is fine, 5.120 + * but with floating point types this == and != are really worthless. Is it possible to 5.121 + * create variant methods in a template class that vary by the type? Or do I just have 5.122 + * to suck it up and create type specific external functions for comparing vectors? 5.123 + * * *= / /= 5.124 + * Defined for scalar multiplication/division with int, float, and double. 5.125 + * * is defined as a standalone template operator for the scalar * Vector form. 5.126 + * 5.127 + * Note that the following typedefs are defined for convenience: 5.128 + * 5.129 + * typedef Vector2<int> Vector2i; 5.130 + * typedef Vector2<float> Vector2f; 5.131 + * typedef Vector2<double> Vector2d; 5.132 + * typedef Vector3<int> Vector3i; 5.133 + * typedef Vector3<float> Vector3f; 5.134 + * typedef Vector3<double> Vector3d; 5.135 + * typedef Vector4<int> Vector4i; 5.136 + * typedef Vector4<float> Vector4f; 5.137 + * typedef Vector4<double> Vector4d; 5.138 + * 5.139 + * 5.140 + * 5.141 + * Scalar multiplication and division are overloaded. Why? 5.142 + * I'm not sure I need this. The idea is to support all likely scalar 5.143 + * types without having to rely on implicit or explicit type conversion, 5.144 + * especially not a conversion that might result in loss of precision. 5.145 + * Multiplying a float Vector by a double scalar, for example. 5.146 + * 5.147 + * Is there a better way to do this? Am I worrying about nothing? 5.148 + * 5.149 + * 5.150 + * 5.151 + * I suppose I could make this into a single Vector template on two parameters 5.152 + * template <typename T, unsigned int N> class Vector 5.153 + * { 5.154 + * T v[N]; 5.155 + * 5.156 + * etc... 5.157 + * 5.158 + * This might buy perfect generality, but it would come at the expense of 5.159 + * loops in all of the code, so I don't think it would really be worth it. 5.160 + * 5.161 + * \endverbatim 5.162 + */ 5.163 + 5.164 ///////////////////////////////////////////////////////////////////////////// 5.165 template <typename T> 5.166 class Vector2 5.167 @@ -127,6 +98,12 @@ 5.168 // Assignment 5.169 inline Vector2<T>& operator=(Vector2<T> const & v2) 5.170 { x = v2.x; y = v2.y; return *this; } 5.171 + 5.172 + /** \brief Directly assign values to the vector. 5.173 + * 5.174 + * Takes 2, 3, or 4 arguments of template type T according to the size of the Vector. 5.175 + */ 5.176 + 5.177 inline Vector2<T>& assign(T const a, T const b) 5.178 { x = a; y = b; return *this; } 5.179 5.180 @@ -181,23 +158,40 @@ 5.181 5.182 // methods 5.183 5.184 + /** \brief The dot product of the vector with v2. 5.185 + */ 5.186 inline T dot(Vector2<T> const & v2) const 5.187 { return x*v2.x + y*v2.y; } 5.188 5.189 + 5.190 + /** \brief Returns the angle (in radians) between the vector and v2. Not meaningful for int vectors. 5.191 + */ 5.192 inline double get_angle(Vector2<T> const & v2) 5.193 { 5.194 double tmp = dot(v2); 5.195 return acos(sqrt(tmp*tmp/(dot(*this)*v2.dot(v2)))); 5.196 } 5.197 5.198 + 5.199 + /** \brief Like get_angle(), but the vectors must already be normalized. Not meaningful for int vectors. 5.200 + */ 5.201 inline double get_anglen(Vector2<T> const & v2) 5.202 { return acos((double) dot(v2)); } 5.203 5.204 + 5.205 + /** \brief Returns a C string representation of the vector. This is one of the few non-inline Vector functions. 5.206 + */ 5.207 std::string to_string(void) const; 5.208 5.209 + 5.210 + /** \brief Get the length of a vector. Returns a double for all vector types. 5.211 + */ 5.212 inline double length(void) const 5.213 { return sqrt((dot(*this))); } 5.214 5.215 + 5.216 + /** \brief Normalizes the vector. Not meaningful for int vectors. 5.217 + */ 5.218 inline Vector2<T>& normalize() 5.219 { 5.220 double l = length(); 5.221 @@ -205,9 +199,14 @@ 5.222 x /= l; y /= l; 5.223 return *this; } 5.224 5.225 + /** \brief Calculates the projection of the vector onto v2. Not meaningful for int vectors. 5.226 + */ 5.227 inline Vector2<T> proj(Vector2<T> const & v2) 5.228 { Vector2<T> vres; vres = v2 * (dot(v2)/v2.dot(v2)); return vres; } 5.229 - inline Vector2<T>& proj(Vector2<T> const & v2, Vector2<T>& vres) 5.230 + /** \copybrief arda::Math::Vector2::proj 5.231 + * Returns result in vres 5.232 + */ 5.233 + inline Vector2<T>& proj(Vector2<T> const & v2, Vector2<T>& vres) 5.234 { vres = v2 * dot(v2)/v2.dot(v2); return vres; } 5.235 }; 5.236 5.237 @@ -226,6 +225,9 @@ 5.238 5.239 5.240 ///////////////////////////////////////////////////////////////////////////// 5.241 + /** \class arda::Math::Vector3 5.242 + * \copydoc arda::Math::Vector2 5.243 + */ 5.244 template <typename T> 5.245 class Vector3 5.246 { 5.247 @@ -250,6 +252,7 @@ 5.248 inline Vector3<T>& operator=(Vector3<T> const & v2) 5.249 { x = v2.x; y = v2.y; z = v2.z; return *this; } 5.250 5.251 + /** \copydoc arda::Math::Vector2::assign */ 5.252 inline Vector3<T>& assign(T const a, T const b, T const c) 5.253 { x = a; y = b; z = c; return *this; } 5.254 5.255 @@ -304,6 +307,12 @@ 5.256 5.257 // methods 5.258 5.259 + /** \brief Cross product of the vector with another Vector. Result returned in vres. 5.260 + * 5.261 + * The version that takes two arguments stores the result in the second 5.262 + * argument. This may be faster since no temporary object is created 5.263 + * during the operation. 5.264 + */ 5.265 inline Vector3<T>& cross(Vector3<T> const & v2, Vector3<T>& vres) 5.266 { 5.267 vres.x = y*v2.z - v2.y*z; 5.268 @@ -311,6 +320,8 @@ 5.269 vres.z = x*v2.y - v2.x*y; 5.270 return vres; 5.271 } 5.272 + /** \brief Cross product of the vector with another Vector. 5.273 + * \copydetails arda::Math::Vector3::cross */ 5.274 inline Vector3<T> cross(Vector3<T> const & v2) 5.275 { 5.276 Vector3<T> vres; 5.277 @@ -320,28 +331,38 @@ 5.278 return vres; 5.279 } 5.280 5.281 + /** \copydoc arda::Math::Vector2::dot */ 5.282 inline T dot(Vector3<T> const & v2) const 5.283 { return x*v2.x + y*v2.y + z*v2.z; } 5.284 5.285 + /** \copydoc arda::Math::Vector2::get_angle */ 5.286 inline double get_angle(Vector3<T> const & v2) 5.287 { 5.288 double tmp = dot(v2); 5.289 return acos(sqrt(tmp*tmp/(dot(*this)*v2.dot(v2)))); 5.290 } 5.291 5.292 + /** \copydoc arda::Math::Vector2::get_anglen */ 5.293 inline double get_anglen(Vector3<T> const & v2) 5.294 { return acos((double) dot(v2)); } 5.295 5.296 + /** \copydoc arda::Math::Vector2::to_string */ 5.297 std::string to_string(void) const; 5.298 5.299 + /** \copydoc arda::Math::Vector2::length */ 5.300 inline double length(void) const 5.301 { return sqrt((dot(*this))); } 5.302 5.303 + /** \copydoc arda::Math::Vector2::normalize */ 5.304 inline Vector3<T>& normalize() 5.305 { double l = length(); if (l == 0.0) return *this; x /= l; y /= l; z /= l; return *this; } 5.306 5.307 + /** \copydoc arda::Math::Vector2::proj */ 5.308 inline Vector3<T> proj(Vector3<T> const & v2) 5.309 { Vector3<T> vres; vres = v2 * dot(v2)/v2.dot(v2); return vres; } 5.310 + /** \copybrief arda::Math::Vector2::proj 5.311 + * Returns result in vres 5.312 + */ 5.313 inline Vector3<T>& proj(Vector3<T> const & v2, Vector3<T>& vres) 5.314 { vres = v2 * dot(v2)/v2.dot(v2); return vres; } 5.315 }; 5.316 @@ -360,6 +381,9 @@ 5.317 { return Vector3<T>(v) *= a;} 5.318 5.319 ///////////////////////////////////////////////////////////////////////////// 5.320 + /** \class arda::Math::Vector4 5.321 + * \copydoc arda::Math::Vector2 5.322 + */ 5.323 template <typename T> 5.324 class Vector4 5.325 { 5.326 @@ -387,6 +411,7 @@ 5.327 inline Vector4<T>& operator=(Vector4<T> const & v2) 5.328 { x = v2.x; y = v2.y; z = v2.z; w = v2.w; return *this; } 5.329 5.330 + /** \copydoc arda::Math::Vector2::assign */ 5.331 inline Vector4<T>& assign(T const a, T const b, T const c, T const d) 5.332 { x = a; y = b; z = c; w = d; return *this; } 5.333 5.334 @@ -441,28 +466,38 @@ 5.335 5.336 // methods 5.337 5.338 + /** \copydoc arda::Math::Vector2::dot */ 5.339 inline T dot(Vector4<T> const & v2) const 5.340 { return x*v2.x + y*v2.y + z*v2.z + w*v2.w; } 5.341 5.342 + /** \copydoc arda::Math::Vector2::get_angle */ 5.343 inline double get_angle(Vector4<T> const & v2) 5.344 { 5.345 double tmp = dot(v2); 5.346 return acos(sqrt(tmp*tmp/(dot(*this)*v2.dot(v2)))); 5.347 } 5.348 5.349 + /** \copydoc arda::Math::Vector2::get_anglen */ 5.350 inline double get_anglen(Vector4<T> const & v2) 5.351 { return acos((double) dot(v2)); } 5.352 5.353 + /** \copydoc arda::Math::Vector2::to_string */ 5.354 std::string to_string(void) const; 5.355 5.356 + /** \copydoc arda::Math::Vector2::length */ 5.357 inline double length(void) const 5.358 { return sqrt((dot(*this))); } 5.359 5.360 + /** \copydoc arda::Math::Vector2::normalize */ 5.361 inline Vector4<T>& normalize() 5.362 { double l = length(); if (l == 0.0) return *this; x /= l; y /= l; z /= l; w /= l; return *this; } 5.363 5.364 + /** \copydoc arda::Math::Vector2::proj */ 5.365 inline Vector4<T> proj(Vector4<T> const & v2) 5.366 { Vector4<T> vres; vres = v2 * dot(v2)/v2.dot(v2); return vres; } 5.367 + /** \copybrief arda::Math::Vector2::proj 5.368 + * Returns result in vres 5.369 + */ 5.370 inline Vector4<T>& proj(Vector4<T> const & v2, Vector4<T>& vres) 5.371 { vres = v2 * dot(v2)/v2.dot(v2); return vres; } 5.372 };