├── .gitignore ├── .travis.yml ├── CMakeLists.txt ├── LICENSE ├── README.md ├── doc ├── Doxyfile ├── Makefile ├── index.md ├── static │ ├── logo-48x48.png │ └── logo.png └── tutorial.md ├── include └── ooduck │ ├── _defs │ ├── collection.h │ ├── hashmap.h │ ├── iterable.h │ ├── list.h │ ├── object.h │ ├── singleton.h │ ├── string.h │ └── value.h │ ├── _priv │ ├── collection.h │ ├── hashmap.h │ ├── iterable.h │ ├── list.h │ ├── object.h │ ├── singleton.h │ ├── string.h │ └── value.h │ ├── asprintf.h │ ├── collection.h │ ├── define.h │ ├── e4c.h │ ├── exceptions.h │ ├── hashmap.h │ ├── iterable.h │ ├── list.h │ ├── object.h │ ├── singleton.h │ ├── string.h │ └── value.h ├── src ├── asprintf.c ├── collection.c ├── config.h.in ├── e4c.c ├── exceptions.c ├── hashmap.c ├── iterable.c ├── list.c ├── object.c ├── singleton.c ├── string.c └── value.c └── test └── main.c /.gitignore: -------------------------------------------------------------------------------- 1 | config.h 2 | *.o 3 | ooduck-example 4 | libooduck.so 5 | __build__ 6 | html -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | 3 | language: c 4 | compiler: 5 | - gcc 6 | - clang 7 | 8 | addons: 9 | apt: 10 | packages: 11 | - cmake 12 | 13 | install: 14 | - cmake . -DWITH_DEBUG=1 15 | - make 16 | 17 | script: 18 | - make test 19 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required (VERSION 2.6) 2 | 3 | # Project meta informations 4 | project (OODuck) 5 | set (OODUCK_AUTHOR "David Delassus ") 6 | set (OODUCK_PACKAGE_NAME "OODuck") 7 | set (OODUCK_VERSION_MAJOR 0) 8 | set (OODUCK_VERSION_MINOR 4) 9 | set (OODUCK_VERSION_PATCH 1) 10 | set (OODUCK_LICENSE "MIT") 11 | 12 | # Build configuration 13 | set (CMAKE_C_FLAGS "--std=c99 -Wall -O2") 14 | 15 | if (WITH_PTHREAD) 16 | set (CMAKE_C_FLAGS "-DHAVE_PTHREAD -DE4C_THREADSAFE -lpthread") 17 | endif (WITH_PTHREAD) 18 | 19 | if (WITH_DEBUG) 20 | set (CMAKE_BUILD_TYPE DEBUG) 21 | set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -g") 22 | else (WITH_DEBUG) 23 | set (CMAKE_BUILD_TYPE RELEASE) 24 | endif (WITH_DEBUG) 25 | 26 | message ("!! Build type: ${CMAKE_BUILD_TYPE}") 27 | message ("!! CFLAGS: ${CMAKE_C_FLAGS}") 28 | 29 | configure_file ( 30 | "${PROJECT_SOURCE_DIR}/src/config.h.in" 31 | "${PROJECT_BINARY_DIR}/generated/ooduck/config.h" 32 | ) 33 | 34 | include_directories ( 35 | "${PROJECT_SOURCE_DIR}/include" 36 | "${PROJECT_BINARY_DIR}/generated" 37 | ) 38 | 39 | add_library (ooduck SHARED 40 | "${PROJECT_SOURCE_DIR}/src/asprintf.c" 41 | "${PROJECT_SOURCE_DIR}/src/e4c.c" 42 | "${PROJECT_SOURCE_DIR}/src/exceptions.c" 43 | "${PROJECT_SOURCE_DIR}/src/object.c" 44 | "${PROJECT_SOURCE_DIR}/src/singleton.c" 45 | "${PROJECT_SOURCE_DIR}/src/value.c" 46 | "${PROJECT_SOURCE_DIR}/src/string.c" 47 | "${PROJECT_SOURCE_DIR}/src/iterable.c" 48 | "${PROJECT_SOURCE_DIR}/src/collection.c" 49 | "${PROJECT_SOURCE_DIR}/src/hashmap.c" 50 | "${PROJECT_SOURCE_DIR}/src/list.c" 51 | ) 52 | 53 | if (WITH_DEBUG) 54 | add_executable (ooduck-example "${PROJECT_SOURCE_DIR}/test/main.c") 55 | target_link_libraries (ooduck-example ooduck) 56 | 57 | enable_testing() 58 | add_test (ooduck-test ooduck-example) 59 | endif (WITH_DEBUG) 60 | 61 | # Deployment configuration 62 | 63 | install (TARGETS ooduck DESTINATION lib) 64 | 65 | set (HEADERS 66 | "${PROJECT_BINARY_DIR}/generated/ooduck/config.h" 67 | "${PROJECT_SOURCE_DIR}/include/ooduck/asprintf.h" 68 | "${PROJECT_SOURCE_DIR}/include/ooduck/e4c.h" 69 | "${PROJECT_SOURCE_DIR}/include/ooduck/exceptions.h" 70 | "${PROJECT_SOURCE_DIR}/include/ooduck/define.h" 71 | "${PROJECT_SOURCE_DIR}/include/ooduck/object.h" 72 | "${PROJECT_SOURCE_DIR}/include/ooduck/_defs/object.h" 73 | "${PROJECT_SOURCE_DIR}/include/ooduck/_priv/object.h" 74 | "${PROJECT_SOURCE_DIR}/include/ooduck/singleton.h" 75 | "${PROJECT_SOURCE_DIR}/include/ooduck/_defs/singleton.h" 76 | "${PROJECT_SOURCE_DIR}/include/ooduck/_priv/singleton.h" 77 | "${PROJECT_SOURCE_DIR}/include/ooduck/value.h" 78 | "${PROJECT_SOURCE_DIR}/include/ooduck/_defs/value.h" 79 | "${PROJECT_SOURCE_DIR}/include/ooduck/_priv/value.h" 80 | "${PROJECT_SOURCE_DIR}/include/ooduck/string.h" 81 | "${PROJECT_SOURCE_DIR}/include/ooduck/_defs/string.h" 82 | "${PROJECT_SOURCE_DIR}/include/ooduck/_priv/string.h" 83 | "${PROJECT_SOURCE_DIR}/include/ooduck/iterable.h" 84 | "${PROJECT_SOURCE_DIR}/include/ooduck/_defs/iterable.h" 85 | "${PROJECT_SOURCE_DIR}/include/ooduck/_priv/iterable.h" 86 | "${PROJECT_SOURCE_DIR}/include/ooduck/collection.h" 87 | "${PROJECT_SOURCE_DIR}/include/ooduck/_defs/collection.h" 88 | "${PROJECT_SOURCE_DIR}/include/ooduck/_priv/collection.h" 89 | "${PROJECT_SOURCE_DIR}/include/ooduck/hashmap.h" 90 | "${PROJECT_SOURCE_DIR}/include/ooduck/_defs/hashmap.h" 91 | "${PROJECT_SOURCE_DIR}/include/ooduck/_priv/hashmap.h" 92 | "${PROJECT_SOURCE_DIR}/include/ooduck/list.h" 93 | "${PROJECT_SOURCE_DIR}/include/ooduck/_defs/list.h" 94 | "${PROJECT_SOURCE_DIR}/include/ooduck/_priv/list.h" 95 | ) 96 | 97 | install (FILES ${HEADERS} DESTINATION include/ooduck) -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (C) 2015 David Delassus 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in 11 | all copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 19 | THE SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OODuck 2 | 3 | ![ ](doc/static/logo.png) 4 | 5 | [![Travis-CI build](https://travis-ci.org/linkdd/ooduck.svg)](https://travis-ci.org/linkdd/ooduck) 6 | 7 | OODuck is an **O**bject **O**riented framework in C with **D**uck typing support. 8 | 9 | It is inspired of the famous [ooc.pdf](http://www.cs.rit.edu/~ats/books/ooc.pdf) 10 | and is using [exceptions4c](https://github.com/guillermocalvo/exceptions4c) 11 | 12 | ## Build library 13 | 14 | Build system is based on CMake: 15 | 16 | $ mkdir __build__ && cd __build__ 17 | $ cmake .. 18 | $ make 19 | 20 | With multi-threading support: 21 | 22 | $ mkdir __build__ && cd __build__ 23 | $ cmake .. -DWITH_PTHREAD=1 24 | $ make 25 | 26 | Or in debug mode: 27 | 28 | $ mkdir __build__ && cd __build__ 29 | $ cmake .. -DWITH_DEBUG=1 30 | $ make 31 | 32 | ## Installation 33 | 34 | Once the project is built, you can install it: 35 | 36 | $ make install 37 | 38 | To change default installation location, run ``cmake`` with the following option: 39 | 40 | $ cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/usr 41 | 42 | To install in another directory: 43 | 44 | $ make install DESTDIR=/opt/fakeroot 45 | 46 | ## Documentation 47 | 48 | To build documentation, you will need ``doxygen`` installed: 49 | 50 | $ cd doc 51 | $ make 52 | 53 | Then, open the file ``doc/html/index.html`` in your browser. 54 | 55 | Or, take a look at the [online documentation](https://linkdd.github.io/ooduck/) 56 | 57 | ## License 58 | 59 | OODuck is released under the terms of the MIT license. See the LICENSE file for details. 60 | -------------------------------------------------------------------------------- /doc/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.9.1 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = OODuck 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 0.5 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = "C Oriented Object framework with duck-typing support" 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = ../../doc 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = "The $name class" \ 122 | "The $name widget" \ 123 | "The $name file" \ 124 | is \ 125 | provides \ 126 | specifies \ 127 | contains \ 128 | represents \ 129 | a \ 130 | an \ 131 | the 132 | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 | # doxygen will generate a detailed section even if there is only a brief 135 | # description. 136 | # The default value is: NO. 137 | 138 | ALWAYS_DETAILED_SEC = NO 139 | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 | # inherited members of a class in the documentation of that class as if those 142 | # members were ordinary class members. Constructors, destructors and assignment 143 | # operators of the base classes will not be shown. 144 | # The default value is: NO. 145 | 146 | INLINE_INHERITED_MEMB = NO 147 | 148 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149 | # before files name in the file list and in the header files. If set to NO the 150 | # shortest path that makes the file name unique will be used 151 | # The default value is: YES. 152 | 153 | FULL_PATH_NAMES = YES 154 | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 | # Stripping is only done if one of the specified strings matches the left-hand 157 | # part of the path. The tag can be used to show relative paths in the file list. 158 | # If left blank the directory from which doxygen is run is used as the path to 159 | # strip. 160 | # 161 | # Note that you can specify absolute paths here, but also relative paths, which 162 | # will be relative from the directory where doxygen is started. 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 | 165 | STRIP_FROM_PATH = 166 | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 | # path mentioned in the documentation of a class, which tells the reader which 169 | # header file to include in order to use a class. If left blank only the name of 170 | # the header file containing the class definition is used. Otherwise one should 171 | # specify the list of include paths that are normally passed to the compiler 172 | # using the -I flag. 173 | 174 | STRIP_FROM_INC_PATH = 175 | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 | # less readable) file names. This can be useful is your file systems doesn't 178 | # support long names like on DOS, Mac, or CD-ROM. 179 | # The default value is: NO. 180 | 181 | SHORT_NAMES = NO 182 | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 | # first line (until the first dot) of a Javadoc-style comment as the brief 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 | # style comments (thus requiring an explicit @brief command for a brief 187 | # description.) 188 | # The default value is: NO. 189 | 190 | JAVADOC_AUTOBRIEF = NO 191 | 192 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193 | # line (until the first dot) of a Qt-style comment as the brief description. If 194 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195 | # requiring an explicit \brief command for a brief description.) 196 | # The default value is: NO. 197 | 198 | QT_AUTOBRIEF = NO 199 | 200 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202 | # a brief description. This used to be the default behavior. The new default is 203 | # to treat a multi-line C++ comment block as a detailed description. Set this 204 | # tag to YES if you prefer the old behavior instead. 205 | # 206 | # Note that setting this tag to YES also means that rational rose comments are 207 | # not recognized any more. 208 | # The default value is: NO. 209 | 210 | MULTILINE_CPP_IS_BRIEF = NO 211 | 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213 | # documentation from any documented member that it re-implements. 214 | # The default value is: YES. 215 | 216 | INHERIT_DOCS = YES 217 | 218 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 219 | # page for each member. If set to NO, the documentation of a member will be part 220 | # of the file/class/namespace that contains it. 221 | # The default value is: NO. 222 | 223 | SEPARATE_MEMBER_PAGES = NO 224 | 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226 | # uses this value to replace tabs by spaces in code fragments. 227 | # Minimum value: 1, maximum value: 16, default value: 4. 228 | 229 | TAB_SIZE = 4 230 | 231 | # This tag can be used to specify a number of aliases that act as commands in 232 | # the documentation. An alias has the form: 233 | # name=value 234 | # For example adding 235 | # "sideeffect=@par Side Effects:\n" 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the 237 | # documentation, which will result in a user-defined paragraph with heading 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert 239 | # newlines. 240 | 241 | ALIASES = 242 | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" 245 | # will allow you to use the command class in the itcl::class meaning. 246 | 247 | TCL_SUBST = 248 | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 | # only. Doxygen will then generate output that is more tailored for C. For 251 | # instance, some of the names that are used will be different. The list of all 252 | # members will be omitted, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_FOR_C = NO 256 | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 | # Python sources only. Doxygen will then generate output that is more tailored 259 | # for that language. For instance, namespaces will be presented as packages, 260 | # qualified scopes will look different, etc. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_OUTPUT_JAVA = NO 264 | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 | # sources. Doxygen will then generate output that is tailored for Fortran. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_FOR_FORTRAN = NO 270 | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 | # sources. Doxygen will then generate output that is tailored for VHDL. 273 | # The default value is: NO. 274 | 275 | OPTIMIZE_OUTPUT_VHDL = NO 276 | 277 | # Doxygen selects the parser to use depending on the extension of the files it 278 | # parses. With this tag you can assign which parser to use for a given 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it 280 | # using this tag. The format is ext=language, where ext is a file extension, and 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 | # 289 | # Note: For files without extension you can use no_extension as a placeholder. 290 | # 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 | # the files are not read by doxygen. 293 | 294 | EXTENSION_MAPPING = 295 | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 | # according to the Markdown format, which allows for more readable 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 | # The output of markdown processing is further processed by doxygen, so you can 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 | # case of backward compatibilities issues. 302 | # The default value is: YES. 303 | 304 | MARKDOWN_SUPPORT = YES 305 | 306 | # When enabled doxygen tries to link words that correspond to documented 307 | # classes, or namespaces to their corresponding documentation. Such a link can 308 | # be prevented in individual cases by putting a % sign in front of the word or 309 | # globally by setting AUTOLINK_SUPPORT to NO. 310 | # The default value is: YES. 311 | 312 | AUTOLINK_SUPPORT = YES 313 | 314 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 315 | # to include (a tag file for) the STL sources as input, then you should set this 316 | # tag to YES in order to let doxygen match functions declarations and 317 | # definitions whose arguments contain STL classes (e.g. func(std::string); 318 | # versus func(std::string) {}). This also make the inheritance and collaboration 319 | # diagrams that involve STL classes more complete and accurate. 320 | # The default value is: NO. 321 | 322 | BUILTIN_STL_SUPPORT = NO 323 | 324 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 325 | # enable parsing support. 326 | # The default value is: NO. 327 | 328 | CPP_CLI_SUPPORT = NO 329 | 330 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 331 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 332 | # will parse them like normal C++ but will assume all classes use public instead 333 | # of private inheritance when no explicit protection keyword is present. 334 | # The default value is: NO. 335 | 336 | SIP_SUPPORT = NO 337 | 338 | # For Microsoft's IDL there are propget and propput attributes to indicate 339 | # getter and setter methods for a property. Setting this option to YES will make 340 | # doxygen to replace the get and set methods by a property in the documentation. 341 | # This will only work if the methods are indeed getting or setting a simple 342 | # type. If this is not the case, or you want to show the methods anyway, you 343 | # should set this option to NO. 344 | # The default value is: YES. 345 | 346 | IDL_PROPERTY_SUPPORT = YES 347 | 348 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 349 | # tag is set to YES then doxygen will reuse the documentation of the first 350 | # member in the group (if any) for the other members of the group. By default 351 | # all members of a group must be documented explicitly. 352 | # The default value is: NO. 353 | 354 | DISTRIBUTE_GROUP_DOC = NO 355 | 356 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 357 | # (for instance a group of public functions) to be put as a subgroup of that 358 | # type (e.g. under the Public Functions section). Set it to NO to prevent 359 | # subgrouping. Alternatively, this can be done per class using the 360 | # \nosubgrouping command. 361 | # The default value is: YES. 362 | 363 | SUBGROUPING = YES 364 | 365 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 366 | # are shown inside the group in which they are included (e.g. using \ingroup) 367 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 368 | # and RTF). 369 | # 370 | # Note that this feature does not work in combination with 371 | # SEPARATE_MEMBER_PAGES. 372 | # The default value is: NO. 373 | 374 | INLINE_GROUPED_CLASSES = NO 375 | 376 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 377 | # with only public data fields or simple typedef fields will be shown inline in 378 | # the documentation of the scope in which they are defined (i.e. file, 379 | # namespace, or group documentation), provided this scope is documented. If set 380 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 381 | # Man pages) or section (for LaTeX and RTF). 382 | # The default value is: NO. 383 | 384 | INLINE_SIMPLE_STRUCTS = NO 385 | 386 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 387 | # enum is documented as struct, union, or enum with the name of the typedef. So 388 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 389 | # with name TypeT. When disabled the typedef will appear as a member of a file, 390 | # namespace, or class. And the struct will be named TypeS. This can typically be 391 | # useful for C code in case the coding convention dictates that all compound 392 | # types are typedef'ed and only the typedef is referenced, never the tag name. 393 | # The default value is: NO. 394 | 395 | TYPEDEF_HIDES_STRUCT = YES 396 | 397 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 398 | # cache is used to resolve symbols given their name and scope. Since this can be 399 | # an expensive process and often the same symbol appears multiple times in the 400 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 401 | # doxygen will become slower. If the cache is too large, memory is wasted. The 402 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 403 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 404 | # symbols. At the end of a run doxygen will report the cache usage and suggest 405 | # the optimal cache size from a speed point of view. 406 | # Minimum value: 0, maximum value: 9, default value: 0. 407 | 408 | LOOKUP_CACHE_SIZE = 0 409 | 410 | #--------------------------------------------------------------------------- 411 | # Build related configuration options 412 | #--------------------------------------------------------------------------- 413 | 414 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 415 | # documentation are documented, even if no documentation was available. Private 416 | # class members and static file members will be hidden unless the 417 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 418 | # Note: This will also disable the warnings about undocumented members that are 419 | # normally produced when WARNINGS is set to YES. 420 | # The default value is: NO. 421 | 422 | EXTRACT_ALL = NO 423 | 424 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 425 | # be included in the documentation. 426 | # The default value is: NO. 427 | 428 | EXTRACT_PRIVATE = NO 429 | 430 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 431 | # scope will be included in the documentation. 432 | # The default value is: NO. 433 | 434 | EXTRACT_PACKAGE = YES 435 | 436 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 437 | # included in the documentation. 438 | # The default value is: NO. 439 | 440 | EXTRACT_STATIC = NO 441 | 442 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 443 | # locally in source files will be included in the documentation. If set to NO, 444 | # only classes defined in header files are included. Does not have any effect 445 | # for Java sources. 446 | # The default value is: YES. 447 | 448 | EXTRACT_LOCAL_CLASSES = YES 449 | 450 | # This flag is only useful for Objective-C code. If set to YES, local methods, 451 | # which are defined in the implementation section but not in the interface are 452 | # included in the documentation. If set to NO, only methods in the interface are 453 | # included. 454 | # The default value is: NO. 455 | 456 | EXTRACT_LOCAL_METHODS = NO 457 | 458 | # If this flag is set to YES, the members of anonymous namespaces will be 459 | # extracted and appear in the documentation as a namespace called 460 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 461 | # the file that contains the anonymous namespace. By default anonymous namespace 462 | # are hidden. 463 | # The default value is: NO. 464 | 465 | EXTRACT_ANON_NSPACES = NO 466 | 467 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 468 | # undocumented members inside documented classes or files. If set to NO these 469 | # members will be included in the various overviews, but no documentation 470 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 471 | # The default value is: NO. 472 | 473 | HIDE_UNDOC_MEMBERS = YES 474 | 475 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 476 | # undocumented classes that are normally visible in the class hierarchy. If set 477 | # to NO, these classes will be included in the various overviews. This option 478 | # has no effect if EXTRACT_ALL is enabled. 479 | # The default value is: NO. 480 | 481 | HIDE_UNDOC_CLASSES = YES 482 | 483 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 484 | # (class|struct|union) declarations. If set to NO, these declarations will be 485 | # included in the documentation. 486 | # The default value is: NO. 487 | 488 | HIDE_FRIEND_COMPOUNDS = NO 489 | 490 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 491 | # documentation blocks found inside the body of a function. If set to NO, these 492 | # blocks will be appended to the function's detailed documentation block. 493 | # The default value is: NO. 494 | 495 | HIDE_IN_BODY_DOCS = NO 496 | 497 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 498 | # \internal command is included. If the tag is set to NO then the documentation 499 | # will be excluded. Set it to YES to include the internal documentation. 500 | # The default value is: NO. 501 | 502 | INTERNAL_DOCS = NO 503 | 504 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 505 | # names in lower-case letters. If set to YES, upper-case letters are also 506 | # allowed. This is useful if you have classes or files whose names only differ 507 | # in case and if your file system supports case sensitive file names. Windows 508 | # and Mac users are advised to set this option to NO. 509 | # The default value is: system dependent. 510 | 511 | CASE_SENSE_NAMES = NO 512 | 513 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 514 | # their full class and namespace scopes in the documentation. If set to YES, the 515 | # scope will be hidden. 516 | # The default value is: NO. 517 | 518 | HIDE_SCOPE_NAMES = NO 519 | 520 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 521 | # append additional text to a page's title, such as Class Reference. If set to 522 | # YES the compound reference will be hidden. 523 | # The default value is: NO. 524 | 525 | HIDE_COMPOUND_REFERENCE= NO 526 | 527 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 528 | # the files that are included by a file in the documentation of that file. 529 | # The default value is: YES. 530 | 531 | SHOW_INCLUDE_FILES = NO 532 | 533 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 534 | # grouped member an include statement to the documentation, telling the reader 535 | # which file to include in order to use the member. 536 | # The default value is: NO. 537 | 538 | SHOW_GROUPED_MEMB_INC = NO 539 | 540 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 541 | # files with double quotes in the documentation rather than with sharp brackets. 542 | # The default value is: NO. 543 | 544 | FORCE_LOCAL_INCLUDES = NO 545 | 546 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 547 | # documentation for inline members. 548 | # The default value is: YES. 549 | 550 | INLINE_INFO = YES 551 | 552 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 553 | # (detailed) documentation of file and class members alphabetically by member 554 | # name. If set to NO, the members will appear in declaration order. 555 | # The default value is: YES. 556 | 557 | SORT_MEMBER_DOCS = YES 558 | 559 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 560 | # descriptions of file, namespace and class members alphabetically by member 561 | # name. If set to NO, the members will appear in declaration order. Note that 562 | # this will also influence the order of the classes in the class list. 563 | # The default value is: NO. 564 | 565 | SORT_BRIEF_DOCS = NO 566 | 567 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 568 | # (brief and detailed) documentation of class members so that constructors and 569 | # destructors are listed first. If set to NO the constructors will appear in the 570 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 571 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 572 | # member documentation. 573 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 574 | # detailed member documentation. 575 | # The default value is: NO. 576 | 577 | SORT_MEMBERS_CTORS_1ST = NO 578 | 579 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 580 | # of group names into alphabetical order. If set to NO the group names will 581 | # appear in their defined order. 582 | # The default value is: NO. 583 | 584 | SORT_GROUP_NAMES = NO 585 | 586 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 587 | # fully-qualified names, including namespaces. If set to NO, the class list will 588 | # be sorted only by class name, not including the namespace part. 589 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 590 | # Note: This option applies only to the class list, not to the alphabetical 591 | # list. 592 | # The default value is: NO. 593 | 594 | SORT_BY_SCOPE_NAME = NO 595 | 596 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 597 | # type resolution of all parameters of a function it will reject a match between 598 | # the prototype and the implementation of a member function even if there is 599 | # only one candidate or it is obvious which candidate to choose by doing a 600 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 601 | # accept a match between prototype and implementation in such cases. 602 | # The default value is: NO. 603 | 604 | STRICT_PROTO_MATCHING = NO 605 | 606 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 607 | # list. This list is created by putting \todo commands in the documentation. 608 | # The default value is: YES. 609 | 610 | GENERATE_TODOLIST = YES 611 | 612 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 613 | # list. This list is created by putting \test commands in the documentation. 614 | # The default value is: YES. 615 | 616 | GENERATE_TESTLIST = YES 617 | 618 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 619 | # list. This list is created by putting \bug commands in the documentation. 620 | # The default value is: YES. 621 | 622 | GENERATE_BUGLIST = YES 623 | 624 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 625 | # the deprecated list. This list is created by putting \deprecated commands in 626 | # the documentation. 627 | # The default value is: YES. 628 | 629 | GENERATE_DEPRECATEDLIST= YES 630 | 631 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 632 | # sections, marked by \if ... \endif and \cond 633 | # ... \endcond blocks. 634 | 635 | ENABLED_SECTIONS = 636 | 637 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 638 | # initial value of a variable or macro / define can have for it to appear in the 639 | # documentation. If the initializer consists of more lines than specified here 640 | # it will be hidden. Use a value of 0 to hide initializers completely. The 641 | # appearance of the value of individual variables and macros / defines can be 642 | # controlled using \showinitializer or \hideinitializer command in the 643 | # documentation regardless of this setting. 644 | # Minimum value: 0, maximum value: 10000, default value: 30. 645 | 646 | MAX_INITIALIZER_LINES = 30 647 | 648 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 649 | # the bottom of the documentation of classes and structs. If set to YES, the 650 | # list will mention the files that were used to generate the documentation. 651 | # The default value is: YES. 652 | 653 | SHOW_USED_FILES = NO 654 | 655 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 656 | # will remove the Files entry from the Quick Index and from the Folder Tree View 657 | # (if specified). 658 | # The default value is: YES. 659 | 660 | SHOW_FILES = NO 661 | 662 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 663 | # page. This will remove the Namespaces entry from the Quick Index and from the 664 | # Folder Tree View (if specified). 665 | # The default value is: YES. 666 | 667 | SHOW_NAMESPACES = YES 668 | 669 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 670 | # doxygen should invoke to get the current version for each file (typically from 671 | # the version control system). Doxygen will invoke the program by executing (via 672 | # popen()) the command command input-file, where command is the value of the 673 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 674 | # by doxygen. Whatever the program writes to standard output is used as the file 675 | # version. For an example see the documentation. 676 | 677 | FILE_VERSION_FILTER = 678 | 679 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 680 | # by doxygen. The layout file controls the global structure of the generated 681 | # output files in an output format independent way. To create the layout file 682 | # that represents doxygen's defaults, run doxygen with the -l option. You can 683 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 684 | # will be used as the name of the layout file. 685 | # 686 | # Note that if you run doxygen from a directory containing a file called 687 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 688 | # tag is left empty. 689 | 690 | LAYOUT_FILE = 691 | 692 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 693 | # the reference definitions. This must be a list of .bib files. The .bib 694 | # extension is automatically appended if omitted. This requires the bibtex tool 695 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 696 | # For LaTeX the style of the bibliography can be controlled using 697 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 698 | # search path. See also \cite for info how to create references. 699 | 700 | CITE_BIB_FILES = 701 | 702 | #--------------------------------------------------------------------------- 703 | # Configuration options related to warning and progress messages 704 | #--------------------------------------------------------------------------- 705 | 706 | # The QUIET tag can be used to turn on/off the messages that are generated to 707 | # standard output by doxygen. If QUIET is set to YES this implies that the 708 | # messages are off. 709 | # The default value is: NO. 710 | 711 | QUIET = NO 712 | 713 | # The WARNINGS tag can be used to turn on/off the warning messages that are 714 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 715 | # this implies that the warnings are on. 716 | # 717 | # Tip: Turn warnings on while writing the documentation. 718 | # The default value is: YES. 719 | 720 | WARNINGS = YES 721 | 722 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 723 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 724 | # will automatically be disabled. 725 | # The default value is: YES. 726 | 727 | WARN_IF_UNDOCUMENTED = NO 728 | 729 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 730 | # potential errors in the documentation, such as not documenting some parameters 731 | # in a documented function, or documenting parameters that don't exist or using 732 | # markup commands wrongly. 733 | # The default value is: YES. 734 | 735 | WARN_IF_DOC_ERROR = YES 736 | 737 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 738 | # are documented, but have no documentation for their parameters or return 739 | # value. If set to NO, doxygen will only warn about wrong or incomplete 740 | # parameter documentation, but not about the absence of documentation. 741 | # The default value is: NO. 742 | 743 | WARN_NO_PARAMDOC = NO 744 | 745 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 746 | # can produce. The string should contain the $file, $line, and $text tags, which 747 | # will be replaced by the file and line number from which the warning originated 748 | # and the warning text. Optionally the format may contain $version, which will 749 | # be replaced by the version of the file (if it could be obtained via 750 | # FILE_VERSION_FILTER) 751 | # The default value is: $file:$line: $text. 752 | 753 | WARN_FORMAT = "$file:$line: $text" 754 | 755 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 756 | # messages should be written. If left blank the output is written to standard 757 | # error (stderr). 758 | 759 | WARN_LOGFILE = 760 | 761 | #--------------------------------------------------------------------------- 762 | # Configuration options related to the input files 763 | #--------------------------------------------------------------------------- 764 | 765 | # The INPUT tag is used to specify the files and/or directories that contain 766 | # documented source files. You may enter file names like myfile.cpp or 767 | # directories like /usr/src/myproject. Separate the files or directories with 768 | # spaces. 769 | # Note: If this tag is empty the current directory is searched. 770 | 771 | INPUT = ../../doc/index.md ../../doc/tutorial.md . 772 | USE_MDFILE_AS_MAINPAGE = ../../doc/index.md 773 | 774 | # This tag can be used to specify the character encoding of the source files 775 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 776 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 777 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 778 | # possible encodings. 779 | # The default value is: UTF-8. 780 | 781 | INPUT_ENCODING = UTF-8 782 | 783 | # If the value of the INPUT tag contains directories, you can use the 784 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 785 | # *.h) to filter out the source-files in the directories. If left blank the 786 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 787 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 788 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 789 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 790 | # *.qsf, *.as and *.js. 791 | 792 | FILE_PATTERNS = *.h 793 | 794 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 795 | # be searched for input files as well. 796 | # The default value is: NO. 797 | 798 | RECURSIVE = YES 799 | 800 | # The EXCLUDE tag can be used to specify files and/or directories that should be 801 | # excluded from the INPUT source files. This way you can easily exclude a 802 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 803 | # 804 | # Note that relative paths are relative to the directory from which doxygen is 805 | # run. 806 | 807 | EXCLUDE = 808 | 809 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 810 | # directories that are symbolic links (a Unix file system feature) are excluded 811 | # from the input. 812 | # The default value is: NO. 813 | 814 | EXCLUDE_SYMLINKS = NO 815 | 816 | # If the value of the INPUT tag contains directories, you can use the 817 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 818 | # certain files from those directories. 819 | # 820 | # Note that the wildcards are matched against the file with absolute path, so to 821 | # exclude all test directories for example use the pattern */test/* 822 | 823 | EXCLUDE_PATTERNS = 824 | 825 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 826 | # (namespaces, classes, functions, etc.) that should be excluded from the 827 | # output. The symbol name can be a fully qualified name, a word, or if the 828 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 829 | # AClass::ANamespace, ANamespace::*Test 830 | # 831 | # Note that the wildcards are matched against the file with absolute path, so to 832 | # exclude all test directories use the pattern */test/* 833 | 834 | EXCLUDE_SYMBOLS = 835 | 836 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 837 | # that contain example code fragments that are included (see the \include 838 | # command). 839 | 840 | EXAMPLE_PATH = 841 | 842 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 843 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 844 | # *.h) to filter out the source-files in the directories. If left blank all 845 | # files are included. 846 | 847 | EXAMPLE_PATTERNS = * 848 | 849 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 850 | # searched for input files to be used with the \include or \dontinclude commands 851 | # irrespective of the value of the RECURSIVE tag. 852 | # The default value is: NO. 853 | 854 | EXAMPLE_RECURSIVE = NO 855 | 856 | # The IMAGE_PATH tag can be used to specify one or more files or directories 857 | # that contain images that are to be included in the documentation (see the 858 | # \image command). 859 | 860 | IMAGE_PATH = 861 | 862 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 863 | # invoke to filter for each input file. Doxygen will invoke the filter program 864 | # by executing (via popen()) the command: 865 | # 866 | # 867 | # 868 | # where is the value of the INPUT_FILTER tag, and is the 869 | # name of an input file. Doxygen will then use the output that the filter 870 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 871 | # will be ignored. 872 | # 873 | # Note that the filter must not add or remove lines; it is applied before the 874 | # code is scanned, but not when the output code is generated. If lines are added 875 | # or removed, the anchors will not be placed correctly. 876 | 877 | INPUT_FILTER = 878 | 879 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 880 | # basis. Doxygen will compare the file name with each pattern and apply the 881 | # filter if there is a match. The filters are a list of the form: pattern=filter 882 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 883 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 884 | # patterns match the file name, INPUT_FILTER is applied. 885 | 886 | FILTER_PATTERNS = 887 | 888 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 889 | # INPUT_FILTER) will also be used to filter the input files that are used for 890 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 891 | # The default value is: NO. 892 | 893 | FILTER_SOURCE_FILES = NO 894 | 895 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 896 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 897 | # it is also possible to disable source filtering for a specific pattern using 898 | # *.ext= (so without naming a filter). 899 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 900 | 901 | FILTER_SOURCE_PATTERNS = 902 | 903 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 904 | # is part of the input, its contents will be placed on the main page 905 | # (index.html). This can be useful if you have a project on for instance GitHub 906 | # and want to reuse the introduction page also for the doxygen output. 907 | 908 | USE_MDFILE_AS_MAINPAGE = 909 | 910 | #--------------------------------------------------------------------------- 911 | # Configuration options related to source browsing 912 | #--------------------------------------------------------------------------- 913 | 914 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 915 | # generated. Documented entities will be cross-referenced with these sources. 916 | # 917 | # Note: To get rid of all source code in the generated output, make sure that 918 | # also VERBATIM_HEADERS is set to NO. 919 | # The default value is: NO. 920 | 921 | SOURCE_BROWSER = NO 922 | 923 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 924 | # classes and enums directly into the documentation. 925 | # The default value is: NO. 926 | 927 | INLINE_SOURCES = NO 928 | 929 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 930 | # special comment blocks from generated source code fragments. Normal C, C++ and 931 | # Fortran comments will always remain visible. 932 | # The default value is: YES. 933 | 934 | STRIP_CODE_COMMENTS = YES 935 | 936 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 937 | # function all documented functions referencing it will be listed. 938 | # The default value is: NO. 939 | 940 | REFERENCED_BY_RELATION = NO 941 | 942 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 943 | # all documented entities called/used by that function will be listed. 944 | # The default value is: NO. 945 | 946 | REFERENCES_RELATION = NO 947 | 948 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 949 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 950 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 951 | # link to the documentation. 952 | # The default value is: YES. 953 | 954 | REFERENCES_LINK_SOURCE = YES 955 | 956 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 957 | # source code will show a tooltip with additional information such as prototype, 958 | # brief description and links to the definition and documentation. Since this 959 | # will make the HTML file larger and loading of large files a bit slower, you 960 | # can opt to disable this feature. 961 | # The default value is: YES. 962 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 963 | 964 | SOURCE_TOOLTIPS = YES 965 | 966 | # If the USE_HTAGS tag is set to YES then the references to source code will 967 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 968 | # source browser. The htags tool is part of GNU's global source tagging system 969 | # (see http://www.gnu.org/software/global/global.html). You will need version 970 | # 4.8.6 or higher. 971 | # 972 | # To use it do the following: 973 | # - Install the latest version of global 974 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 975 | # - Make sure the INPUT points to the root of the source tree 976 | # - Run doxygen as normal 977 | # 978 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 979 | # tools must be available from the command line (i.e. in the search path). 980 | # 981 | # The result: instead of the source browser generated by doxygen, the links to 982 | # source code will now point to the output of htags. 983 | # The default value is: NO. 984 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 985 | 986 | USE_HTAGS = NO 987 | 988 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 989 | # verbatim copy of the header file for each class for which an include is 990 | # specified. Set to NO to disable this. 991 | # See also: Section \class. 992 | # The default value is: YES. 993 | 994 | VERBATIM_HEADERS = YES 995 | 996 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 997 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 998 | # cost of reduced performance. This can be particularly helpful with template 999 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1000 | # information. 1001 | # Note: The availability of this option depends on whether or not doxygen was 1002 | # compiled with the --with-libclang option. 1003 | # The default value is: NO. 1004 | 1005 | CLANG_ASSISTED_PARSING = NO 1006 | 1007 | # If clang assisted parsing is enabled you can provide the compiler with command 1008 | # line options that you would normally use when invoking the compiler. Note that 1009 | # the include paths will already be set by doxygen for the files and directories 1010 | # specified with INPUT and INCLUDE_PATH. 1011 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1012 | 1013 | CLANG_OPTIONS = 1014 | 1015 | #--------------------------------------------------------------------------- 1016 | # Configuration options related to the alphabetical class index 1017 | #--------------------------------------------------------------------------- 1018 | 1019 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1020 | # compounds will be generated. Enable this if the project contains a lot of 1021 | # classes, structs, unions or interfaces. 1022 | # The default value is: YES. 1023 | 1024 | ALPHABETICAL_INDEX = YES 1025 | 1026 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1027 | # which the alphabetical index list will be split. 1028 | # Minimum value: 1, maximum value: 20, default value: 5. 1029 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1030 | 1031 | COLS_IN_ALPHA_INDEX = 5 1032 | 1033 | # In case all classes in a project start with a common prefix, all classes will 1034 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1035 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1036 | # while generating the index headers. 1037 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1038 | 1039 | IGNORE_PREFIX = 1040 | 1041 | #--------------------------------------------------------------------------- 1042 | # Configuration options related to the HTML output 1043 | #--------------------------------------------------------------------------- 1044 | 1045 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1046 | # The default value is: YES. 1047 | 1048 | GENERATE_HTML = YES 1049 | 1050 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1051 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1052 | # it. 1053 | # The default directory is: html. 1054 | # This tag requires that the tag GENERATE_HTML is set to YES. 1055 | 1056 | HTML_OUTPUT = html 1057 | 1058 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1059 | # generated HTML page (for example: .htm, .php, .asp). 1060 | # The default value is: .html. 1061 | # This tag requires that the tag GENERATE_HTML is set to YES. 1062 | 1063 | HTML_FILE_EXTENSION = .html 1064 | 1065 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1066 | # each generated HTML page. If the tag is left blank doxygen will generate a 1067 | # standard header. 1068 | # 1069 | # To get valid HTML the header file that includes any scripts and style sheets 1070 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1071 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1072 | # default header using 1073 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1074 | # YourConfigFile 1075 | # and then modify the file new_header.html. See also section "Doxygen usage" 1076 | # for information on how to generate the default header that doxygen normally 1077 | # uses. 1078 | # Note: The header is subject to change so you typically have to regenerate the 1079 | # default header when upgrading to a newer version of doxygen. For a description 1080 | # of the possible markers and block names see the documentation. 1081 | # This tag requires that the tag GENERATE_HTML is set to YES. 1082 | 1083 | HTML_HEADER = 1084 | 1085 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1086 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1087 | # footer. See HTML_HEADER for more information on how to generate a default 1088 | # footer and what special commands can be used inside the footer. See also 1089 | # section "Doxygen usage" for information on how to generate the default footer 1090 | # that doxygen normally uses. 1091 | # This tag requires that the tag GENERATE_HTML is set to YES. 1092 | 1093 | HTML_FOOTER = 1094 | 1095 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1096 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1097 | # the HTML output. If left blank doxygen will generate a default style sheet. 1098 | # See also section "Doxygen usage" for information on how to generate the style 1099 | # sheet that doxygen normally uses. 1100 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1101 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1102 | # obsolete. 1103 | # This tag requires that the tag GENERATE_HTML is set to YES. 1104 | 1105 | HTML_STYLESHEET = 1106 | 1107 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1108 | # cascading style sheets that are included after the standard style sheets 1109 | # created by doxygen. Using this option one can overrule certain style aspects. 1110 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1111 | # standard style sheet and is therefore more robust against future updates. 1112 | # Doxygen will copy the style sheet files to the output directory. 1113 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1114 | # style sheet in the list overrules the setting of the previous ones in the 1115 | # list). For an example see the documentation. 1116 | # This tag requires that the tag GENERATE_HTML is set to YES. 1117 | 1118 | HTML_EXTRA_STYLESHEET = 1119 | 1120 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1121 | # other source files which should be copied to the HTML output directory. Note 1122 | # that these files will be copied to the base HTML output directory. Use the 1123 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1124 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1125 | # files will be copied as-is; there are no commands or markers available. 1126 | # This tag requires that the tag GENERATE_HTML is set to YES. 1127 | 1128 | HTML_EXTRA_FILES = 1129 | 1130 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1131 | # will adjust the colors in the style sheet and background images according to 1132 | # this color. Hue is specified as an angle on a colorwheel, see 1133 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1134 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1135 | # purple, and 360 is red again. 1136 | # Minimum value: 0, maximum value: 359, default value: 220. 1137 | # This tag requires that the tag GENERATE_HTML is set to YES. 1138 | 1139 | HTML_COLORSTYLE_HUE = 220 1140 | 1141 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1142 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1143 | # value of 255 will produce the most vivid colors. 1144 | # Minimum value: 0, maximum value: 255, default value: 100. 1145 | # This tag requires that the tag GENERATE_HTML is set to YES. 1146 | 1147 | HTML_COLORSTYLE_SAT = 100 1148 | 1149 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1150 | # luminance component of the colors in the HTML output. Values below 100 1151 | # gradually make the output lighter, whereas values above 100 make the output 1152 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1153 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1154 | # change the gamma. 1155 | # Minimum value: 40, maximum value: 240, default value: 80. 1156 | # This tag requires that the tag GENERATE_HTML is set to YES. 1157 | 1158 | HTML_COLORSTYLE_GAMMA = 80 1159 | 1160 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1161 | # page will contain the date and time when the page was generated. Setting this 1162 | # to YES can help to show when doxygen was last run and thus if the 1163 | # documentation is up to date. 1164 | # The default value is: NO. 1165 | # This tag requires that the tag GENERATE_HTML is set to YES. 1166 | 1167 | HTML_TIMESTAMP = NO 1168 | 1169 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1170 | # documentation will contain sections that can be hidden and shown after the 1171 | # page has loaded. 1172 | # The default value is: NO. 1173 | # This tag requires that the tag GENERATE_HTML is set to YES. 1174 | 1175 | HTML_DYNAMIC_SECTIONS = NO 1176 | 1177 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1178 | # shown in the various tree structured indices initially; the user can expand 1179 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1180 | # such a level that at most the specified number of entries are visible (unless 1181 | # a fully collapsed tree already exceeds this amount). So setting the number of 1182 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1183 | # representing an infinite number of entries and will result in a full expanded 1184 | # tree by default. 1185 | # Minimum value: 0, maximum value: 9999, default value: 100. 1186 | # This tag requires that the tag GENERATE_HTML is set to YES. 1187 | 1188 | HTML_INDEX_NUM_ENTRIES = 100 1189 | 1190 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1191 | # generated that can be used as input for Apple's Xcode 3 integrated development 1192 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1193 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1194 | # Makefile in the HTML output directory. Running make will produce the docset in 1195 | # that directory and running make install will install the docset in 1196 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1197 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1198 | # for more information. 1199 | # The default value is: NO. 1200 | # This tag requires that the tag GENERATE_HTML is set to YES. 1201 | 1202 | GENERATE_DOCSET = NO 1203 | 1204 | # This tag determines the name of the docset feed. A documentation feed provides 1205 | # an umbrella under which multiple documentation sets from a single provider 1206 | # (such as a company or product suite) can be grouped. 1207 | # The default value is: Doxygen generated docs. 1208 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1209 | 1210 | DOCSET_FEEDNAME = "Doxygen generated docs" 1211 | 1212 | # This tag specifies a string that should uniquely identify the documentation 1213 | # set bundle. This should be a reverse domain-name style string, e.g. 1214 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1215 | # The default value is: org.doxygen.Project. 1216 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1217 | 1218 | DOCSET_BUNDLE_ID = org.doxygen.Project 1219 | 1220 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1221 | # the documentation publisher. This should be a reverse domain-name style 1222 | # string, e.g. com.mycompany.MyDocSet.documentation. 1223 | # The default value is: org.doxygen.Publisher. 1224 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1225 | 1226 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1227 | 1228 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1229 | # The default value is: Publisher. 1230 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1231 | 1232 | DOCSET_PUBLISHER_NAME = Publisher 1233 | 1234 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1235 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1236 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1237 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1238 | # Windows. 1239 | # 1240 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1241 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1242 | # files are now used as the Windows 98 help format, and will replace the old 1243 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1244 | # HTML files also contain an index, a table of contents, and you can search for 1245 | # words in the documentation. The HTML workshop also contains a viewer for 1246 | # compressed HTML files. 1247 | # The default value is: NO. 1248 | # This tag requires that the tag GENERATE_HTML is set to YES. 1249 | 1250 | GENERATE_HTMLHELP = NO 1251 | 1252 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1253 | # file. You can add a path in front of the file if the result should not be 1254 | # written to the html output directory. 1255 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1256 | 1257 | CHM_FILE = 1258 | 1259 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1260 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1261 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1262 | # The file has to be specified with full path. 1263 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1264 | 1265 | HHC_LOCATION = 1266 | 1267 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1268 | # (YES) or that it should be included in the master .chm file (NO). 1269 | # The default value is: NO. 1270 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1271 | 1272 | GENERATE_CHI = NO 1273 | 1274 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1275 | # and project file content. 1276 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1277 | 1278 | CHM_INDEX_ENCODING = 1279 | 1280 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1281 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1282 | # enables the Previous and Next buttons. 1283 | # The default value is: NO. 1284 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1285 | 1286 | BINARY_TOC = NO 1287 | 1288 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1289 | # the table of contents of the HTML help documentation and to the tree view. 1290 | # The default value is: NO. 1291 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1292 | 1293 | TOC_EXPAND = NO 1294 | 1295 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1296 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1297 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1298 | # (.qch) of the generated HTML documentation. 1299 | # The default value is: NO. 1300 | # This tag requires that the tag GENERATE_HTML is set to YES. 1301 | 1302 | GENERATE_QHP = NO 1303 | 1304 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1305 | # the file name of the resulting .qch file. The path specified is relative to 1306 | # the HTML output folder. 1307 | # This tag requires that the tag GENERATE_QHP is set to YES. 1308 | 1309 | QCH_FILE = 1310 | 1311 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1312 | # Project output. For more information please see Qt Help Project / Namespace 1313 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1314 | # The default value is: org.doxygen.Project. 1315 | # This tag requires that the tag GENERATE_QHP is set to YES. 1316 | 1317 | QHP_NAMESPACE = org.doxygen.Project 1318 | 1319 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1320 | # Help Project output. For more information please see Qt Help Project / Virtual 1321 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1322 | # folders). 1323 | # The default value is: doc. 1324 | # This tag requires that the tag GENERATE_QHP is set to YES. 1325 | 1326 | QHP_VIRTUAL_FOLDER = doc 1327 | 1328 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1329 | # filter to add. For more information please see Qt Help Project / Custom 1330 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1331 | # filters). 1332 | # This tag requires that the tag GENERATE_QHP is set to YES. 1333 | 1334 | QHP_CUST_FILTER_NAME = 1335 | 1336 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1337 | # custom filter to add. For more information please see Qt Help Project / Custom 1338 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1339 | # filters). 1340 | # This tag requires that the tag GENERATE_QHP is set to YES. 1341 | 1342 | QHP_CUST_FILTER_ATTRS = 1343 | 1344 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1345 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1346 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1347 | # This tag requires that the tag GENERATE_QHP is set to YES. 1348 | 1349 | QHP_SECT_FILTER_ATTRS = 1350 | 1351 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1352 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1353 | # generated .qhp file. 1354 | # This tag requires that the tag GENERATE_QHP is set to YES. 1355 | 1356 | QHG_LOCATION = 1357 | 1358 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1359 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1360 | # install this plugin and make it available under the help contents menu in 1361 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1362 | # to be copied into the plugins directory of eclipse. The name of the directory 1363 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1364 | # After copying Eclipse needs to be restarted before the help appears. 1365 | # The default value is: NO. 1366 | # This tag requires that the tag GENERATE_HTML is set to YES. 1367 | 1368 | GENERATE_ECLIPSEHELP = NO 1369 | 1370 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1371 | # the directory name containing the HTML and XML files should also have this 1372 | # name. Each documentation set should have its own identifier. 1373 | # The default value is: org.doxygen.Project. 1374 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1375 | 1376 | ECLIPSE_DOC_ID = org.doxygen.Project 1377 | 1378 | # If you want full control over the layout of the generated HTML pages it might 1379 | # be necessary to disable the index and replace it with your own. The 1380 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1381 | # of each HTML page. A value of NO enables the index and the value YES disables 1382 | # it. Since the tabs in the index contain the same information as the navigation 1383 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1384 | # The default value is: NO. 1385 | # This tag requires that the tag GENERATE_HTML is set to YES. 1386 | 1387 | DISABLE_INDEX = NO 1388 | 1389 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1390 | # structure should be generated to display hierarchical information. If the tag 1391 | # value is set to YES, a side panel will be generated containing a tree-like 1392 | # index structure (just like the one that is generated for HTML Help). For this 1393 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1394 | # (i.e. any modern browser). Windows users are probably better off using the 1395 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1396 | # further fine-tune the look of the index. As an example, the default style 1397 | # sheet generated by doxygen has an example that shows how to put an image at 1398 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1399 | # the same information as the tab index, you could consider setting 1400 | # DISABLE_INDEX to YES when enabling this option. 1401 | # The default value is: NO. 1402 | # This tag requires that the tag GENERATE_HTML is set to YES. 1403 | 1404 | GENERATE_TREEVIEW = YES 1405 | 1406 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1407 | # doxygen will group on one line in the generated HTML documentation. 1408 | # 1409 | # Note that a value of 0 will completely suppress the enum values from appearing 1410 | # in the overview section. 1411 | # Minimum value: 0, maximum value: 20, default value: 4. 1412 | # This tag requires that the tag GENERATE_HTML is set to YES. 1413 | 1414 | ENUM_VALUES_PER_LINE = 4 1415 | 1416 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1417 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1418 | # Minimum value: 0, maximum value: 1500, default value: 250. 1419 | # This tag requires that the tag GENERATE_HTML is set to YES. 1420 | 1421 | TREEVIEW_WIDTH = 250 1422 | 1423 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1424 | # external symbols imported via tag files in a separate window. 1425 | # The default value is: NO. 1426 | # This tag requires that the tag GENERATE_HTML is set to YES. 1427 | 1428 | EXT_LINKS_IN_WINDOW = NO 1429 | 1430 | # Use this tag to change the font size of LaTeX formulas included as images in 1431 | # the HTML documentation. When you change the font size after a successful 1432 | # doxygen run you need to manually remove any form_*.png images from the HTML 1433 | # output directory to force them to be regenerated. 1434 | # Minimum value: 8, maximum value: 50, default value: 10. 1435 | # This tag requires that the tag GENERATE_HTML is set to YES. 1436 | 1437 | FORMULA_FONTSIZE = 10 1438 | 1439 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1440 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1441 | # supported properly for IE 6.0, but are supported on all modern browsers. 1442 | # 1443 | # Note that when changing this option you need to delete any form_*.png files in 1444 | # the HTML output directory before the changes have effect. 1445 | # The default value is: YES. 1446 | # This tag requires that the tag GENERATE_HTML is set to YES. 1447 | 1448 | FORMULA_TRANSPARENT = YES 1449 | 1450 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1451 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1452 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1453 | # installed or if you want to formulas look prettier in the HTML output. When 1454 | # enabled you may also need to install MathJax separately and configure the path 1455 | # to it using the MATHJAX_RELPATH option. 1456 | # The default value is: NO. 1457 | # This tag requires that the tag GENERATE_HTML is set to YES. 1458 | 1459 | USE_MATHJAX = NO 1460 | 1461 | # When MathJax is enabled you can set the default output format to be used for 1462 | # the MathJax output. See the MathJax site (see: 1463 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1464 | # Possible values are: HTML-CSS (which is slower, but has the best 1465 | # compatibility), NativeMML (i.e. MathML) and SVG. 1466 | # The default value is: HTML-CSS. 1467 | # This tag requires that the tag USE_MATHJAX is set to YES. 1468 | 1469 | MATHJAX_FORMAT = HTML-CSS 1470 | 1471 | # When MathJax is enabled you need to specify the location relative to the HTML 1472 | # output directory using the MATHJAX_RELPATH option. The destination directory 1473 | # should contain the MathJax.js script. For instance, if the mathjax directory 1474 | # is located at the same level as the HTML output directory, then 1475 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1476 | # Content Delivery Network so you can quickly see the result without installing 1477 | # MathJax. However, it is strongly recommended to install a local copy of 1478 | # MathJax from http://www.mathjax.org before deployment. 1479 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1480 | # This tag requires that the tag USE_MATHJAX is set to YES. 1481 | 1482 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1483 | 1484 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1485 | # extension names that should be enabled during MathJax rendering. For example 1486 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1487 | # This tag requires that the tag USE_MATHJAX is set to YES. 1488 | 1489 | MATHJAX_EXTENSIONS = 1490 | 1491 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1492 | # of code that will be used on startup of the MathJax code. See the MathJax site 1493 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1494 | # example see the documentation. 1495 | # This tag requires that the tag USE_MATHJAX is set to YES. 1496 | 1497 | MATHJAX_CODEFILE = 1498 | 1499 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1500 | # the HTML output. The underlying search engine uses javascript and DHTML and 1501 | # should work on any modern browser. Note that when using HTML help 1502 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1503 | # there is already a search function so this one should typically be disabled. 1504 | # For large projects the javascript based search engine can be slow, then 1505 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1506 | # search using the keyboard; to jump to the search box use + S 1507 | # (what the is depends on the OS and browser, but it is typically 1508 | # , /