├── .gitignore ├── .travis.yml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── config.doxyfile ├── examples ├── basic │ ├── basic.ino │ ├── partition-table.csv │ └── platformio.ini ├── dump │ ├── dump.ino │ ├── partition-table.csv │ └── platformio.ini └── info │ ├── info.ino │ ├── partition-table.csv │ └── platformio.ini ├── keywords.txt ├── library.json ├── library.properties ├── pre-commit └── src ├── EEPROM32_Rotate.cpp └── EEPROM32_Rotate.h /.gitignore: -------------------------------------------------------------------------------- 1 | # Precompiled Headers 2 | *.gch 3 | *.pch 4 | 5 | # PlatformIO folders 6 | .pio* 7 | 8 | # Documentation 9 | docs/* 10 | 11 | # Credentials 12 | credentials.h 13 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - '2.7' 4 | sudo: false 5 | cache: 6 | directories: 7 | - "~/.platformio" 8 | install: 9 | - pip install -U platformio 10 | before_script: 11 | - cd examples/basic 12 | script: 13 | - pio run 14 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # EEPROM32_Rotate change log 2 | 3 | The format is based on [Keep a Changelog](http://keepachangelog.com/) 4 | and this project adheres to [Semantic Versioning](http://semver.org/). 5 | 6 | ## [0.9.5] 2023-11-18 7 | ### Fix 8 | - Fix missing definition of _user_defined_size 9 | 10 | ## [0.9.4] 2019-09-23 11 | ### Fix 12 | - Added required header 13 | - Removed unused variable 14 | - Force SDK 1.0.2 in examples 15 | 16 | ## [0.9.3] 2019-02-12 17 | ### Fix 18 | - Fix missing parens to support ESP-IDF under gcc 5.2.0 19 | 20 | ## [0.9.2] 2018-12-09 21 | ### Fix 22 | - Fix magic number check around split (thanks to @arihantdaga and @mcspr) 23 | 24 | ## [0.9.0] 2018-06-03 25 | - Initial working version 26 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER 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 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # EEPROM32 Rotate 2 | 3 | This is a wrapper around the Arduino Core for ESP32 EEPROM library that handles partition rotating while keeping (almost) full compatibility with the original API. 4 | 5 | If you are using the ESP8266, visit the repository for the ESP8266 version of this library here: https://github.com/xoseperez/eeprom_rotate 6 | 7 | [![version](https://img.shields.io/badge/version-0.9.5-brightgreen.svg)](CHANGELOG.md) 8 | [![travis](https://travis-ci.org/xoseperez/eeprom32_rotate.svg?branch=master)](https://travis-ci.org/xoseperez/eeprom32_rotate) 9 | [![codacy](https://img.shields.io/codacy/grade/73a1774d4563493dbad4ebfaa55e0568/master.svg)](https://www.codacy.com/app/xoseperez/eeprom32_rotate/dashboard) 10 | [![license](https://img.shields.io/github/license/xoseperez/EEPROM32_Rotate.svg)](LICENSE) 11 |
12 | [![donate](https://img.shields.io/badge/donate-PayPal-blue.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=xose%2eperez%40gmail%2ecom&lc=US&no_note=0¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHostedGuest) 13 | [![twitter](https://img.shields.io/twitter/follow/xoseperez.svg?style=social)](https://twitter.com/intent/follow?screen_name=xoseperez) 14 | 15 | The emulated EEPROM in the ESP32 uses one SPI flash memory partition to store the data. Due to the nature of this flash memory (NOR) a full partition erase must be done prior to write any new data. If a power failure (intended or not) happens during this process the partition data is lost. 16 | 17 | Also, writing data to a NOR memory can be done byte by byte but only to change a 1 to a 0. The only way to turn 0s to 1s is to perform a sector erase which turns all memory positions in that sector to 1. But sector erasing must be done in full sectors, thus wearing out the flash memory faster. 18 | 19 | A way to overcome this is to use more than one partition to store data and check on boot which one has the latest valid data. 20 | 21 | This is what this library does. 22 | 23 | **NOTICE**: Please note EEPROM emulation in the ESP32 is no longer maintained and only supported for backwards compatibility. Moreover, the latest 1.0.3 SDK version breaks this library. Therefore, this library will no longer be maintained either. 24 | 25 | ## How does it work? 26 | 27 | Instead of using a single partition to persist the data from the emulated EEPROM, this library uses a number of partitions to do so: a partition pool. 28 | 29 | The library overwrites two methods of the original one: `begin` and `commit`. 30 | 31 | The `begin` method will load the data from all the partitions in the partition pool one after the other trying to figure out which one has the **latest valid information**. To do 32 | this it checks two values: 33 | 34 | * A 2-bytes CRC 35 | * A 1-byte auto-increment number 36 | 37 | These values are stored in a certain position in the partition (at the very beginning by default but the user can choose another position with the `offset` method). 38 | 39 | The CRC is calculated based on the contents of the partition (except for those special 3 bytes). If the calculated CRC matches that stored in the partition then the library checks the auto-increment and selects the partition with the most recent number (taking overflows into account, of course). 40 | 41 | Those special values are stored by the overwritten `commit` method prior to the actual commit. 42 | 43 | With every commit, the library will hop to the next partition. This way, in case of a power failure in the middle of a commit, the CRC for that partition will fail and the library will use the data in the latest known-good partition. 44 | 45 | Notice this is not the same as using different EEPROM objects. Because they are isolated instances with different data and each one of them uses memory to store the contents of SPIFFS, thus eating a lot of RAM. This library creates one single object and one single memory buffer instead, but rotates the backend partition used to persist the data. 46 | 47 | ## Partition table 48 | 49 | This library (in practice) requires a custom partition table to work. You could use any partition in the default partition scheme but you will want to create a custom one defining as many partitions for EEPROM as you'd like to. 50 | 51 | This is not difficult at all, using PlatformIO. If anyone knows how to do it with the Arduino IDE (not touching the core files) then, please, let me know. 52 | 53 | ### PlatformIO 54 | 55 | PlatformIO lets you define a CSV file for each environment in your platformio.ini file. Like this: 56 | 57 | ``` 58 | [env:nano32] 59 | platform = espressif32 60 | board = nano32 61 | framework = arduino 62 | board_build.partitions = partition-table.csv 63 | build_flags = -DNO_GLOBAL_EEPROM 64 | ``` 65 | 66 | This CSV file defines the different partitions in the SPI flash memory: 67 | 68 | ``` 69 | # Name, Type, SubType, Offset, Size, Flags 70 | nvs, data, nvs, 0x9000, 0x5000, 71 | otadata, data, ota, 0xe000, 0x2000, 72 | app0, app, ota_0, 0x10000, 0x140000, 73 | app1, app, ota_1, 0x150000,0x140000, 74 | eeprom0, data, 0x99, 0x290000,0x1000, 75 | eeprom1, data, 0x99, 0x291000,0x1000, 76 | spiffs, data, spiffs, 0x292000,0x16E000, 77 | ``` 78 | 79 | Here you can see that we have added two partitions for EEPROM (eeprom0 and eeprom1). You will be adding later these partitions to the EEPROM_Rotate partition pool like this: 80 | 81 | ``` 82 | EEPROM32_Rotate EEPROM; 83 | EEPROM.add_by_name("eeprom0"); 84 | EEPROM.add_by_name("eeprom1"); 85 | ``` 86 | 87 | Now your emulated EEPROM will be rotating between those two partitions, reducing the wearing out of the flash memory and preventing failure. 88 | 89 | ## API 90 | 91 | The library inherits form the Arduino Core for ESP32 EEPROM library, but it uses a slightly different API. Differences are in the constructor. The original EEPROM library for ESP32 has different constructor signatures but only valid at the moment is: 92 | 93 | ``` 94 | EEPROMClass EEPROM("eeprom0"); 95 | ``` 96 | 97 | To make this library API more consistent, I have decided to change the way you create and 'populate' an object: 98 | 99 | ``` 100 | EEPROM32_Rotate EEPROM; 101 | EEPROM.add_by_name("eeprom0"); 102 | ``` 103 | 104 | Now you may find obvious how to add more partitions to the pool. 105 | 106 | ``` 107 | EEPROM32_Rotate EEPROM; 108 | EEPROM.add_by_name("eeprom0"); 109 | EEPROM.add_by_name("eeprom1"); 110 | EEPROM.add_by_name("eeprom2"); 111 | EEPROM.add_by_name("eeprom3"); 112 | ``` 113 | 114 | Actually, if all partitions have the same data subtype (usually 0x99, thou this is only a convention) then it's a lot easier to add them all: 115 | 116 | ``` 117 | EEPROM32_Rotate EEPROM; 118 | EEPROM.add_by_subtype(0x99); 119 | ``` 120 | 121 | Now you can use it like a regular EEPROM object: 122 | 123 | ``` 124 | EEPROM32_Rotate EEPROM; 125 | EEPROM.add_by_subtype(0x99); 126 | uint8_t b = EEPROM.read(0); 127 | EEPROM.write(0, b+1); 128 | EEPROM.commit(); 129 | ``` 130 | 131 | Remember than the stock EEPROM library for ESP32 has a bunch of convenient methods like `readLong`, `readBytes`, `writeString`,... you can also use those! 132 | 133 | In addition, the EEPROM32_Rotate library exposes a set of new methods to configure the partition rotating and performing other special actions: 134 | 135 | #### uint8_t add_by_name(const char* name) 136 | 137 | Adds a new partition to the partition pool using its name. Returns 1 if successfully added, 0 otherwise. If a partition is already in the pool it's not added again. 138 | 139 | Please notice that the 'length()' method of the class will return the size of the smallest partition. Also, notice that the size of the memory buffer must not be bigger than the smallest partition. There is no check for this. 140 | 141 | #### bool add_by_subtype(uint8_t subtype) 142 | 143 | Adds all partitions with the given subtype to the pool. Returns the number of partitions added. If a partition is already in the pool it's not added again. 144 | 145 | Please notice that the 'length()' method of the class will return the size of the smallest partition. Also, notice that the size of the memory buffer must not be bigger than the smallest partition. There is no check for this. 146 | 147 | #### void offset(uint8_t offset) 148 | 149 | Define the offset in the memory buffer where the special auto-increment and CRC values will be stored. The default value is 0. This special data uses 3 bytes of space in the emulated EEPROM memory buffer. This value must not be bigger than the size of the memory buffer minus 3 bytes. 150 | 151 | #### uint8_t size() 152 | 153 | Returns the number of partitions used for rotating EEPROM. 154 | 155 | #### char * name(uint8_t index) 156 | 157 | Returns the name of the n-th partition in the pool. 158 | 159 | #### char * current() 160 | 161 | Returns the name of the current partition, that whose contents match those of the EEPROM memory buffer. 162 | 163 | #### void dump(Stream & debug, uint8_t index) | void dump(Stream & debug) 164 | 165 | Dumps the EEPROM data to the given stream in a human-friendly way. You can specify the index for the partition to dump the data, otherwise it will use the current partition. It will only dump the size of the memory buffer. 166 | 167 | ## Notes 168 | 169 | ### Disabling the original global EEPROM object 170 | 171 | The original EEPROM library automatically instantiates an EEPROM object that's 172 | already available to use. This consumes little memory (since the data buffer is 173 | only created and populated when calling `begin`). But anyway if you don't want to 174 | have a unused object around you can disable the object instantiation by using 175 | the `NO_GLOBAL_EEPROM` build flag. 176 | 177 | ## License 178 | 179 | Copyright (C) 2018 by Xose Pérez 180 | 181 | The EEPROM32_Rotate library is free software: you can redistribute it and/or modify 182 | it under the terms of the GNU Lesser General Public License as published by 183 | the Free Software Foundation, either version 3 of the License, or 184 | (at your option) any later version. 185 | 186 | The EEPROM32_Rotate library is distributed in the hope that it will be useful, 187 | but WITHOUT ANY WARRANTY; without even the implied warranty of 188 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 189 | GNU Lesser General Public License for more details. 190 | 191 | You should have received a copy of the GNU Lesser General Public License 192 | along with the EEPROM32_Rotate library. If not, see . 193 | -------------------------------------------------------------------------------- /config.doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.15 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the configuration 21 | # file that follow. The default is UTF-8 which is also the encoding used for all 22 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 23 | # iconv built into libc) for the transcoding. See 24 | # https://www.gnu.org/software/libiconv/ for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "EEPROM32_Rotate Library" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all 97 | # documentation generated by doxygen is written. Doxygen will use this 98 | # information to generate all generated output in the proper direction. 99 | # Possible values are: None, LTR, RTL and Context. 100 | # The default value is: None. 101 | 102 | OUTPUT_TEXT_DIRECTION = None 103 | 104 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 105 | # descriptions after the members that are listed in the file and class 106 | # documentation (similar to Javadoc). Set to NO to disable this. 107 | # The default value is: YES. 108 | 109 | BRIEF_MEMBER_DESC = YES 110 | 111 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 112 | # description of a member or function before the detailed description 113 | # 114 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 115 | # brief descriptions will be completely suppressed. 116 | # The default value is: YES. 117 | 118 | REPEAT_BRIEF = YES 119 | 120 | # This tag implements a quasi-intelligent brief description abbreviator that is 121 | # used to form the text in various listings. Each string in this list, if found 122 | # as the leading text of the brief description, will be stripped from the text 123 | # and the result, after processing the whole list, is used as the annotated 124 | # text. Otherwise, the brief description is used as-is. If left blank, the 125 | # following values are used ($name is automatically replaced with the name of 126 | # the entity):The $name class, The $name widget, The $name file, is, provides, 127 | # specifies, contains, represents, a, an and the. 128 | 129 | ABBREVIATE_BRIEF = "The $name class" \ 130 | "The $name widget" \ 131 | "The $name file" \ 132 | is \ 133 | provides \ 134 | specifies \ 135 | contains \ 136 | represents \ 137 | a \ 138 | an \ 139 | the 140 | 141 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 142 | # doxygen will generate a detailed section even if there is only a brief 143 | # description. 144 | # The default value is: NO. 145 | 146 | ALWAYS_DETAILED_SEC = NO 147 | 148 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 149 | # inherited members of a class in the documentation of that class as if those 150 | # members were ordinary class members. Constructors, destructors and assignment 151 | # operators of the base classes will not be shown. 152 | # The default value is: NO. 153 | 154 | INLINE_INHERITED_MEMB = NO 155 | 156 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 157 | # before files name in the file list and in the header files. If set to NO the 158 | # shortest path that makes the file name unique will be used 159 | # The default value is: YES. 160 | 161 | FULL_PATH_NAMES = YES 162 | 163 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 164 | # Stripping is only done if one of the specified strings matches the left-hand 165 | # part of the path. The tag can be used to show relative paths in the file list. 166 | # If left blank the directory from which doxygen is run is used as the path to 167 | # strip. 168 | # 169 | # Note that you can specify absolute paths here, but also relative paths, which 170 | # will be relative from the directory where doxygen is started. 171 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 172 | 173 | STRIP_FROM_PATH = 174 | 175 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 176 | # path mentioned in the documentation of a class, which tells the reader which 177 | # header file to include in order to use a class. If left blank only the name of 178 | # the header file containing the class definition is used. Otherwise one should 179 | # specify the list of include paths that are normally passed to the compiler 180 | # using the -I flag. 181 | 182 | STRIP_FROM_INC_PATH = 183 | 184 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 185 | # less readable) file names. This can be useful is your file systems doesn't 186 | # support long names like on DOS, Mac, or CD-ROM. 187 | # The default value is: NO. 188 | 189 | SHORT_NAMES = NO 190 | 191 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 192 | # first line (until the first dot) of a Javadoc-style comment as the brief 193 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 194 | # style comments (thus requiring an explicit @brief command for a brief 195 | # description.) 196 | # The default value is: NO. 197 | 198 | JAVADOC_AUTOBRIEF = NO 199 | 200 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 201 | # line (until the first dot) of a Qt-style comment as the brief description. If 202 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 203 | # requiring an explicit \brief command for a brief description.) 204 | # The default value is: NO. 205 | 206 | QT_AUTOBRIEF = NO 207 | 208 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 209 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 210 | # a brief description. This used to be the default behavior. The new default is 211 | # to treat a multi-line C++ comment block as a detailed description. Set this 212 | # tag to YES if you prefer the old behavior instead. 213 | # 214 | # Note that setting this tag to YES also means that rational rose comments are 215 | # not recognized any more. 216 | # The default value is: NO. 217 | 218 | MULTILINE_CPP_IS_BRIEF = NO 219 | 220 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 221 | # documentation from any documented member that it re-implements. 222 | # The default value is: YES. 223 | 224 | INHERIT_DOCS = YES 225 | 226 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 227 | # page for each member. If set to NO, the documentation of a member will be part 228 | # of the file/class/namespace that contains it. 229 | # The default value is: NO. 230 | 231 | SEPARATE_MEMBER_PAGES = NO 232 | 233 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 234 | # uses this value to replace tabs by spaces in code fragments. 235 | # Minimum value: 1, maximum value: 16, default value: 4. 236 | 237 | TAB_SIZE = 4 238 | 239 | # This tag can be used to specify a number of aliases that act as commands in 240 | # the documentation. An alias has the form: 241 | # name=value 242 | # For example adding 243 | # "sideeffect=@par Side Effects:\n" 244 | # will allow you to put the command \sideeffect (or @sideeffect) in the 245 | # documentation, which will result in a user-defined paragraph with heading 246 | # "Side Effects:". You can put \n's in the value part of an alias to insert 247 | # newlines (in the resulting output). You can put ^^ in the value part of an 248 | # alias to insert a newline as if a physical newline was in the original file. 249 | 250 | ALIASES = 251 | 252 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 253 | # A mapping has the form "name=value". For example adding "class=itcl::class" 254 | # will allow you to use the command class in the itcl::class meaning. 255 | 256 | TCL_SUBST = 257 | 258 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 259 | # only. Doxygen will then generate output that is more tailored for C. For 260 | # instance, some of the names that are used will be different. The list of all 261 | # members will be omitted, etc. 262 | # The default value is: NO. 263 | 264 | OPTIMIZE_OUTPUT_FOR_C = YES 265 | 266 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 267 | # Python sources only. Doxygen will then generate output that is more tailored 268 | # for that language. For instance, namespaces will be presented as packages, 269 | # qualified scopes will look different, etc. 270 | # The default value is: NO. 271 | 272 | OPTIMIZE_OUTPUT_JAVA = NO 273 | 274 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 275 | # sources. Doxygen will then generate output that is tailored for Fortran. 276 | # The default value is: NO. 277 | 278 | OPTIMIZE_FOR_FORTRAN = NO 279 | 280 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 281 | # sources. Doxygen will then generate output that is tailored for VHDL. 282 | # The default value is: NO. 283 | 284 | OPTIMIZE_OUTPUT_VHDL = NO 285 | 286 | # Doxygen selects the parser to use depending on the extension of the files it 287 | # parses. With this tag you can assign which parser to use for a given 288 | # extension. Doxygen has a built-in mapping, but you can override or extend it 289 | # using this tag. The format is ext=language, where ext is a file extension, and 290 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 291 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 292 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 293 | # Fortran. In the later case the parser tries to guess whether the code is fixed 294 | # or free formatted code, this is the default for Fortran type files), VHDL. For 295 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 296 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 297 | # 298 | # Note: For files without extension you can use no_extension as a placeholder. 299 | # 300 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 301 | # the files are not read by doxygen. 302 | 303 | EXTENSION_MAPPING = 304 | 305 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 306 | # according to the Markdown format, which allows for more readable 307 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 308 | # The output of markdown processing is further processed by doxygen, so you can 309 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 310 | # case of backward compatibilities issues. 311 | # The default value is: YES. 312 | 313 | MARKDOWN_SUPPORT = YES 314 | 315 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 316 | # to that level are automatically included in the table of contents, even if 317 | # they do not have an id attribute. 318 | # Note: This feature currently applies only to Markdown headings. 319 | # Minimum value: 0, maximum value: 99, default value: 0. 320 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 321 | 322 | TOC_INCLUDE_HEADINGS = 0 323 | 324 | # When enabled doxygen tries to link words that correspond to documented 325 | # classes, or namespaces to their corresponding documentation. Such a link can 326 | # be prevented in individual cases by putting a % sign in front of the word or 327 | # globally by setting AUTOLINK_SUPPORT to NO. 328 | # The default value is: YES. 329 | 330 | AUTOLINK_SUPPORT = YES 331 | 332 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 333 | # to include (a tag file for) the STL sources as input, then you should set this 334 | # tag to YES in order to let doxygen match functions declarations and 335 | # definitions whose arguments contain STL classes (e.g. func(std::string); 336 | # versus func(std::string) {}). This also make the inheritance and collaboration 337 | # diagrams that involve STL classes more complete and accurate. 338 | # The default value is: NO. 339 | 340 | BUILTIN_STL_SUPPORT = NO 341 | 342 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 343 | # enable parsing support. 344 | # The default value is: NO. 345 | 346 | CPP_CLI_SUPPORT = NO 347 | 348 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 349 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 350 | # will parse them like normal C++ but will assume all classes use public instead 351 | # of private inheritance when no explicit protection keyword is present. 352 | # The default value is: NO. 353 | 354 | SIP_SUPPORT = NO 355 | 356 | # For Microsoft's IDL there are propget and propput attributes to indicate 357 | # getter and setter methods for a property. Setting this option to YES will make 358 | # doxygen to replace the get and set methods by a property in the documentation. 359 | # This will only work if the methods are indeed getting or setting a simple 360 | # type. If this is not the case, or you want to show the methods anyway, you 361 | # should set this option to NO. 362 | # The default value is: YES. 363 | 364 | IDL_PROPERTY_SUPPORT = YES 365 | 366 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 367 | # tag is set to YES then doxygen will reuse the documentation of the first 368 | # member in the group (if any) for the other members of the group. By default 369 | # all members of a group must be documented explicitly. 370 | # The default value is: NO. 371 | 372 | DISTRIBUTE_GROUP_DOC = NO 373 | 374 | # If one adds a struct or class to a group and this option is enabled, then also 375 | # any nested class or struct is added to the same group. By default this option 376 | # is disabled and one has to add nested compounds explicitly via \ingroup. 377 | # The default value is: NO. 378 | 379 | GROUP_NESTED_COMPOUNDS = NO 380 | 381 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 382 | # (for instance a group of public functions) to be put as a subgroup of that 383 | # type (e.g. under the Public Functions section). Set it to NO to prevent 384 | # subgrouping. Alternatively, this can be done per class using the 385 | # \nosubgrouping command. 386 | # The default value is: YES. 387 | 388 | SUBGROUPING = YES 389 | 390 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 391 | # are shown inside the group in which they are included (e.g. using \ingroup) 392 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 393 | # and RTF). 394 | # 395 | # Note that this feature does not work in combination with 396 | # SEPARATE_MEMBER_PAGES. 397 | # The default value is: NO. 398 | 399 | INLINE_GROUPED_CLASSES = NO 400 | 401 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 402 | # with only public data fields or simple typedef fields will be shown inline in 403 | # the documentation of the scope in which they are defined (i.e. file, 404 | # namespace, or group documentation), provided this scope is documented. If set 405 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 406 | # Man pages) or section (for LaTeX and RTF). 407 | # The default value is: NO. 408 | 409 | INLINE_SIMPLE_STRUCTS = NO 410 | 411 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 412 | # enum is documented as struct, union, or enum with the name of the typedef. So 413 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 414 | # with name TypeT. When disabled the typedef will appear as a member of a file, 415 | # namespace, or class. And the struct will be named TypeS. This can typically be 416 | # useful for C code in case the coding convention dictates that all compound 417 | # types are typedef'ed and only the typedef is referenced, never the tag name. 418 | # The default value is: NO. 419 | 420 | TYPEDEF_HIDES_STRUCT = NO 421 | 422 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 423 | # cache is used to resolve symbols given their name and scope. Since this can be 424 | # an expensive process and often the same symbol appears multiple times in the 425 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 426 | # doxygen will become slower. If the cache is too large, memory is wasted. The 427 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 428 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 429 | # symbols. At the end of a run doxygen will report the cache usage and suggest 430 | # the optimal cache size from a speed point of view. 431 | # Minimum value: 0, maximum value: 9, default value: 0. 432 | 433 | LOOKUP_CACHE_SIZE = 0 434 | 435 | #--------------------------------------------------------------------------- 436 | # Build related configuration options 437 | #--------------------------------------------------------------------------- 438 | 439 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 440 | # documentation are documented, even if no documentation was available. Private 441 | # class members and static file members will be hidden unless the 442 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 443 | # Note: This will also disable the warnings about undocumented members that are 444 | # normally produced when WARNINGS is set to YES. 445 | # The default value is: NO. 446 | 447 | EXTRACT_ALL = NO 448 | 449 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 450 | # be included in the documentation. 451 | # The default value is: NO. 452 | 453 | EXTRACT_PRIVATE = NO 454 | 455 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 456 | # scope will be included in the documentation. 457 | # The default value is: NO. 458 | 459 | EXTRACT_PACKAGE = NO 460 | 461 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 462 | # included in the documentation. 463 | # The default value is: NO. 464 | 465 | EXTRACT_STATIC = NO 466 | 467 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 468 | # locally in source files will be included in the documentation. If set to NO, 469 | # only classes defined in header files are included. Does not have any effect 470 | # for Java sources. 471 | # The default value is: YES. 472 | 473 | EXTRACT_LOCAL_CLASSES = YES 474 | 475 | # This flag is only useful for Objective-C code. If set to YES, local methods, 476 | # which are defined in the implementation section but not in the interface are 477 | # included in the documentation. If set to NO, only methods in the interface are 478 | # included. 479 | # The default value is: NO. 480 | 481 | EXTRACT_LOCAL_METHODS = NO 482 | 483 | # If this flag is set to YES, the members of anonymous namespaces will be 484 | # extracted and appear in the documentation as a namespace called 485 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 486 | # the file that contains the anonymous namespace. By default anonymous namespace 487 | # are hidden. 488 | # The default value is: NO. 489 | 490 | EXTRACT_ANON_NSPACES = NO 491 | 492 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 493 | # undocumented members inside documented classes or files. If set to NO these 494 | # members will be included in the various overviews, but no documentation 495 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 496 | # The default value is: NO. 497 | 498 | HIDE_UNDOC_MEMBERS = NO 499 | 500 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 501 | # undocumented classes that are normally visible in the class hierarchy. If set 502 | # to NO, these classes will be included in the various overviews. This option 503 | # has no effect if EXTRACT_ALL is enabled. 504 | # The default value is: NO. 505 | 506 | HIDE_UNDOC_CLASSES = NO 507 | 508 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 509 | # (class|struct|union) declarations. If set to NO, these declarations will be 510 | # included in the documentation. 511 | # The default value is: NO. 512 | 513 | HIDE_FRIEND_COMPOUNDS = NO 514 | 515 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 516 | # documentation blocks found inside the body of a function. If set to NO, these 517 | # blocks will be appended to the function's detailed documentation block. 518 | # The default value is: NO. 519 | 520 | HIDE_IN_BODY_DOCS = NO 521 | 522 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 523 | # \internal command is included. If the tag is set to NO then the documentation 524 | # will be excluded. Set it to YES to include the internal documentation. 525 | # The default value is: NO. 526 | 527 | INTERNAL_DOCS = NO 528 | 529 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 530 | # names in lower-case letters. If set to YES, upper-case letters are also 531 | # allowed. This is useful if you have classes or files whose names only differ 532 | # in case and if your file system supports case sensitive file names. Windows 533 | # and Mac users are advised to set this option to NO. 534 | # The default value is: system dependent. 535 | 536 | CASE_SENSE_NAMES = YES 537 | 538 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 539 | # their full class and namespace scopes in the documentation. If set to YES, the 540 | # scope will be hidden. 541 | # The default value is: NO. 542 | 543 | HIDE_SCOPE_NAMES = NO 544 | 545 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 546 | # append additional text to a page's title, such as Class Reference. If set to 547 | # YES the compound reference will be hidden. 548 | # The default value is: NO. 549 | 550 | HIDE_COMPOUND_REFERENCE= NO 551 | 552 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 553 | # the files that are included by a file in the documentation of that file. 554 | # The default value is: YES. 555 | 556 | SHOW_INCLUDE_FILES = YES 557 | 558 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 559 | # grouped member an include statement to the documentation, telling the reader 560 | # which file to include in order to use the member. 561 | # The default value is: NO. 562 | 563 | SHOW_GROUPED_MEMB_INC = NO 564 | 565 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 566 | # files with double quotes in the documentation rather than with sharp brackets. 567 | # The default value is: NO. 568 | 569 | FORCE_LOCAL_INCLUDES = NO 570 | 571 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 572 | # documentation for inline members. 573 | # The default value is: YES. 574 | 575 | INLINE_INFO = YES 576 | 577 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 578 | # (detailed) documentation of file and class members alphabetically by member 579 | # name. If set to NO, the members will appear in declaration order. 580 | # The default value is: YES. 581 | 582 | SORT_MEMBER_DOCS = YES 583 | 584 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 585 | # descriptions of file, namespace and class members alphabetically by member 586 | # name. If set to NO, the members will appear in declaration order. Note that 587 | # this will also influence the order of the classes in the class list. 588 | # The default value is: NO. 589 | 590 | SORT_BRIEF_DOCS = NO 591 | 592 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 593 | # (brief and detailed) documentation of class members so that constructors and 594 | # destructors are listed first. If set to NO the constructors will appear in the 595 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 596 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 597 | # member documentation. 598 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 599 | # detailed member documentation. 600 | # The default value is: NO. 601 | 602 | SORT_MEMBERS_CTORS_1ST = NO 603 | 604 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 605 | # of group names into alphabetical order. If set to NO the group names will 606 | # appear in their defined order. 607 | # The default value is: NO. 608 | 609 | SORT_GROUP_NAMES = NO 610 | 611 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 612 | # fully-qualified names, including namespaces. If set to NO, the class list will 613 | # be sorted only by class name, not including the namespace part. 614 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 615 | # Note: This option applies only to the class list, not to the alphabetical 616 | # list. 617 | # The default value is: NO. 618 | 619 | SORT_BY_SCOPE_NAME = NO 620 | 621 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 622 | # type resolution of all parameters of a function it will reject a match between 623 | # the prototype and the implementation of a member function even if there is 624 | # only one candidate or it is obvious which candidate to choose by doing a 625 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 626 | # accept a match between prototype and implementation in such cases. 627 | # The default value is: NO. 628 | 629 | STRICT_PROTO_MATCHING = NO 630 | 631 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 632 | # list. This list is created by putting \todo commands in the documentation. 633 | # The default value is: YES. 634 | 635 | GENERATE_TODOLIST = YES 636 | 637 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 638 | # list. This list is created by putting \test commands in the documentation. 639 | # The default value is: YES. 640 | 641 | GENERATE_TESTLIST = YES 642 | 643 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 644 | # list. This list is created by putting \bug commands in the documentation. 645 | # The default value is: YES. 646 | 647 | GENERATE_BUGLIST = YES 648 | 649 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 650 | # the deprecated list. This list is created by putting \deprecated commands in 651 | # the documentation. 652 | # The default value is: YES. 653 | 654 | GENERATE_DEPRECATEDLIST= YES 655 | 656 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 657 | # sections, marked by \if ... \endif and \cond 658 | # ... \endcond blocks. 659 | 660 | ENABLED_SECTIONS = 661 | 662 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 663 | # initial value of a variable or macro / define can have for it to appear in the 664 | # documentation. If the initializer consists of more lines than specified here 665 | # it will be hidden. Use a value of 0 to hide initializers completely. The 666 | # appearance of the value of individual variables and macros / defines can be 667 | # controlled using \showinitializer or \hideinitializer command in the 668 | # documentation regardless of this setting. 669 | # Minimum value: 0, maximum value: 10000, default value: 30. 670 | 671 | MAX_INITIALIZER_LINES = 30 672 | 673 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 674 | # the bottom of the documentation of classes and structs. If set to YES, the 675 | # list will mention the files that were used to generate the documentation. 676 | # The default value is: YES. 677 | 678 | SHOW_USED_FILES = YES 679 | 680 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 681 | # will remove the Files entry from the Quick Index and from the Folder Tree View 682 | # (if specified). 683 | # The default value is: YES. 684 | 685 | SHOW_FILES = YES 686 | 687 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 688 | # page. This will remove the Namespaces entry from the Quick Index and from the 689 | # Folder Tree View (if specified). 690 | # The default value is: YES. 691 | 692 | SHOW_NAMESPACES = YES 693 | 694 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 695 | # doxygen should invoke to get the current version for each file (typically from 696 | # the version control system). Doxygen will invoke the program by executing (via 697 | # popen()) the command command input-file, where command is the value of the 698 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 699 | # by doxygen. Whatever the program writes to standard output is used as the file 700 | # version. For an example see the documentation. 701 | 702 | FILE_VERSION_FILTER = 703 | 704 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 705 | # by doxygen. The layout file controls the global structure of the generated 706 | # output files in an output format independent way. To create the layout file 707 | # that represents doxygen's defaults, run doxygen with the -l option. You can 708 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 709 | # will be used as the name of the layout file. 710 | # 711 | # Note that if you run doxygen from a directory containing a file called 712 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 713 | # tag is left empty. 714 | 715 | LAYOUT_FILE = 716 | 717 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 718 | # the reference definitions. This must be a list of .bib files. The .bib 719 | # extension is automatically appended if omitted. This requires the bibtex tool 720 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 721 | # For LaTeX the style of the bibliography can be controlled using 722 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 723 | # search path. See also \cite for info how to create references. 724 | 725 | CITE_BIB_FILES = 726 | 727 | #--------------------------------------------------------------------------- 728 | # Configuration options related to warning and progress messages 729 | #--------------------------------------------------------------------------- 730 | 731 | # The QUIET tag can be used to turn on/off the messages that are generated to 732 | # standard output by doxygen. If QUIET is set to YES this implies that the 733 | # messages are off. 734 | # The default value is: NO. 735 | 736 | QUIET = NO 737 | 738 | # The WARNINGS tag can be used to turn on/off the warning messages that are 739 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 740 | # this implies that the warnings are on. 741 | # 742 | # Tip: Turn warnings on while writing the documentation. 743 | # The default value is: YES. 744 | 745 | WARNINGS = YES 746 | 747 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 748 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 749 | # will automatically be disabled. 750 | # The default value is: YES. 751 | 752 | WARN_IF_UNDOCUMENTED = YES 753 | 754 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 755 | # potential errors in the documentation, such as not documenting some parameters 756 | # in a documented function, or documenting parameters that don't exist or using 757 | # markup commands wrongly. 758 | # The default value is: YES. 759 | 760 | WARN_IF_DOC_ERROR = YES 761 | 762 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 763 | # are documented, but have no documentation for their parameters or return 764 | # value. If set to NO, doxygen will only warn about wrong or incomplete 765 | # parameter documentation, but not about the absence of documentation. 766 | # The default value is: NO. 767 | 768 | WARN_NO_PARAMDOC = NO 769 | 770 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 771 | # a warning is encountered. 772 | # The default value is: NO. 773 | 774 | WARN_AS_ERROR = NO 775 | 776 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 777 | # can produce. The string should contain the $file, $line, and $text tags, which 778 | # will be replaced by the file and line number from which the warning originated 779 | # and the warning text. Optionally the format may contain $version, which will 780 | # be replaced by the version of the file (if it could be obtained via 781 | # FILE_VERSION_FILTER) 782 | # The default value is: $file:$line: $text. 783 | 784 | WARN_FORMAT = "$file:$line: $text" 785 | 786 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 787 | # messages should be written. If left blank the output is written to standard 788 | # error (stderr). 789 | 790 | WARN_LOGFILE = 791 | 792 | #--------------------------------------------------------------------------- 793 | # Configuration options related to the input files 794 | #--------------------------------------------------------------------------- 795 | 796 | # The INPUT tag is used to specify the files and/or directories that contain 797 | # documented source files. You may enter file names like myfile.cpp or 798 | # directories like /usr/src/myproject. Separate the files or directories with 799 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 800 | # Note: If this tag is empty the current directory is searched. 801 | 802 | INPUT = 803 | 804 | # This tag can be used to specify the character encoding of the source files 805 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 806 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 807 | # documentation (see: https://www.gnu.org/software/libiconv/) for the list of 808 | # possible encodings. 809 | # The default value is: UTF-8. 810 | 811 | INPUT_ENCODING = UTF-8 812 | 813 | # If the value of the INPUT tag contains directories, you can use the 814 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 815 | # *.h) to filter out the source-files in the directories. 816 | # 817 | # Note that for custom extensions or not directly supported extensions you also 818 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 819 | # read by doxygen. 820 | # 821 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 822 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 823 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 824 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 825 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 826 | 827 | FILE_PATTERNS = *.c \ 828 | *.cc \ 829 | *.cxx \ 830 | *.cpp \ 831 | *.c++ \ 832 | *.java \ 833 | *.ii \ 834 | *.ixx \ 835 | *.ipp \ 836 | *.i++ \ 837 | *.inl \ 838 | *.idl \ 839 | *.ddl \ 840 | *.odl \ 841 | *.h \ 842 | *.hh \ 843 | *.hxx \ 844 | *.hpp \ 845 | *.h++ \ 846 | *.cs \ 847 | *.d \ 848 | *.php \ 849 | *.php4 \ 850 | *.php5 \ 851 | *.phtml \ 852 | *.inc \ 853 | *.m \ 854 | *.markdown \ 855 | *.md \ 856 | *.mm \ 857 | *.dox \ 858 | *.py \ 859 | *.pyw \ 860 | *.f90 \ 861 | *.f95 \ 862 | *.f03 \ 863 | *.f08 \ 864 | *.f \ 865 | *.for \ 866 | *.tcl \ 867 | *.vhd \ 868 | *.vhdl \ 869 | *.ucf \ 870 | *.qsf 871 | 872 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 873 | # be searched for input files as well. 874 | # The default value is: NO. 875 | 876 | RECURSIVE = YES 877 | 878 | # The EXCLUDE tag can be used to specify files and/or directories that should be 879 | # excluded from the INPUT source files. This way you can easily exclude a 880 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 881 | # 882 | # Note that relative paths are relative to the directory from which doxygen is 883 | # run. 884 | 885 | EXCLUDE = test 886 | 887 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 888 | # directories that are symbolic links (a Unix file system feature) are excluded 889 | # from the input. 890 | # The default value is: NO. 891 | 892 | EXCLUDE_SYMLINKS = NO 893 | 894 | # If the value of the INPUT tag contains directories, you can use the 895 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 896 | # certain files from those directories. 897 | # 898 | # Note that the wildcards are matched against the file with absolute path, so to 899 | # exclude all test directories for example use the pattern */test/* 900 | 901 | EXCLUDE_PATTERNS = 902 | 903 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 904 | # (namespaces, classes, functions, etc.) that should be excluded from the 905 | # output. The symbol name can be a fully qualified name, a word, or if the 906 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 907 | # AClass::ANamespace, ANamespace::*Test 908 | # 909 | # Note that the wildcards are matched against the file with absolute path, so to 910 | # exclude all test directories use the pattern */test/* 911 | 912 | EXCLUDE_SYMBOLS = 913 | 914 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 915 | # that contain example code fragments that are included (see the \include 916 | # command). 917 | 918 | EXAMPLE_PATH = examples 919 | 920 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 921 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 922 | # *.h) to filter out the source-files in the directories. If left blank all 923 | # files are included. 924 | 925 | EXAMPLE_PATTERNS = * 926 | 927 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 928 | # searched for input files to be used with the \include or \dontinclude commands 929 | # irrespective of the value of the RECURSIVE tag. 930 | # The default value is: NO. 931 | 932 | EXAMPLE_RECURSIVE = YES 933 | 934 | # The IMAGE_PATH tag can be used to specify one or more files or directories 935 | # that contain images that are to be included in the documentation (see the 936 | # \image command). 937 | 938 | IMAGE_PATH = 939 | 940 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 941 | # invoke to filter for each input file. Doxygen will invoke the filter program 942 | # by executing (via popen()) the command: 943 | # 944 | # 945 | # 946 | # where is the value of the INPUT_FILTER tag, and is the 947 | # name of an input file. Doxygen will then use the output that the filter 948 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 949 | # will be ignored. 950 | # 951 | # Note that the filter must not add or remove lines; it is applied before the 952 | # code is scanned, but not when the output code is generated. If lines are added 953 | # or removed, the anchors will not be placed correctly. 954 | # 955 | # Note that for custom extensions or not directly supported extensions you also 956 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 957 | # properly processed by doxygen. 958 | 959 | INPUT_FILTER = 960 | 961 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 962 | # basis. Doxygen will compare the file name with each pattern and apply the 963 | # filter if there is a match. The filters are a list of the form: pattern=filter 964 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 965 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 966 | # patterns match the file name, INPUT_FILTER is applied. 967 | # 968 | # Note that for custom extensions or not directly supported extensions you also 969 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 970 | # properly processed by doxygen. 971 | 972 | FILTER_PATTERNS = 973 | 974 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 975 | # INPUT_FILTER) will also be used to filter the input files that are used for 976 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 977 | # The default value is: NO. 978 | 979 | FILTER_SOURCE_FILES = NO 980 | 981 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 982 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 983 | # it is also possible to disable source filtering for a specific pattern using 984 | # *.ext= (so without naming a filter). 985 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 986 | 987 | FILTER_SOURCE_PATTERNS = 988 | 989 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 990 | # is part of the input, its contents will be placed on the main page 991 | # (index.html). This can be useful if you have a project on for instance GitHub 992 | # and want to reuse the introduction page also for the doxygen output. 993 | 994 | USE_MDFILE_AS_MAINPAGE = README.md 995 | 996 | #--------------------------------------------------------------------------- 997 | # Configuration options related to source browsing 998 | #--------------------------------------------------------------------------- 999 | 1000 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1001 | # generated. Documented entities will be cross-referenced with these sources. 1002 | # 1003 | # Note: To get rid of all source code in the generated output, make sure that 1004 | # also VERBATIM_HEADERS is set to NO. 1005 | # The default value is: NO. 1006 | 1007 | SOURCE_BROWSER = YES 1008 | 1009 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1010 | # classes and enums directly into the documentation. 1011 | # The default value is: NO. 1012 | 1013 | INLINE_SOURCES = NO 1014 | 1015 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1016 | # special comment blocks from generated source code fragments. Normal C, C++ and 1017 | # Fortran comments will always remain visible. 1018 | # The default value is: YES. 1019 | 1020 | STRIP_CODE_COMMENTS = YES 1021 | 1022 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1023 | # entity all documented functions referencing it will be listed. 1024 | # The default value is: NO. 1025 | 1026 | REFERENCED_BY_RELATION = NO 1027 | 1028 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1029 | # all documented entities called/used by that function will be listed. 1030 | # The default value is: NO. 1031 | 1032 | REFERENCES_RELATION = NO 1033 | 1034 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1035 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1036 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1037 | # link to the documentation. 1038 | # The default value is: YES. 1039 | 1040 | REFERENCES_LINK_SOURCE = YES 1041 | 1042 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1043 | # source code will show a tooltip with additional information such as prototype, 1044 | # brief description and links to the definition and documentation. Since this 1045 | # will make the HTML file larger and loading of large files a bit slower, you 1046 | # can opt to disable this feature. 1047 | # The default value is: YES. 1048 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1049 | 1050 | SOURCE_TOOLTIPS = YES 1051 | 1052 | # If the USE_HTAGS tag is set to YES then the references to source code will 1053 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1054 | # source browser. The htags tool is part of GNU's global source tagging system 1055 | # (see https://www.gnu.org/software/global/global.html). You will need version 1056 | # 4.8.6 or higher. 1057 | # 1058 | # To use it do the following: 1059 | # - Install the latest version of global 1060 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1061 | # - Make sure the INPUT points to the root of the source tree 1062 | # - Run doxygen as normal 1063 | # 1064 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1065 | # tools must be available from the command line (i.e. in the search path). 1066 | # 1067 | # The result: instead of the source browser generated by doxygen, the links to 1068 | # source code will now point to the output of htags. 1069 | # The default value is: NO. 1070 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1071 | 1072 | USE_HTAGS = NO 1073 | 1074 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1075 | # verbatim copy of the header file for each class for which an include is 1076 | # specified. Set to NO to disable this. 1077 | # See also: Section \class. 1078 | # The default value is: YES. 1079 | 1080 | VERBATIM_HEADERS = YES 1081 | 1082 | #--------------------------------------------------------------------------- 1083 | # Configuration options related to the alphabetical class index 1084 | #--------------------------------------------------------------------------- 1085 | 1086 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1087 | # compounds will be generated. Enable this if the project contains a lot of 1088 | # classes, structs, unions or interfaces. 1089 | # The default value is: YES. 1090 | 1091 | ALPHABETICAL_INDEX = YES 1092 | 1093 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1094 | # which the alphabetical index list will be split. 1095 | # Minimum value: 1, maximum value: 20, default value: 5. 1096 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1097 | 1098 | COLS_IN_ALPHA_INDEX = 5 1099 | 1100 | # In case all classes in a project start with a common prefix, all classes will 1101 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1102 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1103 | # while generating the index headers. 1104 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1105 | 1106 | IGNORE_PREFIX = 1107 | 1108 | #--------------------------------------------------------------------------- 1109 | # Configuration options related to the HTML output 1110 | #--------------------------------------------------------------------------- 1111 | 1112 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1113 | # The default value is: YES. 1114 | 1115 | GENERATE_HTML = YES 1116 | 1117 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1118 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1119 | # it. 1120 | # The default directory is: html. 1121 | # This tag requires that the tag GENERATE_HTML is set to YES. 1122 | 1123 | HTML_OUTPUT = docs 1124 | 1125 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1126 | # generated HTML page (for example: .htm, .php, .asp). 1127 | # The default value is: .html. 1128 | # This tag requires that the tag GENERATE_HTML is set to YES. 1129 | 1130 | HTML_FILE_EXTENSION = .html 1131 | 1132 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1133 | # each generated HTML page. If the tag is left blank doxygen will generate a 1134 | # standard header. 1135 | # 1136 | # To get valid HTML the header file that includes any scripts and style sheets 1137 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1138 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1139 | # default header using 1140 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1141 | # YourConfigFile 1142 | # and then modify the file new_header.html. See also section "Doxygen usage" 1143 | # for information on how to generate the default header that doxygen normally 1144 | # uses. 1145 | # Note: The header is subject to change so you typically have to regenerate the 1146 | # default header when upgrading to a newer version of doxygen. For a description 1147 | # of the possible markers and block names see the documentation. 1148 | # This tag requires that the tag GENERATE_HTML is set to YES. 1149 | 1150 | HTML_HEADER = 1151 | 1152 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1153 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1154 | # footer. See HTML_HEADER for more information on how to generate a default 1155 | # footer and what special commands can be used inside the footer. See also 1156 | # section "Doxygen usage" for information on how to generate the default footer 1157 | # that doxygen normally uses. 1158 | # This tag requires that the tag GENERATE_HTML is set to YES. 1159 | 1160 | HTML_FOOTER = 1161 | 1162 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1163 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1164 | # the HTML output. If left blank doxygen will generate a default style sheet. 1165 | # See also section "Doxygen usage" for information on how to generate the style 1166 | # sheet that doxygen normally uses. 1167 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1168 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1169 | # obsolete. 1170 | # This tag requires that the tag GENERATE_HTML is set to YES. 1171 | 1172 | HTML_STYLESHEET = 1173 | 1174 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1175 | # cascading style sheets that are included after the standard style sheets 1176 | # created by doxygen. Using this option one can overrule certain style aspects. 1177 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1178 | # standard style sheet and is therefore more robust against future updates. 1179 | # Doxygen will copy the style sheet files to the output directory. 1180 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1181 | # style sheet in the list overrules the setting of the previous ones in the 1182 | # list). For an example see the documentation. 1183 | # This tag requires that the tag GENERATE_HTML is set to YES. 1184 | 1185 | HTML_EXTRA_STYLESHEET = 1186 | 1187 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1188 | # other source files which should be copied to the HTML output directory. Note 1189 | # that these files will be copied to the base HTML output directory. Use the 1190 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1191 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1192 | # files will be copied as-is; there are no commands or markers available. 1193 | # This tag requires that the tag GENERATE_HTML is set to YES. 1194 | 1195 | HTML_EXTRA_FILES = 1196 | 1197 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1198 | # will adjust the colors in the style sheet and background images according to 1199 | # this color. Hue is specified as an angle on a colorwheel, see 1200 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1201 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1202 | # purple, and 360 is red again. 1203 | # Minimum value: 0, maximum value: 359, default value: 220. 1204 | # This tag requires that the tag GENERATE_HTML is set to YES. 1205 | 1206 | HTML_COLORSTYLE_HUE = 220 1207 | 1208 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1209 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1210 | # value of 255 will produce the most vivid colors. 1211 | # Minimum value: 0, maximum value: 255, default value: 100. 1212 | # This tag requires that the tag GENERATE_HTML is set to YES. 1213 | 1214 | HTML_COLORSTYLE_SAT = 100 1215 | 1216 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1217 | # luminance component of the colors in the HTML output. Values below 100 1218 | # gradually make the output lighter, whereas values above 100 make the output 1219 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1220 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1221 | # change the gamma. 1222 | # Minimum value: 40, maximum value: 240, default value: 80. 1223 | # This tag requires that the tag GENERATE_HTML is set to YES. 1224 | 1225 | HTML_COLORSTYLE_GAMMA = 80 1226 | 1227 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1228 | # page will contain the date and time when the page was generated. Setting this 1229 | # to YES can help to show when doxygen was last run and thus if the 1230 | # documentation is up to date. 1231 | # The default value is: NO. 1232 | # This tag requires that the tag GENERATE_HTML is set to YES. 1233 | 1234 | HTML_TIMESTAMP = NO 1235 | 1236 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1237 | # documentation will contain a main index with vertical navigation menus that 1238 | # are dynamically created via Javascript. If disabled, the navigation index will 1239 | # consists of multiple levels of tabs that are statically embedded in every HTML 1240 | # page. Disable this option to support browsers that do not have Javascript, 1241 | # like the Qt help browser. 1242 | # The default value is: YES. 1243 | # This tag requires that the tag GENERATE_HTML is set to YES. 1244 | 1245 | HTML_DYNAMIC_MENUS = YES 1246 | 1247 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1248 | # documentation will contain sections that can be hidden and shown after the 1249 | # page has loaded. 1250 | # The default value is: NO. 1251 | # This tag requires that the tag GENERATE_HTML is set to YES. 1252 | 1253 | HTML_DYNAMIC_SECTIONS = NO 1254 | 1255 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1256 | # shown in the various tree structured indices initially; the user can expand 1257 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1258 | # such a level that at most the specified number of entries are visible (unless 1259 | # a fully collapsed tree already exceeds this amount). So setting the number of 1260 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1261 | # representing an infinite number of entries and will result in a full expanded 1262 | # tree by default. 1263 | # Minimum value: 0, maximum value: 9999, default value: 100. 1264 | # This tag requires that the tag GENERATE_HTML is set to YES. 1265 | 1266 | HTML_INDEX_NUM_ENTRIES = 100 1267 | 1268 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1269 | # generated that can be used as input for Apple's Xcode 3 integrated development 1270 | # environment (see: https://developer.apple.com/tools/xcode/), introduced with 1271 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1272 | # Makefile in the HTML output directory. Running make will produce the docset in 1273 | # that directory and running make install will install the docset in 1274 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1275 | # startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1276 | # for more information. 1277 | # The default value is: NO. 1278 | # This tag requires that the tag GENERATE_HTML is set to YES. 1279 | 1280 | GENERATE_DOCSET = NO 1281 | 1282 | # This tag determines the name of the docset feed. A documentation feed provides 1283 | # an umbrella under which multiple documentation sets from a single provider 1284 | # (such as a company or product suite) can be grouped. 1285 | # The default value is: Doxygen generated docs. 1286 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1287 | 1288 | DOCSET_FEEDNAME = "Doxygen generated docs" 1289 | 1290 | # This tag specifies a string that should uniquely identify the documentation 1291 | # set bundle. This should be a reverse domain-name style string, e.g. 1292 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1293 | # The default value is: org.doxygen.Project. 1294 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1295 | 1296 | DOCSET_BUNDLE_ID = org.doxygen.Project 1297 | 1298 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1299 | # the documentation publisher. This should be a reverse domain-name style 1300 | # string, e.g. com.mycompany.MyDocSet.documentation. 1301 | # The default value is: org.doxygen.Publisher. 1302 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1303 | 1304 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1305 | 1306 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1307 | # The default value is: Publisher. 1308 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1309 | 1310 | DOCSET_PUBLISHER_NAME = Publisher 1311 | 1312 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1313 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1314 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1315 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1316 | # Windows. 1317 | # 1318 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1319 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1320 | # files are now used as the Windows 98 help format, and will replace the old 1321 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1322 | # HTML files also contain an index, a table of contents, and you can search for 1323 | # words in the documentation. The HTML workshop also contains a viewer for 1324 | # compressed HTML files. 1325 | # The default value is: NO. 1326 | # This tag requires that the tag GENERATE_HTML is set to YES. 1327 | 1328 | GENERATE_HTMLHELP = NO 1329 | 1330 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1331 | # file. You can add a path in front of the file if the result should not be 1332 | # written to the html output directory. 1333 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1334 | 1335 | CHM_FILE = 1336 | 1337 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1338 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1339 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1340 | # The file has to be specified with full path. 1341 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1342 | 1343 | HHC_LOCATION = 1344 | 1345 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1346 | # (YES) or that it should be included in the master .chm file (NO). 1347 | # The default value is: NO. 1348 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1349 | 1350 | GENERATE_CHI = NO 1351 | 1352 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1353 | # and project file content. 1354 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1355 | 1356 | CHM_INDEX_ENCODING = 1357 | 1358 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1359 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1360 | # enables the Previous and Next buttons. 1361 | # The default value is: NO. 1362 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1363 | 1364 | BINARY_TOC = NO 1365 | 1366 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1367 | # the table of contents of the HTML help documentation and to the tree view. 1368 | # The default value is: NO. 1369 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1370 | 1371 | TOC_EXPAND = NO 1372 | 1373 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1374 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1375 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1376 | # (.qch) of the generated HTML documentation. 1377 | # The default value is: NO. 1378 | # This tag requires that the tag GENERATE_HTML is set to YES. 1379 | 1380 | GENERATE_QHP = NO 1381 | 1382 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1383 | # the file name of the resulting .qch file. The path specified is relative to 1384 | # the HTML output folder. 1385 | # This tag requires that the tag GENERATE_QHP is set to YES. 1386 | 1387 | QCH_FILE = 1388 | 1389 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1390 | # Project output. For more information please see Qt Help Project / Namespace 1391 | # (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace). 1392 | # The default value is: org.doxygen.Project. 1393 | # This tag requires that the tag GENERATE_QHP is set to YES. 1394 | 1395 | QHP_NAMESPACE = org.doxygen.Project 1396 | 1397 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1398 | # Help Project output. For more information please see Qt Help Project / Virtual 1399 | # Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders). 1400 | # The default value is: doc. 1401 | # This tag requires that the tag GENERATE_QHP is set to YES. 1402 | 1403 | QHP_VIRTUAL_FOLDER = doc 1404 | 1405 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1406 | # filter to add. For more information please see Qt Help Project / Custom 1407 | # Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). 1408 | # This tag requires that the tag GENERATE_QHP is set to YES. 1409 | 1410 | QHP_CUST_FILTER_NAME = 1411 | 1412 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1413 | # custom filter to add. For more information please see Qt Help Project / Custom 1414 | # Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). 1415 | # This tag requires that the tag GENERATE_QHP is set to YES. 1416 | 1417 | QHP_CUST_FILTER_ATTRS = 1418 | 1419 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1420 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1421 | # http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes). 1422 | # This tag requires that the tag GENERATE_QHP is set to YES. 1423 | 1424 | QHP_SECT_FILTER_ATTRS = 1425 | 1426 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1427 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1428 | # generated .qhp file. 1429 | # This tag requires that the tag GENERATE_QHP is set to YES. 1430 | 1431 | QHG_LOCATION = 1432 | 1433 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1434 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1435 | # install this plugin and make it available under the help contents menu in 1436 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1437 | # to be copied into the plugins directory of eclipse. The name of the directory 1438 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1439 | # After copying Eclipse needs to be restarted before the help appears. 1440 | # The default value is: NO. 1441 | # This tag requires that the tag GENERATE_HTML is set to YES. 1442 | 1443 | GENERATE_ECLIPSEHELP = NO 1444 | 1445 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1446 | # the directory name containing the HTML and XML files should also have this 1447 | # name. Each documentation set should have its own identifier. 1448 | # The default value is: org.doxygen.Project. 1449 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1450 | 1451 | ECLIPSE_DOC_ID = org.doxygen.Project 1452 | 1453 | # If you want full control over the layout of the generated HTML pages it might 1454 | # be necessary to disable the index and replace it with your own. The 1455 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1456 | # of each HTML page. A value of NO enables the index and the value YES disables 1457 | # it. Since the tabs in the index contain the same information as the navigation 1458 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1459 | # The default value is: NO. 1460 | # This tag requires that the tag GENERATE_HTML is set to YES. 1461 | 1462 | DISABLE_INDEX = NO 1463 | 1464 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1465 | # structure should be generated to display hierarchical information. If the tag 1466 | # value is set to YES, a side panel will be generated containing a tree-like 1467 | # index structure (just like the one that is generated for HTML Help). For this 1468 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1469 | # (i.e. any modern browser). Windows users are probably better off using the 1470 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1471 | # further fine-tune the look of the index. As an example, the default style 1472 | # sheet generated by doxygen has an example that shows how to put an image at 1473 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1474 | # the same information as the tab index, you could consider setting 1475 | # DISABLE_INDEX to YES when enabling this option. 1476 | # The default value is: NO. 1477 | # This tag requires that the tag GENERATE_HTML is set to YES. 1478 | 1479 | GENERATE_TREEVIEW = NO 1480 | 1481 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1482 | # doxygen will group on one line in the generated HTML documentation. 1483 | # 1484 | # Note that a value of 0 will completely suppress the enum values from appearing 1485 | # in the overview section. 1486 | # Minimum value: 0, maximum value: 20, default value: 4. 1487 | # This tag requires that the tag GENERATE_HTML is set to YES. 1488 | 1489 | ENUM_VALUES_PER_LINE = 4 1490 | 1491 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1492 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1493 | # Minimum value: 0, maximum value: 1500, default value: 250. 1494 | # This tag requires that the tag GENERATE_HTML is set to YES. 1495 | 1496 | TREEVIEW_WIDTH = 250 1497 | 1498 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1499 | # external symbols imported via tag files in a separate window. 1500 | # The default value is: NO. 1501 | # This tag requires that the tag GENERATE_HTML is set to YES. 1502 | 1503 | EXT_LINKS_IN_WINDOW = NO 1504 | 1505 | # Use this tag to change the font size of LaTeX formulas included as images in 1506 | # the HTML documentation. When you change the font size after a successful 1507 | # doxygen run you need to manually remove any form_*.png images from the HTML 1508 | # output directory to force them to be regenerated. 1509 | # Minimum value: 8, maximum value: 50, default value: 10. 1510 | # This tag requires that the tag GENERATE_HTML is set to YES. 1511 | 1512 | FORMULA_FONTSIZE = 10 1513 | 1514 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1515 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1516 | # supported properly for IE 6.0, but are supported on all modern browsers. 1517 | # 1518 | # Note that when changing this option you need to delete any form_*.png files in 1519 | # the HTML output directory before the changes have effect. 1520 | # The default value is: YES. 1521 | # This tag requires that the tag GENERATE_HTML is set to YES. 1522 | 1523 | FORMULA_TRANSPARENT = YES 1524 | 1525 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1526 | # https://www.mathjax.org) which uses client side Javascript for the rendering 1527 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1528 | # installed or if you want to formulas look prettier in the HTML output. When 1529 | # enabled you may also need to install MathJax separately and configure the path 1530 | # to it using the MATHJAX_RELPATH option. 1531 | # The default value is: NO. 1532 | # This tag requires that the tag GENERATE_HTML is set to YES. 1533 | 1534 | USE_MATHJAX = NO 1535 | 1536 | # When MathJax is enabled you can set the default output format to be used for 1537 | # the MathJax output. See the MathJax site (see: 1538 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1539 | # Possible values are: HTML-CSS (which is slower, but has the best 1540 | # compatibility), NativeMML (i.e. MathML) and SVG. 1541 | # The default value is: HTML-CSS. 1542 | # This tag requires that the tag USE_MATHJAX is set to YES. 1543 | 1544 | MATHJAX_FORMAT = HTML-CSS 1545 | 1546 | # When MathJax is enabled you need to specify the location relative to the HTML 1547 | # output directory using the MATHJAX_RELPATH option. The destination directory 1548 | # should contain the MathJax.js script. For instance, if the mathjax directory 1549 | # is located at the same level as the HTML output directory, then 1550 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1551 | # Content Delivery Network so you can quickly see the result without installing 1552 | # MathJax. However, it is strongly recommended to install a local copy of 1553 | # MathJax from https://www.mathjax.org before deployment. 1554 | # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/. 1555 | # This tag requires that the tag USE_MATHJAX is set to YES. 1556 | 1557 | MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/ 1558 | 1559 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1560 | # extension names that should be enabled during MathJax rendering. For example 1561 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1562 | # This tag requires that the tag USE_MATHJAX is set to YES. 1563 | 1564 | MATHJAX_EXTENSIONS = 1565 | 1566 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1567 | # of code that will be used on startup of the MathJax code. See the MathJax site 1568 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1569 | # example see the documentation. 1570 | # This tag requires that the tag USE_MATHJAX is set to YES. 1571 | 1572 | MATHJAX_CODEFILE = 1573 | 1574 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1575 | # the HTML output. The underlying search engine uses javascript and DHTML and 1576 | # should work on any modern browser. Note that when using HTML help 1577 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1578 | # there is already a search function so this one should typically be disabled. 1579 | # For large projects the javascript based search engine can be slow, then 1580 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1581 | # search using the keyboard; to jump to the search box use + S 1582 | # (what the is depends on the OS and browser, but it is typically 1583 | # , /