├── .codespellrc ├── .github ├── dependabot.yml └── workflows │ ├── check-arduino.yml │ ├── compile-examples.yml │ ├── report-size-deltas.yml │ ├── spell-check.yml │ └── sync-labels.yml ├── .gitignore ├── LICENSE.txt ├── README.adoc ├── docs ├── api.md └── readme.md ├── documentation ├── Doxyfile └── src │ └── Logo.png ├── examples ├── MIDIUSB_buzzer │ └── MIDIUSB_buzzer.ino ├── MIDIUSB_clock │ └── MIDIUSB_clock.ino ├── MIDIUSB_loop │ └── MIDIUSB_loop.ino ├── MIDIUSB_read │ └── MIDIUSB_read.ino └── MIDIUSB_write │ └── MIDIUSB_write.ino ├── keywords.txt ├── library.properties └── src ├── MIDIUSB.cpp ├── MIDIUSB.h ├── MIDIUSB_Defs.h ├── frequencyToNote.h ├── pitchToFrequency.h └── pitchToNote.h /.codespellrc: -------------------------------------------------------------------------------- 1 | # See: https://github.com/codespell-project/codespell#using-a-config-file 2 | [codespell] 3 | # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: 4 | ignore-words-list = , 5 | check-filenames = 6 | check-hidden = 7 | skip = ./.git 8 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file 2 | version: 2 3 | 4 | updates: 5 | # Configure check for outdated GitHub Actions actions in workflows. 6 | # See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot 7 | - package-ecosystem: github-actions 8 | directory: / # Check the repository's workflows under /.github/workflows/ 9 | schedule: 10 | interval: daily 11 | labels: 12 | - "topic: infrastructure" 13 | -------------------------------------------------------------------------------- /.github/workflows/check-arduino.yml: -------------------------------------------------------------------------------- 1 | name: Check Arduino 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | pull_request: 7 | schedule: 8 | # Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint. 9 | - cron: "0 8 * * TUE" 10 | workflow_dispatch: 11 | repository_dispatch: 12 | 13 | jobs: 14 | lint: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout repository 19 | uses: actions/checkout@v4 20 | 21 | - name: Arduino Lint 22 | uses: arduino/arduino-lint-action@v2 23 | with: 24 | compliance: specification 25 | library-manager: update 26 | # Always use this setting for official repositories. Remove for 3rd party projects. 27 | official: true 28 | project-type: library 29 | -------------------------------------------------------------------------------- /.github/workflows/compile-examples.yml: -------------------------------------------------------------------------------- 1 | name: Compile Examples 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | paths: 7 | - ".github/workflows/compile-examples.yml" 8 | - "examples/**" 9 | - "src/**" 10 | pull_request: 11 | paths: 12 | - ".github/workflows/compile-examples.yml" 13 | - "examples/**" 14 | - "src/**" 15 | schedule: 16 | # Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms). 17 | - cron: "0 8 * * TUE" 18 | workflow_dispatch: 19 | repository_dispatch: 20 | 21 | jobs: 22 | build: 23 | name: ${{ matrix.board.fqbn }} 24 | runs-on: ubuntu-latest 25 | 26 | env: 27 | SKETCHES_REPORTS_PATH: sketches-reports 28 | 29 | strategy: 30 | fail-fast: false 31 | 32 | matrix: 33 | board: 34 | - fqbn: arduino:avr:leonardo 35 | platforms: | 36 | - name: arduino:avr 37 | tone: true 38 | artifact-name-suffix: arduino-avr-leonardo 39 | - fqbn: arduino:sam:arduino_due_x_dbg 40 | platforms: | 41 | - name: arduino:sam 42 | # Bug report: https://github.com/arduino/ArduinoCore-sam/issues/24 43 | # Change the value to true once it is fixed. 44 | tone: false 45 | artifact-name-suffix: arduino-sam-arduino_due_x_dbg 46 | - fqbn: arduino:samd:mkrzero 47 | platforms: | 48 | - name: arduino:samd 49 | tone: true 50 | artifact-name-suffix: arduino-samd-mkrzero 51 | - fqbn: arduino:samd:nano_33_iot 52 | platforms: | 53 | - name: arduino:samd 54 | tone: true 55 | artifact-name-suffix: arduino-samd-nano_33_iot 56 | 57 | # Make board type-specific customizations to the matrix jobs 58 | include: 59 | - board: 60 | tone: true 61 | sketch-paths: | 62 | - examples/MIDIUSB_buzzer 63 | - board: 64 | tone: false 65 | sketch-paths: "" 66 | 67 | steps: 68 | - name: Checkout repository 69 | uses: actions/checkout@v4 70 | 71 | - name: Compile examples 72 | uses: arduino/compile-sketches@v1 73 | with: 74 | github-token: ${{ secrets.GITHUB_TOKEN }} 75 | fqbn: ${{ matrix.board.fqbn }} 76 | platforms: ${{ matrix.board.platforms }} 77 | libraries: | 78 | # Install the library from the local path. 79 | - source-path: ./ 80 | # Additional library dependencies can be listed here. 81 | # See: https://github.com/arduino/compile-sketches#libraries 82 | sketch-paths: | 83 | # Examples to compile for all boards 84 | - examples/MIDIUSB_clock 85 | - examples/MIDIUSB_loop 86 | - examples/MIDIUSB_read 87 | - examples/MIDIUSB_read 88 | # Board-specific examples 89 | ${{ matrix.sketch-paths }} 90 | enable-deltas-report: true 91 | sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }} 92 | 93 | - name: Save sketches report as workflow artifact 94 | uses: actions/upload-artifact@v4 95 | with: 96 | if-no-files-found: error 97 | path: ${{ env.SKETCHES_REPORTS_PATH }} 98 | name: sketches-report-${{ matrix.board.artifact-name-suffix }} 99 | -------------------------------------------------------------------------------- /.github/workflows/report-size-deltas.yml: -------------------------------------------------------------------------------- 1 | name: Report Size Deltas 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | paths: 7 | - ".github/workflows/report-size-deltas.yml" 8 | schedule: 9 | # Run at the minimum interval allowed by GitHub Actions. 10 | # Note: GitHub Actions periodically has outages which result in workflow failures. 11 | # In this event, the workflows will start passing again once the service recovers. 12 | - cron: "*/5 * * * *" 13 | workflow_dispatch: 14 | repository_dispatch: 15 | 16 | jobs: 17 | report: 18 | runs-on: ubuntu-latest 19 | steps: 20 | - name: Comment size deltas reports to PRs 21 | uses: arduino/report-size-deltas@v1 22 | with: 23 | # Regex matching the names of the workflow artifacts created by the "Compile Examples" workflow 24 | sketches-reports-source: ^sketches-report-.+ 25 | -------------------------------------------------------------------------------- /.github/workflows/spell-check.yml: -------------------------------------------------------------------------------- 1 | name: Spell Check 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | pull_request: 7 | schedule: 8 | # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates. 9 | - cron: "0 8 * * TUE" 10 | workflow_dispatch: 11 | repository_dispatch: 12 | 13 | jobs: 14 | spellcheck: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout repository 19 | uses: actions/checkout@v4 20 | 21 | - name: Spell check 22 | uses: codespell-project/actions-codespell@master 23 | -------------------------------------------------------------------------------- /.github/workflows/sync-labels.yml: -------------------------------------------------------------------------------- 1 | # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md 2 | name: Sync Labels 3 | 4 | # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows 5 | on: 6 | push: 7 | paths: 8 | - ".github/workflows/sync-labels.ya?ml" 9 | - ".github/label-configuration-files/*.ya?ml" 10 | pull_request: 11 | paths: 12 | - ".github/workflows/sync-labels.ya?ml" 13 | - ".github/label-configuration-files/*.ya?ml" 14 | schedule: 15 | # Run daily at 8 AM UTC to sync with changes to shared label configurations. 16 | - cron: "0 8 * * *" 17 | workflow_dispatch: 18 | repository_dispatch: 19 | 20 | env: 21 | CONFIGURATIONS_FOLDER: .github/label-configuration-files 22 | CONFIGURATIONS_ARTIFACT: label-configuration-files 23 | 24 | jobs: 25 | check: 26 | runs-on: ubuntu-latest 27 | 28 | steps: 29 | - name: Checkout repository 30 | uses: actions/checkout@v4 31 | 32 | - name: Download JSON schema for labels configuration file 33 | id: download-schema 34 | uses: carlosperate/download-file-action@v2 35 | with: 36 | file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json 37 | location: ${{ runner.temp }}/label-configuration-schema 38 | 39 | - name: Install JSON schema validator 40 | run: | 41 | sudo npm install \ 42 | --global \ 43 | ajv-cli \ 44 | ajv-formats 45 | 46 | - name: Validate local labels configuration 47 | run: | 48 | # See: https://github.com/ajv-validator/ajv-cli#readme 49 | ajv validate \ 50 | --all-errors \ 51 | -c ajv-formats \ 52 | -s "${{ steps.download-schema.outputs.file-path }}" \ 53 | -d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}" 54 | 55 | download: 56 | needs: check 57 | runs-on: ubuntu-latest 58 | 59 | strategy: 60 | matrix: 61 | filename: 62 | # Filenames of the shared configurations to apply to the repository in addition to the local configuration. 63 | # https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels 64 | - universal.yml 65 | 66 | steps: 67 | - name: Download 68 | uses: carlosperate/download-file-action@v2 69 | with: 70 | file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} 71 | 72 | - name: Pass configuration files to next job via workflow artifact 73 | uses: actions/upload-artifact@v4 74 | with: 75 | path: | 76 | *.yaml 77 | *.yml 78 | if-no-files-found: error 79 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 80 | 81 | sync: 82 | needs: download 83 | runs-on: ubuntu-latest 84 | 85 | steps: 86 | - name: Set environment variables 87 | run: | 88 | # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable 89 | echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV" 90 | 91 | - name: Determine whether to dry run 92 | id: dry-run 93 | if: > 94 | github.event_name == 'pull_request' || 95 | ( 96 | ( 97 | github.event_name == 'push' || 98 | github.event_name == 'workflow_dispatch' 99 | ) && 100 | github.ref != format('refs/heads/{0}', github.event.repository.default_branch) 101 | ) 102 | run: | 103 | # Use of this flag in the github-label-sync command will cause it to only check the validity of the 104 | # configuration. 105 | echo "::set-output name=flag::--dry-run" 106 | 107 | - name: Checkout repository 108 | uses: actions/checkout@v4 109 | 110 | - name: Download configuration files artifact 111 | uses: actions/download-artifact@v4 112 | with: 113 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 114 | path: ${{ env.CONFIGURATIONS_FOLDER }} 115 | 116 | - name: Remove unneeded artifact 117 | uses: geekyeggo/delete-artifact@v5 118 | with: 119 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 120 | 121 | - name: Merge label configuration files 122 | run: | 123 | # Merge all configuration files 124 | shopt -s extglob 125 | cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}" 126 | 127 | - name: Install github-label-sync 128 | run: sudo npm install --global github-label-sync 129 | 130 | - name: Sync labels 131 | env: 132 | GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} 133 | run: | 134 | # See: https://github.com/Financial-Times/github-label-sync 135 | github-label-sync \ 136 | --labels "${{ env.MERGED_CONFIGURATION_PATH }}" \ 137 | ${{ steps.dry-run.outputs.flag }} \ 138 | ${{ github.repository }} 139 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | documentation/html 2 | CMakeLists.txt 3 | src/.idea 4 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | , 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | :repository-owner: arduino-libraries 2 | :repository-name: MIDIUSB 3 | 4 | = {repository-name} Library for Arduino = 5 | 6 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml/badge.svg["Check Arduino status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml"] 7 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"] 8 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] 9 | 10 | This library allows an Arduino board with USB capabilities to act as a MIDI instrument over USB. The library is based on PluggableUSB, so is only compatible with Arduino IDE 1.6.6 and newer. 11 | 12 | Furthermore, since PluggableUSB only targets boards with native USB capabilities, this library only supports these boards (eg. Leonardo, Micro, Due, Zero and so on) 13 | 14 | For more information about this library please visit us at 15 | http://www.arduino.cc/en/Reference/{repository-name} 16 | 17 | == Test procedure (Linux) == 18 | 19 | Load the correct driver (`sudo modprobe snd_seq_midi`) 20 | 21 | Flash the board with `MIDIUSB_loop` example, then execute `aseqdump -l`; the output will be something similar to 22 | ```bash 23 | Port Client name Port name 24 | 0:0 System Timer 25 | 0:1 System Announce 26 | 14:0 Midi Through Midi Through Port-0 27 | 20:0 Arduino Micro Arduino Micro MIDI 1 28 | ``` 29 | Port `20` is the one we'll use in the following examples. 30 | 31 | Start `fluidsynth` inside a shell with a soundbank 32 | ```bash 33 | fluidsynth --server --audio-driver=alsa -o audio.alsa.device=hw:0 ~/Synth.SF2 34 | ``` 35 | 36 | In another shell, execute 37 | ```bash 38 | aconnect 20 128 39 | ``` 40 | to connect our MIDI device with fluidsynth 41 | 42 | Then, execute 43 | ```bash 44 | aplaymidi --port=20:0 ~/some_midi_file.mid 45 | ``` 46 | and the file will be played after a complete roundtrip to the board. 47 | -------------------------------------------------------------------------------- /docs/api.md: -------------------------------------------------------------------------------- 1 | # MIDIUSB library 2 | 3 | ## Functions 4 | 5 | ### `MidiUSB.read()` 6 | 7 | This functions reads data from the USB and packages it into a MIDI packet (midiEventPacket_t struct ). For example, you can use this function to act as a MIDI IN device, getting notes from the PC and transforming them into audible music. 8 | 9 | ### `MidiUSB.sendMIDI(midiEventPacket_t event)` 10 | Using this function you will send a MIDI encoded packet to the PC. You can use it to produce music by reading inputs and transfer the encoded data to a software synth. 11 | 12 | ### `MidiUSB.flush()` 13 | 14 | This function forces the USB layer to send the data immediately. Since the USB bus is not realtime, a `sendMIDI()` doesn't guarantee the data to be sent with the correct timing unless immediately followed by a `flush()` -------------------------------------------------------------------------------- /docs/readme.md: -------------------------------------------------------------------------------- 1 | # MIDIUSB library 2 | 3 | This library allows any microcontroller with native USB capabilities (atmega32u4 based boards or ARM boards) to appear as a MIDI peripheral over USB to a connected computer. 4 | 5 | The library is compatible with PluggableUSB-ready cores (AVR core > 1.6.8, SAM core > 1.6.4, SAMD core > 1.6.1) 6 | 7 | ---- 8 | 9 | ## The library creates the following data type 10 | 11 | ``` 12 | typedef struct { 13 | uint8_t header; // cable + command 14 | uint8_t byte1; // command + channel 15 | uint8_t byte2; // note number or other data 16 | uint8_t byte3; // velocity or other data or zero. 17 | } midiEventPacket_t; 18 | ``` 19 | 20 | Note that a USB MIDI message contains an extra byte, compared to a 21 | UART MIDI message. The `header` byte is added. Also, while UART MIDI 22 | messages are variable length, a USB MIDI message is always four bytes - any trailing bytes not used by a particular message type will be 23 | zero. 24 | 25 | ---- 26 | 27 | ## The library exposes the following functions 28 | 29 | ``` 30 | midiEventPacket_t read(void); 31 | ``` 32 | Read a USB message from USB. 33 | If no message is available, the result "header" will be zero. 34 | 35 | ``` 36 | void sendMIDI(midiEventPacket_t event); 37 | ``` 38 | Send a single USB message. 39 | 40 | ``` 41 | void flush(void); 42 | ``` 43 | Wait for all messages to actually be sent. 44 | 45 | ``` 46 | uint32_t available(void); 47 | ``` 48 | Return the number of USB messages that are available and unread. 49 | 50 | ``` 51 | size_t write(const uint8_t *buffer, size_t size); 52 | ``` 53 | Write possubly multiple messages to USB. size_t should be a multiple of four. 54 | 55 | ---- 56 | 57 | ## Examples 58 | 59 | - [MIDIUSB_read](https://github.com/arduino-libraries/MIDIUSB/blob/master/examples/MIDIUSB_read/MIDIUSB_read.ino) 60 | Trivial example that dumps received messages to Serial debug statements. 61 | 62 | - [MIDIUSB_write](https://github.com/arduino-libraries/MIDIUSB/blob/master/examples/MIDIUSB_write/MIDIUSB_write.ino) 63 | Trivial example that sends a middle C note lasting 500ms every two second. 64 | 65 | - [MIDIUSB_loop](https://github.com/arduino-libraries/MIDIUSB/blob/master/examples/MIDIUSB_loop/MIDIUSB_loop.ino) 66 | Trivial MIDI loopback. Resends each MIDI message that is received. 67 | 68 | - [MIDI Device](https://docs.arduino.cc/tutorials/generic/midi-device) 69 | More complex example: implements a MIDI keyboard that scans 7 buttons and sends MIDI NoteOn/NoteOff messages. 70 | 71 | - [MIDIUSB_buzzer](https://github.com/arduino-libraries/MIDIUSB/blob/master/examples/MIDIUSB_buzzer/MIDIUSB_buzzer.ino) 72 | More complex example: implements a MIDI sound device Uses MidiUSB.read() to read MIDI messages; converts noteOn and noteOff messages to actual tones using the TONE library. Also interprets controlChange to text on Serial, and dumps any other messages in debug format. 73 | 74 | - [MIDIUSB_clock](https://github.com/arduino-libraries/MIDIUSB/blob/master/examples/MIDIUSB_clock/MIDIUSB_clock.ino) 75 | Simple example of beat clock based on MIDI pulse messages received from software. 76 | Interprets message types 0xF8, 0xFA, and 0xFC 77 | 78 | - [MIDI Library](https://www.arduino.cc/reference/en/libraries/midi-library/) 79 | MIDIUSB can be used as the "transport layer" for the more advanced Arduino MIDI library. 80 | -------------------------------------------------------------------------------- /documentation/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.10 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "MIDIUSB" 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 = src/Logo.png 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = . 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = 122 | 123 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124 | # doxygen will generate a detailed section even if there is only a brief 125 | # description. 126 | # The default value is: NO. 127 | 128 | ALWAYS_DETAILED_SEC = NO 129 | 130 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131 | # inherited members of a class in the documentation of that class as if those 132 | # members were ordinary class members. Constructors, destructors and assignment 133 | # operators of the base classes will not be shown. 134 | # The default value is: NO. 135 | 136 | INLINE_INHERITED_MEMB = NO 137 | 138 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 139 | # before files name in the file list and in the header files. If set to NO the 140 | # shortest path that makes the file name unique will be used 141 | # The default value is: YES. 142 | 143 | FULL_PATH_NAMES = NO 144 | 145 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146 | # Stripping is only done if one of the specified strings matches the left-hand 147 | # part of the path. The tag can be used to show relative paths in the file list. 148 | # If left blank the directory from which doxygen is run is used as the path to 149 | # strip. 150 | # 151 | # Note that you can specify absolute paths here, but also relative paths, which 152 | # will be relative from the directory where doxygen is started. 153 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 154 | 155 | STRIP_FROM_PATH = 156 | 157 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 158 | # path mentioned in the documentation of a class, which tells the reader which 159 | # header file to include in order to use a class. If left blank only the name of 160 | # the header file containing the class definition is used. Otherwise one should 161 | # specify the list of include paths that are normally passed to the compiler 162 | # using the -I flag. 163 | 164 | STRIP_FROM_INC_PATH = 165 | 166 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167 | # less readable) file names. This can be useful is your file systems doesn't 168 | # support long names like on DOS, Mac, or CD-ROM. 169 | # The default value is: NO. 170 | 171 | SHORT_NAMES = NO 172 | 173 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174 | # first line (until the first dot) of a Javadoc-style comment as the brief 175 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 176 | # style comments (thus requiring an explicit @brief command for a brief 177 | # description.) 178 | # The default value is: NO. 179 | 180 | JAVADOC_AUTOBRIEF = YES 181 | 182 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 | # line (until the first dot) of a Qt-style comment as the brief description. If 184 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185 | # requiring an explicit \brief command for a brief description.) 186 | # The default value is: NO. 187 | 188 | QT_AUTOBRIEF = NO 189 | 190 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 192 | # a brief description. This used to be the default behavior. The new default is 193 | # to treat a multi-line C++ comment block as a detailed description. Set this 194 | # tag to YES if you prefer the old behavior instead. 195 | # 196 | # Note that setting this tag to YES also means that rational rose comments are 197 | # not recognized any more. 198 | # The default value is: NO. 199 | 200 | MULTILINE_CPP_IS_BRIEF = NO 201 | 202 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 | # documentation from any documented member that it re-implements. 204 | # The default value is: YES. 205 | 206 | INHERIT_DOCS = YES 207 | 208 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 209 | # page for each member. If set to NO, the documentation of a member will be part 210 | # of the file/class/namespace that contains it. 211 | # The default value is: NO. 212 | 213 | SEPARATE_MEMBER_PAGES = NO 214 | 215 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216 | # uses this value to replace tabs by spaces in code fragments. 217 | # Minimum value: 1, maximum value: 16, default value: 4. 218 | 219 | TAB_SIZE = 4 220 | 221 | # This tag can be used to specify a number of aliases that act as commands in 222 | # the documentation. An alias has the form: 223 | # name=value 224 | # For example adding 225 | # "sideeffect=@par Side Effects:\n" 226 | # will allow you to put the command \sideeffect (or @sideeffect) in the 227 | # documentation, which will result in a user-defined paragraph with heading 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert 229 | # newlines. 230 | 231 | ALIASES = 232 | 233 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 234 | # A mapping has the form "name=value". For example adding "class=itcl::class" 235 | # will allow you to use the command class in the itcl::class meaning. 236 | 237 | TCL_SUBST = 238 | 239 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 240 | # only. Doxygen will then generate output that is more tailored for C. For 241 | # instance, some of the names that are used will be different. The list of all 242 | # members will be omitted, etc. 243 | # The default value is: NO. 244 | 245 | OPTIMIZE_OUTPUT_FOR_C = NO 246 | 247 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 248 | # Python sources only. Doxygen will then generate output that is more tailored 249 | # for that language. For instance, namespaces will be presented as packages, 250 | # qualified scopes will look different, etc. 251 | # The default value is: NO. 252 | 253 | OPTIMIZE_OUTPUT_JAVA = NO 254 | 255 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 256 | # sources. Doxygen will then generate output that is tailored for Fortran. 257 | # The default value is: NO. 258 | 259 | OPTIMIZE_FOR_FORTRAN = NO 260 | 261 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 262 | # sources. Doxygen will then generate output that is tailored for VHDL. 263 | # The default value is: NO. 264 | 265 | OPTIMIZE_OUTPUT_VHDL = NO 266 | 267 | # Doxygen selects the parser to use depending on the extension of the files it 268 | # parses. With this tag you can assign which parser to use for a given 269 | # extension. Doxygen has a built-in mapping, but you can override or extend it 270 | # using this tag. The format is ext=language, where ext is a file extension, and 271 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 272 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 273 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 274 | # Fortran. In the later case the parser tries to guess whether the code is fixed 275 | # or free formatted code, this is the default for Fortran type files), VHDL. For 276 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 277 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 278 | # 279 | # Note: For files without extension you can use no_extension as a placeholder. 280 | # 281 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 282 | # the files are not read by doxygen. 283 | 284 | EXTENSION_MAPPING = 285 | 286 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 287 | # according to the Markdown format, which allows for more readable 288 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 289 | # The output of markdown processing is further processed by doxygen, so you can 290 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 291 | # case of backward compatibilities issues. 292 | # The default value is: YES. 293 | 294 | MARKDOWN_SUPPORT = YES 295 | 296 | # When enabled doxygen tries to link words that correspond to documented 297 | # classes, or namespaces to their corresponding documentation. Such a link can 298 | # be prevented in individual cases by putting a % sign in front of the word or 299 | # globally by setting AUTOLINK_SUPPORT to NO. 300 | # The default value is: YES. 301 | 302 | AUTOLINK_SUPPORT = YES 303 | 304 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 305 | # to include (a tag file for) the STL sources as input, then you should set this 306 | # tag to YES in order to let doxygen match functions declarations and 307 | # definitions whose arguments contain STL classes (e.g. func(std::string); 308 | # versus func(std::string) {}). This also make the inheritance and collaboration 309 | # diagrams that involve STL classes more complete and accurate. 310 | # The default value is: NO. 311 | 312 | BUILTIN_STL_SUPPORT = NO 313 | 314 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 315 | # enable parsing support. 316 | # The default value is: NO. 317 | 318 | CPP_CLI_SUPPORT = NO 319 | 320 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 321 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 322 | # will parse them like normal C++ but will assume all classes use public instead 323 | # of private inheritance when no explicit protection keyword is present. 324 | # The default value is: NO. 325 | 326 | SIP_SUPPORT = NO 327 | 328 | # For Microsoft's IDL there are propget and propput attributes to indicate 329 | # getter and setter methods for a property. Setting this option to YES will make 330 | # doxygen to replace the get and set methods by a property in the documentation. 331 | # This will only work if the methods are indeed getting or setting a simple 332 | # type. If this is not the case, or you want to show the methods anyway, you 333 | # should set this option to NO. 334 | # The default value is: YES. 335 | #IDL_PROPERTY_SUPPORT = YES 336 | 337 | 338 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 339 | # tag is set to YES then doxygen will reuse the documentation of the first 340 | # member in the group (if any) for the other members of the group. By default 341 | # all members of a group must be documented explicitly. 342 | # The default value is: NO. 343 | 344 | DISTRIBUTE_GROUP_DOC = NO 345 | 346 | # If one adds a struct or class to a group and this option is enabled, then also 347 | # any nested class or struct is added to the same group. By default this option 348 | # is disabled and one has to add nested compounds explicitly via \ingroup. 349 | # The default value is: NO. 350 | 351 | GROUP_NESTED_COMPOUNDS = NO 352 | 353 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 354 | # (for instance a group of public functions) to be put as a subgroup of that 355 | # type (e.g. under the Public Functions section). Set it to NO to prevent 356 | # subgrouping. Alternatively, this can be done per class using the 357 | # \nosubgrouping command. 358 | # The default value is: YES. 359 | 360 | SUBGROUPING = YES 361 | 362 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 363 | # are shown inside the group in which they are included (e.g. using \ingroup) 364 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 365 | # and RTF). 366 | # 367 | # Note that this feature does not work in combination with 368 | # SEPARATE_MEMBER_PAGES. 369 | # The default value is: NO. 370 | 371 | INLINE_GROUPED_CLASSES = NO 372 | 373 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 374 | # with only public data fields or simple typedef fields will be shown inline in 375 | # the documentation of the scope in which they are defined (i.e. file, 376 | # namespace, or group documentation), provided this scope is documented. If set 377 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 378 | # Man pages) or section (for LaTeX and RTF). 379 | # The default value is: NO. 380 | 381 | INLINE_SIMPLE_STRUCTS = NO 382 | 383 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 384 | # enum is documented as struct, union, or enum with the name of the typedef. So 385 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 386 | # with name TypeT. When disabled the typedef will appear as a member of a file, 387 | # namespace, or class. And the struct will be named TypeS. This can typically be 388 | # useful for C code in case the coding convention dictates that all compound 389 | # types are typedef'ed and only the typedef is referenced, never the tag name. 390 | # The default value is: NO. 391 | 392 | TYPEDEF_HIDES_STRUCT = NO 393 | 394 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 395 | # cache is used to resolve symbols given their name and scope. Since this can be 396 | # an expensive process and often the same symbol appears multiple times in the 397 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 398 | # doxygen will become slower. If the cache is too large, memory is wasted. The 399 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 400 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 401 | # symbols. At the end of a run doxygen will report the cache usage and suggest 402 | # the optimal cache size from a speed point of view. 403 | # Minimum value: 0, maximum value: 9, default value: 0. 404 | 405 | LOOKUP_CACHE_SIZE = 0 406 | 407 | #--------------------------------------------------------------------------- 408 | # Build related configuration options 409 | #--------------------------------------------------------------------------- 410 | 411 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 412 | # documentation are documented, even if no documentation was available. Private 413 | # class members and static file members will be hidden unless the 414 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 415 | # Note: This will also disable the warnings about undocumented members that are 416 | # normally produced when WARNINGS is set to YES. 417 | # The default value is: NO. 418 | 419 | EXTRACT_ALL = YES 420 | 421 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 422 | # be included in the documentation. 423 | # The default value is: NO. 424 | 425 | EXTRACT_PRIVATE = NO 426 | 427 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 428 | # scope will be included in the documentation. 429 | # The default value is: NO. 430 | 431 | EXTRACT_PACKAGE = NO 432 | 433 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 434 | # included in the documentation. 435 | # The default value is: NO. 436 | 437 | EXTRACT_STATIC = NO 438 | 439 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 440 | # locally in source files will be included in the documentation. If set to NO, 441 | # only classes defined in header files are included. Does not have any effect 442 | # for Java sources. 443 | # The default value is: YES. 444 | 445 | EXTRACT_LOCAL_CLASSES = YES 446 | 447 | # This flag is only useful for Objective-C code. If set to YES, local methods, 448 | # which are defined in the implementation section but not in the interface are 449 | # included in the documentation. If set to NO, only methods in the interface are 450 | # included. 451 | # The default value is: NO. 452 | 453 | EXTRACT_LOCAL_METHODS = NO 454 | 455 | # If this flag is set to YES, the members of anonymous namespaces will be 456 | # extracted and appear in the documentation as a namespace called 457 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 458 | # the file that contains the anonymous namespace. By default anonymous namespace 459 | # are hidden. 460 | # The default value is: NO. 461 | 462 | EXTRACT_ANON_NSPACES = NO 463 | 464 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 465 | # undocumented members inside documented classes or files. If set to NO these 466 | # members will be included in the various overviews, but no documentation 467 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 468 | # The default value is: NO. 469 | 470 | HIDE_UNDOC_MEMBERS = NO 471 | 472 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 473 | # undocumented classes that are normally visible in the class hierarchy. If set 474 | # to NO, these classes will be included in the various overviews. This option 475 | # has no effect if EXTRACT_ALL is enabled. 476 | # The default value is: NO. 477 | 478 | HIDE_UNDOC_CLASSES = NO 479 | 480 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 481 | # (class|struct|union) declarations. If set to NO, these declarations will be 482 | # included in the documentation. 483 | # The default value is: NO. 484 | 485 | HIDE_FRIEND_COMPOUNDS = NO 486 | 487 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 488 | # documentation blocks found inside the body of a function. If set to NO, these 489 | # blocks will be appended to the function's detailed documentation block. 490 | # The default value is: NO. 491 | 492 | HIDE_IN_BODY_DOCS = NO 493 | 494 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 495 | # \internal command is included. If the tag is set to NO then the documentation 496 | # will be excluded. Set it to YES to include the internal documentation. 497 | # The default value is: NO. 498 | 499 | INTERNAL_DOCS = NO 500 | 501 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 502 | # names in lower-case letters. If set to YES, upper-case letters are also 503 | # allowed. This is useful if you have classes or files whose names only differ 504 | # in case and if your file system supports case sensitive file names. Windows 505 | # and Mac users are advised to set this option to NO. 506 | # The default value is: system dependent. 507 | 508 | CASE_SENSE_NAMES = YES 509 | 510 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 511 | # their full class and namespace scopes in the documentation. If set to YES, the 512 | # scope will be hidden. 513 | # The default value is: NO. 514 | 515 | HIDE_SCOPE_NAMES = NO 516 | 517 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 518 | # append additional text to a page's title, such as Class Reference. If set to 519 | # YES the compound reference will be hidden. 520 | # The default value is: NO. 521 | 522 | HIDE_COMPOUND_REFERENCE= NO 523 | 524 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 525 | # the files that are included by a file in the documentation of that file. 526 | # The default value is: YES. 527 | 528 | SHOW_INCLUDE_FILES = YES 529 | 530 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 531 | # grouped member an include statement to the documentation, telling the reader 532 | # which file to include in order to use the member. 533 | # The default value is: NO. 534 | 535 | SHOW_GROUPED_MEMB_INC = NO 536 | 537 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 538 | # files with double quotes in the documentation rather than with sharp brackets. 539 | # The default value is: NO. 540 | 541 | FORCE_LOCAL_INCLUDES = NO 542 | 543 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 544 | # documentation for inline members. 545 | # The default value is: YES. 546 | 547 | INLINE_INFO = YES 548 | 549 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 550 | # (detailed) documentation of file and class members alphabetically by member 551 | # name. If set to NO, the members will appear in declaration order. 552 | # The default value is: YES. 553 | 554 | SORT_MEMBER_DOCS = YES 555 | 556 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 557 | # descriptions of file, namespace and class members alphabetically by member 558 | # name. If set to NO, the members will appear in declaration order. Note that 559 | # this will also influence the order of the classes in the class list. 560 | # The default value is: NO. 561 | 562 | SORT_BRIEF_DOCS = YES 563 | 564 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 565 | # (brief and detailed) documentation of class members so that constructors and 566 | # destructors are listed first. If set to NO the constructors will appear in the 567 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 568 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 569 | # member documentation. 570 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 571 | # detailed member documentation. 572 | # The default value is: NO. 573 | 574 | SORT_MEMBERS_CTORS_1ST = NO 575 | 576 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 577 | # of group names into alphabetical order. If set to NO the group names will 578 | # appear in their defined order. 579 | # The default value is: NO. 580 | 581 | SORT_GROUP_NAMES = NO 582 | 583 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 584 | # fully-qualified names, including namespaces. If set to NO, the class list will 585 | # be sorted only by class name, not including the namespace part. 586 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 587 | # Note: This option applies only to the class list, not to the alphabetical 588 | # list. 589 | # The default value is: NO. 590 | 591 | SORT_BY_SCOPE_NAME = NO 592 | 593 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 594 | # type resolution of all parameters of a function it will reject a match between 595 | # the prototype and the implementation of a member function even if there is 596 | # only one candidate or it is obvious which candidate to choose by doing a 597 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 598 | # accept a match between prototype and implementation in such cases. 599 | # The default value is: NO. 600 | 601 | STRICT_PROTO_MATCHING = NO 602 | 603 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 604 | # list. This list is created by putting \todo commands in the documentation. 605 | # The default value is: YES. 606 | 607 | GENERATE_TODOLIST = YES 608 | 609 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 610 | # list. This list is created by putting \test commands in the documentation. 611 | # The default value is: YES. 612 | 613 | GENERATE_TESTLIST = YES 614 | 615 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 616 | # list. This list is created by putting \bug commands in the documentation. 617 | # The default value is: YES. 618 | 619 | GENERATE_BUGLIST = YES 620 | 621 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 622 | # the deprecated list. This list is created by putting \deprecated commands in 623 | # the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_DEPRECATEDLIST= YES 627 | 628 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 629 | # sections, marked by \if ... \endif and \cond 630 | # ... \endcond blocks. 631 | 632 | ENABLED_SECTIONS = 633 | 634 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 635 | # initial value of a variable or macro / define can have for it to appear in the 636 | # documentation. If the initializer consists of more lines than specified here 637 | # it will be hidden. Use a value of 0 to hide initializers completely. The 638 | # appearance of the value of individual variables and macros / defines can be 639 | # controlled using \showinitializer or \hideinitializer command in the 640 | # documentation regardless of this setting. 641 | # Minimum value: 0, maximum value: 10000, default value: 30. 642 | 643 | MAX_INITIALIZER_LINES = 30 644 | 645 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 646 | # the bottom of the documentation of classes and structs. If set to YES, the 647 | # list will mention the files that were used to generate the documentation. 648 | # The default value is: YES. 649 | 650 | SHOW_USED_FILES = YES 651 | 652 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 653 | # will remove the Files entry from the Quick Index and from the Folder Tree View 654 | # (if specified). 655 | # The default value is: YES. 656 | 657 | SHOW_FILES = YES 658 | 659 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 660 | # page. This will remove the Namespaces entry from the Quick Index and from the 661 | # Folder Tree View (if specified). 662 | # The default value is: YES. 663 | 664 | SHOW_NAMESPACES = YES 665 | 666 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 667 | # doxygen should invoke to get the current version for each file (typically from 668 | # the version control system). Doxygen will invoke the program by executing (via 669 | # popen()) the command command input-file, where command is the value of the 670 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 671 | # by doxygen. Whatever the program writes to standard output is used as the file 672 | # version. For an example see the documentation. 673 | 674 | FILE_VERSION_FILTER = 675 | 676 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 677 | # by doxygen. The layout file controls the global structure of the generated 678 | # output files in an output format independent way. To create the layout file 679 | # that represents doxygen's defaults, run doxygen with the -l option. You can 680 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 681 | # will be used as the name of the layout file. 682 | # 683 | # Note that if you run doxygen from a directory containing a file called 684 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 685 | # tag is left empty. 686 | 687 | LAYOUT_FILE = 688 | 689 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 690 | # the reference definitions. This must be a list of .bib files. The .bib 691 | # extension is automatically appended if omitted. This requires the bibtex tool 692 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 693 | # For LaTeX the style of the bibliography can be controlled using 694 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 695 | # search path. See also \cite for info how to create references. 696 | 697 | CITE_BIB_FILES = 698 | 699 | #--------------------------------------------------------------------------- 700 | # Configuration options related to warning and progress messages 701 | #--------------------------------------------------------------------------- 702 | 703 | # The QUIET tag can be used to turn on/off the messages that are generated to 704 | # standard output by doxygen. If QUIET is set to YES this implies that the 705 | # messages are off. 706 | # The default value is: NO. 707 | 708 | QUIET = YES 709 | 710 | # The WARNINGS tag can be used to turn on/off the warning messages that are 711 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 712 | # this implies that the warnings are on. 713 | # 714 | # Tip: Turn warnings on while writing the documentation. 715 | # The default value is: YES. 716 | 717 | WARNINGS = YES 718 | 719 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 720 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 721 | # will automatically be disabled. 722 | # The default value is: YES. 723 | 724 | WARN_IF_UNDOCUMENTED = YES 725 | 726 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 727 | # potential errors in the documentation, such as not documenting some parameters 728 | # in a documented function, or documenting parameters that don't exist or using 729 | # markup commands wrongly. 730 | # The default value is: YES. 731 | 732 | WARN_IF_DOC_ERROR = YES 733 | 734 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 735 | # are documented, but have no documentation for their parameters or return 736 | # value. If set to NO, doxygen will only warn about wrong or incomplete 737 | # parameter documentation, but not about the absence of documentation. 738 | # The default value is: NO. 739 | 740 | WARN_NO_PARAMDOC = NO 741 | 742 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 743 | # can produce. The string should contain the $file, $line, and $text tags, which 744 | # will be replaced by the file and line number from which the warning originated 745 | # and the warning text. Optionally the format may contain $version, which will 746 | # be replaced by the version of the file (if it could be obtained via 747 | # FILE_VERSION_FILTER) 748 | # The default value is: $file:$line: $text. 749 | 750 | WARN_FORMAT = "$file:$line: $text" 751 | 752 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 753 | # messages should be written. If left blank the output is written to standard 754 | # error (stderr). 755 | 756 | WARN_LOGFILE = 757 | 758 | #--------------------------------------------------------------------------- 759 | # Configuration options related to the input files 760 | #--------------------------------------------------------------------------- 761 | 762 | # The INPUT tag is used to specify the files and/or directories that contain 763 | # documented source files. You may enter file names like myfile.cpp or 764 | # directories like /usr/src/myproject. Separate the files or directories with 765 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 766 | # Note: If this tag is empty the current directory is searched. 767 | 768 | INPUT = .. \ 769 | ../../ArduinoSrc/hardware/arduino/sam/cores/arduino/USB 770 | 771 | # This tag can be used to specify the character encoding of the source files 772 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 773 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 774 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 775 | # possible encodings. 776 | # The default value is: UTF-8. 777 | 778 | INPUT_ENCODING = UTF-8 779 | 780 | # If the value of the INPUT tag contains directories, you can use the 781 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 782 | # *.h) to filter out the source-files in the directories. 783 | # 784 | # Note that for custom extensions or not directly supported extensions you also 785 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 786 | # read by doxygen. 787 | # 788 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 789 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 790 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 791 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, 792 | # *.vhdl, *.ucf, *.qsf, *.as and *.js. 793 | 794 | FILE_PATTERNS = *.h *.hh *.hpp *.hxx *.c *.cc *.cxx *.cpp *.ino *.pde 795 | 796 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 797 | # be searched for input files as well. 798 | # The default value is: NO. 799 | 800 | RECURSIVE = YES 801 | 802 | # The EXCLUDE tag can be used to specify files and/or directories that should be 803 | # excluded from the INPUT source files. This way you can easily exclude a 804 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 805 | # 806 | # Note that relative paths are relative to the directory from which doxygen is 807 | # run. 808 | 809 | EXCLUDE = 810 | 811 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 812 | # directories that are symbolic links (a Unix file system feature) are excluded 813 | # from the input. 814 | # The default value is: NO. 815 | 816 | EXCLUDE_SYMLINKS = NO 817 | 818 | # If the value of the INPUT tag contains directories, you can use the 819 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 820 | # certain files from those directories. 821 | # 822 | # Note that the wildcards are matched against the file with absolute path, so to 823 | # exclude all test directories for example use the pattern */test/* 824 | 825 | EXCLUDE_PATTERNS = */system/CMSIS/* 826 | 827 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 828 | # (namespaces, classes, functions, etc.) that should be excluded from the 829 | # output. The symbol name can be a fully qualified name, a word, or if the 830 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 831 | # AClass::ANamespace, ANamespace::*Test 832 | # 833 | # Note that the wildcards are matched against the file with absolute path, so to 834 | # exclude all test directories use the pattern */test/* 835 | 836 | EXCLUDE_SYMBOLS = 837 | 838 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 839 | # that contain example code fragments that are included (see the \include 840 | # command). 841 | 842 | EXAMPLE_PATH = 843 | 844 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 845 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 846 | # *.h) to filter out the source-files in the directories. If left blank all 847 | # files are included. 848 | 849 | EXAMPLE_PATTERNS = 850 | 851 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 852 | # searched for input files to be used with the \include or \dontinclude commands 853 | # irrespective of the value of the RECURSIVE tag. 854 | # The default value is: NO. 855 | 856 | EXAMPLE_RECURSIVE = YES 857 | 858 | # The IMAGE_PATH tag can be used to specify one or more files or directories 859 | # that contain images that are to be included in the documentation (see the 860 | # \image command). 861 | 862 | IMAGE_PATH = src 863 | 864 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 865 | # invoke to filter for each input file. Doxygen will invoke the filter program 866 | # by executing (via popen()) the command: 867 | # 868 | # 869 | # 870 | # where is the value of the INPUT_FILTER tag, and is the 871 | # name of an input file. Doxygen will then use the output that the filter 872 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 873 | # will be ignored. 874 | # 875 | # Note that the filter must not add or remove lines; it is applied before the 876 | # code is scanned, but not when the output code is generated. If lines are added 877 | # or removed, the anchors will not be placed correctly. 878 | 879 | INPUT_FILTER = 880 | 881 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 882 | # basis. Doxygen will compare the file name with each pattern and apply the 883 | # filter if there is a match. The filters are a list of the form: pattern=filter 884 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 885 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 886 | # patterns match the file name, INPUT_FILTER is applied. 887 | 888 | FILTER_PATTERNS = 889 | 890 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 891 | # INPUT_FILTER) will also be used to filter the input files that are used for 892 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 893 | # The default value is: NO. 894 | 895 | FILTER_SOURCE_FILES = NO 896 | 897 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 898 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 899 | # it is also possible to disable source filtering for a specific pattern using 900 | # *.ext= (so without naming a filter). 901 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 902 | 903 | FILTER_SOURCE_PATTERNS = 904 | 905 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 906 | # is part of the input, its contents will be placed on the main page 907 | # (index.html). This can be useful if you have a project on for instance GitHub 908 | # and want to reuse the introduction page also for the doxygen output. 909 | 910 | USE_MDFILE_AS_MAINPAGE = 911 | 912 | #--------------------------------------------------------------------------- 913 | # Configuration options related to source browsing 914 | #--------------------------------------------------------------------------- 915 | 916 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 917 | # generated. Documented entities will be cross-referenced with these sources. 918 | # 919 | # Note: To get rid of all source code in the generated output, make sure that 920 | # also VERBATIM_HEADERS is set to NO. 921 | # The default value is: NO. 922 | 923 | SOURCE_BROWSER = NO 924 | 925 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 926 | # classes and enums directly into the documentation. 927 | # The default value is: NO. 928 | 929 | INLINE_SOURCES = NO 930 | 931 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 932 | # special comment blocks from generated source code fragments. Normal C, C++ and 933 | # Fortran comments will always remain visible. 934 | # The default value is: YES. 935 | 936 | STRIP_CODE_COMMENTS = YES 937 | 938 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 939 | # function all documented functions referencing it will be listed. 940 | # The default value is: NO. 941 | 942 | REFERENCED_BY_RELATION = NO 943 | 944 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 945 | # all documented entities called/used by that function will be listed. 946 | # The default value is: NO. 947 | 948 | REFERENCES_RELATION = NO 949 | 950 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 951 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 952 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 953 | # link to the documentation. 954 | # The default value is: YES. 955 | 956 | REFERENCES_LINK_SOURCE = YES 957 | 958 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 959 | # source code will show a tooltip with additional information such as prototype, 960 | # brief description and links to the definition and documentation. Since this 961 | # will make the HTML file larger and loading of large files a bit slower, you 962 | # can opt to disable this feature. 963 | # The default value is: YES. 964 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 965 | 966 | SOURCE_TOOLTIPS = YES 967 | 968 | # If the USE_HTAGS tag is set to YES then the references to source code will 969 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 970 | # source browser. The htags tool is part of GNU's global source tagging system 971 | # (see http://www.gnu.org/software/global/global.html). You will need version 972 | # 4.8.6 or higher. 973 | # 974 | # To use it do the following: 975 | # - Install the latest version of global 976 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 977 | # - Make sure the INPUT points to the root of the source tree 978 | # - Run doxygen as normal 979 | # 980 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 981 | # tools must be available from the command line (i.e. in the search path). 982 | # 983 | # The result: instead of the source browser generated by doxygen, the links to 984 | # source code will now point to the output of htags. 985 | # The default value is: NO. 986 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 987 | 988 | USE_HTAGS = NO 989 | 990 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 991 | # verbatim copy of the header file for each class for which an include is 992 | # specified. Set to NO to disable this. 993 | # See also: Section \class. 994 | # The default value is: YES. 995 | 996 | VERBATIM_HEADERS = YES 997 | 998 | #--------------------------------------------------------------------------- 999 | # Configuration options related to the alphabetical class index 1000 | #--------------------------------------------------------------------------- 1001 | 1002 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1003 | # compounds will be generated. Enable this if the project contains a lot of 1004 | # classes, structs, unions or interfaces. 1005 | # The default value is: YES. 1006 | 1007 | ALPHABETICAL_INDEX = YES 1008 | 1009 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1010 | # which the alphabetical index list will be split. 1011 | # Minimum value: 1, maximum value: 20, default value: 5. 1012 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1013 | 1014 | COLS_IN_ALPHA_INDEX = 5 1015 | 1016 | # In case all classes in a project start with a common prefix, all classes will 1017 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1018 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1019 | # while generating the index headers. 1020 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1021 | 1022 | IGNORE_PREFIX = 1023 | 1024 | #--------------------------------------------------------------------------- 1025 | # Configuration options related to the HTML output 1026 | #--------------------------------------------------------------------------- 1027 | 1028 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1029 | # The default value is: YES. 1030 | 1031 | GENERATE_HTML = YES 1032 | 1033 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1034 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1035 | # it. 1036 | # The default directory is: html. 1037 | # This tag requires that the tag GENERATE_HTML is set to YES. 1038 | 1039 | HTML_OUTPUT = html 1040 | 1041 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1042 | # generated HTML page (for example: .htm, .php, .asp). 1043 | # The default value is: .html. 1044 | # This tag requires that the tag GENERATE_HTML is set to YES. 1045 | 1046 | HTML_FILE_EXTENSION = .html 1047 | 1048 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1049 | # each generated HTML page. If the tag is left blank doxygen will generate a 1050 | # standard header. 1051 | # 1052 | # To get valid HTML the header file that includes any scripts and style sheets 1053 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1054 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1055 | # default header using 1056 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1057 | # YourConfigFile 1058 | # and then modify the file new_header.html. See also section "Doxygen usage" 1059 | # for information on how to generate the default header that doxygen normally 1060 | # uses. 1061 | # Note: The header is subject to change so you typically have to regenerate the 1062 | # default header when upgrading to a newer version of doxygen. For a description 1063 | # of the possible markers and block names see the documentation. 1064 | # This tag requires that the tag GENERATE_HTML is set to YES. 1065 | 1066 | HTML_HEADER = 1067 | 1068 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1069 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1070 | # footer. See HTML_HEADER for more information on how to generate a default 1071 | # footer and what special commands can be used inside the footer. See also 1072 | # section "Doxygen usage" for information on how to generate the default footer 1073 | # that doxygen normally uses. 1074 | # This tag requires that the tag GENERATE_HTML is set to YES. 1075 | 1076 | HTML_FOOTER = 1077 | 1078 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1079 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1080 | # the HTML output. If left blank doxygen will generate a default style sheet. 1081 | # See also section "Doxygen usage" for information on how to generate the style 1082 | # sheet that doxygen normally uses. 1083 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1084 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1085 | # obsolete. 1086 | # This tag requires that the tag GENERATE_HTML is set to YES. 1087 | 1088 | HTML_STYLESHEET = 1089 | 1090 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1091 | # cascading style sheets that are included after the standard style sheets 1092 | # created by doxygen. Using this option one can overrule certain style aspects. 1093 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1094 | # standard style sheet and is therefore more robust against future updates. 1095 | # Doxygen will copy the style sheet files to the output directory. 1096 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1097 | # style sheet in the list overrules the setting of the previous ones in the 1098 | # list). For an example see the documentation. 1099 | # This tag requires that the tag GENERATE_HTML is set to YES. 1100 | 1101 | HTML_EXTRA_STYLESHEET = 1102 | 1103 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1104 | # other source files which should be copied to the HTML output directory. Note 1105 | # that these files will be copied to the base HTML output directory. Use the 1106 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1107 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1108 | # files will be copied as-is; there are no commands or markers available. 1109 | # This tag requires that the tag GENERATE_HTML is set to YES. 1110 | 1111 | HTML_EXTRA_FILES = 1112 | 1113 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1114 | # will adjust the colors in the style sheet and background images according to 1115 | # this color. Hue is specified as an angle on a colorwheel, see 1116 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1117 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1118 | # purple, and 360 is red again. 1119 | # Minimum value: 0, maximum value: 359, default value: 220. 1120 | # This tag requires that the tag GENERATE_HTML is set to YES. 1121 | 1122 | HTML_COLORSTYLE_HUE = 220 1123 | 1124 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1125 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1126 | # value of 255 will produce the most vivid colors. 1127 | # Minimum value: 0, maximum value: 255, default value: 100. 1128 | # This tag requires that the tag GENERATE_HTML is set to YES. 1129 | 1130 | HTML_COLORSTYLE_SAT = 100 1131 | 1132 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1133 | # luminance component of the colors in the HTML output. Values below 100 1134 | # gradually make the output lighter, whereas values above 100 make the output 1135 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1136 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1137 | # change the gamma. 1138 | # Minimum value: 40, maximum value: 240, default value: 80. 1139 | # This tag requires that the tag GENERATE_HTML is set to YES. 1140 | 1141 | HTML_COLORSTYLE_GAMMA = 80 1142 | 1143 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1144 | # page will contain the date and time when the page was generated. Setting this 1145 | # to YES can help to show when doxygen was last run and thus if the 1146 | # documentation is up to date. 1147 | # The default value is: NO. 1148 | # This tag requires that the tag GENERATE_HTML is set to YES. 1149 | 1150 | HTML_TIMESTAMP = NO 1151 | 1152 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1153 | # documentation will contain sections that can be hidden and shown after the 1154 | # page has loaded. 1155 | # The default value is: NO. 1156 | # This tag requires that the tag GENERATE_HTML is set to YES. 1157 | 1158 | HTML_DYNAMIC_SECTIONS = NO 1159 | 1160 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1161 | # shown in the various tree structured indices initially; the user can expand 1162 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1163 | # such a level that at most the specified number of entries are visible (unless 1164 | # a fully collapsed tree already exceeds this amount). So setting the number of 1165 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1166 | # representing an infinite number of entries and will result in a full expanded 1167 | # tree by default. 1168 | # Minimum value: 0, maximum value: 9999, default value: 100. 1169 | # This tag requires that the tag GENERATE_HTML is set to YES. 1170 | 1171 | HTML_INDEX_NUM_ENTRIES = 100 1172 | 1173 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1174 | # generated that can be used as input for Apple's Xcode 3 integrated development 1175 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1176 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1177 | # Makefile in the HTML output directory. Running make will produce the docset in 1178 | # that directory and running make install will install the docset in 1179 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1180 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1181 | # for more information. 1182 | # The default value is: NO. 1183 | # This tag requires that the tag GENERATE_HTML is set to YES. 1184 | 1185 | GENERATE_DOCSET = NO 1186 | 1187 | # This tag determines the name of the docset feed. A documentation feed provides 1188 | # an umbrella under which multiple documentation sets from a single provider 1189 | # (such as a company or product suite) can be grouped. 1190 | # The default value is: Doxygen generated docs. 1191 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1192 | 1193 | DOCSET_FEEDNAME = "Doxygen generated docs" 1194 | 1195 | # This tag specifies a string that should uniquely identify the documentation 1196 | # set bundle. This should be a reverse domain-name style string, e.g. 1197 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1198 | # The default value is: org.doxygen.Project. 1199 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1200 | 1201 | DOCSET_BUNDLE_ID = org.doxygen.Project 1202 | 1203 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1204 | # the documentation publisher. This should be a reverse domain-name style 1205 | # string, e.g. com.mycompany.MyDocSet.documentation. 1206 | # The default value is: org.doxygen.Publisher. 1207 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1208 | 1209 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1210 | 1211 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1212 | # The default value is: Publisher. 1213 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1214 | 1215 | DOCSET_PUBLISHER_NAME = Publisher 1216 | 1217 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1218 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1219 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1220 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1221 | # Windows. 1222 | # 1223 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1224 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1225 | # files are now used as the Windows 98 help format, and will replace the old 1226 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1227 | # HTML files also contain an index, a table of contents, and you can search for 1228 | # words in the documentation. The HTML workshop also contains a viewer for 1229 | # compressed HTML files. 1230 | # The default value is: NO. 1231 | # This tag requires that the tag GENERATE_HTML is set to YES. 1232 | 1233 | GENERATE_HTMLHELP = NO 1234 | 1235 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1236 | # file. You can add a path in front of the file if the result should not be 1237 | # written to the html output directory. 1238 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1239 | 1240 | CHM_FILE = 1241 | 1242 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1243 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1244 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1245 | # The file has to be specified with full path. 1246 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1247 | 1248 | HHC_LOCATION = 1249 | 1250 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1251 | # (YES) or that it should be included in the master .chm file (NO). 1252 | # The default value is: NO. 1253 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1254 | 1255 | GENERATE_CHI = NO 1256 | 1257 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1258 | # and project file content. 1259 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1260 | 1261 | CHM_INDEX_ENCODING = 1262 | 1263 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1264 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1265 | # enables the Previous and Next buttons. 1266 | # The default value is: NO. 1267 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1268 | 1269 | BINARY_TOC = NO 1270 | 1271 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1272 | # the table of contents of the HTML help documentation and to the tree view. 1273 | # The default value is: NO. 1274 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1275 | 1276 | TOC_EXPAND = NO 1277 | 1278 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1279 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1280 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1281 | # (.qch) of the generated HTML documentation. 1282 | # The default value is: NO. 1283 | # This tag requires that the tag GENERATE_HTML is set to YES. 1284 | 1285 | GENERATE_QHP = NO 1286 | 1287 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1288 | # the file name of the resulting .qch file. The path specified is relative to 1289 | # the HTML output folder. 1290 | # This tag requires that the tag GENERATE_QHP is set to YES. 1291 | 1292 | QCH_FILE = 1293 | 1294 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1295 | # Project output. For more information please see Qt Help Project / Namespace 1296 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1297 | # The default value is: org.doxygen.Project. 1298 | # This tag requires that the tag GENERATE_QHP is set to YES. 1299 | 1300 | QHP_NAMESPACE = org.doxygen.Project 1301 | 1302 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1303 | # Help Project output. For more information please see Qt Help Project / Virtual 1304 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1305 | # folders). 1306 | # The default value is: doc. 1307 | # This tag requires that the tag GENERATE_QHP is set to YES. 1308 | 1309 | QHP_VIRTUAL_FOLDER = doc 1310 | 1311 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1312 | # filter to add. For more information please see Qt Help Project / Custom 1313 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1314 | # filters). 1315 | # This tag requires that the tag GENERATE_QHP is set to YES. 1316 | 1317 | QHP_CUST_FILTER_NAME = 1318 | 1319 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1320 | # custom filter to add. For more information please see Qt Help Project / Custom 1321 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1322 | # filters). 1323 | # This tag requires that the tag GENERATE_QHP is set to YES. 1324 | 1325 | QHP_CUST_FILTER_ATTRS = 1326 | 1327 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1328 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1329 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1330 | # This tag requires that the tag GENERATE_QHP is set to YES. 1331 | 1332 | QHP_SECT_FILTER_ATTRS = 1333 | 1334 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1335 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1336 | # generated .qhp file. 1337 | # This tag requires that the tag GENERATE_QHP is set to YES. 1338 | 1339 | QHG_LOCATION = 1340 | 1341 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1342 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1343 | # install this plugin and make it available under the help contents menu in 1344 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1345 | # to be copied into the plugins directory of eclipse. The name of the directory 1346 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1347 | # After copying Eclipse needs to be restarted before the help appears. 1348 | # The default value is: NO. 1349 | # This tag requires that the tag GENERATE_HTML is set to YES. 1350 | 1351 | GENERATE_ECLIPSEHELP = NO 1352 | 1353 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1354 | # the directory name containing the HTML and XML files should also have this 1355 | # name. Each documentation set should have its own identifier. 1356 | # The default value is: org.doxygen.Project. 1357 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1358 | 1359 | ECLIPSE_DOC_ID = org.doxygen.Project 1360 | 1361 | # If you want full control over the layout of the generated HTML pages it might 1362 | # be necessary to disable the index and replace it with your own. The 1363 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1364 | # of each HTML page. A value of NO enables the index and the value YES disables 1365 | # it. Since the tabs in the index contain the same information as the navigation 1366 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1367 | # The default value is: NO. 1368 | # This tag requires that the tag GENERATE_HTML is set to YES. 1369 | 1370 | DISABLE_INDEX = NO 1371 | 1372 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1373 | # structure should be generated to display hierarchical information. If the tag 1374 | # value is set to YES, a side panel will be generated containing a tree-like 1375 | # index structure (just like the one that is generated for HTML Help). For this 1376 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1377 | # (i.e. any modern browser). Windows users are probably better off using the 1378 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1379 | # further fine-tune the look of the index. As an example, the default style 1380 | # sheet generated by doxygen has an example that shows how to put an image at 1381 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1382 | # the same information as the tab index, you could consider setting 1383 | # DISABLE_INDEX to YES when enabling this option. 1384 | # The default value is: NO. 1385 | # This tag requires that the tag GENERATE_HTML is set to YES. 1386 | 1387 | GENERATE_TREEVIEW = YES 1388 | 1389 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1390 | # doxygen will group on one line in the generated HTML documentation. 1391 | # 1392 | # Note that a value of 0 will completely suppress the enum values from appearing 1393 | # in the overview section. 1394 | # Minimum value: 0, maximum value: 20, default value: 4. 1395 | # This tag requires that the tag GENERATE_HTML is set to YES. 1396 | 1397 | ENUM_VALUES_PER_LINE = 4 1398 | 1399 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1400 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1401 | # Minimum value: 0, maximum value: 1500, default value: 250. 1402 | # This tag requires that the tag GENERATE_HTML is set to YES. 1403 | 1404 | TREEVIEW_WIDTH = 250 1405 | 1406 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1407 | # external symbols imported via tag files in a separate window. 1408 | # The default value is: NO. 1409 | # This tag requires that the tag GENERATE_HTML is set to YES. 1410 | 1411 | EXT_LINKS_IN_WINDOW = NO 1412 | 1413 | # Use this tag to change the font size of LaTeX formulas included as images in 1414 | # the HTML documentation. When you change the font size after a successful 1415 | # doxygen run you need to manually remove any form_*.png images from the HTML 1416 | # output directory to force them to be regenerated. 1417 | # Minimum value: 8, maximum value: 50, default value: 10. 1418 | # This tag requires that the tag GENERATE_HTML is set to YES. 1419 | 1420 | FORMULA_FONTSIZE = 10 1421 | 1422 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1423 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1424 | # supported properly for IE 6.0, but are supported on all modern browsers. 1425 | # 1426 | # Note that when changing this option you need to delete any form_*.png files in 1427 | # the HTML output directory before the changes have effect. 1428 | # The default value is: YES. 1429 | # This tag requires that the tag GENERATE_HTML is set to YES. 1430 | 1431 | FORMULA_TRANSPARENT = YES 1432 | 1433 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1434 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1435 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1436 | # installed or if you want to formulas look prettier in the HTML output. When 1437 | # enabled you may also need to install MathJax separately and configure the path 1438 | # to it using the MATHJAX_RELPATH option. 1439 | # The default value is: NO. 1440 | # This tag requires that the tag GENERATE_HTML is set to YES. 1441 | 1442 | USE_MATHJAX = NO 1443 | 1444 | # When MathJax is enabled you can set the default output format to be used for 1445 | # the MathJax output. See the MathJax site (see: 1446 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1447 | # Possible values are: HTML-CSS (which is slower, but has the best 1448 | # compatibility), NativeMML (i.e. MathML) and SVG. 1449 | # The default value is: HTML-CSS. 1450 | # This tag requires that the tag USE_MATHJAX is set to YES. 1451 | 1452 | MATHJAX_FORMAT = HTML-CSS 1453 | 1454 | # When MathJax is enabled you need to specify the location relative to the HTML 1455 | # output directory using the MATHJAX_RELPATH option. The destination directory 1456 | # should contain the MathJax.js script. For instance, if the mathjax directory 1457 | # is located at the same level as the HTML output directory, then 1458 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1459 | # Content Delivery Network so you can quickly see the result without installing 1460 | # MathJax. However, it is strongly recommended to install a local copy of 1461 | # MathJax from http://www.mathjax.org before deployment. 1462 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1463 | # This tag requires that the tag USE_MATHJAX is set to YES. 1464 | 1465 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1466 | 1467 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1468 | # extension names that should be enabled during MathJax rendering. For example 1469 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1470 | # This tag requires that the tag USE_MATHJAX is set to YES. 1471 | 1472 | MATHJAX_EXTENSIONS = 1473 | 1474 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1475 | # of code that will be used on startup of the MathJax code. See the MathJax site 1476 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1477 | # example see the documentation. 1478 | # This tag requires that the tag USE_MATHJAX is set to YES. 1479 | 1480 | MATHJAX_CODEFILE = 1481 | 1482 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1483 | # the HTML output. The underlying search engine uses javascript and DHTML and 1484 | # should work on any modern browser. Note that when using HTML help 1485 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1486 | # there is already a search function so this one should typically be disabled. 1487 | # For large projects the javascript based search engine can be slow, then 1488 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1489 | # search using the keyboard; to jump to the search box use + S 1490 | # (what the is depends on the OS and browser, but it is typically 1491 | # , /