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