├── .github └── workflows │ └── cmake.yml ├── .gitignore ├── CHANGELOG.md ├── CMakeLists.txt ├── LICENSE ├── README.md ├── cmake └── sqidsConfig.cmake.in ├── docs └── Doxyfile.in ├── include └── sqids │ ├── blocklist.hpp │ └── sqids.hpp └── tests ├── CMakeLists.txt ├── alphabetTests.cpp ├── blocklistTests.cpp ├── encodingTests.cpp └── minLengthTests.cpp /.github/workflows/cmake.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | on: 3 | push: 4 | jobs: 5 | build-project: 6 | runs-on: ubuntu-latest 7 | steps: 8 | - name: Checkout the repository 9 | uses: actions/checkout@v3.5.3 10 | 11 | - name: Configure 12 | uses: threeal/cmake-action@v1.3.0 13 | 14 | - name: Build 15 | run: cmake -S . -B build && cmake --build build 16 | 17 | - name: Run tests 18 | run: cd build && ctest -V 19 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode/ 2 | build/ 3 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # CHANGELOG 2 | 3 | @todo -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.14) 2 | 3 | project( 4 | "sqids" 5 | VERSION 0.2.0 6 | DESCRIPTION 7 | "A small header-only library that lets you generate URL-friendly IDs from numbers." 8 | HOMEPAGE_URL "https://github.com/sqids/sqids-cpp") 9 | 10 | include(GNUInstallDirs) 11 | 12 | add_library(sqids INTERFACE) 13 | 14 | target_include_directories( 15 | sqids INTERFACE $ 16 | $) 17 | 18 | target_compile_features(sqids INTERFACE cxx_std_11) 19 | 20 | include(CMakePackageConfigHelpers) 21 | 22 | write_basic_package_version_file( 23 | "sqidsConfigVersion.cmake" 24 | VERSION ${PROJECT_VERSION} 25 | COMPATIBILITY SameMajorVersion) 26 | 27 | configure_package_config_file( 28 | "${PROJECT_SOURCE_DIR}/cmake/${PROJECT_NAME}Config.cmake.in" 29 | "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake" 30 | INSTALL_DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake) 31 | 32 | install( 33 | TARGETS sqids 34 | EXPORT ${PROJECT_NAME}_Targets 35 | ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} 36 | LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} 37 | RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) 38 | 39 | install( 40 | EXPORT ${PROJECT_NAME}_Targets 41 | FILE ${PROJECT_NAME}Targets.cmake 42 | NAMESPACE ${PROJECT_NAME}:: 43 | DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake) 44 | 45 | install(FILES "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake" 46 | "${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake" 47 | DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake) 48 | 49 | install(DIRECTORY ${PROJECT_SOURCE_DIR}/include/sqids DESTINATION include) 50 | 51 | enable_testing() 52 | 53 | add_subdirectory(tests) 54 | 55 | option(BUILD_DOCS "Build documentation" OFF) 56 | 57 | if(BUILD_DOCS) 58 | find_package(Doxygen) 59 | 60 | if(DOXYGEN_FOUND) 61 | configure_file("${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile.in" 62 | "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile" @ONLY) 63 | add_custom_target( 64 | doxygen ALL 65 | COMMAND ${DOXYGEN_EXECUTABLE} "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile" 66 | WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} 67 | COMMENT "Generating Doxygen documentation" 68 | VERBATIM) 69 | else(DOXYGEN_FOUND) 70 | message("Doxygen needs to be installed to generate documentation") 71 | endif(DOXYGEN_FOUND) 72 | endif(BUILD_DOCS) 73 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023-present Sqids maintainers. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 |

Sqids C++

3 | 4 | 5 |

6 | 7 | 8 | 9 | 10 |

11 | 12 |

13 | Sqids (pronounced "squids") is a small library that lets you generate YouTube-looking IDs from numbers. It's good for link shortening, fast & URL-safe ID generation and decoding back into numbers for quicker database lookups. 14 |

