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