├── .github └── workflows │ └── main.yml ├── .gitignore ├── CMakeLists.txt ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── ORG_CODE_OF_CONDUCT.md ├── README.md ├── doxygen.conf ├── examples ├── CMakeLists.txt ├── externref.cc ├── externref.wat ├── fuel.cc ├── fuel.wat ├── gcd.cc ├── gcd.wat ├── hello.cc ├── hello.wat ├── interrupt.cc ├── interrupt.wat ├── linking.cc ├── linking1.wat ├── linking2.wat ├── memory.cc └── memory.wat ├── include └── wasmtime.hh └── tests ├── CMakeLists.txt ├── double-include-a.cc ├── double-include-b.cc ├── func.cc ├── simple.cc └── types.cc /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: [main] 5 | pull_request: 6 | branches: [main] 7 | schedule: 8 | - cron: '0 0 * * *' # run at 00:00 UTC 9 | 10 | # Cancel any in-flight jobs for the same PR/branch so there's only one active 11 | # at a time 12 | concurrency: 13 | group: ${{ github.workflow }}-${{ github.ref }} 14 | cancel-in-progress: true 15 | 16 | jobs: 17 | doc: 18 | runs-on: ubuntu-latest 19 | steps: 20 | - uses: actions/checkout@v4 21 | - run: curl -L https://www.doxygen.nl/files/doxygen-1.9.5.linux.bin.tar.gz | tar xzf - 22 | - run: echo "`pwd`/doxygen-1.9.5/bin" >> $GITHUB_PATH 23 | - run: doxygen doxygen.conf 24 | - run: tar czf html.tar.gz html 25 | - uses: actions/upload-artifact@v4 26 | with: 27 | name: c-api 28 | path: html.tar.gz 29 | - uses: JamesIves/github-pages-deploy-action@4.1.3 30 | with: 31 | branch: gh-pages 32 | folder: html 33 | single-commit: true 34 | if: github.event_name == 'push' && github.ref == 'refs/heads/main' 35 | 36 | test: 37 | runs-on: ${{ matrix.os }} 38 | strategy: 39 | matrix: 40 | include: 41 | # linux debug/release 42 | - os: ubuntu-latest 43 | config: Release 44 | args: -DCMAKE_CXX_COMPILER=clang++ 45 | - os: ubuntu-latest 46 | config: Debug 47 | args: -DCMAKE_CXX_COMPILER=clang++ 48 | 49 | # sanitizers 50 | - os: ubuntu-latest 51 | config: Debug 52 | args: -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_CXX_FLAGS="-fsanitize=address -fno-omit-frame-pointer" 53 | - os: ubuntu-latest 54 | config: Debug 55 | args: -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_CXX_FLAGS="-fsanitize=undefined -fno-omit-frame-pointer" 56 | 57 | # linux/gcc debug/release 58 | - os: ubuntu-latest 59 | config: Release 60 | gcc: true 61 | args: -DCMAKE_CXX_COMPILER=g++-10 62 | - os: ubuntu-latest 63 | config: Debug 64 | gcc: true 65 | args: -DCMAKE_CXX_COMPILER=g++-10 66 | 67 | # macos debug/release 68 | - os: macos-latest 69 | config: Release 70 | - os: macos-latest 71 | config: Debug 72 | 73 | # clang-cl debug/release 74 | - os: windows-latest 75 | config: Debug 76 | args: -T ClangCL 77 | - os: windows-latest 78 | config: Release 79 | args: -T ClangCL 80 | 81 | # cl.exe debug/release 82 | - os: windows-latest 83 | config: Debug 84 | - os: windows-latest 85 | config: Release 86 | steps: 87 | - uses: actions/checkout@v4 88 | 89 | # Download the c-api directory 90 | - run: | 91 | curl -LO https://github.com/bytecodealliance/wasmtime/releases/download/dev/wasmtime-dev-x86_64-windows-c-api.zip 92 | unzip wasmtime-dev-x86_64-windows-c-api.zip 93 | mv wasmtime-dev-x86_64-windows-c-api c-api 94 | if: matrix.os == 'windows-latest' 95 | shell: bash 96 | - run: | 97 | curl -LO https://github.com/bytecodealliance/wasmtime/releases/download/dev/wasmtime-dev-aarch64-macos-c-api.tar.xz 98 | mkdir c-api 99 | tar xf wasmtime-dev-aarch64-macos-c-api.tar.xz -C c-api --strip-components=1 100 | if: matrix.os == 'macos-latest' 101 | - run: | 102 | curl -LO https://github.com/bytecodealliance/wasmtime/releases/download/dev/wasmtime-dev-x86_64-linux-c-api.tar.xz 103 | mkdir c-api 104 | tar xf wasmtime-dev-x86_64-linux-c-api.tar.xz -C c-api --strip-components=1 105 | if: matrix.os == 'ubuntu-latest' 106 | 107 | - run: sudo apt-get update -y && sudo apt-get install -y g++-10 108 | if: matrix.gcc 109 | 110 | # Configure CMake appropriately 111 | - run: cmake -B build ${{ matrix.args }} 112 | if: matrix.os == 'windows-latest' 113 | 114 | - run: cmake -B build ${{ matrix.args }} -DCMAKE_BUILD_TYPE=${{ matrix.config }} 115 | if: matrix.os == 'ubuntu-latest' 116 | 117 | - run: echo /usr/local/opt/llvm/bin >> $GITHUB_PATH 118 | if: matrix.os == 'macos-latest' 119 | - run: cmake -B build -DCMAKE_BUILD_TYPE=${{ matrix.config }} ${{ matrix.args }} 120 | if: matrix.os == 'macos-latest' 121 | 122 | - run: cmake --build build --config ${{ matrix.config }} --verbose --parallel 4 123 | - run: ctest -C ${{ matrix.config }} --parallel 4 124 | working-directory: build 125 | env: 126 | CTEST_OUTPUT_ON_FAILURE: 1 127 | 128 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | cmake-build-*/ 3 | build 4 | c-api 5 | html 6 | latex 7 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.14) 2 | project(Wasmtime VERSION 0.27.0) 3 | 4 | if (NOT CMAKE_CXX_STANDARD) 5 | message(STATUS "Cannot detect C++ Standard. Switching to C++17 by default !!") 6 | set(CMAKE_CXX_STANDARD 17) 7 | endif() 8 | message(STATUS "CMAKE_CXX_STANDARD is ${CMAKE_CXX_STANDARD}") 9 | if (NOT CMAKE_CXX_STANDARD GREATER_EQUAL 17) 10 | message(FATAL_ERROR "WASMTIME_CPP library does not support ${CMAKE_CXX_STANDARD}") 11 | endif() 12 | set(CMAKE_CXX_STANDARD_REQUIRED True) 13 | 14 | option(ENABLE_CODE_ANALYSIS "Run code analysis" OFF) 15 | message(STATUS "ENABLE_CODE_ANALYSIS ${ENABLE_CODE_ANALYSIS}") 16 | 17 | if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") 18 | add_compile_options (-fdiagnostics-color=always) 19 | elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") 20 | add_compile_options (-fcolor-diagnostics) 21 | endif () 22 | 23 | add_library(wasmtime-cpp INTERFACE) 24 | target_link_libraries(wasmtime-cpp INTERFACE wasmtime) 25 | if (MSVC) 26 | target_compile_options(wasmtime-cpp INTERFACE /DWASM_API_EXTERN= /DWASI_API_EXTERN=) 27 | target_link_libraries(wasmtime-cpp INTERFACE ws2_32 bcrypt advapi32 userenv ntdll shell32 ole32) 28 | else() 29 | target_link_libraries(wasmtime-cpp INTERFACE stdc++ pthread) 30 | endif() 31 | 32 | target_include_directories( 33 | wasmtime-cpp 34 | INTERFACE 35 | ${PROJECT_SOURCE_DIR}/include 36 | ${PROJECT_SOURCE_DIR}/c-api/include) 37 | target_link_directories(wasmtime-cpp INTERFACE ${PROJECT_SOURCE_DIR}/c-api/lib) 38 | 39 | enable_testing() 40 | add_subdirectory(examples) 41 | add_subdirectory(tests) 42 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | *Note*: this Code of Conduct pertains to individuals' behavior. Please also see the [Organizational Code of Conduct][OCoC]. 4 | 5 | ## Our Pledge 6 | 7 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. 8 | 9 | ## Our Standards 10 | 11 | Examples of behavior that contributes to creating a positive environment include: 12 | 13 | * Using welcoming and inclusive language 14 | * Being respectful of differing viewpoints and experiences 15 | * Gracefully accepting constructive criticism 16 | * Focusing on what is best for the community 17 | * Showing empathy towards other community members 18 | 19 | Examples of unacceptable behavior by participants include: 20 | 21 | * The use of sexualized language or imagery and unwelcome sexual attention or advances 22 | * Trolling, insulting/derogatory comments, and personal or political attacks 23 | * Public or private harassment 24 | * Publishing others' private information, such as a physical or electronic address, without explicit permission 25 | * Other conduct which could reasonably be considered inappropriate in a professional setting 26 | 27 | ## Our Responsibilities 28 | 29 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. 30 | 31 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. 32 | 33 | ## Scope 34 | 35 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. 36 | 37 | ## Enforcement 38 | 39 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Bytecode Alliance CoC team at [report@bytecodealliance.org](mailto:report@bytecodealliance.org). The CoC team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The CoC team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. 40 | 41 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the Bytecode Alliance's leadership. 42 | 43 | ## Attribution 44 | 45 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] 46 | 47 | [OCoC]: https://github.com/bytecodealliance/wasmtime/blob/main/ORG_CODE_OF_CONDUCT.md 48 | [homepage]: https://www.contributor-covenant.org 49 | [version]: https://www.contributor-covenant.org/version/1/4/ 50 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to `wasmtime-cpp` 2 | 3 | `wasmtime-cpp` is a [Bytecode Alliance] project. It follows the Bytecode 4 | Alliance's [Code of Conduct] and [Organizational Code of Conduct]. 5 | 6 | So far this extension has been written by folks who are primarily Rust 7 | programmers, so feel free to create a PR to help make things more idiomatic if 8 | you see something! 9 | 10 | ## Building 11 | 12 | You'll need to acquire a [Wasmtime] installation. You can do this by extracting 13 | the C API of Wasmtime into a top-level folder called `c-api` in this repository. 14 | After doing this `c-api/include/wasmtime.h` should exist. 15 | 16 | [wasmtime]: https://wasmtime.dev/ 17 | 18 | Afterwards you can configure the C++ build with CMake: 19 | 20 | ``` 21 | $ mkdir build 22 | $ cd build 23 | $ cmake .. 24 | $ cmake --build . 25 | ``` 26 | 27 | Building will build all examples and tests. This is a header-only library which 28 | uses the C-API as a precompiled binary, so there's nothing to build for the 29 | library itself. This me 30 | 31 | ## Testing 32 | 33 | To run tests you can use CMake's `ctest` command inside the build directory. 34 | Note that this does not automatically rebuild binaries, so you may wish to run 35 | the build command first. 36 | 37 | ``` 38 | $ ctest 39 | ``` 40 | 41 | ### CI and Releases 42 | 43 | The CI for this project does a few different things. First it generates API docs 44 | for pushes to the `main` branch and are [published online][apidoc]. It also runs 45 | all tests against many supported platforms. Additionally `clang-format` is used 46 | for formatting `wasmtime.hh` and `clang-tidy` is used for more lint checks. 47 | 48 | [Bytecode Alliance]: https://bytecodealliance.org/ 49 | [Code of Conduct]: CODE_OF_CONDUCT.md 50 | [Organizational Code of Conduct]: ORG_CODE_OF_CONDUCT.md 51 | [Wasmtime]: https://github.com/bytecodealliance/wasmtime 52 | [apidoc]: https://bytecodealliance.github.io/wasmtime-cpp/ 53 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | 204 | 205 | --- LLVM Exceptions to the Apache 2.0 License ---- 206 | 207 | As an exception, if, as a result of your compiling your source code, portions 208 | of this Software are embedded into an Object form of such source code, you 209 | may redistribute such embedded portions in such Object form without complying 210 | with the conditions of Sections 4(a), 4(b) and 4(d) of the License. 211 | 212 | In addition, if you combine or link compiled forms of this Software with 213 | software that is licensed under the GPLv2 ("Combined Software") and if a 214 | court of competent jurisdiction determines that the patent provision (Section 215 | 3), the indemnity provision (Section 9) or other Section of the License 216 | conflicts with the conditions of the GPLv2, you may retroactively and 217 | prospectively choose to deem waived or otherwise exclude such Section(s) of 218 | the License, but only in their entirety and only with respect to the Combined 219 | Software. 220 | 221 | -------------------------------------------------------------------------------- /ORG_CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Bytecode Alliance Organizational Code of Conduct (OCoC) 2 | 3 | *Note*: this Code of Conduct pertains to organizations' behavior. Please also see the [Individual Code of Conduct](CODE_OF_CONDUCT.md). 4 | 5 | ## Preamble 6 | 7 | The Bytecode Alliance (BA) welcomes involvement from organizations, 8 | including commercial organizations. This document is an 9 | *organizational* code of conduct, intended particularly to provide 10 | guidance to commercial organizations. It is distinct from the 11 | [Individual Code of Conduct (ICoC)](CODE_OF_CONDUCT.md), and does not 12 | replace the ICoC. This OCoC applies to any group of people acting in 13 | concert as a BA member or as a participant in BA activities, whether 14 | or not that group is formally incorporated in some jurisdiction. 15 | 16 | The code of conduct described below is not a set of rigid rules, and 17 | we did not write it to encompass every conceivable scenario that might 18 | arise. For example, it is theoretically possible there would be times 19 | when asserting patents is in the best interest of the BA community as 20 | a whole. In such instances, consult with the BA, strive for 21 | consensus, and interpret these rules with an intent that is generous 22 | to the community the BA serves. 23 | 24 | While we may revise these guidelines from time to time based on 25 | real-world experience, overall they are based on a simple principle: 26 | 27 | *Bytecode Alliance members should observe the distinction between 28 | public community functions and private functions — especially 29 | commercial ones — and should ensure that the latter support, or at 30 | least do not harm, the former.* 31 | 32 | ## Guidelines 33 | 34 | * **Do not cause confusion about Wasm standards or interoperability.** 35 | 36 | Having an interoperable WebAssembly core is a high priority for 37 | the BA, and members should strive to preserve that core. It is fine 38 | to develop additional non-standard features or APIs, but they 39 | should always be clearly distinguished from the core interoperable 40 | Wasm. 41 | 42 | Treat the WebAssembly name and any BA-associated names with 43 | respect, and follow BA trademark and branding guidelines. If you 44 | distribute a customized version of software originally produced by 45 | the BA, or if you build a product or service using BA-derived 46 | software, use names that clearly distinguish your work from the 47 | original. (You should still provide proper attribution to the 48 | original, of course, wherever such attribution would normally be 49 | given.) 50 | 51 | Further, do not use the WebAssembly name or BA-associated names in 52 | other public namespaces in ways that could cause confusion, e.g., 53 | in company names, names of commercial service offerings, domain 54 | names, publicly-visible social media accounts or online service 55 | accounts, etc. It may sometimes be reasonable, however, to 56 | register such a name in a new namespace and then immediately donate 57 | control of that account to the BA, because that would help the project 58 | maintain its identity. 59 | 60 | For further guidance, see the BA Trademark and Branding Policy 61 | [TODO: create policy, then insert link]. 62 | 63 | * **Do not restrict contributors.** If your company requires 64 | employees or contractors to sign non-compete agreements, those 65 | agreements must not prevent people from participating in the BA or 66 | contributing to related projects. 67 | 68 | This does not mean that all non-compete agreements are incompatible 69 | with this code of conduct. For example, a company may restrict an 70 | employee's ability to solicit the company's customers. However, an 71 | agreement must not block any form of technical or social 72 | participation in BA activities, including but not limited to the 73 | implementation of particular features. 74 | 75 | The accumulation of experience and expertise in individual persons, 76 | who are ultimately free to direct their energy and attention as 77 | they decide, is one of the most important drivers of progress in 78 | open source projects. A company that limits this freedom may hinder 79 | the success of the BA's efforts. 80 | 81 | * **Do not use patents as offensive weapons.** If any BA participant 82 | prevents the adoption or development of BA technologies by 83 | asserting its patents, that undermines the purpose of the 84 | coalition. The collaboration fostered by the BA cannot include 85 | members who act to undermine its work. 86 | 87 | * **Practice responsible disclosure** for security vulnerabilities. 88 | Use designated, non-public reporting channels to disclose technical 89 | vulnerabilities, and give the project a reasonable period to 90 | respond, remediate, and patch. [TODO: optionally include the 91 | security vulnerability reporting URL here.] 92 | 93 | Vulnerability reporters may patch their company's own offerings, as 94 | long as that patching does not significantly delay the reporting of 95 | the vulnerability. Vulnerability information should never be used 96 | for unilateral commercial advantage. Vendors may legitimately 97 | compete on the speed and reliability with which they deploy 98 | security fixes, but withholding vulnerability information damages 99 | everyone in the long run by risking harm to the BA project's 100 | reputation and to the security of all users. 101 | 102 | * **Respect the letter and spirit of open source practice.** While 103 | there is not space to list here all possible aspects of standard 104 | open source practice, some examples will help show what we mean: 105 | 106 | * Abide by all applicable open source license terms. Do not engage 107 | in copyright violation or misattribution of any kind. 108 | 109 | * Do not claim others' ideas or designs as your own. 110 | 111 | * When others engage in publicly visible work (e.g., an upcoming 112 | demo that is coordinated in a public issue tracker), do not 113 | unilaterally announce early releases or early demonstrations of 114 | that work ahead of their schedule in order to secure private 115 | advantage (such as marketplace advantage) for yourself. 116 | 117 | The BA reserves the right to determine what constitutes good open 118 | source practices and to take action as it deems appropriate to 119 | encourage, and if necessary enforce, such practices. 120 | 121 | ## Enforcement 122 | 123 | Instances of organizational behavior in violation of the OCoC may 124 | be reported by contacting the Bytecode Alliance CoC team at 125 | [report@bytecodealliance.org](mailto:report@bytecodealliance.org). The 126 | CoC team will review and investigate all complaints, and will respond 127 | in a way that it deems appropriate to the circumstances. The CoC team 128 | is obligated to maintain confidentiality with regard to the reporter of 129 | an incident. Further details of specific enforcement policies may be 130 | posted separately. 131 | 132 | When the BA deems an organization in violation of this OCoC, the BA 133 | will, at its sole discretion, determine what action to take. The BA 134 | will decide what type, degree, and duration of corrective action is 135 | needed, if any, before a violating organization can be considered for 136 | membership (if it was not already a member) or can have its membership 137 | reinstated (if it was a member and the BA canceled its membership due 138 | to the violation). 139 | 140 | In practice, the BA's first approach will be to start a conversation, 141 | with punitive enforcement used only as a last resort. Violations 142 | often turn out to be unintentional and swiftly correctable with all 143 | parties acting in good faith. 144 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Repository has Moved 2 | As of 3 | [bytecodealliance/wasmtime#10582](https://github.com/bytecodealliance/wasmtime/pull/10582) 4 | this repository has moved into the Wasmtime repository itself. Please use the 5 | header files from the Wasmtime repository instead of this repository from now 6 | on. 7 | -------------------------------------------------------------------------------- /doxygen.conf: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.9.1 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the 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 = "Wasmtime: C++" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = 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 | # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all 97 | # documentation generated by doxygen is written. Doxygen will use this 98 | # information to generate all generated output in the proper direction. 99 | # Possible values are: None, LTR, RTL and Context. 100 | # The default value is: None. 101 | 102 | OUTPUT_TEXT_DIRECTION = None 103 | 104 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 105 | # descriptions after the members that are listed in the file and class 106 | # documentation (similar to Javadoc). Set to NO to disable this. 107 | # The default value is: YES. 108 | 109 | BRIEF_MEMBER_DESC = YES 110 | 111 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 112 | # description of a member or function before the detailed description 113 | # 114 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 115 | # brief descriptions will be completely suppressed. 116 | # The default value is: YES. 117 | 118 | REPEAT_BRIEF = YES 119 | 120 | # This tag implements a quasi-intelligent brief description abbreviator that is 121 | # used to form the text in various listings. Each string in this list, if found 122 | # as the leading text of the brief description, will be stripped from the text 123 | # and the result, after processing the whole list, is used as the annotated 124 | # text. Otherwise, the brief description is used as-is. If left blank, the 125 | # following values are used ($name is automatically replaced with the name of 126 | # the entity):The $name class, The $name widget, The $name file, is, provides, 127 | # specifies, contains, represents, a, an and the. 128 | 129 | ABBREVIATE_BRIEF = "The $name class" \ 130 | "The $name widget" \ 131 | "The $name file" \ 132 | is \ 133 | provides \ 134 | specifies \ 135 | contains \ 136 | represents \ 137 | a \ 138 | an \ 139 | the 140 | 141 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 142 | # doxygen will generate a detailed section even if there is only a brief 143 | # description. 144 | # The default value is: NO. 145 | 146 | ALWAYS_DETAILED_SEC = NO 147 | 148 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 149 | # inherited members of a class in the documentation of that class as if those 150 | # members were ordinary class members. Constructors, destructors and assignment 151 | # operators of the base classes will not be shown. 152 | # The default value is: NO. 153 | 154 | INLINE_INHERITED_MEMB = NO 155 | 156 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 157 | # before files name in the file list and in the header files. If set to NO the 158 | # shortest path that makes the file name unique will be used 159 | # The default value is: YES. 160 | 161 | FULL_PATH_NAMES = YES 162 | 163 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 164 | # Stripping is only done if one of the specified strings matches the left-hand 165 | # part of the path. The tag can be used to show relative paths in the file list. 166 | # If left blank the directory from which doxygen is run is used as the path to 167 | # strip. 168 | # 169 | # Note that you can specify absolute paths here, but also relative paths, which 170 | # will be relative from the directory where doxygen is started. 171 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 172 | 173 | STRIP_FROM_PATH = 174 | 175 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 176 | # path mentioned in the documentation of a class, which tells the reader which 177 | # header file to include in order to use a class. If left blank only the name of 178 | # the header file containing the class definition is used. Otherwise one should 179 | # specify the list of include paths that are normally passed to the compiler 180 | # using the -I flag. 181 | 182 | STRIP_FROM_INC_PATH = 183 | 184 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 185 | # less readable) file names. This can be useful is your file systems doesn't 186 | # support long names like on DOS, Mac, or CD-ROM. 187 | # The default value is: NO. 188 | 189 | SHORT_NAMES = NO 190 | 191 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 192 | # first line (until the first dot) of a Javadoc-style comment as the brief 193 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 194 | # style comments (thus requiring an explicit @brief command for a brief 195 | # description.) 196 | # The default value is: NO. 197 | 198 | JAVADOC_AUTOBRIEF = NO 199 | 200 | # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 201 | # such as 202 | # /*************** 203 | # as being the beginning of a Javadoc-style comment "banner". If set to NO, the 204 | # Javadoc-style will behave just like regular comments and it will not be 205 | # interpreted by doxygen. 206 | # The default value is: NO. 207 | 208 | JAVADOC_BANNER = NO 209 | 210 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 211 | # line (until the first dot) of a Qt-style comment as the brief description. If 212 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 213 | # requiring an explicit \brief command for a brief description.) 214 | # The default value is: NO. 215 | 216 | QT_AUTOBRIEF = NO 217 | 218 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 219 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 220 | # a brief description. This used to be the default behavior. The new default is 221 | # to treat a multi-line C++ comment block as a detailed description. Set this 222 | # tag to YES if you prefer the old behavior instead. 223 | # 224 | # Note that setting this tag to YES also means that rational rose comments are 225 | # not recognized any more. 226 | # The default value is: NO. 227 | 228 | MULTILINE_CPP_IS_BRIEF = NO 229 | 230 | # By default Python docstrings are displayed as preformatted text and doxygen's 231 | # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 232 | # doxygen's special commands can be used and the contents of the docstring 233 | # documentation blocks is shown as doxygen documentation. 234 | # The default value is: YES. 235 | 236 | PYTHON_DOCSTRING = YES 237 | 238 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 239 | # documentation from any documented member that it re-implements. 240 | # The default value is: YES. 241 | 242 | INHERIT_DOCS = YES 243 | 244 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 245 | # page for each member. If set to NO, the documentation of a member will be part 246 | # of the file/class/namespace that contains it. 247 | # The default value is: NO. 248 | 249 | SEPARATE_MEMBER_PAGES = NO 250 | 251 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 252 | # uses this value to replace tabs by spaces in code fragments. 253 | # Minimum value: 1, maximum value: 16, default value: 4. 254 | 255 | TAB_SIZE = 4 256 | 257 | # This tag can be used to specify a number of aliases that act as commands in 258 | # the documentation. An alias has the form: 259 | # name=value 260 | # For example adding 261 | # "sideeffect=@par Side Effects:\n" 262 | # will allow you to put the command \sideeffect (or @sideeffect) in the 263 | # documentation, which will result in a user-defined paragraph with heading 264 | # "Side Effects:". You can put \n's in the value part of an alias to insert 265 | # newlines (in the resulting output). You can put ^^ in the value part of an 266 | # alias to insert a newline as if a physical newline was in the original file. 267 | # When you need a literal { or } or , in the value part of an alias you have to 268 | # escape them by means of a backslash (\), this can lead to conflicts with the 269 | # commands \{ and \} for these it is advised to use the version @{ and @} or use 270 | # a double escape (\\{ and \\}) 271 | 272 | ALIASES = 273 | 274 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 275 | # only. Doxygen will then generate output that is more tailored for C. For 276 | # instance, some of the names that are used will be different. The list of all 277 | # members will be omitted, etc. 278 | # The default value is: NO. 279 | 280 | OPTIMIZE_OUTPUT_FOR_C = NO 281 | 282 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 283 | # Python sources only. Doxygen will then generate output that is more tailored 284 | # for that language. For instance, namespaces will be presented as packages, 285 | # qualified scopes will look different, etc. 286 | # The default value is: NO. 287 | 288 | OPTIMIZE_OUTPUT_JAVA = NO 289 | 290 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 291 | # sources. Doxygen will then generate output that is tailored for Fortran. 292 | # The default value is: NO. 293 | 294 | OPTIMIZE_FOR_FORTRAN = NO 295 | 296 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 297 | # sources. Doxygen will then generate output that is tailored for VHDL. 298 | # The default value is: NO. 299 | 300 | OPTIMIZE_OUTPUT_VHDL = NO 301 | 302 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 303 | # sources only. Doxygen will then generate output that is more tailored for that 304 | # language. For instance, namespaces will be presented as modules, types will be 305 | # separated into more groups, etc. 306 | # The default value is: NO. 307 | 308 | OPTIMIZE_OUTPUT_SLICE = NO 309 | 310 | # Doxygen selects the parser to use depending on the extension of the files it 311 | # parses. With this tag you can assign which parser to use for a given 312 | # extension. Doxygen has a built-in mapping, but you can override or extend it 313 | # using this tag. The format is ext=language, where ext is a file extension, and 314 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 315 | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, 316 | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 317 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 318 | # tries to guess whether the code is fixed or free formatted code, this is the 319 | # default for Fortran type files). For instance to make doxygen treat .inc files 320 | # as Fortran files (default is PHP), and .f files as C (default is Fortran), 321 | # use: inc=Fortran f=C. 322 | # 323 | # Note: For files without extension you can use no_extension as a placeholder. 324 | # 325 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 326 | # the files are not read by doxygen. When specifying no_extension you should add 327 | # * to the FILE_PATTERNS. 328 | # 329 | # Note see also the list of default file extension mappings. 330 | 331 | EXTENSION_MAPPING = 332 | 333 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 334 | # according to the Markdown format, which allows for more readable 335 | # documentation. See https://daringfireball.net/projects/markdown/ for details. 336 | # The output of markdown processing is further processed by doxygen, so you can 337 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 338 | # case of backward compatibilities issues. 339 | # The default value is: YES. 340 | 341 | MARKDOWN_SUPPORT = YES 342 | 343 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 344 | # to that level are automatically included in the table of contents, even if 345 | # they do not have an id attribute. 346 | # Note: This feature currently applies only to Markdown headings. 347 | # Minimum value: 0, maximum value: 99, default value: 5. 348 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 349 | 350 | TOC_INCLUDE_HEADINGS = 5 351 | 352 | # When enabled doxygen tries to link words that correspond to documented 353 | # classes, or namespaces to their corresponding documentation. Such a link can 354 | # be prevented in individual cases by putting a % sign in front of the word or 355 | # globally by setting AUTOLINK_SUPPORT to NO. 356 | # The default value is: YES. 357 | 358 | AUTOLINK_SUPPORT = YES 359 | 360 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 361 | # to include (a tag file for) the STL sources as input, then you should set this 362 | # tag to YES in order to let doxygen match functions declarations and 363 | # definitions whose arguments contain STL classes (e.g. func(std::string); 364 | # versus func(std::string) {}). This also make the inheritance and collaboration 365 | # diagrams that involve STL classes more complete and accurate. 366 | # The default value is: NO. 367 | 368 | BUILTIN_STL_SUPPORT = NO 369 | 370 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 371 | # enable parsing support. 372 | # The default value is: NO. 373 | 374 | CPP_CLI_SUPPORT = NO 375 | 376 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 377 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 378 | # will parse them like normal C++ but will assume all classes use public instead 379 | # of private inheritance when no explicit protection keyword is present. 380 | # The default value is: NO. 381 | 382 | SIP_SUPPORT = NO 383 | 384 | # For Microsoft's IDL there are propget and propput attributes to indicate 385 | # getter and setter methods for a property. Setting this option to YES will make 386 | # doxygen to replace the get and set methods by a property in the documentation. 387 | # This will only work if the methods are indeed getting or setting a simple 388 | # type. If this is not the case, or you want to show the methods anyway, you 389 | # should set this option to NO. 390 | # The default value is: YES. 391 | 392 | IDL_PROPERTY_SUPPORT = YES 393 | 394 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 395 | # tag is set to YES then doxygen will reuse the documentation of the first 396 | # member in the group (if any) for the other members of the group. By default 397 | # all members of a group must be documented explicitly. 398 | # The default value is: NO. 399 | 400 | DISTRIBUTE_GROUP_DOC = NO 401 | 402 | # If one adds a struct or class to a group and this option is enabled, then also 403 | # any nested class or struct is added to the same group. By default this option 404 | # is disabled and one has to add nested compounds explicitly via \ingroup. 405 | # The default value is: NO. 406 | 407 | GROUP_NESTED_COMPOUNDS = NO 408 | 409 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 410 | # (for instance a group of public functions) to be put as a subgroup of that 411 | # type (e.g. under the Public Functions section). Set it to NO to prevent 412 | # subgrouping. Alternatively, this can be done per class using the 413 | # \nosubgrouping command. 414 | # The default value is: YES. 415 | 416 | SUBGROUPING = YES 417 | 418 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 419 | # are shown inside the group in which they are included (e.g. using \ingroup) 420 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 421 | # and RTF). 422 | # 423 | # Note that this feature does not work in combination with 424 | # SEPARATE_MEMBER_PAGES. 425 | # The default value is: NO. 426 | 427 | INLINE_GROUPED_CLASSES = NO 428 | 429 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 430 | # with only public data fields or simple typedef fields will be shown inline in 431 | # the documentation of the scope in which they are defined (i.e. file, 432 | # namespace, or group documentation), provided this scope is documented. If set 433 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 434 | # Man pages) or section (for LaTeX and RTF). 435 | # The default value is: NO. 436 | 437 | INLINE_SIMPLE_STRUCTS = NO 438 | 439 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 440 | # enum is documented as struct, union, or enum with the name of the typedef. So 441 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 442 | # with name TypeT. When disabled the typedef will appear as a member of a file, 443 | # namespace, or class. And the struct will be named TypeS. This can typically be 444 | # useful for C code in case the coding convention dictates that all compound 445 | # types are typedef'ed and only the typedef is referenced, never the tag name. 446 | # The default value is: NO. 447 | 448 | TYPEDEF_HIDES_STRUCT = NO 449 | 450 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 451 | # cache is used to resolve symbols given their name and scope. Since this can be 452 | # an expensive process and often the same symbol appears multiple times in the 453 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 454 | # doxygen will become slower. If the cache is too large, memory is wasted. The 455 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 456 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 457 | # symbols. At the end of a run doxygen will report the cache usage and suggest 458 | # the optimal cache size from a speed point of view. 459 | # Minimum value: 0, maximum value: 9, default value: 0. 460 | 461 | LOOKUP_CACHE_SIZE = 0 462 | 463 | # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use 464 | # during processing. When set to 0 doxygen will based this on the number of 465 | # cores available in the system. You can set it explicitly to a value larger 466 | # than 0 to get more control over the balance between CPU load and processing 467 | # speed. At this moment only the input processing can be done using multiple 468 | # threads. Since this is still an experimental feature the default is set to 1, 469 | # which efficively disables parallel processing. Please report any issues you 470 | # encounter. Generating dot graphs in parallel is controlled by the 471 | # DOT_NUM_THREADS setting. 472 | # Minimum value: 0, maximum value: 32, default value: 1. 473 | 474 | NUM_PROC_THREADS = 1 475 | 476 | #--------------------------------------------------------------------------- 477 | # Build related configuration options 478 | #--------------------------------------------------------------------------- 479 | 480 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 481 | # documentation are documented, even if no documentation was available. Private 482 | # class members and static file members will be hidden unless the 483 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 484 | # Note: This will also disable the warnings about undocumented members that are 485 | # normally produced when WARNINGS is set to YES. 486 | # The default value is: NO. 487 | 488 | EXTRACT_ALL = NO 489 | 490 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 491 | # be included in the documentation. 492 | # The default value is: NO. 493 | 494 | EXTRACT_PRIVATE = NO 495 | 496 | # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 497 | # methods of a class will be included in the documentation. 498 | # The default value is: NO. 499 | 500 | EXTRACT_PRIV_VIRTUAL = NO 501 | 502 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 503 | # scope will be included in the documentation. 504 | # The default value is: NO. 505 | 506 | EXTRACT_PACKAGE = NO 507 | 508 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 509 | # included in the documentation. 510 | # The default value is: NO. 511 | 512 | EXTRACT_STATIC = NO 513 | 514 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 515 | # locally in source files will be included in the documentation. If set to NO, 516 | # only classes defined in header files are included. Does not have any effect 517 | # for Java sources. 518 | # The default value is: YES. 519 | 520 | EXTRACT_LOCAL_CLASSES = YES 521 | 522 | # This flag is only useful for Objective-C code. If set to YES, local methods, 523 | # which are defined in the implementation section but not in the interface are 524 | # included in the documentation. If set to NO, only methods in the interface are 525 | # included. 526 | # The default value is: NO. 527 | 528 | EXTRACT_LOCAL_METHODS = NO 529 | 530 | # If this flag is set to YES, the members of anonymous namespaces will be 531 | # extracted and appear in the documentation as a namespace called 532 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 533 | # the file that contains the anonymous namespace. By default anonymous namespace 534 | # are hidden. 535 | # The default value is: NO. 536 | 537 | EXTRACT_ANON_NSPACES = NO 538 | 539 | # If this flag is set to YES, the name of an unnamed parameter in a declaration 540 | # will be determined by the corresponding definition. By default unnamed 541 | # parameters remain unnamed in the output. 542 | # The default value is: YES. 543 | 544 | RESOLVE_UNNAMED_PARAMS = YES 545 | 546 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 547 | # undocumented members inside documented classes or files. If set to NO these 548 | # members will be included in the various overviews, but no documentation 549 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 550 | # The default value is: NO. 551 | 552 | HIDE_UNDOC_MEMBERS = NO 553 | 554 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 555 | # undocumented classes that are normally visible in the class hierarchy. If set 556 | # to NO, these classes will be included in the various overviews. This option 557 | # has no effect if EXTRACT_ALL is enabled. 558 | # The default value is: NO. 559 | 560 | HIDE_UNDOC_CLASSES = NO 561 | 562 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 563 | # declarations. If set to NO, these declarations will be included in the 564 | # documentation. 565 | # The default value is: NO. 566 | 567 | HIDE_FRIEND_COMPOUNDS = YES 568 | 569 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 570 | # documentation blocks found inside the body of a function. If set to NO, these 571 | # blocks will be appended to the function's detailed documentation block. 572 | # The default value is: NO. 573 | 574 | HIDE_IN_BODY_DOCS = NO 575 | 576 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 577 | # \internal command is included. If the tag is set to NO then the documentation 578 | # will be excluded. Set it to YES to include the internal documentation. 579 | # The default value is: NO. 580 | 581 | INTERNAL_DOCS = NO 582 | 583 | # With the correct setting of option CASE_SENSE_NAMES doxygen will better be 584 | # able to match the capabilities of the underlying filesystem. In case the 585 | # filesystem is case sensitive (i.e. it supports files in the same directory 586 | # whose names only differ in casing), the option must be set to YES to properly 587 | # deal with such files in case they appear in the input. For filesystems that 588 | # are not case sensitive the option should be be set to NO to properly deal with 589 | # output files written for symbols that only differ in casing, such as for two 590 | # classes, one named CLASS and the other named Class, and to also support 591 | # references to files without having to specify the exact matching casing. On 592 | # Windows (including Cygwin) and MacOS, users should typically set this option 593 | # to NO, whereas on Linux or other Unix flavors it should typically be set to 594 | # YES. 595 | # The default value is: system dependent. 596 | 597 | CASE_SENSE_NAMES = NO 598 | 599 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 600 | # their full class and namespace scopes in the documentation. If set to YES, the 601 | # scope will be hidden. 602 | # The default value is: NO. 603 | 604 | HIDE_SCOPE_NAMES = NO 605 | 606 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 607 | # append additional text to a page's title, such as Class Reference. If set to 608 | # YES the compound reference will be hidden. 609 | # The default value is: NO. 610 | 611 | HIDE_COMPOUND_REFERENCE= NO 612 | 613 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 614 | # the files that are included by a file in the documentation of that file. 615 | # The default value is: YES. 616 | 617 | SHOW_INCLUDE_FILES = YES 618 | 619 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 620 | # grouped member an include statement to the documentation, telling the reader 621 | # which file to include in order to use the member. 622 | # The default value is: NO. 623 | 624 | SHOW_GROUPED_MEMB_INC = NO 625 | 626 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 627 | # files with double quotes in the documentation rather than with sharp brackets. 628 | # The default value is: NO. 629 | 630 | FORCE_LOCAL_INCLUDES = NO 631 | 632 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 633 | # documentation for inline members. 634 | # The default value is: YES. 635 | 636 | INLINE_INFO = YES 637 | 638 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 639 | # (detailed) documentation of file and class members alphabetically by member 640 | # name. If set to NO, the members will appear in declaration order. 641 | # The default value is: YES. 642 | 643 | SORT_MEMBER_DOCS = YES 644 | 645 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 646 | # descriptions of file, namespace and class members alphabetically by member 647 | # name. If set to NO, the members will appear in declaration order. Note that 648 | # this will also influence the order of the classes in the class list. 649 | # The default value is: NO. 650 | 651 | SORT_BRIEF_DOCS = NO 652 | 653 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 654 | # (brief and detailed) documentation of class members so that constructors and 655 | # destructors are listed first. If set to NO the constructors will appear in the 656 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 657 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 658 | # member documentation. 659 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 660 | # detailed member documentation. 661 | # The default value is: NO. 662 | 663 | SORT_MEMBERS_CTORS_1ST = NO 664 | 665 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 666 | # of group names into alphabetical order. If set to NO the group names will 667 | # appear in their defined order. 668 | # The default value is: NO. 669 | 670 | SORT_GROUP_NAMES = NO 671 | 672 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 673 | # fully-qualified names, including namespaces. If set to NO, the class list will 674 | # be sorted only by class name, not including the namespace part. 675 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 676 | # Note: This option applies only to the class list, not to the alphabetical 677 | # list. 678 | # The default value is: NO. 679 | 680 | SORT_BY_SCOPE_NAME = NO 681 | 682 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 683 | # type resolution of all parameters of a function it will reject a match between 684 | # the prototype and the implementation of a member function even if there is 685 | # only one candidate or it is obvious which candidate to choose by doing a 686 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 687 | # accept a match between prototype and implementation in such cases. 688 | # The default value is: NO. 689 | 690 | STRICT_PROTO_MATCHING = NO 691 | 692 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 693 | # list. This list is created by putting \todo commands in the documentation. 694 | # The default value is: YES. 695 | 696 | GENERATE_TODOLIST = YES 697 | 698 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 699 | # list. This list is created by putting \test commands in the documentation. 700 | # The default value is: YES. 701 | 702 | GENERATE_TESTLIST = YES 703 | 704 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 705 | # list. This list is created by putting \bug commands in the documentation. 706 | # The default value is: YES. 707 | 708 | GENERATE_BUGLIST = YES 709 | 710 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 711 | # the deprecated list. This list is created by putting \deprecated commands in 712 | # the documentation. 713 | # The default value is: YES. 714 | 715 | GENERATE_DEPRECATEDLIST= YES 716 | 717 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 718 | # sections, marked by \if ... \endif and \cond 719 | # ... \endcond blocks. 720 | 721 | ENABLED_SECTIONS = 722 | 723 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 724 | # initial value of a variable or macro / define can have for it to appear in the 725 | # documentation. If the initializer consists of more lines than specified here 726 | # it will be hidden. Use a value of 0 to hide initializers completely. The 727 | # appearance of the value of individual variables and macros / defines can be 728 | # controlled using \showinitializer or \hideinitializer command in the 729 | # documentation regardless of this setting. 730 | # Minimum value: 0, maximum value: 10000, default value: 30. 731 | 732 | MAX_INITIALIZER_LINES = 30 733 | 734 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 735 | # the bottom of the documentation of classes and structs. If set to YES, the 736 | # list will mention the files that were used to generate the documentation. 737 | # The default value is: YES. 738 | 739 | SHOW_USED_FILES = YES 740 | 741 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 742 | # will remove the Files entry from the Quick Index and from the Folder Tree View 743 | # (if specified). 744 | # The default value is: YES. 745 | 746 | SHOW_FILES = YES 747 | 748 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 749 | # page. This will remove the Namespaces entry from the Quick Index and from the 750 | # Folder Tree View (if specified). 751 | # The default value is: YES. 752 | 753 | SHOW_NAMESPACES = YES 754 | 755 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 756 | # doxygen should invoke to get the current version for each file (typically from 757 | # the version control system). Doxygen will invoke the program by executing (via 758 | # popen()) the command command input-file, where command is the value of the 759 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 760 | # by doxygen. Whatever the program writes to standard output is used as the file 761 | # version. For an example see the documentation. 762 | 763 | FILE_VERSION_FILTER = 764 | 765 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 766 | # by doxygen. The layout file controls the global structure of the generated 767 | # output files in an output format independent way. To create the layout file 768 | # that represents doxygen's defaults, run doxygen with the -l option. You can 769 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 770 | # will be used as the name of the layout file. 771 | # 772 | # Note that if you run doxygen from a directory containing a file called 773 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 774 | # tag is left empty. 775 | 776 | LAYOUT_FILE = 777 | 778 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 779 | # the reference definitions. This must be a list of .bib files. The .bib 780 | # extension is automatically appended if omitted. This requires the bibtex tool 781 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 782 | # For LaTeX the style of the bibliography can be controlled using 783 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 784 | # search path. See also \cite for info how to create references. 785 | 786 | CITE_BIB_FILES = 787 | 788 | #--------------------------------------------------------------------------- 789 | # Configuration options related to warning and progress messages 790 | #--------------------------------------------------------------------------- 791 | 792 | # The QUIET tag can be used to turn on/off the messages that are generated to 793 | # standard output by doxygen. If QUIET is set to YES this implies that the 794 | # messages are off. 795 | # The default value is: NO. 796 | 797 | QUIET = NO 798 | 799 | # The WARNINGS tag can be used to turn on/off the warning messages that are 800 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 801 | # this implies that the warnings are on. 802 | # 803 | # Tip: Turn warnings on while writing the documentation. 804 | # The default value is: YES. 805 | 806 | WARNINGS = YES 807 | 808 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 809 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 810 | # will automatically be disabled. 811 | # The default value is: YES. 812 | 813 | WARN_IF_UNDOCUMENTED = NO 814 | 815 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 816 | # potential errors in the documentation, such as not documenting some parameters 817 | # in a documented function, or documenting parameters that don't exist or using 818 | # markup commands wrongly. 819 | # The default value is: YES. 820 | 821 | WARN_IF_DOC_ERROR = YES 822 | 823 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 824 | # are documented, but have no documentation for their parameters or return 825 | # value. If set to NO, doxygen will only warn about wrong or incomplete 826 | # parameter documentation, but not about the absence of documentation. If 827 | # EXTRACT_ALL is set to YES then this flag will automatically be disabled. 828 | # The default value is: NO. 829 | 830 | WARN_NO_PARAMDOC = NO 831 | 832 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 833 | # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 834 | # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 835 | # at the end of the doxygen process doxygen will return with a non-zero status. 836 | # Possible values are: NO, YES and FAIL_ON_WARNINGS. 837 | # The default value is: NO. 838 | 839 | WARN_AS_ERROR = YES 840 | 841 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 842 | # can produce. The string should contain the $file, $line, and $text tags, which 843 | # will be replaced by the file and line number from which the warning originated 844 | # and the warning text. Optionally the format may contain $version, which will 845 | # be replaced by the version of the file (if it could be obtained via 846 | # FILE_VERSION_FILTER) 847 | # The default value is: $file:$line: $text. 848 | 849 | WARN_FORMAT = "$file:$line: $text" 850 | 851 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 852 | # messages should be written. If left blank the output is written to standard 853 | # error (stderr). 854 | 855 | WARN_LOGFILE = 856 | 857 | #--------------------------------------------------------------------------- 858 | # Configuration options related to the input files 859 | #--------------------------------------------------------------------------- 860 | 861 | # The INPUT tag is used to specify the files and/or directories that contain 862 | # documented source files. You may enter file names like myfile.cpp or 863 | # directories like /usr/src/myproject. Separate the files or directories with 864 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 865 | # Note: If this tag is empty the current directory is searched. 866 | 867 | INPUT = include 868 | 869 | # This tag can be used to specify the character encoding of the source files 870 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 871 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 872 | # documentation (see: 873 | # https://www.gnu.org/software/libiconv/) for the list of possible encodings. 874 | # The default value is: UTF-8. 875 | 876 | INPUT_ENCODING = UTF-8 877 | 878 | # If the value of the INPUT tag contains directories, you can use the 879 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 880 | # *.h) to filter out the source-files in the directories. 881 | # 882 | # Note that for custom extensions or not directly supported extensions you also 883 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 884 | # read by doxygen. 885 | # 886 | # Note the list of default checked file patterns might differ from the list of 887 | # default file extension mappings. 888 | # 889 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 890 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 891 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 892 | # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), 893 | # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, 894 | # *.ucf, *.qsf and *.ice. 895 | 896 | FILE_PATTERNS = *.c \ 897 | *.cc \ 898 | *.cxx \ 899 | *.cpp \ 900 | *.c++ \ 901 | *.java \ 902 | *.ii \ 903 | *.ixx \ 904 | *.ipp \ 905 | *.i++ \ 906 | *.inl \ 907 | *.idl \ 908 | *.ddl \ 909 | *.odl \ 910 | *.h \ 911 | *.hh \ 912 | *.hxx \ 913 | *.hpp \ 914 | *.h++ \ 915 | *.cs \ 916 | *.d \ 917 | *.php \ 918 | *.php4 \ 919 | *.php5 \ 920 | *.phtml \ 921 | *.inc \ 922 | *.m \ 923 | *.markdown \ 924 | *.md \ 925 | *.mm \ 926 | *.dox \ 927 | *.py \ 928 | *.pyw \ 929 | *.f90 \ 930 | *.f95 \ 931 | *.f03 \ 932 | *.f08 \ 933 | *.f18 \ 934 | *.f \ 935 | *.for \ 936 | *.vhd \ 937 | *.vhdl \ 938 | *.ucf \ 939 | *.qsf \ 940 | *.ice 941 | 942 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 943 | # be searched for input files as well. 944 | # The default value is: NO. 945 | 946 | RECURSIVE = NO 947 | 948 | # The EXCLUDE tag can be used to specify files and/or directories that should be 949 | # excluded from the INPUT source files. This way you can easily exclude a 950 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 951 | # 952 | # Note that relative paths are relative to the directory from which doxygen is 953 | # run. 954 | 955 | EXCLUDE = 956 | 957 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 958 | # directories that are symbolic links (a Unix file system feature) are excluded 959 | # from the input. 960 | # The default value is: NO. 961 | 962 | EXCLUDE_SYMLINKS = NO 963 | 964 | # If the value of the INPUT tag contains directories, you can use the 965 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 966 | # certain files from those directories. 967 | # 968 | # Note that the wildcards are matched against the file with absolute path, so to 969 | # exclude all test directories for example use the pattern */test/* 970 | 971 | EXCLUDE_PATTERNS = 972 | 973 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 974 | # (namespaces, classes, functions, etc.) that should be excluded from the 975 | # output. The symbol name can be a fully qualified name, a word, or if the 976 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 977 | # AClass::ANamespace, ANamespace::*Test 978 | # 979 | # Note that the wildcards are matched against the file with absolute path, so to 980 | # exclude all test directories use the pattern */test/* 981 | 982 | EXCLUDE_SYMBOLS = 983 | 984 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 985 | # that contain example code fragments that are included (see the \include 986 | # command). 987 | 988 | EXAMPLE_PATH = examples 989 | 990 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 991 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 992 | # *.h) to filter out the source-files in the directories. If left blank all 993 | # files are included. 994 | 995 | EXAMPLE_PATTERNS = * 996 | 997 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 998 | # searched for input files to be used with the \include or \dontinclude commands 999 | # irrespective of the value of the RECURSIVE tag. 1000 | # The default value is: NO. 1001 | 1002 | EXAMPLE_RECURSIVE = NO 1003 | 1004 | # The IMAGE_PATH tag can be used to specify one or more files or directories 1005 | # that contain images that are to be included in the documentation (see the 1006 | # \image command). 1007 | 1008 | IMAGE_PATH = 1009 | 1010 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 1011 | # invoke to filter for each input file. Doxygen will invoke the filter program 1012 | # by executing (via popen()) the command: 1013 | # 1014 | # 1015 | # 1016 | # where is the value of the INPUT_FILTER tag, and is the 1017 | # name of an input file. Doxygen will then use the output that the filter 1018 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 1019 | # will be ignored. 1020 | # 1021 | # Note that the filter must not add or remove lines; it is applied before the 1022 | # code is scanned, but not when the output code is generated. If lines are added 1023 | # or removed, the anchors will not be placed correctly. 1024 | # 1025 | # Note that for custom extensions or not directly supported extensions you also 1026 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1027 | # properly processed by doxygen. 1028 | 1029 | INPUT_FILTER = 1030 | 1031 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1032 | # basis. Doxygen will compare the file name with each pattern and apply the 1033 | # filter if there is a match. The filters are a list of the form: pattern=filter 1034 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 1035 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1036 | # patterns match the file name, INPUT_FILTER is applied. 1037 | # 1038 | # Note that for custom extensions or not directly supported extensions you also 1039 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1040 | # properly processed by doxygen. 1041 | 1042 | FILTER_PATTERNS = 1043 | 1044 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1045 | # INPUT_FILTER) will also be used to filter the input files that are used for 1046 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1047 | # The default value is: NO. 1048 | 1049 | FILTER_SOURCE_FILES = NO 1050 | 1051 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1052 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1053 | # it is also possible to disable source filtering for a specific pattern using 1054 | # *.ext= (so without naming a filter). 1055 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1056 | 1057 | FILTER_SOURCE_PATTERNS = 1058 | 1059 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1060 | # is part of the input, its contents will be placed on the main page 1061 | # (index.html). This can be useful if you have a project on for instance GitHub 1062 | # and want to reuse the introduction page also for the doxygen output. 1063 | 1064 | USE_MDFILE_AS_MAINPAGE = 1065 | 1066 | #--------------------------------------------------------------------------- 1067 | # Configuration options related to source browsing 1068 | #--------------------------------------------------------------------------- 1069 | 1070 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1071 | # generated. Documented entities will be cross-referenced with these sources. 1072 | # 1073 | # Note: To get rid of all source code in the generated output, make sure that 1074 | # also VERBATIM_HEADERS is set to NO. 1075 | # The default value is: NO. 1076 | 1077 | SOURCE_BROWSER = NO 1078 | 1079 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1080 | # classes and enums directly into the documentation. 1081 | # The default value is: NO. 1082 | 1083 | INLINE_SOURCES = NO 1084 | 1085 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1086 | # special comment blocks from generated source code fragments. Normal C, C++ and 1087 | # Fortran comments will always remain visible. 1088 | # The default value is: YES. 1089 | 1090 | STRIP_CODE_COMMENTS = YES 1091 | 1092 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1093 | # entity all documented functions referencing it will be listed. 1094 | # The default value is: NO. 1095 | 1096 | REFERENCED_BY_RELATION = NO 1097 | 1098 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1099 | # all documented entities called/used by that function will be listed. 1100 | # The default value is: NO. 1101 | 1102 | REFERENCES_RELATION = NO 1103 | 1104 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1105 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1106 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1107 | # link to the documentation. 1108 | # The default value is: YES. 1109 | 1110 | REFERENCES_LINK_SOURCE = YES 1111 | 1112 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1113 | # source code will show a tooltip with additional information such as prototype, 1114 | # brief description and links to the definition and documentation. Since this 1115 | # will make the HTML file larger and loading of large files a bit slower, you 1116 | # can opt to disable this feature. 1117 | # The default value is: YES. 1118 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1119 | 1120 | SOURCE_TOOLTIPS = YES 1121 | 1122 | # If the USE_HTAGS tag is set to YES then the references to source code will 1123 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1124 | # source browser. The htags tool is part of GNU's global source tagging system 1125 | # (see https://www.gnu.org/software/global/global.html). You will need version 1126 | # 4.8.6 or higher. 1127 | # 1128 | # To use it do the following: 1129 | # - Install the latest version of global 1130 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1131 | # - Make sure the INPUT points to the root of the source tree 1132 | # - Run doxygen as normal 1133 | # 1134 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1135 | # tools must be available from the command line (i.e. in the search path). 1136 | # 1137 | # The result: instead of the source browser generated by doxygen, the links to 1138 | # source code will now point to the output of htags. 1139 | # The default value is: NO. 1140 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1141 | 1142 | USE_HTAGS = NO 1143 | 1144 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1145 | # verbatim copy of the header file for each class for which an include is 1146 | # specified. Set to NO to disable this. 1147 | # See also: Section \class. 1148 | # The default value is: YES. 1149 | 1150 | VERBATIM_HEADERS = YES 1151 | 1152 | #--------------------------------------------------------------------------- 1153 | # Configuration options related to the alphabetical class index 1154 | #--------------------------------------------------------------------------- 1155 | 1156 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1157 | # compounds will be generated. Enable this if the project contains a lot of 1158 | # classes, structs, unions or interfaces. 1159 | # The default value is: YES. 1160 | 1161 | ALPHABETICAL_INDEX = YES 1162 | 1163 | # In case all classes in a project start with a common prefix, all classes will 1164 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1165 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1166 | # while generating the index headers. 1167 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1168 | 1169 | IGNORE_PREFIX = 1170 | 1171 | #--------------------------------------------------------------------------- 1172 | # Configuration options related to the HTML output 1173 | #--------------------------------------------------------------------------- 1174 | 1175 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1176 | # The default value is: YES. 1177 | 1178 | GENERATE_HTML = YES 1179 | 1180 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1181 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1182 | # it. 1183 | # The default directory is: html. 1184 | # This tag requires that the tag GENERATE_HTML is set to YES. 1185 | 1186 | HTML_OUTPUT = html 1187 | 1188 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1189 | # generated HTML page (for example: .htm, .php, .asp). 1190 | # The default value is: .html. 1191 | # This tag requires that the tag GENERATE_HTML is set to YES. 1192 | 1193 | HTML_FILE_EXTENSION = .html 1194 | 1195 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1196 | # each generated HTML page. If the tag is left blank doxygen will generate a 1197 | # standard header. 1198 | # 1199 | # To get valid HTML the header file that includes any scripts and style sheets 1200 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1201 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1202 | # default header using 1203 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1204 | # YourConfigFile 1205 | # and then modify the file new_header.html. See also section "Doxygen usage" 1206 | # for information on how to generate the default header that doxygen normally 1207 | # uses. 1208 | # Note: The header is subject to change so you typically have to regenerate the 1209 | # default header when upgrading to a newer version of doxygen. For a description 1210 | # of the possible markers and block names see the documentation. 1211 | # This tag requires that the tag GENERATE_HTML is set to YES. 1212 | 1213 | HTML_HEADER = 1214 | 1215 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1216 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1217 | # footer. See HTML_HEADER for more information on how to generate a default 1218 | # footer and what special commands can be used inside the footer. See also 1219 | # section "Doxygen usage" for information on how to generate the default footer 1220 | # that doxygen normally uses. 1221 | # This tag requires that the tag GENERATE_HTML is set to YES. 1222 | 1223 | HTML_FOOTER = 1224 | 1225 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1226 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1227 | # the HTML output. If left blank doxygen will generate a default style sheet. 1228 | # See also section "Doxygen usage" for information on how to generate the style 1229 | # sheet that doxygen normally uses. 1230 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1231 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1232 | # obsolete. 1233 | # This tag requires that the tag GENERATE_HTML is set to YES. 1234 | 1235 | HTML_STYLESHEET = 1236 | 1237 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1238 | # cascading style sheets that are included after the standard style sheets 1239 | # created by doxygen. Using this option one can overrule certain style aspects. 1240 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1241 | # standard style sheet and is therefore more robust against future updates. 1242 | # Doxygen will copy the style sheet files to the output directory. 1243 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1244 | # style sheet in the list overrules the setting of the previous ones in the 1245 | # list). For an example see the documentation. 1246 | # This tag requires that the tag GENERATE_HTML is set to YES. 1247 | 1248 | HTML_EXTRA_STYLESHEET = 1249 | 1250 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1251 | # other source files which should be copied to the HTML output directory. Note 1252 | # that these files will be copied to the base HTML output directory. Use the 1253 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1254 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1255 | # files will be copied as-is; there are no commands or markers available. 1256 | # This tag requires that the tag GENERATE_HTML is set to YES. 1257 | 1258 | HTML_EXTRA_FILES = 1259 | 1260 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1261 | # will adjust the colors in the style sheet and background images according to 1262 | # this color. Hue is specified as an angle on a colorwheel, see 1263 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1264 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1265 | # purple, and 360 is red again. 1266 | # Minimum value: 0, maximum value: 359, default value: 220. 1267 | # This tag requires that the tag GENERATE_HTML is set to YES. 1268 | 1269 | HTML_COLORSTYLE_HUE = 220 1270 | 1271 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1272 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1273 | # value of 255 will produce the most vivid colors. 1274 | # Minimum value: 0, maximum value: 255, default value: 100. 1275 | # This tag requires that the tag GENERATE_HTML is set to YES. 1276 | 1277 | HTML_COLORSTYLE_SAT = 100 1278 | 1279 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1280 | # luminance component of the colors in the HTML output. Values below 100 1281 | # gradually make the output lighter, whereas values above 100 make the output 1282 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1283 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1284 | # change the gamma. 1285 | # Minimum value: 40, maximum value: 240, default value: 80. 1286 | # This tag requires that the tag GENERATE_HTML is set to YES. 1287 | 1288 | HTML_COLORSTYLE_GAMMA = 80 1289 | 1290 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1291 | # page will contain the date and time when the page was generated. Setting this 1292 | # to YES can help to show when doxygen was last run and thus if the 1293 | # documentation is up to date. 1294 | # The default value is: NO. 1295 | # This tag requires that the tag GENERATE_HTML is set to YES. 1296 | 1297 | HTML_TIMESTAMP = NO 1298 | 1299 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1300 | # documentation will contain a main index with vertical navigation menus that 1301 | # are dynamically created via JavaScript. If disabled, the navigation index will 1302 | # consists of multiple levels of tabs that are statically embedded in every HTML 1303 | # page. Disable this option to support browsers that do not have JavaScript, 1304 | # like the Qt help browser. 1305 | # The default value is: YES. 1306 | # This tag requires that the tag GENERATE_HTML is set to YES. 1307 | 1308 | HTML_DYNAMIC_MENUS = YES 1309 | 1310 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1311 | # documentation will contain sections that can be hidden and shown after the 1312 | # page has loaded. 1313 | # The default value is: NO. 1314 | # This tag requires that the tag GENERATE_HTML is set to YES. 1315 | 1316 | HTML_DYNAMIC_SECTIONS = NO 1317 | 1318 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1319 | # shown in the various tree structured indices initially; the user can expand 1320 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1321 | # such a level that at most the specified number of entries are visible (unless 1322 | # a fully collapsed tree already exceeds this amount). So setting the number of 1323 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1324 | # representing an infinite number of entries and will result in a full expanded 1325 | # tree by default. 1326 | # Minimum value: 0, maximum value: 9999, default value: 100. 1327 | # This tag requires that the tag GENERATE_HTML is set to YES. 1328 | 1329 | HTML_INDEX_NUM_ENTRIES = 100 1330 | 1331 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1332 | # generated that can be used as input for Apple's Xcode 3 integrated development 1333 | # environment (see: 1334 | # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 1335 | # create a documentation set, doxygen will generate a Makefile in the HTML 1336 | # output directory. Running make will produce the docset in that directory and 1337 | # running make install will install the docset in 1338 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1339 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1340 | # genXcode/_index.html for more information. 1341 | # The default value is: NO. 1342 | # This tag requires that the tag GENERATE_HTML is set to YES. 1343 | 1344 | GENERATE_DOCSET = NO 1345 | 1346 | # This tag determines the name of the docset feed. A documentation feed provides 1347 | # an umbrella under which multiple documentation sets from a single provider 1348 | # (such as a company or product suite) can be grouped. 1349 | # The default value is: Doxygen generated docs. 1350 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1351 | 1352 | DOCSET_FEEDNAME = "Doxygen generated docs" 1353 | 1354 | # This tag specifies a string that should uniquely identify the documentation 1355 | # set bundle. This should be a reverse domain-name style string, e.g. 1356 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1357 | # The default value is: org.doxygen.Project. 1358 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1359 | 1360 | DOCSET_BUNDLE_ID = org.doxygen.Project 1361 | 1362 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1363 | # the documentation publisher. This should be a reverse domain-name style 1364 | # string, e.g. com.mycompany.MyDocSet.documentation. 1365 | # The default value is: org.doxygen.Publisher. 1366 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1367 | 1368 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1369 | 1370 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1371 | # The default value is: Publisher. 1372 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1373 | 1374 | DOCSET_PUBLISHER_NAME = Publisher 1375 | 1376 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1377 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1378 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1379 | # (see: 1380 | # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. 1381 | # 1382 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1383 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1384 | # files are now used as the Windows 98 help format, and will replace the old 1385 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1386 | # HTML files also contain an index, a table of contents, and you can search for 1387 | # words in the documentation. The HTML workshop also contains a viewer for 1388 | # compressed HTML files. 1389 | # The default value is: NO. 1390 | # This tag requires that the tag GENERATE_HTML is set to YES. 1391 | 1392 | GENERATE_HTMLHELP = NO 1393 | 1394 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1395 | # file. You can add a path in front of the file if the result should not be 1396 | # written to the html output directory. 1397 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1398 | 1399 | CHM_FILE = 1400 | 1401 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1402 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1403 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1404 | # The file has to be specified with full path. 1405 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1406 | 1407 | HHC_LOCATION = 1408 | 1409 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1410 | # (YES) or that it should be included in the main .chm file (NO). 1411 | # The default value is: NO. 1412 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1413 | 1414 | GENERATE_CHI = NO 1415 | 1416 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1417 | # and project file content. 1418 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1419 | 1420 | CHM_INDEX_ENCODING = 1421 | 1422 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1423 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1424 | # enables the Previous and Next buttons. 1425 | # The default value is: NO. 1426 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1427 | 1428 | BINARY_TOC = NO 1429 | 1430 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1431 | # the table of contents of the HTML help documentation and to the tree view. 1432 | # The default value is: NO. 1433 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1434 | 1435 | TOC_EXPAND = NO 1436 | 1437 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1438 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1439 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1440 | # (.qch) of the generated HTML documentation. 1441 | # The default value is: NO. 1442 | # This tag requires that the tag GENERATE_HTML is set to YES. 1443 | 1444 | GENERATE_QHP = NO 1445 | 1446 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1447 | # the file name of the resulting .qch file. The path specified is relative to 1448 | # the HTML output folder. 1449 | # This tag requires that the tag GENERATE_QHP is set to YES. 1450 | 1451 | QCH_FILE = 1452 | 1453 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1454 | # Project output. For more information please see Qt Help Project / Namespace 1455 | # (see: 1456 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1457 | # The default value is: org.doxygen.Project. 1458 | # This tag requires that the tag GENERATE_QHP is set to YES. 1459 | 1460 | QHP_NAMESPACE = org.doxygen.Project 1461 | 1462 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1463 | # Help Project output. For more information please see Qt Help Project / Virtual 1464 | # Folders (see: 1465 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 1466 | # The default value is: doc. 1467 | # This tag requires that the tag GENERATE_QHP is set to YES. 1468 | 1469 | QHP_VIRTUAL_FOLDER = doc 1470 | 1471 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1472 | # filter to add. For more information please see Qt Help Project / Custom 1473 | # Filters (see: 1474 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1475 | # This tag requires that the tag GENERATE_QHP is set to YES. 1476 | 1477 | QHP_CUST_FILTER_NAME = 1478 | 1479 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1480 | # custom filter to add. For more information please see Qt Help Project / Custom 1481 | # Filters (see: 1482 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1483 | # This tag requires that the tag GENERATE_QHP is set to YES. 1484 | 1485 | QHP_CUST_FILTER_ATTRS = 1486 | 1487 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1488 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1489 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1490 | # This tag requires that the tag GENERATE_QHP is set to YES. 1491 | 1492 | QHP_SECT_FILTER_ATTRS = 1493 | 1494 | # The QHG_LOCATION tag can be used to specify the location (absolute path 1495 | # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 1496 | # run qhelpgenerator on the generated .qhp file. 1497 | # This tag requires that the tag GENERATE_QHP is set to YES. 1498 | 1499 | QHG_LOCATION = 1500 | 1501 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1502 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1503 | # install this plugin and make it available under the help contents menu in 1504 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1505 | # to be copied into the plugins directory of eclipse. The name of the directory 1506 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1507 | # After copying Eclipse needs to be restarted before the help appears. 1508 | # The default value is: NO. 1509 | # This tag requires that the tag GENERATE_HTML is set to YES. 1510 | 1511 | GENERATE_ECLIPSEHELP = NO 1512 | 1513 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1514 | # the directory name containing the HTML and XML files should also have this 1515 | # name. Each documentation set should have its own identifier. 1516 | # The default value is: org.doxygen.Project. 1517 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1518 | 1519 | ECLIPSE_DOC_ID = org.doxygen.Project 1520 | 1521 | # If you want full control over the layout of the generated HTML pages it might 1522 | # be necessary to disable the index and replace it with your own. The 1523 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1524 | # of each HTML page. A value of NO enables the index and the value YES disables 1525 | # it. Since the tabs in the index contain the same information as the navigation 1526 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1527 | # The default value is: NO. 1528 | # This tag requires that the tag GENERATE_HTML is set to YES. 1529 | 1530 | DISABLE_INDEX = NO 1531 | 1532 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1533 | # structure should be generated to display hierarchical information. If the tag 1534 | # value is set to YES, a side panel will be generated containing a tree-like 1535 | # index structure (just like the one that is generated for HTML Help). For this 1536 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1537 | # (i.e. any modern browser). Windows users are probably better off using the 1538 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1539 | # further fine-tune the look of the index. As an example, the default style 1540 | # sheet generated by doxygen has an example that shows how to put an image at 1541 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1542 | # the same information as the tab index, you could consider setting 1543 | # DISABLE_INDEX to YES when enabling this option. 1544 | # The default value is: NO. 1545 | # This tag requires that the tag GENERATE_HTML is set to YES. 1546 | 1547 | GENERATE_TREEVIEW = NO 1548 | 1549 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1550 | # doxygen will group on one line in the generated HTML documentation. 1551 | # 1552 | # Note that a value of 0 will completely suppress the enum values from appearing 1553 | # in the overview section. 1554 | # Minimum value: 0, maximum value: 20, default value: 4. 1555 | # This tag requires that the tag GENERATE_HTML is set to YES. 1556 | 1557 | ENUM_VALUES_PER_LINE = 4 1558 | 1559 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1560 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1561 | # Minimum value: 0, maximum value: 1500, default value: 250. 1562 | # This tag requires that the tag GENERATE_HTML is set to YES. 1563 | 1564 | TREEVIEW_WIDTH = 250 1565 | 1566 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1567 | # external symbols imported via tag files in a separate window. 1568 | # The default value is: NO. 1569 | # This tag requires that the tag GENERATE_HTML is set to YES. 1570 | 1571 | EXT_LINKS_IN_WINDOW = NO 1572 | 1573 | # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 1574 | # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 1575 | # https://inkscape.org) to generate formulas as SVG images instead of PNGs for 1576 | # the HTML output. These images will generally look nicer at scaled resolutions. 1577 | # Possible values are: png (the default) and svg (looks nicer but requires the 1578 | # pdf2svg or inkscape tool). 1579 | # The default value is: png. 1580 | # This tag requires that the tag GENERATE_HTML is set to YES. 1581 | 1582 | HTML_FORMULA_FORMAT = png 1583 | 1584 | # Use this tag to change the font size of LaTeX formulas included as images in 1585 | # the HTML documentation. When you change the font size after a successful 1586 | # doxygen run you need to manually remove any form_*.png images from the HTML 1587 | # output directory to force them to be regenerated. 1588 | # Minimum value: 8, maximum value: 50, default value: 10. 1589 | # This tag requires that the tag GENERATE_HTML is set to YES. 1590 | 1591 | FORMULA_FONTSIZE = 10 1592 | 1593 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1594 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1595 | # supported properly for IE 6.0, but are supported on all modern browsers. 1596 | # 1597 | # Note that when changing this option you need to delete any form_*.png files in 1598 | # the HTML output directory before the changes have effect. 1599 | # The default value is: YES. 1600 | # This tag requires that the tag GENERATE_HTML is set to YES. 1601 | 1602 | FORMULA_TRANSPARENT = YES 1603 | 1604 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1605 | # to create new LaTeX commands to be used in formulas as building blocks. See 1606 | # the section "Including formulas" for details. 1607 | 1608 | FORMULA_MACROFILE = 1609 | 1610 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1611 | # https://www.mathjax.org) which uses client side JavaScript for the rendering 1612 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1613 | # installed or if you want to formulas look prettier in the HTML output. When 1614 | # enabled you may also need to install MathJax separately and configure the path 1615 | # to it using the MATHJAX_RELPATH option. 1616 | # The default value is: NO. 1617 | # This tag requires that the tag GENERATE_HTML is set to YES. 1618 | 1619 | USE_MATHJAX = NO 1620 | 1621 | # When MathJax is enabled you can set the default output format to be used for 1622 | # the MathJax output. See the MathJax site (see: 1623 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. 1624 | # Possible values are: HTML-CSS (which is slower, but has the best 1625 | # compatibility), NativeMML (i.e. MathML) and SVG. 1626 | # The default value is: HTML-CSS. 1627 | # This tag requires that the tag USE_MATHJAX is set to YES. 1628 | 1629 | MATHJAX_FORMAT = HTML-CSS 1630 | 1631 | # When MathJax is enabled you need to specify the location relative to the HTML 1632 | # output directory using the MATHJAX_RELPATH option. The destination directory 1633 | # should contain the MathJax.js script. For instance, if the mathjax directory 1634 | # is located at the same level as the HTML output directory, then 1635 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1636 | # Content Delivery Network so you can quickly see the result without installing 1637 | # MathJax. However, it is strongly recommended to install a local copy of 1638 | # MathJax from https://www.mathjax.org before deployment. 1639 | # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. 1640 | # This tag requires that the tag USE_MATHJAX is set to YES. 1641 | 1642 | MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 1643 | 1644 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1645 | # extension names that should be enabled during MathJax rendering. For example 1646 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1647 | # This tag requires that the tag USE_MATHJAX is set to YES. 1648 | 1649 | MATHJAX_EXTENSIONS = 1650 | 1651 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1652 | # of code that will be used on startup of the MathJax code. See the MathJax site 1653 | # (see: 1654 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 1655 | # example see the documentation. 1656 | # This tag requires that the tag USE_MATHJAX is set to YES. 1657 | 1658 | MATHJAX_CODEFILE = 1659 | 1660 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1661 | # the HTML output. The underlying search engine uses javascript and DHTML and 1662 | # should work on any modern browser. Note that when using HTML help 1663 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1664 | # there is already a search function so this one should typically be disabled. 1665 | # For large projects the javascript based search engine can be slow, then 1666 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1667 | # search using the keyboard; to jump to the search box use + S 1668 | # (what the is depends on the OS and browser, but it is typically 1669 | # , /