15 | 16 | Features: 17 | 18 | - **Encode multiple numbers** - generate short IDs from one or several non-negative numbers 19 | - **Quick decoding** - easily decode IDs back into numbers 20 | - **Unique IDs** - generate unique IDs by shuffling the alphabet once 21 | - **ID padding** - provide minimum length to make IDs more uniform 22 | - **URL safe** - auto-generated IDs do not contain common profanity 23 | - **Randomized output** - Sequential input provides nonconsecutive IDs 24 | - **Many implementations** - Support for [40+ programming languages](https://sqids.org/) 25 | - **Header-only library** - Simply drop the `include` directory into your project root 26 | 27 | ## 🧰 Use-cases 28 | 29 | Good for: 30 | 31 | - Generating IDs for public URLs (eg: link shortening) 32 | - Generating IDs for internal systems (eg: event tracking) 33 | - Decoding for quicker database lookups (eg: by primary keys) 34 | 35 | Not good for: 36 | 37 | - Sensitive data (this is not an encryption library) 38 | - User IDs (can be decoded revealing user count) 39 | 40 | ## 🚀 Getting started 41 | 42 | ### Installing 43 | 44 | > **Note** 45 | > This step is fully optional. The easiest way to use this library is to merge the `include` directory into your project root and directly include the `sqids.hpp` header: 46 | 47 | > ```cpp 48 | > #include "include/sqids/sqids.hpp" 49 | > ``` 50 | 51 | To install the headers on your system using CMake, run: 52 | 53 | ```bash 54 | mkdir -p build 55 | cd build 56 | cmake .. 57 | cmake --build . --config Release --target install 58 | ``` 59 | 60 | The last command typically needs to run as `sudo`. 61 | 62 | (By default, the headers will be installed to `include/sqids/`, relative to the CMake install prefix, which is usually `/usr/local/` on Linux/Unix.) 63 | 64 | #### Including the library 65 | 66 | In your code, include the library with: 67 | 68 | ```cpp 69 | #include 70 | ``` 71 | 72 | For CMake-based projects, a minimal `CMakeLists.txt` configuration may consist of the following: 73 | 74 | ```cmake 75 | project("sqids-example") 76 | 77 | find_package(sqids CONFIG REQUIRED) 78 | 79 | add_executable(sqids-example main.cpp) 80 | target_link_libraries(sqids-example INTERFACE sqids) 81 | ``` 82 | 83 | ### Running the tests 84 | 85 | ```bash 86 | cmake -S . -B build 87 | cmake --build build 88 | cd build 89 | ctest -V 90 | ``` 91 | 92 | ## 👩‍💻 Examples 93 | 94 | ### Encoding: 95 | 96 | ```cpp 97 | sqidscxx::Sqids sqids; 98 | 99 | auto id = sqids.encode({ 1, 2, 3 }); 100 | ``` 101 | 102 | ### Decoding: 103 | 104 | ```cpp 105 | sqidscxx::Sqids sqids; 106 | 107 | auto numbers = sqids.decode("86Rf07"); 108 | 109 | for (auto number : numbers) { 110 | std::cout << number << std::endl; 111 | } 112 | ``` 113 | 114 | ##### Enforce a *minimum* length for IDs: 115 | 116 | ```cpp 117 | sqidscxx::Sqids sqids({ minLength: 10 }); 118 | 119 | auto id = sqids.encode({ 1, 2, 3 }); 120 | 121 | std::cout << id << std::endl; 122 | ``` 123 | 124 | Output is `86Rf07xd4z`. 125 | 126 | ##### Randomize IDs by providing a custom alphabet: 127 | 128 | ```cpp 129 | sqidscxx::Sqids sqids({ alphabet: "FxnXM1kBN6cuhsAvjW3Co7l2RePyY8DwaU04Tzt9fHQrqSVKdpimLGIJOgb5ZE" }); 130 | 131 | auto id = sqids.encode({ 1, 2, 3 }); 132 | 133 | std::cout << id << std::endl; 134 | ``` 135 | 136 | Output is `B4aajs`. 137 | 138 | ##### Prevent specific words from appearing anywhere in the auto-generated IDs: 139 | 140 | ```cpp 141 | sqidscxx::Sqids sqids({ blocklist: {{ "86Rf07" }} }); 142 | 143 | auto id = sqids.encode({ 1, 2, 3 }); 144 | 145 | std::cout << id << std::endl; 146 | ``` 147 | 148 | Output is `se8ojk`. 149 | 150 | ## 📝 License 151 | 152 | [MIT](LICENSE) 153 | -------------------------------------------------------------------------------- /cmake/sqidsConfig.cmake.in: -------------------------------------------------------------------------------- 1 | @PACKAGE_INIT@ 2 | 3 | include("${CMAKE_CURRENT_LIST_DIR}/@PROJECT_NAME@Targets.cmake") 4 | check_required_components("@PROJECT_NAME@") 5 | -------------------------------------------------------------------------------- /docs/Doxyfile.in: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.10.0 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 | # Note: 17 | # 18 | # Use doxygen to compare the used configuration file with the template 19 | # configuration file: 20 | # doxygen -x [configFile] 21 | # Use doxygen to compare the used configuration file with the template 22 | # configuration file without replacing the environment variables or CMake type 23 | # replacement variables: 24 | # doxygen -x_noenv [configFile] 25 | 26 | #--------------------------------------------------------------------------- 27 | # Project related configuration options 28 | #--------------------------------------------------------------------------- 29 | 30 | # This tag specifies the encoding used for all characters in the configuration 31 | # file that follow. The default is UTF-8 which is also the encoding used for all 32 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 33 | # iconv built into libc) for the transcoding. See 34 | # https://www.gnu.org/software/libiconv/ for the list of possible encodings. 35 | # The default value is: UTF-8. 36 | 37 | DOXYFILE_ENCODING = UTF-8 38 | 39 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 40 | # double-quotes, unless you are using Doxywizard) that should identify the 41 | # project for which the documentation is generated. This name is used in the 42 | # title of most generated pages and in a few other places. 43 | # The default value is: My Project. 44 | 45 | PROJECT_NAME = "sqids" 46 | 47 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 48 | # could be handy for archiving the generated documentation or if some version 49 | # control system is used. 50 | 51 | PROJECT_NUMBER = @CMAKE_PROJECT_VERSION@ 52 | 53 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 54 | # for a project that appears at the top of each page and should give viewer a 55 | # quick idea about the purpose of the project. Keep the description short. 56 | 57 | PROJECT_BRIEF = 58 | 59 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 60 | # in the documentation. The maximum height of the logo should not exceed 55 61 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 62 | # the logo to the output directory. 63 | 64 | PROJECT_LOGO = 65 | 66 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 67 | # into which the generated documentation will be written. If a relative path is 68 | # entered, it will be relative to the location where doxygen was started. If 69 | # left blank the current directory will be used. 70 | 71 | OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/docs/ 72 | 73 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 74 | # sub-directories (in 2 levels) under the output directory of each output format 75 | # and will distribute the generated files over these directories. Enabling this 76 | # option can be useful when feeding doxygen a huge amount of source files, where 77 | # putting all generated files in the same directory would otherwise causes 78 | # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to 79 | # control the number of sub-directories. 80 | # The default value is: NO. 81 | 82 | CREATE_SUBDIRS = NO 83 | 84 | # Controls the number of sub-directories that will be created when 85 | # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every 86 | # level increment doubles the number of directories, resulting in 4096 87 | # directories at level 8 which is the default and also the maximum value. The 88 | # sub-directories are organized in 2 levels, the first level always has a fixed 89 | # number of 16 directories. 90 | # Minimum value: 0, maximum value: 8, default value: 8. 91 | # This tag requires that the tag CREATE_SUBDIRS is set to YES. 92 | 93 | CREATE_SUBDIRS_LEVEL = 8 94 | 95 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 96 | # characters to appear in the names of generated files. If set to NO, non-ASCII 97 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 98 | # U+3044. 99 | # The default value is: NO. 100 | 101 | ALLOW_UNICODE_NAMES = NO 102 | 103 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 104 | # documentation generated by doxygen is written. Doxygen will use this 105 | # information to generate all constant output in the proper language. 106 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, 107 | # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English 108 | # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, 109 | # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with 110 | # English messages), Korean, Korean-en (Korean with English messages), Latvian, 111 | # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, 112 | # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, 113 | # Swedish, Turkish, Ukrainian and Vietnamese. 114 | # The default value is: English. 115 | 116 | OUTPUT_LANGUAGE = English 117 | 118 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 119 | # descriptions after the members that are listed in the file and class 120 | # documentation (similar to Javadoc). Set to NO to disable this. 121 | # The default value is: YES. 122 | 123 | BRIEF_MEMBER_DESC = YES 124 | 125 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 126 | # description of a member or function before the detailed description 127 | # 128 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 129 | # brief descriptions will be completely suppressed. 130 | # The default value is: YES. 131 | 132 | REPEAT_BRIEF = YES 133 | 134 | # This tag implements a quasi-intelligent brief description abbreviator that is 135 | # used to form the text in various listings. Each string in this list, if found 136 | # as the leading text of the brief description, will be stripped from the text 137 | # and the result, after processing the whole list, is used as the annotated 138 | # text. Otherwise, the brief description is used as-is. If left blank, the 139 | # following values are used ($name is automatically replaced with the name of 140 | # the entity):The $name class, The $name widget, The $name file, is, provides, 141 | # specifies, contains, represents, a, an and the. 142 | 143 | ABBREVIATE_BRIEF = "The $name class" \ 144 | "The $name widget" \ 145 | "The $name file" \ 146 | is \ 147 | provides \ 148 | specifies \ 149 | contains \ 150 | represents \ 151 | a \ 152 | an \ 153 | the 154 | 155 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 156 | # doxygen will generate a detailed section even if there is only a brief 157 | # description. 158 | # The default value is: NO. 159 | 160 | ALWAYS_DETAILED_SEC = NO 161 | 162 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 163 | # inherited members of a class in the documentation of that class as if those 164 | # members were ordinary class members. Constructors, destructors and assignment 165 | # operators of the base classes will not be shown. 166 | # The default value is: NO. 167 | 168 | INLINE_INHERITED_MEMB = NO 169 | 170 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 171 | # before files name in the file list and in the header files. If set to NO the 172 | # shortest path that makes the file name unique will be used 173 | # The default value is: YES. 174 | 175 | FULL_PATH_NAMES = YES 176 | 177 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 178 | # Stripping is only done if one of the specified strings matches the left-hand 179 | # part of the path. The tag can be used to show relative paths in the file list. 180 | # If left blank the directory from which doxygen is run is used as the path to 181 | # strip. 182 | # 183 | # Note that you can specify absolute paths here, but also relative paths, which 184 | # will be relative from the directory where doxygen is started. 185 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 186 | 187 | STRIP_FROM_PATH = 188 | 189 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 190 | # path mentioned in the documentation of a class, which tells the reader which 191 | # header file to include in order to use a class. If left blank only the name of 192 | # the header file containing the class definition is used. Otherwise one should 193 | # specify the list of include paths that are normally passed to the compiler 194 | # using the -I flag. 195 | 196 | STRIP_FROM_INC_PATH = 197 | 198 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 199 | # less readable) file names. This can be useful is your file systems doesn't 200 | # support long names like on DOS, Mac, or CD-ROM. 201 | # The default value is: NO. 202 | 203 | SHORT_NAMES = NO 204 | 205 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 206 | # first line (until the first dot) of a Javadoc-style comment as the brief 207 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 208 | # style comments (thus requiring an explicit @brief command for a brief 209 | # description.) 210 | # The default value is: NO. 211 | 212 | JAVADOC_AUTOBRIEF = NO 213 | 214 | # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 215 | # such as 216 | # /*************** 217 | # as being the beginning of a Javadoc-style comment "banner". If set to NO, the 218 | # Javadoc-style will behave just like regular comments and it will not be 219 | # interpreted by doxygen. 220 | # The default value is: NO. 221 | 222 | JAVADOC_BANNER = NO 223 | 224 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 225 | # line (until the first dot) of a Qt-style comment as the brief description. If 226 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 227 | # requiring an explicit \brief command for a brief description.) 228 | # The default value is: NO. 229 | 230 | QT_AUTOBRIEF = NO 231 | 232 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 233 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 234 | # a brief description. This used to be the default behavior. The new default is 235 | # to treat a multi-line C++ comment block as a detailed description. Set this 236 | # tag to YES if you prefer the old behavior instead. 237 | # 238 | # Note that setting this tag to YES also means that rational rose comments are 239 | # not recognized any more. 240 | # The default value is: NO. 241 | 242 | MULTILINE_CPP_IS_BRIEF = NO 243 | 244 | # By default Python docstrings are displayed as preformatted text and doxygen's 245 | # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 246 | # doxygen's special commands can be used and the contents of the docstring 247 | # documentation blocks is shown as doxygen documentation. 248 | # The default value is: YES. 249 | 250 | PYTHON_DOCSTRING = YES 251 | 252 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 253 | # documentation from any documented member that it re-implements. 254 | # The default value is: YES. 255 | 256 | INHERIT_DOCS = YES 257 | 258 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 259 | # page for each member. If set to NO, the documentation of a member will be part 260 | # of the file/class/namespace that contains it. 261 | # The default value is: NO. 262 | 263 | SEPARATE_MEMBER_PAGES = NO 264 | 265 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 266 | # uses this value to replace tabs by spaces in code fragments. 267 | # Minimum value: 1, maximum value: 16, default value: 4. 268 | 269 | TAB_SIZE = 4 270 | 271 | # This tag can be used to specify a number of aliases that act as commands in 272 | # the documentation. An alias has the form: 273 | # name=value 274 | # For example adding 275 | # "sideeffect=@par Side Effects:^^" 276 | # will allow you to put the command \sideeffect (or @sideeffect) in the 277 | # documentation, which will result in a user-defined paragraph with heading 278 | # "Side Effects:". Note that you cannot put \n's in the value part of an alias 279 | # to insert newlines (in the resulting output). You can put ^^ in the value part 280 | # of an alias to insert a newline as if a physical newline was in the original 281 | # file. When you need a literal { or } or , in the value part of an alias you 282 | # have to escape them by means of a backslash (\), this can lead to conflicts 283 | # with the commands \{ and \} for these it is advised to use the version @{ and 284 | # @} or use a double escape (\\{ and \\}) 285 | 286 | ALIASES = 287 | 288 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 289 | # only. Doxygen will then generate output that is more tailored for C. For 290 | # instance, some of the names that are used will be different. The list of all 291 | # members will be omitted, etc. 292 | # The default value is: NO. 293 | 294 | OPTIMIZE_OUTPUT_FOR_C = NO 295 | 296 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 297 | # Python sources only. Doxygen will then generate output that is more tailored 298 | # for that language. For instance, namespaces will be presented as packages, 299 | # qualified scopes will look different, etc. 300 | # The default value is: NO. 301 | 302 | OPTIMIZE_OUTPUT_JAVA = NO 303 | 304 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 305 | # sources. Doxygen will then generate output that is tailored for Fortran. 306 | # The default value is: NO. 307 | 308 | OPTIMIZE_FOR_FORTRAN = NO 309 | 310 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 311 | # sources. Doxygen will then generate output that is tailored for VHDL. 312 | # The default value is: NO. 313 | 314 | OPTIMIZE_OUTPUT_VHDL = NO 315 | 316 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 317 | # sources only. Doxygen will then generate output that is more tailored for that 318 | # language. For instance, namespaces will be presented as modules, types will be 319 | # separated into more groups, etc. 320 | # The default value is: NO. 321 | 322 | OPTIMIZE_OUTPUT_SLICE = NO 323 | 324 | # Doxygen selects the parser to use depending on the extension of the files it 325 | # parses. With this tag you can assign which parser to use for a given 326 | # extension. Doxygen has a built-in mapping, but you can override or extend it 327 | # using this tag. The format is ext=language, where ext is a file extension, and 328 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 329 | # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, 330 | # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 331 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 332 | # tries to guess whether the code is fixed or free formatted code, this is the 333 | # default for Fortran type files). For instance to make doxygen treat .inc files 334 | # as Fortran files (default is PHP), and .f files as C (default is Fortran), 335 | # use: inc=Fortran f=C. 336 | # 337 | # Note: For files without extension you can use no_extension as a placeholder. 338 | # 339 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 340 | # the files are not read by doxygen. When specifying no_extension you should add 341 | # * to the FILE_PATTERNS. 342 | # 343 | # Note see also the list of default file extension mappings. 344 | 345 | EXTENSION_MAPPING = 346 | 347 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 348 | # according to the Markdown format, which allows for more readable 349 | # documentation. See https://daringfireball.net/projects/markdown/ for details. 350 | # The output of markdown processing is further processed by doxygen, so you can 351 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 352 | # case of backward compatibilities issues. 353 | # The default value is: YES. 354 | 355 | MARKDOWN_SUPPORT = YES 356 | 357 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 358 | # to that level are automatically included in the table of contents, even if 359 | # they do not have an id attribute. 360 | # Note: This feature currently applies only to Markdown headings. 361 | # Minimum value: 0, maximum value: 99, default value: 5. 362 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 363 | 364 | TOC_INCLUDE_HEADINGS = 5 365 | 366 | # The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to 367 | # generate identifiers for the Markdown headings. Note: Every identifier is 368 | # unique. 369 | # Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a 370 | # sequence number starting at 0 and GITHUB use the lower case version of title 371 | # with any whitespace replaced by '-' and punctuation characters removed. 372 | # The default value is: DOXYGEN. 373 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 374 | 375 | MARKDOWN_ID_STYLE = DOXYGEN 376 | 377 | # When enabled doxygen tries to link words that correspond to documented 378 | # classes, or namespaces to their corresponding documentation. Such a link can 379 | # be prevented in individual cases by putting a % sign in front of the word or 380 | # globally by setting AUTOLINK_SUPPORT to NO. 381 | # The default value is: YES. 382 | 383 | AUTOLINK_SUPPORT = YES 384 | 385 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 386 | # to include (a tag file for) the STL sources as input, then you should set this 387 | # tag to YES in order to let doxygen match functions declarations and 388 | # definitions whose arguments contain STL classes (e.g. func(std::string); 389 | # versus func(std::string) {}). This also make the inheritance and collaboration 390 | # diagrams that involve STL classes more complete and accurate. 391 | # The default value is: NO. 392 | 393 | BUILTIN_STL_SUPPORT = NO 394 | 395 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 396 | # enable parsing support. 397 | # The default value is: NO. 398 | 399 | CPP_CLI_SUPPORT = NO 400 | 401 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 402 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 403 | # will parse them like normal C++ but will assume all classes use public instead 404 | # of private inheritance when no explicit protection keyword is present. 405 | # The default value is: NO. 406 | 407 | SIP_SUPPORT = NO 408 | 409 | # For Microsoft's IDL there are propget and propput attributes to indicate 410 | # getter and setter methods for a property. Setting this option to YES will make 411 | # doxygen to replace the get and set methods by a property in the documentation. 412 | # This will only work if the methods are indeed getting or setting a simple 413 | # type. If this is not the case, or you want to show the methods anyway, you 414 | # should set this option to NO. 415 | # The default value is: YES. 416 | 417 | IDL_PROPERTY_SUPPORT = YES 418 | 419 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 420 | # tag is set to YES then doxygen will reuse the documentation of the first 421 | # member in the group (if any) for the other members of the group. By default 422 | # all members of a group must be documented explicitly. 423 | # The default value is: NO. 424 | 425 | DISTRIBUTE_GROUP_DOC = NO 426 | 427 | # If one adds a struct or class to a group and this option is enabled, then also 428 | # any nested class or struct is added to the same group. By default this option 429 | # is disabled and one has to add nested compounds explicitly via \ingroup. 430 | # The default value is: NO. 431 | 432 | GROUP_NESTED_COMPOUNDS = NO 433 | 434 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 435 | # (for instance a group of public functions) to be put as a subgroup of that 436 | # type (e.g. under the Public Functions section). Set it to NO to prevent 437 | # subgrouping. Alternatively, this can be done per class using the 438 | # \nosubgrouping command. 439 | # The default value is: YES. 440 | 441 | SUBGROUPING = YES 442 | 443 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 444 | # are shown inside the group in which they are included (e.g. using \ingroup) 445 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 446 | # and RTF). 447 | # 448 | # Note that this feature does not work in combination with 449 | # SEPARATE_MEMBER_PAGES. 450 | # The default value is: NO. 451 | 452 | INLINE_GROUPED_CLASSES = NO 453 | 454 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 455 | # with only public data fields or simple typedef fields will be shown inline in 456 | # the documentation of the scope in which they are defined (i.e. file, 457 | # namespace, or group documentation), provided this scope is documented. If set 458 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 459 | # Man pages) or section (for LaTeX and RTF). 460 | # The default value is: NO. 461 | 462 | INLINE_SIMPLE_STRUCTS = NO 463 | 464 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 465 | # enum is documented as struct, union, or enum with the name of the typedef. So 466 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 467 | # with name TypeT. When disabled the typedef will appear as a member of a file, 468 | # namespace, or class. And the struct will be named TypeS. This can typically be 469 | # useful for C code in case the coding convention dictates that all compound 470 | # types are typedef'ed and only the typedef is referenced, never the tag name. 471 | # The default value is: NO. 472 | 473 | TYPEDEF_HIDES_STRUCT = NO 474 | 475 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 476 | # cache is used to resolve symbols given their name and scope. Since this can be 477 | # an expensive process and often the same symbol appears multiple times in the 478 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 479 | # doxygen will become slower. If the cache is too large, memory is wasted. The 480 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 481 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 482 | # symbols. At the end of a run doxygen will report the cache usage and suggest 483 | # the optimal cache size from a speed point of view. 484 | # Minimum value: 0, maximum value: 9, default value: 0. 485 | 486 | LOOKUP_CACHE_SIZE = 0 487 | 488 | # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use 489 | # during processing. When set to 0 doxygen will based this on the number of 490 | # cores available in the system. You can set it explicitly to a value larger 491 | # than 0 to get more control over the balance between CPU load and processing 492 | # speed. At this moment only the input processing can be done using multiple 493 | # threads. Since this is still an experimental feature the default is set to 1, 494 | # which effectively disables parallel processing. Please report any issues you 495 | # encounter. Generating dot graphs in parallel is controlled by the 496 | # DOT_NUM_THREADS setting. 497 | # Minimum value: 0, maximum value: 32, default value: 1. 498 | 499 | NUM_PROC_THREADS = 1 500 | 501 | # If the TIMESTAMP tag is set different from NO then each generated page will 502 | # contain the date or date and time when the page was generated. Setting this to 503 | # NO can help when comparing the output of multiple runs. 504 | # Possible values are: YES, NO, DATETIME and DATE. 505 | # The default value is: NO. 506 | 507 | TIMESTAMP = NO 508 | 509 | #--------------------------------------------------------------------------- 510 | # Build related configuration options 511 | #--------------------------------------------------------------------------- 512 | 513 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 514 | # documentation are documented, even if no documentation was available. Private 515 | # class members and static file members will be hidden unless the 516 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 517 | # Note: This will also disable the warnings about undocumented members that are 518 | # normally produced when WARNINGS is set to YES. 519 | # The default value is: NO. 520 | 521 | EXTRACT_ALL = NO 522 | 523 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 524 | # be included in the documentation. 525 | # The default value is: NO. 526 | 527 | EXTRACT_PRIVATE = NO 528 | 529 | # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 530 | # methods of a class will be included in the documentation. 531 | # The default value is: NO. 532 | 533 | EXTRACT_PRIV_VIRTUAL = NO 534 | 535 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 536 | # scope will be included in the documentation. 537 | # The default value is: NO. 538 | 539 | EXTRACT_PACKAGE = NO 540 | 541 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 542 | # included in the documentation. 543 | # The default value is: NO. 544 | 545 | EXTRACT_STATIC = NO 546 | 547 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 548 | # locally in source files will be included in the documentation. If set to NO, 549 | # only classes defined in header files are included. Does not have any effect 550 | # for Java sources. 551 | # The default value is: YES. 552 | 553 | EXTRACT_LOCAL_CLASSES = YES 554 | 555 | # This flag is only useful for Objective-C code. If set to YES, local methods, 556 | # which are defined in the implementation section but not in the interface are 557 | # included in the documentation. If set to NO, only methods in the interface are 558 | # included. 559 | # The default value is: NO. 560 | 561 | EXTRACT_LOCAL_METHODS = NO 562 | 563 | # If this flag is set to YES, the members of anonymous namespaces will be 564 | # extracted and appear in the documentation as a namespace called 565 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 566 | # the file that contains the anonymous namespace. By default anonymous namespace 567 | # are hidden. 568 | # The default value is: NO. 569 | 570 | EXTRACT_ANON_NSPACES = NO 571 | 572 | # If this flag is set to YES, the name of an unnamed parameter in a declaration 573 | # will be determined by the corresponding definition. By default unnamed 574 | # parameters remain unnamed in the output. 575 | # The default value is: YES. 576 | 577 | RESOLVE_UNNAMED_PARAMS = YES 578 | 579 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 580 | # undocumented members inside documented classes or files. If set to NO these 581 | # members will be included in the various overviews, but no documentation 582 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 583 | # The default value is: NO. 584 | 585 | HIDE_UNDOC_MEMBERS = NO 586 | 587 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 588 | # undocumented classes that are normally visible in the class hierarchy. If set 589 | # to NO, these classes will be included in the various overviews. This option 590 | # will also hide undocumented C++ concepts if enabled. This option has no effect 591 | # if EXTRACT_ALL is enabled. 592 | # The default value is: NO. 593 | 594 | HIDE_UNDOC_CLASSES = NO 595 | 596 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 597 | # declarations. If set to NO, these declarations will be included in the 598 | # documentation. 599 | # The default value is: NO. 600 | 601 | HIDE_FRIEND_COMPOUNDS = NO 602 | 603 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 604 | # documentation blocks found inside the body of a function. If set to NO, these 605 | # blocks will be appended to the function's detailed documentation block. 606 | # The default value is: NO. 607 | 608 | HIDE_IN_BODY_DOCS = NO 609 | 610 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 611 | # \internal command is included. If the tag is set to NO then the documentation 612 | # will be excluded. Set it to YES to include the internal documentation. 613 | # The default value is: NO. 614 | 615 | INTERNAL_DOCS = NO 616 | 617 | # With the correct setting of option CASE_SENSE_NAMES doxygen will better be 618 | # able to match the capabilities of the underlying filesystem. In case the 619 | # filesystem is case sensitive (i.e. it supports files in the same directory 620 | # whose names only differ in casing), the option must be set to YES to properly 621 | # deal with such files in case they appear in the input. For filesystems that 622 | # are not case sensitive the option should be set to NO to properly deal with 623 | # output files written for symbols that only differ in casing, such as for two 624 | # classes, one named CLASS and the other named Class, and to also support 625 | # references to files without having to specify the exact matching casing. On 626 | # Windows (including Cygwin) and MacOS, users should typically set this option 627 | # to NO, whereas on Linux or other Unix flavors it should typically be set to 628 | # YES. 629 | # Possible values are: SYSTEM, NO and YES. 630 | # The default value is: SYSTEM. 631 | 632 | CASE_SENSE_NAMES = SYSTEM 633 | 634 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 635 | # their full class and namespace scopes in the documentation. If set to YES, the 636 | # scope will be hidden. 637 | # The default value is: NO. 638 | 639 | HIDE_SCOPE_NAMES = NO 640 | 641 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 642 | # append additional text to a page's title, such as Class Reference. If set to 643 | # YES the compound reference will be hidden. 644 | # The default value is: NO. 645 | 646 | HIDE_COMPOUND_REFERENCE= NO 647 | 648 | # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class 649 | # will show which file needs to be included to use the class. 650 | # The default value is: YES. 651 | 652 | SHOW_HEADERFILE = YES 653 | 654 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 655 | # the files that are included by a file in the documentation of that file. 656 | # The default value is: YES. 657 | 658 | SHOW_INCLUDE_FILES = YES 659 | 660 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 661 | # grouped member an include statement to the documentation, telling the reader 662 | # which file to include in order to use the member. 663 | # The default value is: NO. 664 | 665 | SHOW_GROUPED_MEMB_INC = NO 666 | 667 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 668 | # files with double quotes in the documentation rather than with sharp brackets. 669 | # The default value is: NO. 670 | 671 | FORCE_LOCAL_INCLUDES = NO 672 | 673 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 674 | # documentation for inline members. 675 | # The default value is: YES. 676 | 677 | INLINE_INFO = YES 678 | 679 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 680 | # (detailed) documentation of file and class members alphabetically by member 681 | # name. If set to NO, the members will appear in declaration order. 682 | # The default value is: YES. 683 | 684 | SORT_MEMBER_DOCS = YES 685 | 686 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 687 | # descriptions of file, namespace and class members alphabetically by member 688 | # name. If set to NO, the members will appear in declaration order. Note that 689 | # this will also influence the order of the classes in the class list. 690 | # The default value is: NO. 691 | 692 | SORT_BRIEF_DOCS = NO 693 | 694 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 695 | # (brief and detailed) documentation of class members so that constructors and 696 | # destructors are listed first. If set to NO the constructors will appear in the 697 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 698 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 699 | # member documentation. 700 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 701 | # detailed member documentation. 702 | # The default value is: NO. 703 | 704 | SORT_MEMBERS_CTORS_1ST = NO 705 | 706 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 707 | # of group names into alphabetical order. If set to NO the group names will 708 | # appear in their defined order. 709 | # The default value is: NO. 710 | 711 | SORT_GROUP_NAMES = NO 712 | 713 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 714 | # fully-qualified names, including namespaces. If set to NO, the class list will 715 | # be sorted only by class name, not including the namespace part. 716 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 717 | # Note: This option applies only to the class list, not to the alphabetical 718 | # list. 719 | # The default value is: NO. 720 | 721 | SORT_BY_SCOPE_NAME = NO 722 | 723 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 724 | # type resolution of all parameters of a function it will reject a match between 725 | # the prototype and the implementation of a member function even if there is 726 | # only one candidate or it is obvious which candidate to choose by doing a 727 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 728 | # accept a match between prototype and implementation in such cases. 729 | # The default value is: NO. 730 | 731 | STRICT_PROTO_MATCHING = NO 732 | 733 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 734 | # list. This list is created by putting \todo commands in the documentation. 735 | # The default value is: YES. 736 | 737 | GENERATE_TODOLIST = YES 738 | 739 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 740 | # list. This list is created by putting \test commands in the documentation. 741 | # The default value is: YES. 742 | 743 | GENERATE_TESTLIST = YES 744 | 745 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 746 | # list. This list is created by putting \bug commands in the documentation. 747 | # The default value is: YES. 748 | 749 | GENERATE_BUGLIST = YES 750 | 751 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 752 | # the deprecated list. This list is created by putting \deprecated commands in 753 | # the documentation. 754 | # The default value is: YES. 755 | 756 | GENERATE_DEPRECATEDLIST= YES 757 | 758 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 759 | # sections, marked by \if ... \endif and \cond 760 | # ... \endcond blocks. 761 | 762 | ENABLED_SECTIONS = 763 | 764 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 765 | # initial value of a variable or macro / define can have for it to appear in the 766 | # documentation. If the initializer consists of more lines than specified here 767 | # it will be hidden. Use a value of 0 to hide initializers completely. The 768 | # appearance of the value of individual variables and macros / defines can be 769 | # controlled using \showinitializer or \hideinitializer command in the 770 | # documentation regardless of this setting. 771 | # Minimum value: 0, maximum value: 10000, default value: 30. 772 | 773 | MAX_INITIALIZER_LINES = 30 774 | 775 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 776 | # the bottom of the documentation of classes and structs. If set to YES, the 777 | # list will mention the files that were used to generate the documentation. 778 | # The default value is: YES. 779 | 780 | SHOW_USED_FILES = YES 781 | 782 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 783 | # will remove the Files entry from the Quick Index and from the Folder Tree View 784 | # (if specified). 785 | # The default value is: YES. 786 | 787 | SHOW_FILES = YES 788 | 789 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 790 | # page. This will remove the Namespaces entry from the Quick Index and from the 791 | # Folder Tree View (if specified). 792 | # The default value is: YES. 793 | 794 | SHOW_NAMESPACES = YES 795 | 796 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 797 | # doxygen should invoke to get the current version for each file (typically from 798 | # the version control system). Doxygen will invoke the program by executing (via 799 | # popen()) the command command input-file, where command is the value of the 800 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 801 | # by doxygen. Whatever the program writes to standard output is used as the file 802 | # version. For an example see the documentation. 803 | 804 | FILE_VERSION_FILTER = 805 | 806 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 807 | # by doxygen. The layout file controls the global structure of the generated 808 | # output files in an output format independent way. To create the layout file 809 | # that represents doxygen's defaults, run doxygen with the -l option. You can 810 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 811 | # will be used as the name of the layout file. See also section "Changing the 812 | # layout of pages" for information. 813 | # 814 | # Note that if you run doxygen from a directory containing a file called 815 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 816 | # tag is left empty. 817 | 818 | LAYOUT_FILE = 819 | 820 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 821 | # the reference definitions. This must be a list of .bib files. The .bib 822 | # extension is automatically appended if omitted. This requires the bibtex tool 823 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 824 | # For LaTeX the style of the bibliography can be controlled using 825 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 826 | # search path. See also \cite for info how to create references. 827 | 828 | CITE_BIB_FILES = 829 | 830 | #--------------------------------------------------------------------------- 831 | # Configuration options related to warning and progress messages 832 | #--------------------------------------------------------------------------- 833 | 834 | # The QUIET tag can be used to turn on/off the messages that are generated to 835 | # standard output by doxygen. If QUIET is set to YES this implies that the 836 | # messages are off. 837 | # The default value is: NO. 838 | 839 | QUIET = NO 840 | 841 | # The WARNINGS tag can be used to turn on/off the warning messages that are 842 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 843 | # this implies that the warnings are on. 844 | # 845 | # Tip: Turn warnings on while writing the documentation. 846 | # The default value is: YES. 847 | 848 | WARNINGS = YES 849 | 850 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 851 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 852 | # will automatically be disabled. 853 | # The default value is: YES. 854 | 855 | WARN_IF_UNDOCUMENTED = YES 856 | 857 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 858 | # potential errors in the documentation, such as documenting some parameters in 859 | # a documented function twice, or documenting parameters that don't exist or 860 | # using markup commands wrongly. 861 | # The default value is: YES. 862 | 863 | WARN_IF_DOC_ERROR = YES 864 | 865 | # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete 866 | # function parameter documentation. If set to NO, doxygen will accept that some 867 | # parameters have no documentation without warning. 868 | # The default value is: YES. 869 | 870 | WARN_IF_INCOMPLETE_DOC = YES 871 | 872 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 873 | # are documented, but have no documentation for their parameters or return 874 | # value. If set to NO, doxygen will only warn about wrong parameter 875 | # documentation, but not about the absence of documentation. If EXTRACT_ALL is 876 | # set to YES then this flag will automatically be disabled. See also 877 | # WARN_IF_INCOMPLETE_DOC 878 | # The default value is: NO. 879 | 880 | WARN_NO_PARAMDOC = NO 881 | 882 | # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about 883 | # undocumented enumeration values. If set to NO, doxygen will accept 884 | # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag 885 | # will automatically be disabled. 886 | # The default value is: NO. 887 | 888 | WARN_IF_UNDOC_ENUM_VAL = NO 889 | 890 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 891 | # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 892 | # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 893 | # at the end of the doxygen process doxygen will return with a non-zero status. 894 | # If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves 895 | # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not 896 | # write the warning messages in between other messages but write them at the end 897 | # of a run, in case a WARN_LOGFILE is defined the warning messages will be 898 | # besides being in the defined file also be shown at the end of a run, unless 899 | # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case 900 | # the behavior will remain as with the setting FAIL_ON_WARNINGS. 901 | # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. 902 | # The default value is: NO. 903 | 904 | WARN_AS_ERROR = NO 905 | 906 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 907 | # can produce. The string should contain the $file, $line, and $text tags, which 908 | # will be replaced by the file and line number from which the warning originated 909 | # and the warning text. Optionally the format may contain $version, which will 910 | # be replaced by the version of the file (if it could be obtained via 911 | # FILE_VERSION_FILTER) 912 | # See also: WARN_LINE_FORMAT 913 | # The default value is: $file:$line: $text. 914 | 915 | WARN_FORMAT = "$file:$line: $text" 916 | 917 | # In the $text part of the WARN_FORMAT command it is possible that a reference 918 | # to a more specific place is given. To make it easier to jump to this place 919 | # (outside of doxygen) the user can define a custom "cut" / "paste" string. 920 | # Example: 921 | # WARN_LINE_FORMAT = "'vi $file +$line'" 922 | # See also: WARN_FORMAT 923 | # The default value is: at line $line of file $file. 924 | 925 | WARN_LINE_FORMAT = "at line $line of file $file" 926 | 927 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 928 | # messages should be written. If left blank the output is written to standard 929 | # error (stderr). In case the file specified cannot be opened for writing the 930 | # warning and error messages are written to standard error. When as file - is 931 | # specified the warning and error messages are written to standard output 932 | # (stdout). 933 | 934 | WARN_LOGFILE = 935 | 936 | #--------------------------------------------------------------------------- 937 | # Configuration options related to the input files 938 | #--------------------------------------------------------------------------- 939 | 940 | # The INPUT tag is used to specify the files and/or directories that contain 941 | # documented source files. You may enter file names like myfile.cpp or 942 | # directories like /usr/src/myproject. Separate the files or directories with 943 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 944 | # Note: If this tag is empty the current directory is searched. 945 | 946 | INPUT = @CMAKE_CURRENT_SOURCE_DIR@/include/sqids/ 947 | 948 | # This tag can be used to specify the character encoding of the source files 949 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 950 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 951 | # documentation (see: 952 | # https://www.gnu.org/software/libiconv/) for the list of possible encodings. 953 | # See also: INPUT_FILE_ENCODING 954 | # The default value is: UTF-8. 955 | 956 | INPUT_ENCODING = UTF-8 957 | 958 | # This tag can be used to specify the character encoding of the source files 959 | # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify 960 | # character encoding on a per file pattern basis. Doxygen will compare the file 961 | # name with each pattern and apply the encoding instead of the default 962 | # INPUT_ENCODING) if there is a match. The character encodings are a list of the 963 | # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding 964 | # "INPUT_ENCODING" for further information on supported encodings. 965 | 966 | INPUT_FILE_ENCODING = 967 | 968 | # If the value of the INPUT tag contains directories, you can use the 969 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 970 | # *.h) to filter out the source-files in the directories. 971 | # 972 | # Note that for custom extensions or not directly supported extensions you also 973 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 974 | # read by doxygen. 975 | # 976 | # Note the list of default checked file patterns might differ from the list of 977 | # default file extension mappings. 978 | # 979 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, 980 | # *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, 981 | # *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php, 982 | # *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be 983 | # provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 984 | # *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. 985 | 986 | FILE_PATTERNS = *.c \ 987 | *.cc \ 988 | *.cxx \ 989 | *.cxxm \ 990 | *.cpp \ 991 | *.cppm \ 992 | *.c++ \ 993 | *.c++m \ 994 | *.java \ 995 | *.ii \ 996 | *.ixx \ 997 | *.ipp \ 998 | *.i++ \ 999 | *.inl \ 1000 | *.idl \ 1001 | *.ddl \ 1002 | *.odl \ 1003 | *.h \ 1004 | *.hh \ 1005 | *.hxx \ 1006 | *.hpp \ 1007 | *.h++ \ 1008 | *.ixx \ 1009 | *.l \ 1010 | *.cs \ 1011 | *.d \ 1012 | *.php \ 1013 | *.php4 \ 1014 | *.php5 \ 1015 | *.phtml \ 1016 | *.inc \ 1017 | *.m \ 1018 | *.markdown \ 1019 | *.md \ 1020 | *.mm \ 1021 | *.dox \ 1022 | *.py \ 1023 | *.pyw \ 1024 | *.f90 \ 1025 | *.f95 \ 1026 | *.f03 \ 1027 | *.f08 \ 1028 | *.f18 \ 1029 | *.f \ 1030 | *.for \ 1031 | *.vhd \ 1032 | *.vhdl \ 1033 | *.ucf \ 1034 | *.qsf \ 1035 | *.ice 1036 | 1037 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 1038 | # be searched for input files as well. 1039 | # The default value is: NO. 1040 | 1041 | RECURSIVE = NO 1042 | 1043 | # The EXCLUDE tag can be used to specify files and/or directories that should be 1044 | # excluded from the INPUT source files. This way you can easily exclude a 1045 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 1046 | # 1047 | # Note that relative paths are relative to the directory from which doxygen is 1048 | # run. 1049 | 1050 | EXCLUDE = 1051 | 1052 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 1053 | # directories that are symbolic links (a Unix file system feature) are excluded 1054 | # from the input. 1055 | # The default value is: NO. 1056 | 1057 | EXCLUDE_SYMLINKS = NO 1058 | 1059 | # If the value of the INPUT tag contains directories, you can use the 1060 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 1061 | # certain files from those directories. 1062 | # 1063 | # Note that the wildcards are matched against the file with absolute path, so to 1064 | # exclude all test directories for example use the pattern */test/* 1065 | 1066 | EXCLUDE_PATTERNS = 1067 | 1068 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 1069 | # (namespaces, classes, functions, etc.) that should be excluded from the 1070 | # output. The symbol name can be a fully qualified name, a word, or if the 1071 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 1072 | # ANamespace::AClass, ANamespace::*Test 1073 | 1074 | EXCLUDE_SYMBOLS = 1075 | 1076 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 1077 | # that contain example code fragments that are included (see the \include 1078 | # command). 1079 | 1080 | EXAMPLE_PATH = 1081 | 1082 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 1083 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 1084 | # *.h) to filter out the source-files in the directories. If left blank all 1085 | # files are included. 1086 | 1087 | EXAMPLE_PATTERNS = * 1088 | 1089 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 1090 | # searched for input files to be used with the \include or \dontinclude commands 1091 | # irrespective of the value of the RECURSIVE tag. 1092 | # The default value is: NO. 1093 | 1094 | EXAMPLE_RECURSIVE = NO 1095 | 1096 | # The IMAGE_PATH tag can be used to specify one or more files or directories 1097 | # that contain images that are to be included in the documentation (see the 1098 | # \image command). 1099 | 1100 | IMAGE_PATH = 1101 | 1102 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 1103 | # invoke to filter for each input file. Doxygen will invoke the filter program 1104 | # by executing (via popen()) the command: 1105 | # 1106 | # 1107 | # 1108 | # where is the value of the INPUT_FILTER tag, and is the 1109 | # name of an input file. Doxygen will then use the output that the filter 1110 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 1111 | # will be ignored. 1112 | # 1113 | # Note that the filter must not add or remove lines; it is applied before the 1114 | # code is scanned, but not when the output code is generated. If lines are added 1115 | # or removed, the anchors will not be placed correctly. 1116 | # 1117 | # Note that doxygen will use the data processed and written to standard output 1118 | # for further processing, therefore nothing else, like debug statements or used 1119 | # commands (so in case of a Windows batch file always use @echo OFF), should be 1120 | # written to standard output. 1121 | # 1122 | # Note that for custom extensions or not directly supported extensions you also 1123 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1124 | # properly processed by doxygen. 1125 | 1126 | INPUT_FILTER = 1127 | 1128 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1129 | # basis. Doxygen will compare the file name with each pattern and apply the 1130 | # filter if there is a match. The filters are a list of the form: pattern=filter 1131 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 1132 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1133 | # patterns match the file name, INPUT_FILTER is applied. 1134 | # 1135 | # Note that for custom extensions or not directly supported extensions you also 1136 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1137 | # properly processed by doxygen. 1138 | 1139 | FILTER_PATTERNS = 1140 | 1141 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1142 | # INPUT_FILTER) will also be used to filter the input files that are used for 1143 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1144 | # The default value is: NO. 1145 | 1146 | FILTER_SOURCE_FILES = NO 1147 | 1148 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1149 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1150 | # it is also possible to disable source filtering for a specific pattern using 1151 | # *.ext= (so without naming a filter). 1152 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1153 | 1154 | FILTER_SOURCE_PATTERNS = 1155 | 1156 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1157 | # is part of the input, its contents will be placed on the main page 1158 | # (index.html). This can be useful if you have a project on for instance GitHub 1159 | # and want to reuse the introduction page also for the doxygen output. 1160 | 1161 | USE_MDFILE_AS_MAINPAGE = 1162 | 1163 | # The Fortran standard specifies that for fixed formatted Fortran code all 1164 | # characters from position 72 are to be considered as comment. A common 1165 | # extension is to allow longer lines before the automatic comment starts. The 1166 | # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can 1167 | # be processed before the automatic comment starts. 1168 | # Minimum value: 7, maximum value: 10000, default value: 72. 1169 | 1170 | FORTRAN_COMMENT_AFTER = 72 1171 | 1172 | #--------------------------------------------------------------------------- 1173 | # Configuration options related to source browsing 1174 | #--------------------------------------------------------------------------- 1175 | 1176 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1177 | # generated. Documented entities will be cross-referenced with these sources. 1178 | # 1179 | # Note: To get rid of all source code in the generated output, make sure that 1180 | # also VERBATIM_HEADERS is set to NO. 1181 | # The default value is: NO. 1182 | 1183 | SOURCE_BROWSER = NO 1184 | 1185 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1186 | # classes and enums directly into the documentation. 1187 | # The default value is: NO. 1188 | 1189 | INLINE_SOURCES = NO 1190 | 1191 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1192 | # special comment blocks from generated source code fragments. Normal C, C++ and 1193 | # Fortran comments will always remain visible. 1194 | # The default value is: YES. 1195 | 1196 | STRIP_CODE_COMMENTS = YES 1197 | 1198 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1199 | # entity all documented functions referencing it will be listed. 1200 | # The default value is: NO. 1201 | 1202 | REFERENCED_BY_RELATION = NO 1203 | 1204 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1205 | # all documented entities called/used by that function will be listed. 1206 | # The default value is: NO. 1207 | 1208 | REFERENCES_RELATION = NO 1209 | 1210 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1211 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1212 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1213 | # link to the documentation. 1214 | # The default value is: YES. 1215 | 1216 | REFERENCES_LINK_SOURCE = YES 1217 | 1218 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1219 | # source code will show a tooltip with additional information such as prototype, 1220 | # brief description and links to the definition and documentation. Since this 1221 | # will make the HTML file larger and loading of large files a bit slower, you 1222 | # can opt to disable this feature. 1223 | # The default value is: YES. 1224 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1225 | 1226 | SOURCE_TOOLTIPS = YES 1227 | 1228 | # If the USE_HTAGS tag is set to YES then the references to source code will 1229 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1230 | # source browser. The htags tool is part of GNU's global source tagging system 1231 | # (see https://www.gnu.org/software/global/global.html). You will need version 1232 | # 4.8.6 or higher. 1233 | # 1234 | # To use it do the following: 1235 | # - Install the latest version of global 1236 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1237 | # - Make sure the INPUT points to the root of the source tree 1238 | # - Run doxygen as normal 1239 | # 1240 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1241 | # tools must be available from the command line (i.e. in the search path). 1242 | # 1243 | # The result: instead of the source browser generated by doxygen, the links to 1244 | # source code will now point to the output of htags. 1245 | # The default value is: NO. 1246 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1247 | 1248 | USE_HTAGS = NO 1249 | 1250 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1251 | # verbatim copy of the header file for each class for which an include is 1252 | # specified. Set to NO to disable this. 1253 | # See also: Section \class. 1254 | # The default value is: YES. 1255 | 1256 | VERBATIM_HEADERS = YES 1257 | 1258 | #--------------------------------------------------------------------------- 1259 | # Configuration options related to the alphabetical class index 1260 | #--------------------------------------------------------------------------- 1261 | 1262 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1263 | # compounds will be generated. Enable this if the project contains a lot of 1264 | # classes, structs, unions or interfaces. 1265 | # The default value is: YES. 1266 | 1267 | ALPHABETICAL_INDEX = YES 1268 | 1269 | # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) 1270 | # that should be ignored while generating the index headers. The IGNORE_PREFIX 1271 | # tag works for classes, function and member names. The entity will be placed in 1272 | # the alphabetical list under the first letter of the entity name that remains 1273 | # after removing the prefix. 1274 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1275 | 1276 | IGNORE_PREFIX = 1277 | 1278 | #--------------------------------------------------------------------------- 1279 | # Configuration options related to the HTML output 1280 | #--------------------------------------------------------------------------- 1281 | 1282 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1283 | # The default value is: YES. 1284 | 1285 | GENERATE_HTML = YES 1286 | 1287 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1288 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1289 | # it. 1290 | # The default directory is: html. 1291 | # This tag requires that the tag GENERATE_HTML is set to YES. 1292 | 1293 | HTML_OUTPUT = html 1294 | 1295 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1296 | # generated HTML page (for example: .htm, .php, .asp). 1297 | # The default value is: .html. 1298 | # This tag requires that the tag GENERATE_HTML is set to YES. 1299 | 1300 | HTML_FILE_EXTENSION = .html 1301 | 1302 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1303 | # each generated HTML page. If the tag is left blank doxygen will generate a 1304 | # standard header. 1305 | # 1306 | # To get valid HTML the header file that includes any scripts and style sheets 1307 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1308 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1309 | # default header using 1310 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1311 | # YourConfigFile 1312 | # and then modify the file new_header.html. See also section "Doxygen usage" 1313 | # for information on how to generate the default header that doxygen normally 1314 | # uses. 1315 | # Note: The header is subject to change so you typically have to regenerate the 1316 | # default header when upgrading to a newer version of doxygen. For a description 1317 | # of the possible markers and block names see the documentation. 1318 | # This tag requires that the tag GENERATE_HTML is set to YES. 1319 | 1320 | HTML_HEADER = 1321 | 1322 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1323 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1324 | # footer. See HTML_HEADER for more information on how to generate a default 1325 | # footer and what special commands can be used inside the footer. See also 1326 | # section "Doxygen usage" for information on how to generate the default footer 1327 | # that doxygen normally uses. 1328 | # This tag requires that the tag GENERATE_HTML is set to YES. 1329 | 1330 | HTML_FOOTER = 1331 | 1332 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1333 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1334 | # the HTML output. If left blank doxygen will generate a default style sheet. 1335 | # See also section "Doxygen usage" for information on how to generate the style 1336 | # sheet that doxygen normally uses. 1337 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1338 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1339 | # obsolete. 1340 | # This tag requires that the tag GENERATE_HTML is set to YES. 1341 | 1342 | HTML_STYLESHEET = 1343 | 1344 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1345 | # cascading style sheets that are included after the standard style sheets 1346 | # created by doxygen. Using this option one can overrule certain style aspects. 1347 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1348 | # standard style sheet and is therefore more robust against future updates. 1349 | # Doxygen will copy the style sheet files to the output directory. 1350 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1351 | # style sheet in the list overrules the setting of the previous ones in the 1352 | # list). 1353 | # Note: Since the styling of scrollbars can currently not be overruled in 1354 | # Webkit/Chromium, the styling will be left out of the default doxygen.css if 1355 | # one or more extra stylesheets have been specified. So if scrollbar 1356 | # customization is desired it has to be added explicitly. For an example see the 1357 | # documentation. 1358 | # This tag requires that the tag GENERATE_HTML is set to YES. 1359 | 1360 | HTML_EXTRA_STYLESHEET = 1361 | 1362 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1363 | # other source files which should be copied to the HTML output directory. Note 1364 | # that these files will be copied to the base HTML output directory. Use the 1365 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1366 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1367 | # files will be copied as-is; there are no commands or markers available. 1368 | # This tag requires that the tag GENERATE_HTML is set to YES. 1369 | 1370 | HTML_EXTRA_FILES = 1371 | 1372 | # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output 1373 | # should be rendered with a dark or light theme. 1374 | # Possible values are: LIGHT always generate light mode output, DARK always 1375 | # generate dark mode output, AUTO_LIGHT automatically set the mode according to 1376 | # the user preference, use light mode if no preference is set (the default), 1377 | # AUTO_DARK automatically set the mode according to the user preference, use 1378 | # dark mode if no preference is set and TOGGLE allow to user to switch between 1379 | # light and dark mode via a button. 1380 | # The default value is: AUTO_LIGHT. 1381 | # This tag requires that the tag GENERATE_HTML is set to YES. 1382 | 1383 | HTML_COLORSTYLE = AUTO_LIGHT 1384 | 1385 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1386 | # will adjust the colors in the style sheet and background images according to 1387 | # this color. Hue is specified as an angle on a color-wheel, see 1388 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1389 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1390 | # purple, and 360 is red again. 1391 | # Minimum value: 0, maximum value: 359, default value: 220. 1392 | # This tag requires that the tag GENERATE_HTML is set to YES. 1393 | 1394 | HTML_COLORSTYLE_HUE = 220 1395 | 1396 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1397 | # in the HTML output. For a value of 0 the output will use gray-scales only. A 1398 | # value of 255 will produce the most vivid colors. 1399 | # Minimum value: 0, maximum value: 255, default value: 100. 1400 | # This tag requires that the tag GENERATE_HTML is set to YES. 1401 | 1402 | HTML_COLORSTYLE_SAT = 100 1403 | 1404 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1405 | # luminance component of the colors in the HTML output. Values below 100 1406 | # gradually make the output lighter, whereas values above 100 make the output 1407 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1408 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1409 | # change the gamma. 1410 | # Minimum value: 40, maximum value: 240, default value: 80. 1411 | # This tag requires that the tag GENERATE_HTML is set to YES. 1412 | 1413 | HTML_COLORSTYLE_GAMMA = 80 1414 | 1415 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1416 | # documentation will contain a main index with vertical navigation menus that 1417 | # are dynamically created via JavaScript. If disabled, the navigation index will 1418 | # consists of multiple levels of tabs that are statically embedded in every HTML 1419 | # page. Disable this option to support browsers that do not have JavaScript, 1420 | # like the Qt help browser. 1421 | # The default value is: YES. 1422 | # This tag requires that the tag GENERATE_HTML is set to YES. 1423 | 1424 | HTML_DYNAMIC_MENUS = YES 1425 | 1426 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1427 | # documentation will contain sections that can be hidden and shown after the 1428 | # page has loaded. 1429 | # The default value is: NO. 1430 | # This tag requires that the tag GENERATE_HTML is set to YES. 1431 | 1432 | HTML_DYNAMIC_SECTIONS = NO 1433 | 1434 | # If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be 1435 | # dynamically folded and expanded in the generated HTML source code. 1436 | # The default value is: YES. 1437 | # This tag requires that the tag GENERATE_HTML is set to YES. 1438 | 1439 | HTML_CODE_FOLDING = YES 1440 | 1441 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1442 | # shown in the various tree structured indices initially; the user can expand 1443 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1444 | # such a level that at most the specified number of entries are visible (unless 1445 | # a fully collapsed tree already exceeds this amount). So setting the number of 1446 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1447 | # representing an infinite number of entries and will result in a full expanded 1448 | # tree by default. 1449 | # Minimum value: 0, maximum value: 9999, default value: 100. 1450 | # This tag requires that the tag GENERATE_HTML is set to YES. 1451 | 1452 | HTML_INDEX_NUM_ENTRIES = 100 1453 | 1454 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1455 | # generated that can be used as input for Apple's Xcode 3 integrated development 1456 | # environment (see: 1457 | # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 1458 | # create a documentation set, doxygen will generate a Makefile in the HTML 1459 | # output directory. Running make will produce the docset in that directory and 1460 | # running make install will install the docset in 1461 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1462 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1463 | # genXcode/_index.html for more information. 1464 | # The default value is: NO. 1465 | # This tag requires that the tag GENERATE_HTML is set to YES. 1466 | 1467 | GENERATE_DOCSET = NO 1468 | 1469 | # This tag determines the name of the docset feed. A documentation feed provides 1470 | # an umbrella under which multiple documentation sets from a single provider 1471 | # (such as a company or product suite) can be grouped. 1472 | # The default value is: Doxygen generated docs. 1473 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1474 | 1475 | DOCSET_FEEDNAME = "Doxygen generated docs" 1476 | 1477 | # This tag determines the URL of the docset feed. A documentation feed provides 1478 | # an umbrella under which multiple documentation sets from a single provider 1479 | # (such as a company or product suite) can be grouped. 1480 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1481 | 1482 | DOCSET_FEEDURL = 1483 | 1484 | # This tag specifies a string that should uniquely identify the documentation 1485 | # set bundle. This should be a reverse domain-name style string, e.g. 1486 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1487 | # The default value is: org.doxygen.Project. 1488 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1489 | 1490 | DOCSET_BUNDLE_ID = org.doxygen.Project 1491 | 1492 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1493 | # the documentation publisher. This should be a reverse domain-name style 1494 | # string, e.g. com.mycompany.MyDocSet.documentation. 1495 | # The default value is: org.doxygen.Publisher. 1496 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1497 | 1498 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1499 | 1500 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1501 | # The default value is: Publisher. 1502 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1503 | 1504 | DOCSET_PUBLISHER_NAME = Publisher 1505 | 1506 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1507 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1508 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1509 | # on Windows. In the beginning of 2021 Microsoft took the original page, with 1510 | # a.o. the download links, offline the HTML help workshop was already many years 1511 | # in maintenance mode). You can download the HTML help workshop from the web 1512 | # archives at Installation executable (see: 1513 | # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo 1514 | # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). 1515 | # 1516 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1517 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1518 | # files are now used as the Windows 98 help format, and will replace the old 1519 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1520 | # HTML files also contain an index, a table of contents, and you can search for 1521 | # words in the documentation. The HTML workshop also contains a viewer for 1522 | # compressed HTML files. 1523 | # The default value is: NO. 1524 | # This tag requires that the tag GENERATE_HTML is set to YES. 1525 | 1526 | GENERATE_HTMLHELP = NO 1527 | 1528 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1529 | # file. You can add a path in front of the file if the result should not be 1530 | # written to the html output directory. 1531 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1532 | 1533 | CHM_FILE = 1534 | 1535 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1536 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1537 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1538 | # The file has to be specified with full path. 1539 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1540 | 1541 | HHC_LOCATION = 1542 | 1543 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1544 | # (YES) or that it should be included in the main .chm file (NO). 1545 | # The default value is: NO. 1546 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1547 | 1548 | GENERATE_CHI = NO 1549 | 1550 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1551 | # and project file content. 1552 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1553 | 1554 | CHM_INDEX_ENCODING = 1555 | 1556 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1557 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1558 | # enables the Previous and Next buttons. 1559 | # The default value is: NO. 1560 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1561 | 1562 | BINARY_TOC = NO 1563 | 1564 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1565 | # the table of contents of the HTML help documentation and to the tree view. 1566 | # The default value is: NO. 1567 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1568 | 1569 | TOC_EXPAND = NO 1570 | 1571 | # The SITEMAP_URL tag is used to specify the full URL of the place where the 1572 | # generated documentation will be placed on the server by the user during the 1573 | # deployment of the documentation. The generated sitemap is called sitemap.xml 1574 | # and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL 1575 | # is specified no sitemap is generated. For information about the sitemap 1576 | # protocol see https://www.sitemaps.org 1577 | # This tag requires that the tag GENERATE_HTML is set to YES. 1578 | 1579 | SITEMAP_URL = 1580 | 1581 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1582 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1583 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1584 | # (.qch) of the generated HTML documentation. 1585 | # The default value is: NO. 1586 | # This tag requires that the tag GENERATE_HTML is set to YES. 1587 | 1588 | GENERATE_QHP = NO 1589 | 1590 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1591 | # the file name of the resulting .qch file. The path specified is relative to 1592 | # the HTML output folder. 1593 | # This tag requires that the tag GENERATE_QHP is set to YES. 1594 | 1595 | QCH_FILE = 1596 | 1597 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1598 | # Project output. For more information please see Qt Help Project / Namespace 1599 | # (see: 1600 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1601 | # The default value is: org.doxygen.Project. 1602 | # This tag requires that the tag GENERATE_QHP is set to YES. 1603 | 1604 | QHP_NAMESPACE = org.doxygen.Project 1605 | 1606 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1607 | # Help Project output. For more information please see Qt Help Project / Virtual 1608 | # Folders (see: 1609 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 1610 | # The default value is: doc. 1611 | # This tag requires that the tag GENERATE_QHP is set to YES. 1612 | 1613 | QHP_VIRTUAL_FOLDER = doc 1614 | 1615 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1616 | # filter to add. For more information please see Qt Help Project / Custom 1617 | # Filters (see: 1618 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1619 | # This tag requires that the tag GENERATE_QHP is set to YES. 1620 | 1621 | QHP_CUST_FILTER_NAME = 1622 | 1623 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1624 | # custom filter to add. For more information please see Qt Help Project / Custom 1625 | # Filters (see: 1626 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1627 | # This tag requires that the tag GENERATE_QHP is set to YES. 1628 | 1629 | QHP_CUST_FILTER_ATTRS = 1630 | 1631 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1632 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1633 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1634 | # This tag requires that the tag GENERATE_QHP is set to YES. 1635 | 1636 | QHP_SECT_FILTER_ATTRS = 1637 | 1638 | # The QHG_LOCATION tag can be used to specify the location (absolute path 1639 | # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 1640 | # run qhelpgenerator on the generated .qhp file. 1641 | # This tag requires that the tag GENERATE_QHP is set to YES. 1642 | 1643 | QHG_LOCATION = 1644 | 1645 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1646 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1647 | # install this plugin and make it available under the help contents menu in 1648 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1649 | # to be copied into the plugins directory of eclipse. The name of the directory 1650 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1651 | # After copying Eclipse needs to be restarted before the help appears. 1652 | # The default value is: NO. 1653 | # This tag requires that the tag GENERATE_HTML is set to YES. 1654 | 1655 | GENERATE_ECLIPSEHELP = NO 1656 | 1657 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1658 | # the directory name containing the HTML and XML files should also have this 1659 | # name. Each documentation set should have its own identifier. 1660 | # The default value is: org.doxygen.Project. 1661 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1662 | 1663 | ECLIPSE_DOC_ID = org.doxygen.Project 1664 | 1665 | # If you want full control over the layout of the generated HTML pages it might 1666 | # be necessary to disable the index and replace it with your own. The 1667 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1668 | # of each HTML page. A value of NO enables the index and the value YES disables 1669 | # it. Since the tabs in the index contain the same information as the navigation 1670 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1671 | # The default value is: NO. 1672 | # This tag requires that the tag GENERATE_HTML is set to YES. 1673 | 1674 | DISABLE_INDEX = NO 1675 | 1676 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1677 | # structure should be generated to display hierarchical information. If the tag 1678 | # value is set to YES, a side panel will be generated containing a tree-like 1679 | # index structure (just like the one that is generated for HTML Help). For this 1680 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1681 | # (i.e. any modern browser). Windows users are probably better off using the 1682 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1683 | # further fine tune the look of the index (see "Fine-tuning the output"). As an 1684 | # example, the default style sheet generated by doxygen has an example that 1685 | # shows how to put an image at the root of the tree instead of the PROJECT_NAME. 1686 | # Since the tree basically has the same information as the tab index, you could 1687 | # consider setting DISABLE_INDEX to YES when enabling this option. 1688 | # The default value is: NO. 1689 | # This tag requires that the tag GENERATE_HTML is set to YES. 1690 | 1691 | GENERATE_TREEVIEW = NO 1692 | 1693 | # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the 1694 | # FULL_SIDEBAR option determines if the side bar is limited to only the treeview 1695 | # area (value NO) or if it should extend to the full height of the window (value 1696 | # YES). Setting this to YES gives a layout similar to 1697 | # https://docs.readthedocs.io with more room for contents, but less room for the 1698 | # project logo, title, and description. If either GENERATE_TREEVIEW or 1699 | # DISABLE_INDEX is set to NO, this option has no effect. 1700 | # The default value is: NO. 1701 | # This tag requires that the tag GENERATE_HTML is set to YES. 1702 | 1703 | FULL_SIDEBAR = NO 1704 | 1705 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1706 | # doxygen will group on one line in the generated HTML documentation. 1707 | # 1708 | # Note that a value of 0 will completely suppress the enum values from appearing 1709 | # in the overview section. 1710 | # Minimum value: 0, maximum value: 20, default value: 4. 1711 | # This tag requires that the tag GENERATE_HTML is set to YES. 1712 | 1713 | ENUM_VALUES_PER_LINE = 4 1714 | 1715 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1716 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1717 | # Minimum value: 0, maximum value: 1500, default value: 250. 1718 | # This tag requires that the tag GENERATE_HTML is set to YES. 1719 | 1720 | TREEVIEW_WIDTH = 250 1721 | 1722 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1723 | # external symbols imported via tag files in a separate window. 1724 | # The default value is: NO. 1725 | # This tag requires that the tag GENERATE_HTML is set to YES. 1726 | 1727 | EXT_LINKS_IN_WINDOW = NO 1728 | 1729 | # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email 1730 | # addresses. 1731 | # The default value is: YES. 1732 | # This tag requires that the tag GENERATE_HTML is set to YES. 1733 | 1734 | OBFUSCATE_EMAILS = YES 1735 | 1736 | # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 1737 | # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 1738 | # https://inkscape.org) to generate formulas as SVG images instead of PNGs for 1739 | # the HTML output. These images will generally look nicer at scaled resolutions. 1740 | # Possible values are: png (the default) and svg (looks nicer but requires the 1741 | # pdf2svg or inkscape tool). 1742 | # The default value is: png. 1743 | # This tag requires that the tag GENERATE_HTML is set to YES. 1744 | 1745 | HTML_FORMULA_FORMAT = png 1746 | 1747 | # Use this tag to change the font size of LaTeX formulas included as images in 1748 | # the HTML documentation. When you change the font size after a successful 1749 | # doxygen run you need to manually remove any form_*.png images from the HTML 1750 | # output directory to force them to be regenerated. 1751 | # Minimum value: 8, maximum value: 50, default value: 10. 1752 | # This tag requires that the tag GENERATE_HTML is set to YES. 1753 | 1754 | FORMULA_FONTSIZE = 10 1755 | 1756 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1757 | # to create new LaTeX commands to be used in formulas as building blocks. See 1758 | # the section "Including formulas" for details. 1759 | 1760 | FORMULA_MACROFILE = 1761 | 1762 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1763 | # https://www.mathjax.org) which uses client side JavaScript for the rendering 1764 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1765 | # installed or if you want to formulas look prettier in the HTML output. When 1766 | # enabled you may also need to install MathJax separately and configure the path 1767 | # to it using the MATHJAX_RELPATH option. 1768 | # The default value is: NO. 1769 | # This tag requires that the tag GENERATE_HTML is set to YES. 1770 | 1771 | USE_MATHJAX = NO 1772 | 1773 | # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. 1774 | # Note that the different versions of MathJax have different requirements with 1775 | # regards to the different settings, so it is possible that also other MathJax 1776 | # settings have to be changed when switching between the different MathJax 1777 | # versions. 1778 | # Possible values are: MathJax_2 and MathJax_3. 1779 | # The default value is: MathJax_2. 1780 | # This tag requires that the tag USE_MATHJAX is set to YES. 1781 | 1782 | MATHJAX_VERSION = MathJax_2 1783 | 1784 | # When MathJax is enabled you can set the default output format to be used for 1785 | # the MathJax output. For more details about the output format see MathJax 1786 | # version 2 (see: 1787 | # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 1788 | # (see: 1789 | # http://docs.mathjax.org/en/latest/web/components/output.html). 1790 | # Possible values are: HTML-CSS (which is slower, but has the best 1791 | # compatibility. This is the name for Mathjax version 2, for MathJax version 3 1792 | # this will be translated into chtml), NativeMML (i.e. MathML. Only supported 1793 | # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This 1794 | # is the name for Mathjax version 3, for MathJax version 2 this will be 1795 | # translated into HTML-CSS) and SVG. 1796 | # The default value is: HTML-CSS. 1797 | # This tag requires that the tag USE_MATHJAX is set to YES. 1798 | 1799 | MATHJAX_FORMAT = HTML-CSS 1800 | 1801 | # When MathJax is enabled you need to specify the location relative to the HTML 1802 | # output directory using the MATHJAX_RELPATH option. The destination directory 1803 | # should contain the MathJax.js script. For instance, if the mathjax directory 1804 | # is located at the same level as the HTML output directory, then 1805 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1806 | # Content Delivery Network so you can quickly see the result without installing 1807 | # MathJax. However, it is strongly recommended to install a local copy of 1808 | # MathJax from https://www.mathjax.org before deployment. The default value is: 1809 | # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 1810 | # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 1811 | # This tag requires that the tag USE_MATHJAX is set to YES. 1812 | 1813 | MATHJAX_RELPATH = 1814 | 1815 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1816 | # extension names that should be enabled during MathJax rendering. For example 1817 | # for MathJax version 2 (see 1818 | # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): 1819 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1820 | # For example for MathJax version 3 (see 1821 | # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): 1822 | # MATHJAX_EXTENSIONS = ams 1823 | # This tag requires that the tag USE_MATHJAX is set to YES. 1824 | 1825 | MATHJAX_EXTENSIONS = 1826 | 1827 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1828 | # of code that will be used on startup of the MathJax code. See the MathJax site 1829 | # (see: 1830 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 1831 | # example see the documentation. 1832 | # This tag requires that the tag USE_MATHJAX is set to YES. 1833 | 1834 | MATHJAX_CODEFILE = 1835 | 1836 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1837 | # the HTML output. The underlying search engine uses javascript and DHTML and 1838 | # should work on any modern browser. Note that when using HTML help 1839 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1840 | # there is already a search function so this one should typically be disabled. 1841 | # For large projects the javascript based search engine can be slow, then 1842 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1843 | # search using the keyboard; to jump to the search box use + S 1844 | # (what the is depends on the OS and browser, but it is typically 1845 | # , /