├── .travis.yml ├── CMakeLists.txt ├── LICENSE ├── README.md ├── component.mk ├── doc ├── .gitignore └── Doxyfile ├── include └── rotary_encoder.h └── rotary_encoder.c /.travis.yml: -------------------------------------------------------------------------------- 1 | # Build and deploy doxygen documention to GitHub Pages 2 | sudo: false 3 | dist: trusty 4 | 5 | # Blacklist 6 | branches: 7 | only: 8 | - master 9 | 10 | # Environment variables 11 | env: 12 | global: 13 | - GH_REPO_REF: github.com/DavidAntliff/esp32-rotary-encoder.git 14 | 15 | # Install dependencies 16 | addons: 17 | apt: 18 | packages: 19 | - doxygen 20 | - doxygen-doc 21 | - doxygen-latex 22 | - doxygen-gui 23 | - graphviz 24 | 25 | # Build the docs 26 | script: 27 | - cd doc 28 | - doxygen 29 | 30 | # Deploy using Travis-CI/GitHub Pages integration support 31 | deploy: 32 | provider: pages 33 | skip-cleanup: true 34 | local-dir: doc/html 35 | github-token: $GITHUB_TOKEN 36 | on: 37 | branch: master 38 | target-branch: gh-pages 39 | 40 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | #idf_component_register(SRCS "rotary_encoder.c" INCLUDE_DIRS include) 2 | 3 | set(COMPONENT_ADD_INCLUDEDIRS include) 4 | set(COMPONENT_SRCS "rotary_encoder.c") 5 | register_component() 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # esp32-rotary-encoder 2 | 3 | [![Platform: ESP-IDF](https://img.shields.io/badge/ESP--IDF-v3.0%2B-blue.svg)](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/) 4 | [![License: GPL v3](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) 5 | 6 | ## Introduction 7 | 8 | This ESP32 component uses a debouncing state machine to track the position of an [incremental](https://en.wikipedia.org/wiki/Rotary_encoder#Incremental) rotary encoder such as the [EC11](https://www.alps.com/prod/info/E/HTML/Encoder/Incremental/EC11/EC11_list.html) or [LPD3806](https://www.codrey.com/electronic-circuits/paupers-rotary-encoder/). 9 | 10 | These encoders provide two outputs (typically "A" and "B") that have a quadrature relationship - that is, they oscillate between high and low as the shaft rotates, but with a 90 degree phase offset. Therefore the outputs `AB` may go through the following pattern: `00`, `10`, `11`, `01`, `00` ... The direction can be determined by observing the order of this pattern. This component uses a state machine to decode the sequence of quadrature states, and therefore provides a fairly glitch-free and accurate measurement of the encoder's movement. 11 | 12 | Interrupts are registered on the A and B pins to detect edges. This component assumes that `gpio_install_isr_service()` has been called prior. 13 | 14 | The direction event is placed into a FreeRTOS queue and can be used by a task to increment or decrement a counter that represents the encoder's absolute position. 15 | 16 | Encoders that provide a push button are supported, however this component does not provide direct support for the button. Typically, the button is normally open and pushing it closes the contacts, which can be used to pull a GPIO pin high or low depending on arrangement. This can be detected with a normal GPIO poll or interrupt. 17 | 18 | ## Dependencies 19 | 20 | It is written and tested for v3.0-v3.2 of the [ESP-IDF](https://github.com/espressif/esp-idf) environment, using the xtensa-esp32-elf toolchain (gcc version 5.2.0). It may or may not work with older or newer versions. 21 | 22 | ## Example 23 | 24 | An example application that uses this component is available: [esp32-rotary-encoder-example](https://github.com/DavidAntliff/esp32-rotary-encoder-example) 25 | 26 | ## Features 27 | 28 | * Publication of an event into a user-supplied queue when the encoder moves to either a full or half step: 29 | * Full step mode, where the encoder must move through an entire sequence of four steps before an event is published. 30 | * Half step mode, where the encoder must move through half an entire sequence (two steps) before an event is published. 31 | 32 | ## Documentation 33 | 34 | Automatically generated API documentation is available [here](https://davidantliff.github.io/esp32-rotary-encoder/index.html). 35 | 36 | ## Source Code 37 | 38 | The source is available from [GitHub](https://www.github.com/DavidAntliff/esp32-rotary-encoder). 39 | 40 | ## License 41 | 42 | The code in this project is licensed under the GNU GPL Version 3, or (at your option) any later version. - see [LICENSE](LICENSE) for details. 43 | 44 | ## Links 45 | 46 | * [esp32-rotary-encoder-example](https://github.com/DavidAntliff/esp32-rotary-encoder-example) 47 | * [Espressif IoT Development Framework for ESP32](https://github.com/espressif/esp-idf) 48 | 49 | ## Acknowledgements 50 | 51 | Thank you to [Ben Buxton](mailto://bb@cactii.net) who provided the [original](https://github.com/buxtronix/arduino/tree/master/libraries/Rotary) Arduino code that this component is based upon. 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /component.mk: -------------------------------------------------------------------------------- 1 | # Use defaults 2 | -------------------------------------------------------------------------------- /doc/.gitignore: -------------------------------------------------------------------------------- 1 | html/ 2 | latex/ 3 | 4 | -------------------------------------------------------------------------------- /doc/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.13 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 = "esp32-rotary-encoder" 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 = "ESP32-compatible C library for Incremental Rotary Encoders." 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # 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 = "The $name class" \ 122 | "The $name widget" \ 123 | "The $name file" \ 124 | is \ 125 | provides \ 126 | specifies \ 127 | contains \ 128 | represents \ 129 | a \ 130 | an \ 131 | the 132 | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 | # doxygen will generate a detailed section even if there is only a brief 135 | # description. 136 | # The default value is: NO. 137 | 138 | ALWAYS_DETAILED_SEC = NO 139 | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 | # inherited members of a class in the documentation of that class as if those 142 | # members were ordinary class members. Constructors, destructors and assignment 143 | # operators of the base classes will not be shown. 144 | # The default value is: NO. 145 | 146 | INLINE_INHERITED_MEMB = NO 147 | 148 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149 | # before files name in the file list and in the header files. If set to NO the 150 | # shortest path that makes the file name unique will be used 151 | # The default value is: YES. 152 | 153 | FULL_PATH_NAMES = YES 154 | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 | # Stripping is only done if one of the specified strings matches the left-hand 157 | # part of the path. The tag can be used to show relative paths in the file list. 158 | # If left blank the directory from which doxygen is run is used as the path to 159 | # strip. 160 | # 161 | # Note that you can specify absolute paths here, but also relative paths, which 162 | # will be relative from the directory where doxygen is started. 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 | 165 | STRIP_FROM_PATH = 166 | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 | # path mentioned in the documentation of a class, which tells the reader which 169 | # header file to include in order to use a class. If left blank only the name of 170 | # the header file containing the class definition is used. Otherwise one should 171 | # specify the list of include paths that are normally passed to the compiler 172 | # using the -I flag. 173 | 174 | STRIP_FROM_INC_PATH = 175 | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 | # less readable) file names. This can be useful is your file systems doesn't 178 | # support long names like on DOS, Mac, or CD-ROM. 179 | # The default value is: NO. 180 | 181 | SHORT_NAMES = NO 182 | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 | # first line (until the first dot) of a Javadoc-style comment as the brief 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 | # style comments (thus requiring an explicit @brief command for a brief 187 | # description.) 188 | # The default value is: NO. 189 | 190 | JAVADOC_AUTOBRIEF = NO 191 | 192 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193 | # line (until the first dot) of a Qt-style comment as the brief description. If 194 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195 | # requiring an explicit \brief command for a brief description.) 196 | # The default value is: NO. 197 | 198 | QT_AUTOBRIEF = NO 199 | 200 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202 | # a brief description. This used to be the default behavior. The new default is 203 | # to treat a multi-line C++ comment block as a detailed description. Set this 204 | # tag to YES if you prefer the old behavior instead. 205 | # 206 | # Note that setting this tag to YES also means that rational rose comments are 207 | # not recognized any more. 208 | # The default value is: NO. 209 | 210 | MULTILINE_CPP_IS_BRIEF = NO 211 | 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213 | # documentation from any documented member that it re-implements. 214 | # The default value is: YES. 215 | 216 | INHERIT_DOCS = YES 217 | 218 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 219 | # page for each member. If set to NO, the documentation of a member will be part 220 | # of the file/class/namespace that contains it. 221 | # The default value is: NO. 222 | 223 | SEPARATE_MEMBER_PAGES = NO 224 | 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226 | # uses this value to replace tabs by spaces in code fragments. 227 | # Minimum value: 1, maximum value: 16, default value: 4. 228 | 229 | TAB_SIZE = 4 230 | 231 | # This tag can be used to specify a number of aliases that act as commands in 232 | # the documentation. An alias has the form: 233 | # name=value 234 | # For example adding 235 | # "sideeffect=@par Side Effects:\n" 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the 237 | # documentation, which will result in a user-defined paragraph with heading 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert 239 | # newlines. 240 | 241 | ALIASES = 242 | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" 245 | # will allow you to use the command class in the itcl::class meaning. 246 | 247 | TCL_SUBST = 248 | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 | # only. Doxygen will then generate output that is more tailored for C. For 251 | # instance, some of the names that are used will be different. The list of all 252 | # members will be omitted, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_FOR_C = YES 256 | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 | # Python sources only. Doxygen will then generate output that is more tailored 259 | # for that language. For instance, namespaces will be presented as packages, 260 | # qualified scopes will look different, etc. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_OUTPUT_JAVA = NO 264 | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 | # sources. Doxygen will then generate output that is tailored for Fortran. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_FOR_FORTRAN = NO 270 | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 | # sources. Doxygen will then generate output that is tailored for VHDL. 273 | # The default value is: NO. 274 | 275 | OPTIMIZE_OUTPUT_VHDL = NO 276 | 277 | # Doxygen selects the parser to use depending on the extension of the files it 278 | # parses. With this tag you can assign which parser to use for a given 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it 280 | # using this tag. The format is ext=language, where ext is a file extension, and 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 | # 289 | # Note: For files without extension you can use no_extension as a placeholder. 290 | # 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 | # the files are not read by doxygen. 293 | 294 | EXTENSION_MAPPING = 295 | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 | # according to the Markdown format, which allows for more readable 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 | # The output of markdown processing is further processed by doxygen, so you can 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 | # case of backward compatibilities issues. 302 | # The default value is: YES. 303 | 304 | MARKDOWN_SUPPORT = YES 305 | 306 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 307 | # to that level are automatically included in the table of contents, even if 308 | # they do not have an id attribute. 309 | # Note: This feature currently applies only to Markdown headings. 310 | # Minimum value: 0, maximum value: 99, default value: 0. 311 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 312 | 313 | TOC_INCLUDE_HEADINGS = 0 314 | 315 | # When enabled doxygen tries to link words that correspond to documented 316 | # classes, or namespaces to their corresponding documentation. Such a link can 317 | # be prevented in individual cases by putting a % sign in front of the word or 318 | # globally by setting AUTOLINK_SUPPORT to NO. 319 | # The default value is: YES. 320 | 321 | AUTOLINK_SUPPORT = YES 322 | 323 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 324 | # to include (a tag file for) the STL sources as input, then you should set this 325 | # tag to YES in order to let doxygen match functions declarations and 326 | # definitions whose arguments contain STL classes (e.g. func(std::string); 327 | # versus func(std::string) {}). This also make the inheritance and collaboration 328 | # diagrams that involve STL classes more complete and accurate. 329 | # The default value is: NO. 330 | 331 | BUILTIN_STL_SUPPORT = NO 332 | 333 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 334 | # enable parsing support. 335 | # The default value is: NO. 336 | 337 | CPP_CLI_SUPPORT = NO 338 | 339 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 340 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 341 | # will parse them like normal C++ but will assume all classes use public instead 342 | # of private inheritance when no explicit protection keyword is present. 343 | # The default value is: NO. 344 | 345 | SIP_SUPPORT = NO 346 | 347 | # For Microsoft's IDL there are propget and propput attributes to indicate 348 | # getter and setter methods for a property. Setting this option to YES will make 349 | # doxygen to replace the get and set methods by a property in the documentation. 350 | # This will only work if the methods are indeed getting or setting a simple 351 | # type. If this is not the case, or you want to show the methods anyway, you 352 | # should set this option to NO. 353 | # The default value is: YES. 354 | 355 | IDL_PROPERTY_SUPPORT = YES 356 | 357 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 358 | # tag is set to YES then doxygen will reuse the documentation of the first 359 | # member in the group (if any) for the other members of the group. By default 360 | # all members of a group must be documented explicitly. 361 | # The default value is: NO. 362 | 363 | DISTRIBUTE_GROUP_DOC = NO 364 | 365 | # If one adds a struct or class to a group and this option is enabled, then also 366 | # any nested class or struct is added to the same group. By default this option 367 | # is disabled and one has to add nested compounds explicitly via \ingroup. 368 | # The default value is: NO. 369 | 370 | GROUP_NESTED_COMPOUNDS = NO 371 | 372 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 373 | # (for instance a group of public functions) to be put as a subgroup of that 374 | # type (e.g. under the Public Functions section). Set it to NO to prevent 375 | # subgrouping. Alternatively, this can be done per class using the 376 | # \nosubgrouping command. 377 | # The default value is: YES. 378 | 379 | SUBGROUPING = YES 380 | 381 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 382 | # are shown inside the group in which they are included (e.g. using \ingroup) 383 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 384 | # and RTF). 385 | # 386 | # Note that this feature does not work in combination with 387 | # SEPARATE_MEMBER_PAGES. 388 | # The default value is: NO. 389 | 390 | INLINE_GROUPED_CLASSES = NO 391 | 392 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 393 | # with only public data fields or simple typedef fields will be shown inline in 394 | # the documentation of the scope in which they are defined (i.e. file, 395 | # namespace, or group documentation), provided this scope is documented. If set 396 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 397 | # Man pages) or section (for LaTeX and RTF). 398 | # The default value is: NO. 399 | 400 | INLINE_SIMPLE_STRUCTS = NO 401 | 402 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 403 | # enum is documented as struct, union, or enum with the name of the typedef. So 404 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 405 | # with name TypeT. When disabled the typedef will appear as a member of a file, 406 | # namespace, or class. And the struct will be named TypeS. This can typically be 407 | # useful for C code in case the coding convention dictates that all compound 408 | # types are typedef'ed and only the typedef is referenced, never the tag name. 409 | # The default value is: NO. 410 | 411 | TYPEDEF_HIDES_STRUCT = NO 412 | 413 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 414 | # cache is used to resolve symbols given their name and scope. Since this can be 415 | # an expensive process and often the same symbol appears multiple times in the 416 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 417 | # doxygen will become slower. If the cache is too large, memory is wasted. The 418 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 419 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 420 | # symbols. At the end of a run doxygen will report the cache usage and suggest 421 | # the optimal cache size from a speed point of view. 422 | # Minimum value: 0, maximum value: 9, default value: 0. 423 | 424 | LOOKUP_CACHE_SIZE = 0 425 | 426 | #--------------------------------------------------------------------------- 427 | # Build related configuration options 428 | #--------------------------------------------------------------------------- 429 | 430 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 431 | # documentation are documented, even if no documentation was available. Private 432 | # class members and static file members will be hidden unless the 433 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 434 | # Note: This will also disable the warnings about undocumented members that are 435 | # normally produced when WARNINGS is set to YES. 436 | # The default value is: NO. 437 | 438 | EXTRACT_ALL = NO 439 | 440 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 441 | # be included in the documentation. 442 | # The default value is: NO. 443 | 444 | EXTRACT_PRIVATE = NO 445 | 446 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 447 | # scope will be included in the documentation. 448 | # The default value is: NO. 449 | 450 | EXTRACT_PACKAGE = NO 451 | 452 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 453 | # included in the documentation. 454 | # The default value is: NO. 455 | 456 | EXTRACT_STATIC = NO 457 | 458 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 459 | # locally in source files will be included in the documentation. If set to NO, 460 | # only classes defined in header files are included. Does not have any effect 461 | # for Java sources. 462 | # The default value is: YES. 463 | 464 | EXTRACT_LOCAL_CLASSES = YES 465 | 466 | # This flag is only useful for Objective-C code. If set to YES, local methods, 467 | # which are defined in the implementation section but not in the interface are 468 | # included in the documentation. If set to NO, only methods in the interface are 469 | # included. 470 | # The default value is: NO. 471 | 472 | EXTRACT_LOCAL_METHODS = NO 473 | 474 | # If this flag is set to YES, the members of anonymous namespaces will be 475 | # extracted and appear in the documentation as a namespace called 476 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 477 | # the file that contains the anonymous namespace. By default anonymous namespace 478 | # are hidden. 479 | # The default value is: NO. 480 | 481 | EXTRACT_ANON_NSPACES = NO 482 | 483 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 484 | # undocumented members inside documented classes or files. If set to NO these 485 | # members will be included in the various overviews, but no documentation 486 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 487 | # The default value is: NO. 488 | 489 | HIDE_UNDOC_MEMBERS = NO 490 | 491 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 492 | # undocumented classes that are normally visible in the class hierarchy. If set 493 | # to NO, these classes will be included in the various overviews. This option 494 | # has no effect if EXTRACT_ALL is enabled. 495 | # The default value is: NO. 496 | 497 | HIDE_UNDOC_CLASSES = NO 498 | 499 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 500 | # (class|struct|union) declarations. If set to NO, these declarations will be 501 | # included in the documentation. 502 | # The default value is: NO. 503 | 504 | HIDE_FRIEND_COMPOUNDS = NO 505 | 506 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 507 | # documentation blocks found inside the body of a function. If set to NO, these 508 | # blocks will be appended to the function's detailed documentation block. 509 | # The default value is: NO. 510 | 511 | HIDE_IN_BODY_DOCS = NO 512 | 513 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 514 | # \internal command is included. If the tag is set to NO then the documentation 515 | # will be excluded. Set it to YES to include the internal documentation. 516 | # The default value is: NO. 517 | 518 | INTERNAL_DOCS = NO 519 | 520 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 521 | # names in lower-case letters. If set to YES, upper-case letters are also 522 | # allowed. This is useful if you have classes or files whose names only differ 523 | # in case and if your file system supports case sensitive file names. Windows 524 | # and Mac users are advised to set this option to NO. 525 | # The default value is: system dependent. 526 | 527 | CASE_SENSE_NAMES = NO 528 | 529 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 530 | # their full class and namespace scopes in the documentation. If set to YES, the 531 | # scope will be hidden. 532 | # The default value is: NO. 533 | 534 | HIDE_SCOPE_NAMES = NO 535 | 536 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 537 | # append additional text to a page's title, such as Class Reference. If set to 538 | # YES the compound reference will be hidden. 539 | # The default value is: NO. 540 | 541 | HIDE_COMPOUND_REFERENCE= NO 542 | 543 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 544 | # the files that are included by a file in the documentation of that file. 545 | # The default value is: YES. 546 | 547 | SHOW_INCLUDE_FILES = YES 548 | 549 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 550 | # grouped member an include statement to the documentation, telling the reader 551 | # which file to include in order to use the member. 552 | # The default value is: NO. 553 | 554 | SHOW_GROUPED_MEMB_INC = NO 555 | 556 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 557 | # files with double quotes in the documentation rather than with sharp brackets. 558 | # The default value is: NO. 559 | 560 | FORCE_LOCAL_INCLUDES = NO 561 | 562 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 563 | # documentation for inline members. 564 | # The default value is: YES. 565 | 566 | INLINE_INFO = YES 567 | 568 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 569 | # (detailed) documentation of file and class members alphabetically by member 570 | # name. If set to NO, the members will appear in declaration order. 571 | # The default value is: YES. 572 | 573 | SORT_MEMBER_DOCS = NO 574 | 575 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 576 | # descriptions of file, namespace and class members alphabetically by member 577 | # name. If set to NO, the members will appear in declaration order. Note that 578 | # this will also influence the order of the classes in the class list. 579 | # The default value is: NO. 580 | 581 | SORT_BRIEF_DOCS = NO 582 | 583 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 584 | # (brief and detailed) documentation of class members so that constructors and 585 | # destructors are listed first. If set to NO the constructors will appear in the 586 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 587 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 588 | # member documentation. 589 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 590 | # detailed member documentation. 591 | # The default value is: NO. 592 | 593 | SORT_MEMBERS_CTORS_1ST = NO 594 | 595 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 596 | # of group names into alphabetical order. If set to NO the group names will 597 | # appear in their defined order. 598 | # The default value is: NO. 599 | 600 | SORT_GROUP_NAMES = NO 601 | 602 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 603 | # fully-qualified names, including namespaces. If set to NO, the class list will 604 | # be sorted only by class name, not including the namespace part. 605 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 606 | # Note: This option applies only to the class list, not to the alphabetical 607 | # list. 608 | # The default value is: NO. 609 | 610 | SORT_BY_SCOPE_NAME = NO 611 | 612 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 613 | # type resolution of all parameters of a function it will reject a match between 614 | # the prototype and the implementation of a member function even if there is 615 | # only one candidate or it is obvious which candidate to choose by doing a 616 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 617 | # accept a match between prototype and implementation in such cases. 618 | # The default value is: NO. 619 | 620 | STRICT_PROTO_MATCHING = NO 621 | 622 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 623 | # list. This list is created by putting \todo commands in the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_TODOLIST = YES 627 | 628 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 629 | # list. This list is created by putting \test commands in the documentation. 630 | # The default value is: YES. 631 | 632 | GENERATE_TESTLIST = YES 633 | 634 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 635 | # list. This list is created by putting \bug commands in the documentation. 636 | # The default value is: YES. 637 | 638 | GENERATE_BUGLIST = YES 639 | 640 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 641 | # the deprecated list. This list is created by putting \deprecated commands in 642 | # the documentation. 643 | # The default value is: YES. 644 | 645 | GENERATE_DEPRECATEDLIST= YES 646 | 647 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 648 | # sections, marked by \if ... \endif and \cond 649 | # ... \endcond blocks. 650 | 651 | ENABLED_SECTIONS = 652 | 653 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 654 | # initial value of a variable or macro / define can have for it to appear in the 655 | # documentation. If the initializer consists of more lines than specified here 656 | # it will be hidden. Use a value of 0 to hide initializers completely. The 657 | # appearance of the value of individual variables and macros / defines can be 658 | # controlled using \showinitializer or \hideinitializer command in the 659 | # documentation regardless of this setting. 660 | # Minimum value: 0, maximum value: 10000, default value: 30. 661 | 662 | MAX_INITIALIZER_LINES = 30 663 | 664 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 665 | # the bottom of the documentation of classes and structs. If set to YES, the 666 | # list will mention the files that were used to generate the documentation. 667 | # The default value is: YES. 668 | 669 | SHOW_USED_FILES = YES 670 | 671 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 672 | # will remove the Files entry from the Quick Index and from the Folder Tree View 673 | # (if specified). 674 | # The default value is: YES. 675 | 676 | SHOW_FILES = YES 677 | 678 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 679 | # page. This will remove the Namespaces entry from the Quick Index and from the 680 | # Folder Tree View (if specified). 681 | # The default value is: YES. 682 | 683 | SHOW_NAMESPACES = YES 684 | 685 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 686 | # doxygen should invoke to get the current version for each file (typically from 687 | # the version control system). Doxygen will invoke the program by executing (via 688 | # popen()) the command command input-file, where command is the value of the 689 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 690 | # by doxygen. Whatever the program writes to standard output is used as the file 691 | # version. For an example see the documentation. 692 | 693 | FILE_VERSION_FILTER = 694 | 695 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 696 | # by doxygen. The layout file controls the global structure of the generated 697 | # output files in an output format independent way. To create the layout file 698 | # that represents doxygen's defaults, run doxygen with the -l option. You can 699 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 700 | # will be used as the name of the layout file. 701 | # 702 | # Note that if you run doxygen from a directory containing a file called 703 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 704 | # tag is left empty. 705 | 706 | LAYOUT_FILE = 707 | 708 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 709 | # the reference definitions. This must be a list of .bib files. The .bib 710 | # extension is automatically appended if omitted. This requires the bibtex tool 711 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 712 | # For LaTeX the style of the bibliography can be controlled using 713 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 714 | # search path. See also \cite for info how to create references. 715 | 716 | CITE_BIB_FILES = 717 | 718 | #--------------------------------------------------------------------------- 719 | # Configuration options related to warning and progress messages 720 | #--------------------------------------------------------------------------- 721 | 722 | # The QUIET tag can be used to turn on/off the messages that are generated to 723 | # standard output by doxygen. If QUIET is set to YES this implies that the 724 | # messages are off. 725 | # The default value is: NO. 726 | 727 | QUIET = NO 728 | 729 | # The WARNINGS tag can be used to turn on/off the warning messages that are 730 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 731 | # this implies that the warnings are on. 732 | # 733 | # Tip: Turn warnings on while writing the documentation. 734 | # The default value is: YES. 735 | 736 | WARNINGS = YES 737 | 738 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 739 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 740 | # will automatically be disabled. 741 | # The default value is: YES. 742 | 743 | WARN_IF_UNDOCUMENTED = YES 744 | 745 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 746 | # potential errors in the documentation, such as not documenting some parameters 747 | # in a documented function, or documenting parameters that don't exist or using 748 | # markup commands wrongly. 749 | # The default value is: YES. 750 | 751 | WARN_IF_DOC_ERROR = YES 752 | 753 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 754 | # are documented, but have no documentation for their parameters or return 755 | # value. If set to NO, doxygen will only warn about wrong or incomplete 756 | # parameter documentation, but not about the absence of documentation. 757 | # The default value is: NO. 758 | 759 | WARN_NO_PARAMDOC = NO 760 | 761 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 762 | # a warning is encountered. 763 | # The default value is: NO. 764 | 765 | WARN_AS_ERROR = NO 766 | 767 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 768 | # can produce. The string should contain the $file, $line, and $text tags, which 769 | # will be replaced by the file and line number from which the warning originated 770 | # and the warning text. Optionally the format may contain $version, which will 771 | # be replaced by the version of the file (if it could be obtained via 772 | # FILE_VERSION_FILTER) 773 | # The default value is: $file:$line: $text. 774 | 775 | WARN_FORMAT = "$file:$line: $text" 776 | 777 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 778 | # messages should be written. If left blank the output is written to standard 779 | # error (stderr). 780 | 781 | WARN_LOGFILE = 782 | 783 | #--------------------------------------------------------------------------- 784 | # Configuration options related to the input files 785 | #--------------------------------------------------------------------------- 786 | 787 | # The INPUT tag is used to specify the files and/or directories that contain 788 | # documented source files. You may enter file names like myfile.cpp or 789 | # directories like /usr/src/myproject. Separate the files or directories with 790 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 791 | # Note: If this tag is empty the current directory is searched. 792 | 793 | INPUT = ../README.md \ 794 | ../include \ 795 | .. 796 | 797 | # This tag can be used to specify the character encoding of the source files 798 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 799 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 800 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 801 | # possible encodings. 802 | # The default value is: UTF-8. 803 | 804 | INPUT_ENCODING = UTF-8 805 | 806 | # If the value of the INPUT tag contains directories, you can use the 807 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 808 | # *.h) to filter out the source-files in the directories. 809 | # 810 | # Note that for custom extensions or not directly supported extensions you also 811 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 812 | # read by doxygen. 813 | # 814 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 815 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 816 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 817 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 818 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 819 | 820 | FILE_PATTERNS = *.c \ 821 | *.cc \ 822 | *.cxx \ 823 | *.cpp \ 824 | *.c++ \ 825 | *.java \ 826 | *.ii \ 827 | *.ixx \ 828 | *.ipp \ 829 | *.i++ \ 830 | *.inl \ 831 | *.idl \ 832 | *.ddl \ 833 | *.odl \ 834 | *.h \ 835 | *.hh \ 836 | *.hxx \ 837 | *.hpp \ 838 | *.h++ \ 839 | *.cs \ 840 | *.d \ 841 | *.php \ 842 | *.php4 \ 843 | *.php5 \ 844 | *.phtml \ 845 | *.inc \ 846 | *.m \ 847 | *.markdown \ 848 | *.md \ 849 | *.mm \ 850 | *.dox \ 851 | *.py \ 852 | *.pyw \ 853 | *.f90 \ 854 | *.f95 \ 855 | *.f03 \ 856 | *.f08 \ 857 | *.f \ 858 | *.for \ 859 | *.tcl \ 860 | *.vhd \ 861 | *.vhdl \ 862 | *.ucf \ 863 | *.qsf 864 | 865 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 866 | # be searched for input files as well. 867 | # The default value is: NO. 868 | 869 | RECURSIVE = NO 870 | 871 | # The EXCLUDE tag can be used to specify files and/or directories that should be 872 | # excluded from the INPUT source files. This way you can easily exclude a 873 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 874 | # 875 | # Note that relative paths are relative to the directory from which doxygen is 876 | # run. 877 | 878 | EXCLUDE = 879 | 880 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 881 | # directories that are symbolic links (a Unix file system feature) are excluded 882 | # from the input. 883 | # The default value is: NO. 884 | 885 | EXCLUDE_SYMLINKS = NO 886 | 887 | # If the value of the INPUT tag contains directories, you can use the 888 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 889 | # certain files from those directories. 890 | # 891 | # Note that the wildcards are matched against the file with absolute path, so to 892 | # exclude all test directories for example use the pattern */test/* 893 | 894 | EXCLUDE_PATTERNS = 895 | 896 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 897 | # (namespaces, classes, functions, etc.) that should be excluded from the 898 | # output. The symbol name can be a fully qualified name, a word, or if the 899 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 900 | # AClass::ANamespace, ANamespace::*Test 901 | # 902 | # Note that the wildcards are matched against the file with absolute path, so to 903 | # exclude all test directories use the pattern */test/* 904 | 905 | EXCLUDE_SYMBOLS = 906 | 907 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 908 | # that contain example code fragments that are included (see the \include 909 | # command). 910 | 911 | EXAMPLE_PATH = 912 | 913 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 914 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 915 | # *.h) to filter out the source-files in the directories. If left blank all 916 | # files are included. 917 | 918 | EXAMPLE_PATTERNS = * 919 | 920 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 921 | # searched for input files to be used with the \include or \dontinclude commands 922 | # irrespective of the value of the RECURSIVE tag. 923 | # The default value is: NO. 924 | 925 | EXAMPLE_RECURSIVE = NO 926 | 927 | # The IMAGE_PATH tag can be used to specify one or more files or directories 928 | # that contain images that are to be included in the documentation (see the 929 | # \image command). 930 | 931 | IMAGE_PATH = 932 | 933 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 934 | # invoke to filter for each input file. Doxygen will invoke the filter program 935 | # by executing (via popen()) the command: 936 | # 937 | # 938 | # 939 | # where is the value of the INPUT_FILTER tag, and is the 940 | # name of an input file. Doxygen will then use the output that the filter 941 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 942 | # will be ignored. 943 | # 944 | # Note that the filter must not add or remove lines; it is applied before the 945 | # code is scanned, but not when the output code is generated. If lines are added 946 | # or removed, the anchors will not be placed correctly. 947 | # 948 | # Note that for custom extensions or not directly supported extensions you also 949 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 950 | # properly processed by doxygen. 951 | 952 | INPUT_FILTER = 953 | 954 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 955 | # basis. Doxygen will compare the file name with each pattern and apply the 956 | # filter if there is a match. The filters are a list of the form: pattern=filter 957 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 958 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 959 | # patterns match the file name, INPUT_FILTER is applied. 960 | # 961 | # Note that for custom extensions or not directly supported extensions you also 962 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 963 | # properly processed by doxygen. 964 | 965 | FILTER_PATTERNS = 966 | 967 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 968 | # INPUT_FILTER) will also be used to filter the input files that are used for 969 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 970 | # The default value is: NO. 971 | 972 | FILTER_SOURCE_FILES = NO 973 | 974 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 975 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 976 | # it is also possible to disable source filtering for a specific pattern using 977 | # *.ext= (so without naming a filter). 978 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 979 | 980 | FILTER_SOURCE_PATTERNS = 981 | 982 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 983 | # is part of the input, its contents will be placed on the main page 984 | # (index.html). This can be useful if you have a project on for instance GitHub 985 | # and want to reuse the introduction page also for the doxygen output. 986 | 987 | USE_MDFILE_AS_MAINPAGE = ../README.md 988 | 989 | #--------------------------------------------------------------------------- 990 | # Configuration options related to source browsing 991 | #--------------------------------------------------------------------------- 992 | 993 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 994 | # generated. Documented entities will be cross-referenced with these sources. 995 | # 996 | # Note: To get rid of all source code in the generated output, make sure that 997 | # also VERBATIM_HEADERS is set to NO. 998 | # The default value is: NO. 999 | 1000 | SOURCE_BROWSER = NO 1001 | 1002 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1003 | # classes and enums directly into the documentation. 1004 | # The default value is: NO. 1005 | 1006 | INLINE_SOURCES = NO 1007 | 1008 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1009 | # special comment blocks from generated source code fragments. Normal C, C++ and 1010 | # Fortran comments will always remain visible. 1011 | # The default value is: YES. 1012 | 1013 | STRIP_CODE_COMMENTS = YES 1014 | 1015 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1016 | # function all documented functions referencing it will be listed. 1017 | # The default value is: NO. 1018 | 1019 | REFERENCED_BY_RELATION = NO 1020 | 1021 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1022 | # all documented entities called/used by that function will be listed. 1023 | # The default value is: NO. 1024 | 1025 | REFERENCES_RELATION = NO 1026 | 1027 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1028 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1029 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1030 | # link to the documentation. 1031 | # The default value is: YES. 1032 | 1033 | REFERENCES_LINK_SOURCE = YES 1034 | 1035 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1036 | # source code will show a tooltip with additional information such as prototype, 1037 | # brief description and links to the definition and documentation. Since this 1038 | # will make the HTML file larger and loading of large files a bit slower, you 1039 | # can opt to disable this feature. 1040 | # The default value is: YES. 1041 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1042 | 1043 | SOURCE_TOOLTIPS = YES 1044 | 1045 | # If the USE_HTAGS tag is set to YES then the references to source code will 1046 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1047 | # source browser. The htags tool is part of GNU's global source tagging system 1048 | # (see http://www.gnu.org/software/global/global.html). You will need version 1049 | # 4.8.6 or higher. 1050 | # 1051 | # To use it do the following: 1052 | # - Install the latest version of global 1053 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1054 | # - Make sure the INPUT points to the root of the source tree 1055 | # - Run doxygen as normal 1056 | # 1057 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1058 | # tools must be available from the command line (i.e. in the search path). 1059 | # 1060 | # The result: instead of the source browser generated by doxygen, the links to 1061 | # source code will now point to the output of htags. 1062 | # The default value is: NO. 1063 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1064 | 1065 | USE_HTAGS = NO 1066 | 1067 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1068 | # verbatim copy of the header file for each class for which an include is 1069 | # specified. Set to NO to disable this. 1070 | # See also: Section \class. 1071 | # The default value is: YES. 1072 | 1073 | VERBATIM_HEADERS = YES 1074 | 1075 | #--------------------------------------------------------------------------- 1076 | # Configuration options related to the alphabetical class index 1077 | #--------------------------------------------------------------------------- 1078 | 1079 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1080 | # compounds will be generated. Enable this if the project contains a lot of 1081 | # classes, structs, unions or interfaces. 1082 | # The default value is: YES. 1083 | 1084 | ALPHABETICAL_INDEX = YES 1085 | 1086 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1087 | # which the alphabetical index list will be split. 1088 | # Minimum value: 1, maximum value: 20, default value: 5. 1089 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1090 | 1091 | COLS_IN_ALPHA_INDEX = 5 1092 | 1093 | # In case all classes in a project start with a common prefix, all classes will 1094 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1095 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1096 | # while generating the index headers. 1097 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1098 | 1099 | IGNORE_PREFIX = 1100 | 1101 | #--------------------------------------------------------------------------- 1102 | # Configuration options related to the HTML output 1103 | #--------------------------------------------------------------------------- 1104 | 1105 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1106 | # The default value is: YES. 1107 | 1108 | GENERATE_HTML = YES 1109 | 1110 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1111 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1112 | # it. 1113 | # The default directory is: html. 1114 | # This tag requires that the tag GENERATE_HTML is set to YES. 1115 | 1116 | HTML_OUTPUT = html 1117 | 1118 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1119 | # generated HTML page (for example: .htm, .php, .asp). 1120 | # The default value is: .html. 1121 | # This tag requires that the tag GENERATE_HTML is set to YES. 1122 | 1123 | HTML_FILE_EXTENSION = .html 1124 | 1125 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1126 | # each generated HTML page. If the tag is left blank doxygen will generate a 1127 | # standard header. 1128 | # 1129 | # To get valid HTML the header file that includes any scripts and style sheets 1130 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1131 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1132 | # default header using 1133 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1134 | # YourConfigFile 1135 | # and then modify the file new_header.html. See also section "Doxygen usage" 1136 | # for information on how to generate the default header that doxygen normally 1137 | # uses. 1138 | # Note: The header is subject to change so you typically have to regenerate the 1139 | # default header when upgrading to a newer version of doxygen. For a description 1140 | # of the possible markers and block names see the documentation. 1141 | # This tag requires that the tag GENERATE_HTML is set to YES. 1142 | 1143 | HTML_HEADER = 1144 | 1145 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1146 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1147 | # footer. See HTML_HEADER for more information on how to generate a default 1148 | # footer and what special commands can be used inside the footer. See also 1149 | # section "Doxygen usage" for information on how to generate the default footer 1150 | # that doxygen normally uses. 1151 | # This tag requires that the tag GENERATE_HTML is set to YES. 1152 | 1153 | HTML_FOOTER = 1154 | 1155 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1156 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1157 | # the HTML output. If left blank doxygen will generate a default style sheet. 1158 | # See also section "Doxygen usage" for information on how to generate the style 1159 | # sheet that doxygen normally uses. 1160 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1161 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1162 | # obsolete. 1163 | # This tag requires that the tag GENERATE_HTML is set to YES. 1164 | 1165 | HTML_STYLESHEET = 1166 | 1167 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1168 | # cascading style sheets that are included after the standard style sheets 1169 | # created by doxygen. Using this option one can overrule certain style aspects. 1170 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1171 | # standard style sheet and is therefore more robust against future updates. 1172 | # Doxygen will copy the style sheet files to the output directory. 1173 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1174 | # style sheet in the list overrules the setting of the previous ones in the 1175 | # list). For an example see the documentation. 1176 | # This tag requires that the tag GENERATE_HTML is set to YES. 1177 | 1178 | HTML_EXTRA_STYLESHEET = 1179 | 1180 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1181 | # other source files which should be copied to the HTML output directory. Note 1182 | # that these files will be copied to the base HTML output directory. Use the 1183 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1184 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1185 | # files will be copied as-is; there are no commands or markers available. 1186 | # This tag requires that the tag GENERATE_HTML is set to YES. 1187 | 1188 | HTML_EXTRA_FILES = 1189 | 1190 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1191 | # will adjust the colors in the style sheet and background images according to 1192 | # this color. Hue is specified as an angle on a colorwheel, see 1193 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1194 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1195 | # purple, and 360 is red again. 1196 | # Minimum value: 0, maximum value: 359, default value: 220. 1197 | # This tag requires that the tag GENERATE_HTML is set to YES. 1198 | 1199 | HTML_COLORSTYLE_HUE = 220 1200 | 1201 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1202 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1203 | # value of 255 will produce the most vivid colors. 1204 | # Minimum value: 0, maximum value: 255, default value: 100. 1205 | # This tag requires that the tag GENERATE_HTML is set to YES. 1206 | 1207 | HTML_COLORSTYLE_SAT = 100 1208 | 1209 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1210 | # luminance component of the colors in the HTML output. Values below 100 1211 | # gradually make the output lighter, whereas values above 100 make the output 1212 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1213 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1214 | # change the gamma. 1215 | # Minimum value: 40, maximum value: 240, default value: 80. 1216 | # This tag requires that the tag GENERATE_HTML is set to YES. 1217 | 1218 | HTML_COLORSTYLE_GAMMA = 80 1219 | 1220 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1221 | # page will contain the date and time when the page was generated. Setting this 1222 | # to YES can help to show when doxygen was last run and thus if the 1223 | # documentation is up to date. 1224 | # The default value is: NO. 1225 | # This tag requires that the tag GENERATE_HTML is set to YES. 1226 | 1227 | HTML_TIMESTAMP = NO 1228 | 1229 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1230 | # documentation will contain sections that can be hidden and shown after the 1231 | # page has loaded. 1232 | # The default value is: NO. 1233 | # This tag requires that the tag GENERATE_HTML is set to YES. 1234 | 1235 | HTML_DYNAMIC_SECTIONS = NO 1236 | 1237 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1238 | # shown in the various tree structured indices initially; the user can expand 1239 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1240 | # such a level that at most the specified number of entries are visible (unless 1241 | # a fully collapsed tree already exceeds this amount). So setting the number of 1242 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1243 | # representing an infinite number of entries and will result in a full expanded 1244 | # tree by default. 1245 | # Minimum value: 0, maximum value: 9999, default value: 100. 1246 | # This tag requires that the tag GENERATE_HTML is set to YES. 1247 | 1248 | HTML_INDEX_NUM_ENTRIES = 100 1249 | 1250 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1251 | # generated that can be used as input for Apple's Xcode 3 integrated development 1252 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1253 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1254 | # Makefile in the HTML output directory. Running make will produce the docset in 1255 | # that directory and running make install will install the docset in 1256 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1257 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1258 | # for more information. 1259 | # The default value is: NO. 1260 | # This tag requires that the tag GENERATE_HTML is set to YES. 1261 | 1262 | GENERATE_DOCSET = NO 1263 | 1264 | # This tag determines the name of the docset feed. A documentation feed provides 1265 | # an umbrella under which multiple documentation sets from a single provider 1266 | # (such as a company or product suite) can be grouped. 1267 | # The default value is: Doxygen generated docs. 1268 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1269 | 1270 | DOCSET_FEEDNAME = "Doxygen generated docs" 1271 | 1272 | # This tag specifies a string that should uniquely identify the documentation 1273 | # set bundle. This should be a reverse domain-name style string, e.g. 1274 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1275 | # The default value is: org.doxygen.Project. 1276 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1277 | 1278 | DOCSET_BUNDLE_ID = org.doxygen.Project 1279 | 1280 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1281 | # the documentation publisher. This should be a reverse domain-name style 1282 | # string, e.g. com.mycompany.MyDocSet.documentation. 1283 | # The default value is: org.doxygen.Publisher. 1284 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1285 | 1286 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1287 | 1288 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1289 | # The default value is: Publisher. 1290 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1291 | 1292 | DOCSET_PUBLISHER_NAME = Publisher 1293 | 1294 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1295 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1296 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1297 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1298 | # Windows. 1299 | # 1300 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1301 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1302 | # files are now used as the Windows 98 help format, and will replace the old 1303 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1304 | # HTML files also contain an index, a table of contents, and you can search for 1305 | # words in the documentation. The HTML workshop also contains a viewer for 1306 | # compressed HTML files. 1307 | # The default value is: NO. 1308 | # This tag requires that the tag GENERATE_HTML is set to YES. 1309 | 1310 | GENERATE_HTMLHELP = NO 1311 | 1312 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1313 | # file. You can add a path in front of the file if the result should not be 1314 | # written to the html output directory. 1315 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1316 | 1317 | CHM_FILE = 1318 | 1319 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1320 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1321 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1322 | # The file has to be specified with full path. 1323 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1324 | 1325 | HHC_LOCATION = 1326 | 1327 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1328 | # (YES) or that it should be included in the master .chm file (NO). 1329 | # The default value is: NO. 1330 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1331 | 1332 | GENERATE_CHI = NO 1333 | 1334 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1335 | # and project file content. 1336 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1337 | 1338 | CHM_INDEX_ENCODING = 1339 | 1340 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1341 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1342 | # enables the Previous and Next buttons. 1343 | # The default value is: NO. 1344 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1345 | 1346 | BINARY_TOC = NO 1347 | 1348 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1349 | # the table of contents of the HTML help documentation and to the tree view. 1350 | # The default value is: NO. 1351 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1352 | 1353 | TOC_EXPAND = NO 1354 | 1355 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1356 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1357 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1358 | # (.qch) of the generated HTML documentation. 1359 | # The default value is: NO. 1360 | # This tag requires that the tag GENERATE_HTML is set to YES. 1361 | 1362 | GENERATE_QHP = NO 1363 | 1364 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1365 | # the file name of the resulting .qch file. The path specified is relative to 1366 | # the HTML output folder. 1367 | # This tag requires that the tag GENERATE_QHP is set to YES. 1368 | 1369 | QCH_FILE = 1370 | 1371 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1372 | # Project output. For more information please see Qt Help Project / Namespace 1373 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1374 | # The default value is: org.doxygen.Project. 1375 | # This tag requires that the tag GENERATE_QHP is set to YES. 1376 | 1377 | QHP_NAMESPACE = org.doxygen.Project 1378 | 1379 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1380 | # Help Project output. For more information please see Qt Help Project / Virtual 1381 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1382 | # folders). 1383 | # The default value is: doc. 1384 | # This tag requires that the tag GENERATE_QHP is set to YES. 1385 | 1386 | QHP_VIRTUAL_FOLDER = doc 1387 | 1388 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1389 | # filter to add. For more information please see Qt Help Project / Custom 1390 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1391 | # filters). 1392 | # This tag requires that the tag GENERATE_QHP is set to YES. 1393 | 1394 | QHP_CUST_FILTER_NAME = 1395 | 1396 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1397 | # custom filter to add. For more information please see Qt Help Project / Custom 1398 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1399 | # filters). 1400 | # This tag requires that the tag GENERATE_QHP is set to YES. 1401 | 1402 | QHP_CUST_FILTER_ATTRS = 1403 | 1404 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1405 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1406 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1407 | # This tag requires that the tag GENERATE_QHP is set to YES. 1408 | 1409 | QHP_SECT_FILTER_ATTRS = 1410 | 1411 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1412 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1413 | # generated .qhp file. 1414 | # This tag requires that the tag GENERATE_QHP is set to YES. 1415 | 1416 | QHG_LOCATION = 1417 | 1418 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1419 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1420 | # install this plugin and make it available under the help contents menu in 1421 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1422 | # to be copied into the plugins directory of eclipse. The name of the directory 1423 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1424 | # After copying Eclipse needs to be restarted before the help appears. 1425 | # The default value is: NO. 1426 | # This tag requires that the tag GENERATE_HTML is set to YES. 1427 | 1428 | GENERATE_ECLIPSEHELP = NO 1429 | 1430 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1431 | # the directory name containing the HTML and XML files should also have this 1432 | # name. Each documentation set should have its own identifier. 1433 | # The default value is: org.doxygen.Project. 1434 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1435 | 1436 | ECLIPSE_DOC_ID = org.doxygen.Project 1437 | 1438 | # If you want full control over the layout of the generated HTML pages it might 1439 | # be necessary to disable the index and replace it with your own. The 1440 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1441 | # of each HTML page. A value of NO enables the index and the value YES disables 1442 | # it. Since the tabs in the index contain the same information as the navigation 1443 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1444 | # The default value is: NO. 1445 | # This tag requires that the tag GENERATE_HTML is set to YES. 1446 | 1447 | DISABLE_INDEX = NO 1448 | 1449 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1450 | # structure should be generated to display hierarchical information. If the tag 1451 | # value is set to YES, a side panel will be generated containing a tree-like 1452 | # index structure (just like the one that is generated for HTML Help). For this 1453 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1454 | # (i.e. any modern browser). Windows users are probably better off using the 1455 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1456 | # further fine-tune the look of the index. As an example, the default style 1457 | # sheet generated by doxygen has an example that shows how to put an image at 1458 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1459 | # the same information as the tab index, you could consider setting 1460 | # DISABLE_INDEX to YES when enabling this option. 1461 | # The default value is: NO. 1462 | # This tag requires that the tag GENERATE_HTML is set to YES. 1463 | 1464 | GENERATE_TREEVIEW = NO 1465 | 1466 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1467 | # doxygen will group on one line in the generated HTML documentation. 1468 | # 1469 | # Note that a value of 0 will completely suppress the enum values from appearing 1470 | # in the overview section. 1471 | # Minimum value: 0, maximum value: 20, default value: 4. 1472 | # This tag requires that the tag GENERATE_HTML is set to YES. 1473 | 1474 | ENUM_VALUES_PER_LINE = 4 1475 | 1476 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1477 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1478 | # Minimum value: 0, maximum value: 1500, default value: 250. 1479 | # This tag requires that the tag GENERATE_HTML is set to YES. 1480 | 1481 | TREEVIEW_WIDTH = 250 1482 | 1483 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1484 | # external symbols imported via tag files in a separate window. 1485 | # The default value is: NO. 1486 | # This tag requires that the tag GENERATE_HTML is set to YES. 1487 | 1488 | EXT_LINKS_IN_WINDOW = NO 1489 | 1490 | # Use this tag to change the font size of LaTeX formulas included as images in 1491 | # the HTML documentation. When you change the font size after a successful 1492 | # doxygen run you need to manually remove any form_*.png images from the HTML 1493 | # output directory to force them to be regenerated. 1494 | # Minimum value: 8, maximum value: 50, default value: 10. 1495 | # This tag requires that the tag GENERATE_HTML is set to YES. 1496 | 1497 | FORMULA_FONTSIZE = 10 1498 | 1499 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1500 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1501 | # supported properly for IE 6.0, but are supported on all modern browsers. 1502 | # 1503 | # Note that when changing this option you need to delete any form_*.png files in 1504 | # the HTML output directory before the changes have effect. 1505 | # The default value is: YES. 1506 | # This tag requires that the tag GENERATE_HTML is set to YES. 1507 | 1508 | FORMULA_TRANSPARENT = YES 1509 | 1510 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1511 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1512 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1513 | # installed or if you want to formulas look prettier in the HTML output. When 1514 | # enabled you may also need to install MathJax separately and configure the path 1515 | # to it using the MATHJAX_RELPATH option. 1516 | # The default value is: NO. 1517 | # This tag requires that the tag GENERATE_HTML is set to YES. 1518 | 1519 | USE_MATHJAX = NO 1520 | 1521 | # When MathJax is enabled you can set the default output format to be used for 1522 | # the MathJax output. See the MathJax site (see: 1523 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1524 | # Possible values are: HTML-CSS (which is slower, but has the best 1525 | # compatibility), NativeMML (i.e. MathML) and SVG. 1526 | # The default value is: HTML-CSS. 1527 | # This tag requires that the tag USE_MATHJAX is set to YES. 1528 | 1529 | MATHJAX_FORMAT = HTML-CSS 1530 | 1531 | # When MathJax is enabled you need to specify the location relative to the HTML 1532 | # output directory using the MATHJAX_RELPATH option. The destination directory 1533 | # should contain the MathJax.js script. For instance, if the mathjax directory 1534 | # is located at the same level as the HTML output directory, then 1535 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1536 | # Content Delivery Network so you can quickly see the result without installing 1537 | # MathJax. However, it is strongly recommended to install a local copy of 1538 | # MathJax from http://www.mathjax.org before deployment. 1539 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1540 | # This tag requires that the tag USE_MATHJAX is set to YES. 1541 | 1542 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1543 | 1544 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1545 | # extension names that should be enabled during MathJax rendering. For example 1546 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1547 | # This tag requires that the tag USE_MATHJAX is set to YES. 1548 | 1549 | MATHJAX_EXTENSIONS = 1550 | 1551 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1552 | # of code that will be used on startup of the MathJax code. See the MathJax site 1553 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1554 | # example see the documentation. 1555 | # This tag requires that the tag USE_MATHJAX is set to YES. 1556 | 1557 | MATHJAX_CODEFILE = 1558 | 1559 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1560 | # the HTML output. The underlying search engine uses javascript and DHTML and 1561 | # should work on any modern browser. Note that when using HTML help 1562 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1563 | # there is already a search function so this one should typically be disabled. 1564 | # For large projects the javascript based search engine can be slow, then 1565 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1566 | # search using the keyboard; to jump to the search box use + S 1567 | # (what the is depends on the OS and browser, but it is typically 1568 | # , /