├── .gitignore ├── library.properties ├── examples ├── SimpleEncoderDemo │ └── SimpleEncoderDemo.ino ├── Encoder │ └── Encoder.ino └── Encoder_interrupt_display │ └── Encoder_interrupt_display.ino ├── CMakeLists.txt ├── AddDoxygenToGHPages.sh ├── src ├── InterruptEncoder.h ├── ESP32Encoder.h ├── InterruptEncoder.cpp └── ESP32Encoder.cpp ├── library.json ├── .travis.yml ├── licence.txt ├── README.md └── doxy.doxyfile /.gitignore: -------------------------------------------------------------------------------- 1 | .pio 2 | .vscode/ 3 | /platformio.ini 4 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=ESP32Encoder 2 | version=0.12.0 3 | author=Kevin Harrington 4 | maintainer=Kevin Harrington 5 | sentence=Encoder library for the ESP32 using interrupts. 6 | paragraph=Encoder library for the ESP32 using interrupts. This library supports quadrature and half quadrature. 7 | category=Device Control 8 | url=https://github.com/madhephaestus/ESP32Encoder/ 9 | architectures=esp32 10 | includes=ESP32Encoder.h 11 | 12 | -------------------------------------------------------------------------------- /examples/SimpleEncoderDemo/SimpleEncoderDemo.ino: -------------------------------------------------------------------------------- 1 | #include // https://github.com/madhephaestus/ESP32Encoder.git 2 | 3 | #define CLK 13 // CLK ENCODER 4 | #define DT 15 // DT ENCODER 5 | 6 | ESP32Encoder encoder; 7 | 8 | void setup () { 9 | encoder.attachHalfQuad ( DT, CLK ); 10 | encoder.setCount ( 0 ); 11 | Serial.begin ( 115200 ); 12 | } 13 | 14 | void loop () { 15 | long newPosition = encoder.getCount() / 2; 16 | Serial.println(newPosition); 17 | } 18 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # CMakeLists.txt of ESP32ENCODER component 2 | 3 | # Src files 4 | file(GLOB_RECURSE ESP32ENCODER_SRCS 5 | src/*.c 6 | src/*.cpp 7 | ) 8 | # Include 9 | set(ESP32ENCODER_INCS 10 | src/ 11 | ) 12 | 13 | # Public component requirement 14 | set(ESP32ENCODER_REQUIRES 15 | driver 16 | esp_timer 17 | ) 18 | 19 | # Private component requirement 20 | set(ESP32ENCODER_PRIV_REQUIRES 21 | ) 22 | 23 | # Register component 24 | idf_component_register( 25 | SRCS ${ESP32ENCODER_SRCS} 26 | INCLUDE_DIRS ${ESP32ENCODER_INCS} 27 | REQUIRES ${ESP32ENCODER_REQUIRES} 28 | PRIV_REQUIRES ${ESP32ENCODER_PRIV_REQUIRES} 29 | ) 30 | -------------------------------------------------------------------------------- /AddDoxygenToGHPages.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | GITURL=$(git config --get remote.origin.url) 4 | 5 | echo $GITURL 6 | 7 | rm -rf html 8 | git clone $GITURL html 9 | cd html 10 | if ( git checkout origin/gh-pages -b gh-pages) then 11 | echo "Checked out $GITURL gh-pages" 12 | else 13 | echo "Creating out $GITURL gh-pages" 14 | git checkout origin/master -b gh-pages 15 | rm -r * 16 | echo "# A simple README file for the gh-pages branch" > README.md 17 | git add README.md 18 | git commit -m"Replaced gh-pages html with simple readme" 19 | git push -u origin gh-pages 20 | fi 21 | cd .. 22 | 23 | doxygen doxy.doxyfile 24 | 25 | cd html 26 | git add * 27 | git add search/* 28 | git commit -a -m"updating the doxygen" 29 | git push 30 | cd .. 31 | rm -rf html 32 | git checkout master -------------------------------------------------------------------------------- /src/InterruptEncoder.h: -------------------------------------------------------------------------------- 1 | /* 2 | * InterruptEncoder.h 3 | * 4 | * Created on: Oct 8, 2020 5 | * Author: hephaestus 6 | */ 7 | 8 | #ifndef INTERRUPTENCODER_H_ 9 | #define INTERRUPTENCODER_H_ 10 | 11 | #define MAX_ENCODERS 16 12 | #define US_DEBOUNCE 10 13 | #ifdef ARDUINO 14 | #include 15 | #else 16 | #include 17 | #endif 18 | 19 | class InterruptEncoder { 20 | private: 21 | bool attached=false; 22 | 23 | 24 | 25 | public: 26 | 27 | int apin=0; 28 | int bpin=0; 29 | InterruptEncoder(); 30 | virtual ~InterruptEncoder(); 31 | void attach(int aPinNum, int bPinNum); 32 | volatile bool aState=0; 33 | volatile bool bState=0; 34 | volatile int64_t count=0; 35 | volatile int64_t microsLastA=0; 36 | volatile int64_t microsTimeBetweenTicks=0; 37 | int64_t read(); 38 | }; 39 | 40 | #endif /* INTERRUPTENCODER_H_ */ 41 | -------------------------------------------------------------------------------- /library.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ESP32Encoder", 3 | "description": "Encoder library for the ESP32 using interrupts. This library supports quadrature and half quadrature.", 4 | "frameworks": ["arduino", "espidf"], 5 | "platforms": ["espressif32"], 6 | "url": "https://github.com/madhephaestus/ESP32Encoder", 7 | "version": "0.11.8", 8 | "keywords": "input, encoder", 9 | "authors": [ 10 | { 11 | "name": "Kevin Harrington", 12 | "url": "https://github.com/madhephaestus", 13 | "email": "mad.hephaestus@gmail.com", 14 | "maintainer": true 15 | } 16 | ], 17 | "repository": { 18 | "type": "git", 19 | "url": "https://github.com/madhephaestus/ESP32Encoder.git" 20 | }, 21 | "export": { 22 | "include": 23 | [ 24 | "examples/*", 25 | "src/*", 26 | "README.md", 27 | "library.*", 28 | "licence.txt" 29 | ] 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # Continuous Integration (CI) is the practice, in software 2 | # engineering, of merging all developer working copies with a shared mainline 3 | # several times a day < https://docs.platformio.org/page/ci/index.html > 4 | # 5 | # Documentation: 6 | # 7 | # * Travis CI Embedded Builds with PlatformIO 8 | # < https://docs.travis-ci.com/user/integration/platformio/ > 9 | # 10 | # * PlatformIO integration with Travis CI 11 | # < https://docs.platformio.org/page/ci/travis.html > 12 | # 13 | # * User Guide for `platformio ci` command 14 | # < https://docs.platformio.org/page/userguide/cmd_ci.html > 15 | # 16 | # 17 | # Please choose one of the following templates (proposed below) and uncomment 18 | # it (remove "# " before each line) or use own configuration according to the 19 | # Travis CI documentation (see above). 20 | # 21 | 22 | language: python 23 | python: 24 | - "3.6" 25 | 26 | # Cache PlatformIO packages using Travis CI container-based infrastructure 27 | sudo: false 28 | cache: 29 | directories: 30 | - "~/.platformio" 31 | - $HOME/.cache/pip 32 | 33 | env: 34 | - PLATFORMIO_CI_SRC=examples/Encoder/Encoder.ino 35 | 36 | install: 37 | - pip install -U platformio pip setuptools 38 | - platformio update 39 | 40 | script: 41 | - platformio ci --lib="." --board=lolin32 --board=esp-wrover-kit 42 | -------------------------------------------------------------------------------- /examples/Encoder/Encoder.ino: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | ESP32Encoder encoder; 4 | ESP32Encoder encoder2; 5 | 6 | // timer and flag for example, not needed for encoders 7 | unsigned long encoder2lastToggled; 8 | bool encoder2Paused = false; 9 | 10 | void setup(){ 11 | 12 | Serial.begin(115200); 13 | // Enable the weak pull down resistors 14 | 15 | //ESP32Encoder::useInternalWeakPullResistors = puType::down; 16 | // Enable the weak pull up resistors 17 | ESP32Encoder::useInternalWeakPullResistors = puType::up; 18 | 19 | // use pin 19 and 18 for the first encoder 20 | encoder.attachHalfQuad(19, 18); 21 | // use pin 17 and 16 for the second encoder 22 | encoder2.attachHalfQuad(17, 16); 23 | 24 | // set starting count value after attaching 25 | encoder.setCount(37); 26 | 27 | // clear the encoder's raw count and set the tracked count to zero 28 | encoder2.clearCount(); 29 | Serial.println("Encoder Start = " + String((int32_t)encoder.getCount())); 30 | // set the lastToggle 31 | encoder2lastToggled = millis(); 32 | } 33 | 34 | void loop(){ 35 | // Loop and read the count 36 | Serial.println("Encoder count = " + String((int32_t)encoder.getCount()) + " " + String((int32_t)encoder2.getCount())); 37 | delay(100); 38 | 39 | // every 5 seconds toggle encoder 2 40 | if (millis() - encoder2lastToggled >= 5000) { 41 | if(encoder2Paused) { 42 | Serial.println("Resuming Encoder 2"); 43 | encoder2.resumeCount(); 44 | } else { 45 | Serial.println("Paused Encoder 2"); 46 | encoder2.pauseCount(); 47 | } 48 | 49 | encoder2Paused = !encoder2Paused; 50 | encoder2lastToggled = millis(); 51 | } 52 | } 53 | 54 | -------------------------------------------------------------------------------- /licence.txt: -------------------------------------------------------------------------------- 1 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 2 | 3 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 4 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 5 | 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 6 | 4. Redistributions of any form whatsoever must retain the following acknowledgment: 'This product includes software developed by the "Universidad de Palermo, Argentina" (http://www.palermo.edu/).' 7 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 8 | 9 | Standard License Header 10 | There is no standard license header for the license 11 | -------------------------------------------------------------------------------- /examples/Encoder_interrupt_display/Encoder_interrupt_display.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include "esp_task_wdt.h" 6 | 7 | static IRAM_ATTR void enc_cb(void* arg) { 8 | ESP32Encoder* enc = (ESP32Encoder*) arg; 9 | //Serial.printf("enc cb: count: %d\n", enc->getCount()); 10 | static bool leds = false; 11 | digitalWrite(LED_BUILTIN, (int)leds); 12 | leds = !leds; 13 | } 14 | 15 | extern bool loopTaskWDTEnabled; 16 | extern TaskHandle_t loopTaskHandle; 17 | 18 | ESP32Encoder encoder(true, enc_cb); 19 | Adafruit_SSD1306 display(128, 32, &Wire); 20 | 21 | static const char* LOG_TAG = "main"; 22 | 23 | void setup(){ 24 | loopTaskWDTEnabled = true; 25 | pinMode(LED_BUILTIN, OUTPUT); 26 | Serial.begin(115200); 27 | // Encoder A and B pins connected with 1K series resistor to pins 4 and 5, common pin to ground. 28 | // |- A --- 1K --- pin 4 29 | // >=[enc]|- GND 30 | // |- B --- 1K --- pin 5 31 | 32 | ESP32Encoder::useInternalWeakPullResistors = puType::up; 33 | encoder.attachSingleEdge(4, 5); 34 | encoder.clearCount(); 35 | encoder.setFilter(1023); 36 | 37 | if (! display.begin(SSD1306_SWITCHCAPVCC, 0x3c)) 38 | { 39 | for (;;) { 40 | Serial.println("display init failed"); 41 | } 42 | } 43 | display.cp437(true); 44 | display.clearDisplay(); 45 | display.setTextSize(2); 46 | display.setTextColor(WHITE); 47 | display.setCursor(0,0); 48 | display.display(); 49 | esp_log_level_set("*", ESP_LOG_DEBUG); 50 | esp_log_level_set("main", ESP_LOG_DEBUG); 51 | esp_log_level_set("ESP32Encoder", ESP_LOG_DEBUG); 52 | esp_task_wdt_add(loopTaskHandle); 53 | } 54 | 55 | void loop(){ 56 | 57 | display.clearDisplay(); 58 | display.setCursor(0,0); 59 | display.printf("E: %lld\n", encoder.getCount()); 60 | display.display(); 61 | Serial.printf("Enc count: %d\n", encoder.getCount()); 62 | delay(500); 63 | 64 | } 65 | -------------------------------------------------------------------------------- /src/ESP32Encoder.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | #include 3 | #include 4 | #ifndef ARDUINO 5 | #include 6 | #include 7 | #include 8 | #include 9 | #endif 10 | 11 | #define MAX_ESP32_ENCODERS PCNT_UNIT_MAX 12 | #define _INT16_MAX 32766 13 | #define _INT16_MIN -32766 14 | #define ISR_CORE_USE_DEFAULT (0xffffffff) 15 | 16 | enum class encType { 17 | single, 18 | half, 19 | full 20 | }; 21 | 22 | enum class puType { 23 | up, 24 | down, 25 | none 26 | }; 27 | 28 | class ESP32Encoder; 29 | 30 | typedef void (*enc_isr_cb_t)(void*); 31 | 32 | class ESP32Encoder { 33 | public: 34 | /** 35 | * @brief Construct a new ESP32Encoder object 36 | * 37 | * @param always_interrupt set to true to enable interrupt on every encoder pulse, otherwise false 38 | * @param enc_isr_cb callback executed on every encoder ISR, gets a pointer to 39 | * the ESP32Encoder instance as an argument, no effect if always_interrupt is 40 | * false 41 | */ 42 | ESP32Encoder(bool always_interrupt=false, enc_isr_cb_t enc_isr_cb=nullptr, void* enc_isr_cb_data=nullptr); 43 | ~ESP32Encoder(); 44 | void attachHalfQuad(int aPintNumber, int bPinNumber); 45 | void attachFullQuad(int aPintNumber, int bPinNumber); 46 | void attachSingleEdge(int aPintNumber, int bPinNumber); 47 | int64_t getCount(); 48 | int64_t clearCount(); 49 | int64_t pauseCount(); 50 | int64_t resumeCount(); 51 | void detach(); 52 | [[deprecated("Replaced by detach")]] void detatch(); 53 | bool isAttached(){return attached;} 54 | void setCount(int64_t value); 55 | void setFilter(uint16_t value); 56 | static ESP32Encoder *encoders[MAX_ESP32_ENCODERS]; 57 | bool always_interrupt; 58 | gpio_num_t aPinNumber; 59 | gpio_num_t bPinNumber; 60 | pcnt_unit_t unit; 61 | int countsMode = 2; 62 | volatile int64_t count=0; 63 | pcnt_config_t r_enc_config; 64 | static puType useInternalWeakPullResistors; 65 | static uint32_t isrServiceCpuCore; 66 | enc_isr_cb_t _enc_isr_cb; 67 | void* _enc_isr_cb_data; 68 | 69 | private: 70 | static bool attachedInterrupt; 71 | void attach(int aPintNumber, int bPinNumber, encType et); 72 | int64_t getCountRaw(); 73 | bool attached; 74 | bool direction; 75 | bool working; 76 | }; 77 | 78 | //Added by Sloeber 79 | #pragma once 80 | -------------------------------------------------------------------------------- /src/InterruptEncoder.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * InterruptEncoder.cpp 3 | * 4 | * Created on: Oct 8, 2020 5 | * Author: hephaestus 6 | */ 7 | #include "InterruptEncoder.h" 8 | #ifdef ARDUINO 9 | void IRAM_ATTR encoderAISR(void * arg) { 10 | InterruptEncoder* object=(InterruptEncoder*)arg; 11 | long start = micros(); 12 | long duration=start - object->microsLastA; 13 | if (duration >= US_DEBOUNCE) { 14 | object->microsLastA = start; 15 | object->microsTimeBetweenTicks=duration; 16 | object->aState = digitalRead(object->apin); 17 | object->bState = digitalRead(object->bpin); 18 | if (object->aState == object->bState) 19 | object->count = object->count + 1; 20 | else 21 | object->count = object->count - 1; 22 | } 23 | } 24 | InterruptEncoder::InterruptEncoder() {} 25 | InterruptEncoder::~InterruptEncoder() { 26 | if(attached) 27 | detachInterrupt(digitalPinToInterrupt(apin)); 28 | } 29 | int64_t InterruptEncoder::read() { 30 | return count*2; 31 | } 32 | void InterruptEncoder::attach(int aPinNum, int bPinNum) { 33 | if(attached) 34 | return; 35 | apin = aPinNum; 36 | bpin = bPinNum; 37 | pinMode(apin, INPUT_PULLUP); 38 | pinMode(bpin, INPUT_PULLUP); 39 | attachInterruptArg(digitalPinToInterrupt(apin), encoderAISR,this, CHANGE); 40 | } 41 | #else 42 | #include 43 | #include 44 | #include 45 | 46 | #define micros() esp_timer_get_time() 47 | #define digitalRead(pin) gpio_get_level((gpio_num_t)pin) 48 | 49 | static void IRAM_ATTR encoderAISR(void * arg) { 50 | InterruptEncoder * object = (InterruptEncoder *)arg; 51 | long start = micros(); 52 | long duration = start - object->microsLastA; 53 | if (duration >= US_DEBOUNCE) { 54 | object->microsLastA = start; 55 | object->microsTimeBetweenTicks = duration; 56 | object->aState = digitalRead(object->apin); 57 | object->bState = digitalRead(object->bpin); 58 | if (object->aState == object->bState) 59 | object->count = object->count + 1; 60 | else 61 | object->count = object->count - 1; 62 | } 63 | } 64 | InterruptEncoder::InterruptEncoder() {} 65 | InterruptEncoder::~InterruptEncoder() { 66 | if (attached) { 67 | gpio_isr_handler_remove((gpio_num_t)apin); 68 | gpio_uninstall_isr_service(); 69 | } 70 | } 71 | int64_t InterruptEncoder::read() { return count * 2; } 72 | void InterruptEncoder::attach(int aPinNum, int bPinNum) { 73 | if (attached) 74 | return; 75 | apin = aPinNum; 76 | bpin = bPinNum; 77 | 78 | gpio_reset_pin((gpio_num_t)apin); 79 | gpio_set_direction((gpio_num_t)apin, GPIO_MODE_INPUT); 80 | gpio_set_level((gpio_num_t)apin, GPIO_PULLUP_ONLY); 81 | gpio_set_intr_type((gpio_num_t)apin, GPIO_INTR_ANYEDGE); 82 | 83 | gpio_install_isr_service(0); 84 | gpio_isr_handler_add((gpio_num_t)apin, encoderAISR, (void *)this); 85 | } 86 | #endif 87 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ESP32Encoder 2 | 3 | [![Build Status](https://travis-ci.com/madhephaestus/ESP32Encoder.svg?branch=master)](https://travis-ci.com/github/madhephaestus/ESP32Encoder) 4 | 5 | 6 | ESP32Encoder library that uses the ESP32 pulse counter hardware peripheral: 7 | 8 | https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/peripherals/pcnt.html 9 | 10 | There is only one interrupt for the peripheral, and that is managed by the library. The user has no interrupt interface, and no interrupts are generated on each pulse. Interrupts arrive when the 16 bit counter buffer overflows, so this library has a tiny interrupt footprint while providing support for up to 8 simultaneous quadrature encoders. 11 | 12 | This hardware peripheral supports only 8 encoders. 13 | 14 | # Support 15 | 16 | ESP32 and ESP32c2 are supported. 17 | 18 | ESP32c3 does not have pulse counter hardware. 19 | 20 | ESP32s3 has just 2 PCNT modules, so only supports 2 hardware accelerated encoders 21 | 22 | # Documentation by Doxygen 23 | 24 | [ESP32Encoder Doxygen](https://madhephaestus.github.io/ESP32Encoder/classESP32Encoder.html) 25 | 26 | # Quadrature Explanation 27 | 28 | For information on the type of encoder this library is for, see: https://en.wikipedia.org/wiki/Incremental_encoder 29 | 30 | The modes of reading encoders in this library are full and half quadrature, and single edge count mode. 31 | 32 | ![Image](https://upload.wikimedia.org/wikipedia/commons/1/1e/Incremental_directional_encoder.gif) 33 | 34 | Full performs a count increment on all 4 edges, half on the rising and falling of a single channel, and single counts just the rising edge of the A channel. 35 | 36 | 37 | 38 | ## Pull Downs/Ups 39 | 40 | To specify the weak pull resistor set the value [useInternalWeakPullResistors](https://madhephaestus.github.io/ESP32Encoder/classESP32Encoder.html#a53dc40c9de240e90a55b427b32da451f) with the enum types [UP, DOWN, or NONE](https://madhephaestus.github.io/ESP32Encoder/ESP32Encoder_8h.html#adca399663765c125d26e6f2896b5b349) 41 | 42 | ## ISR service CPU core 43 | To specify the CPU core for the PCNT ISR service set the value [isrServiceCpuCore](https://madhephaestus.github.io/ESP32Encoder/classESP32Encoder.html#a445e515b31ade19658075aa7417086bb) to the desired core number. This can be usefull to prevent concurrency problems where the total count might not be updated correctly yet while it is read. 44 | 45 | # A note on KY-040 and similar 46 | 47 | The "switch style" encoder wheels used by breakout modules such as: 48 | 49 | https://usa.banggood.com/KY-040-360-Degrees-Rotary-Encoder-Module-with-1516_5mm-Potentiometer-Rotary-Knob-Cap-for-Brick-Sensor-Switch-p-1677837.html 50 | 51 | need electrical debouncing in the range of 0.1 - 2 uf per encoder line to ground. This device bounces much more than the PCNT hardware modules debouncing time limits. Be sure to [setFilter()](https://madhephaestus.github.io/ESP32Encoder/classESP32Encoder.html#ae3cecb7d572685b3195f8a13409b3390) to 1023 as well after attaching in order to get the maximum hardware debouncing. 52 | -------------------------------------------------------------------------------- /src/ESP32Encoder.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * ESP32Encoder.cpp 3 | * 4 | * Created on: Oct 15, 2018 5 | * Author: hephaestus 6 | */ 7 | 8 | #include 9 | #ifdef ARDUINO 10 | #include 11 | #else 12 | #include 13 | #define delay(ms) vTaskDelay(pdMS_TO_TICKS(ms)) 14 | #endif 15 | 16 | #include 17 | #if SOC_PCNT_SUPPORTED 18 | // Not all esp32 chips support the pcnt (notably the esp32c3 does not) 19 | #include 20 | #include "esp_log.h" 21 | #include "esp_ipc.h" 22 | #if ( defined(ESP_ARDUINO_VERSION_MAJOR) && (ESP_ARDUINO_VERSION_MAJOR >= 3) ) 23 | #include 24 | #include 25 | #endif 26 | 27 | static const char* TAG_ENCODER = "ESP32Encoder"; 28 | 29 | static portMUX_TYPE spinlock = portMUX_INITIALIZER_UNLOCKED; 30 | #define _ENTER_CRITICAL() portENTER_CRITICAL_SAFE(&spinlock) 31 | #define _EXIT_CRITICAL() portEXIT_CRITICAL_SAFE(&spinlock) 32 | 33 | 34 | //static ESP32Encoder *gpio2enc[48]; 35 | // 36 | // 37 | puType ESP32Encoder::useInternalWeakPullResistors = puType::down; 38 | uint32_t ESP32Encoder::isrServiceCpuCore = ISR_CORE_USE_DEFAULT; 39 | ESP32Encoder *ESP32Encoder::encoders[MAX_ESP32_ENCODERS] = { NULL, }; 40 | 41 | bool ESP32Encoder::attachedInterrupt=false; 42 | 43 | ESP32Encoder::ESP32Encoder(bool always_interrupt_, enc_isr_cb_t enc_isr_cb, void* enc_isr_cb_data): 44 | always_interrupt{always_interrupt_}, 45 | aPinNumber{(gpio_num_t) 0}, 46 | bPinNumber{(gpio_num_t) 0}, 47 | unit{(pcnt_unit_t) -1}, 48 | countsMode{2}, 49 | count{0}, 50 | r_enc_config{}, 51 | _enc_isr_cb(enc_isr_cb), 52 | _enc_isr_cb_data(enc_isr_cb_data), 53 | attached{false}, 54 | direction{false}, 55 | working{false} 56 | { 57 | if (enc_isr_cb_data == nullptr) 58 | { 59 | _enc_isr_cb_data = this; 60 | } 61 | } 62 | 63 | ESP32Encoder::~ESP32Encoder() {} 64 | 65 | /* Decode what PCNT's unit originated an interrupt 66 | * and pass this information together with the event type 67 | * the main program using a queue. 68 | */ 69 | #ifdef CONFIG_IDF_TARGET_ESP32S2 70 | #define COUNTER_H_LIM cnt_thr_h_lim_lat_un 71 | #define COUNTER_L_LIM cnt_thr_l_lim_lat_un 72 | #define thres0_lat cnt_thr_thres0_lat_un 73 | #define thres1_lat cnt_thr_thres1_lat_un 74 | 75 | #elif CONFIG_IDF_TARGET_ESP32S3 76 | #define COUNTER_H_LIM cnt_thr_h_lim_lat_un 77 | #define COUNTER_L_LIM cnt_thr_l_lim_lat_un 78 | #define thres0_lat cnt_thr_thres0_lat_un 79 | #define thres1_lat cnt_thr_thres1_lat_un 80 | 81 | #elif CONFIG_IDF_TARGET_ESP32C6 82 | #define COUNTER_H_LIM cnt_thr_h_lim_lat 83 | #define COUNTER_L_LIM cnt_thr_l_lim_lat 84 | #define thres0_lat cnt_thr_thres0_lat 85 | #define thres1_lat cnt_thr_thres1_lat 86 | #else 87 | #define COUNTER_H_LIM h_lim_lat 88 | #define COUNTER_L_LIM l_lim_lat 89 | #endif 90 | 91 | 92 | 93 | static void esp32encoder_pcnt_intr_handler(void *arg) { 94 | ESP32Encoder * esp32enc = static_cast(arg); 95 | pcnt_unit_t unit = esp32enc->r_enc_config.unit; 96 | _ENTER_CRITICAL(); 97 | if(PCNT.status_unit[unit].COUNTER_H_LIM){ 98 | esp32enc->count = esp32enc->count + esp32enc->r_enc_config.counter_h_lim; 99 | pcnt_counter_clear(unit); 100 | } else if(PCNT.status_unit[unit].COUNTER_L_LIM){ 101 | esp32enc->count = esp32enc->count + esp32enc->r_enc_config.counter_l_lim; 102 | pcnt_counter_clear(unit); 103 | } else if(esp32enc->always_interrupt && (PCNT.status_unit[unit].thres0_lat || PCNT.status_unit[unit].thres1_lat)) { 104 | int16_t c; 105 | pcnt_get_counter_value(unit, &c); 106 | esp32enc->count = esp32enc->count + c; 107 | pcnt_set_event_value(unit, PCNT_EVT_THRES_0, -1); 108 | pcnt_set_event_value(unit, PCNT_EVT_THRES_1, 1); 109 | pcnt_event_enable(unit, PCNT_EVT_THRES_0); 110 | pcnt_event_enable(unit, PCNT_EVT_THRES_1); 111 | pcnt_counter_clear(unit); 112 | if (esp32enc->_enc_isr_cb) { 113 | esp32enc->_enc_isr_cb(esp32enc->_enc_isr_cb_data); 114 | } 115 | } 116 | _EXIT_CRITICAL(); 117 | } 118 | 119 | 120 | 121 | 122 | 123 | void ESP32Encoder::detach(){ 124 | pcnt_counter_pause(unit); 125 | pcnt_isr_handler_remove(this->r_enc_config.unit); 126 | ESP32Encoder::encoders[unit]=NULL; 127 | attached = false; 128 | } 129 | 130 | void ESP32Encoder::detatch(){ 131 | this->detach(); 132 | } 133 | 134 | static IRAM_ATTR void ipc_install_isr_on_core(void *arg) { 135 | esp_err_t *result = (esp_err_t*) arg; 136 | *result = pcnt_isr_service_install(0); 137 | } 138 | 139 | void ESP32Encoder::attach(int a, int b, encType et) { 140 | if (attached) { 141 | ESP_LOGE(TAG_ENCODER, "attach: already attached"); 142 | return; 143 | } 144 | int index = 0; 145 | for (; index < MAX_ESP32_ENCODERS; index++) { 146 | if (ESP32Encoder::encoders[index] == NULL) { 147 | encoders[index] = this; 148 | break; 149 | } 150 | } 151 | if (index == MAX_ESP32_ENCODERS) { 152 | while(1){ 153 | ESP_LOGE(TAG_ENCODER, "Too many encoders, FAIL!"); 154 | delay(100); 155 | } 156 | 157 | } 158 | 159 | // Set data now that pin attach checks are done 160 | unit = (pcnt_unit_t) index; 161 | this->aPinNumber = (gpio_num_t) a; 162 | this->bPinNumber = (gpio_num_t) b; 163 | 164 | //Set up the IO state of hte pin 165 | gpio_pad_select_gpio(aPinNumber); 166 | gpio_pad_select_gpio(bPinNumber); 167 | gpio_set_direction(aPinNumber, GPIO_MODE_INPUT); 168 | gpio_set_direction(bPinNumber, GPIO_MODE_INPUT); 169 | if(useInternalWeakPullResistors == puType::down){ 170 | gpio_pulldown_en(aPinNumber); 171 | gpio_pulldown_en(bPinNumber); 172 | } 173 | if(useInternalWeakPullResistors == puType::up){ 174 | gpio_pullup_en(aPinNumber); 175 | gpio_pullup_en(bPinNumber); 176 | } 177 | // Set up encoder PCNT configuration 178 | // Configure channel 0 179 | r_enc_config.pulse_gpio_num = aPinNumber; //Rotary Encoder Chan A 180 | r_enc_config.ctrl_gpio_num = bPinNumber; //Rotary Encoder Chan B 181 | 182 | r_enc_config.unit = unit; 183 | r_enc_config.channel = PCNT_CHANNEL_0; 184 | 185 | r_enc_config.pos_mode = et != encType::single ? PCNT_COUNT_DEC : PCNT_COUNT_DIS; //Count Only On Rising-Edges 186 | r_enc_config.neg_mode = PCNT_COUNT_INC; // Discard Falling-Edge 187 | 188 | r_enc_config.lctrl_mode = PCNT_MODE_KEEP; // Rising A on HIGH B = CW Step 189 | r_enc_config.hctrl_mode = PCNT_MODE_REVERSE; // Rising A on LOW B = CCW Step 190 | 191 | r_enc_config .counter_h_lim = _INT16_MAX; 192 | r_enc_config .counter_l_lim = _INT16_MIN ; 193 | 194 | pcnt_unit_config(&r_enc_config); 195 | 196 | // Configure channel 0 197 | r_enc_config.pulse_gpio_num = bPinNumber; //make prior control into signal 198 | r_enc_config.ctrl_gpio_num = aPinNumber; //and prior signal into control 199 | 200 | r_enc_config.channel = PCNT_CHANNEL_1; // channel 1 201 | 202 | r_enc_config.pos_mode = PCNT_COUNT_DIS; //disabling channel 1 203 | r_enc_config.neg_mode = PCNT_COUNT_DIS; // disabling channel 1 204 | 205 | r_enc_config.lctrl_mode = PCNT_MODE_DISABLE; // disabling channel 1 206 | r_enc_config.hctrl_mode = PCNT_MODE_DISABLE; // disabling channel 1 207 | 208 | if (et == encType::full) { 209 | // set up second channel for full quad 210 | 211 | r_enc_config.pos_mode = PCNT_COUNT_DEC; //Count Only On Rising-Edges 212 | r_enc_config.neg_mode = PCNT_COUNT_INC; // Discard Falling-Edge 213 | 214 | r_enc_config.lctrl_mode = PCNT_MODE_REVERSE; // prior high mode is now low 215 | r_enc_config.hctrl_mode = PCNT_MODE_KEEP; // prior low mode is now high 216 | } 217 | pcnt_unit_config(&r_enc_config); 218 | 219 | // Filter out bounces and noise 220 | setFilter(250); // Filter Runt Pulses 221 | 222 | /* Enable events on maximum and minimum limit values */ 223 | pcnt_event_enable(unit, PCNT_EVT_H_LIM); 224 | pcnt_event_enable(unit, PCNT_EVT_L_LIM); 225 | pcnt_counter_pause(unit); // Initial PCNT init 226 | /* Register ISR service and enable interrupts for PCNT unit */ 227 | if(! attachedInterrupt){ 228 | #if ( defined(CONFIG_IDF_TARGET_ESP32S2) || defined(CONFIG_IDF_TARGET_ESP32C6) ) // esp32-s2 and -c6 are single core, no ipc call 229 | esp_err_t er = pcnt_isr_service_install(0); 230 | if (er != ESP_OK){ 231 | ESP_LOGE(TAG_ENCODER, "Encoder install isr service failed"); 232 | } 233 | #else 234 | if (isrServiceCpuCore == ISR_CORE_USE_DEFAULT || isrServiceCpuCore == xPortGetCoreID()) { 235 | esp_err_t er = pcnt_isr_service_install(0); 236 | if (er != ESP_OK){ 237 | ESP_LOGE(TAG_ENCODER, "Encoder install isr service on same core failed"); 238 | } 239 | } else { 240 | esp_err_t ipc_ret_code = ESP_FAIL; 241 | esp_err_t er = esp_ipc_call_blocking(isrServiceCpuCore, ipc_install_isr_on_core, &ipc_ret_code); 242 | if (er != ESP_OK){ 243 | ESP_LOGE(TAG_ENCODER, "IPC call to install isr service on core %ud failed", isrServiceCpuCore); 244 | } 245 | if (ipc_ret_code != ESP_OK){ 246 | ESP_LOGE(TAG_ENCODER, "Encoder install isr service on core %ud failed", isrServiceCpuCore); 247 | } 248 | } 249 | #endif 250 | 251 | attachedInterrupt=true; 252 | } 253 | 254 | // Add ISR handler for this unit 255 | if (pcnt_isr_handler_add(unit, esp32encoder_pcnt_intr_handler, this) != ESP_OK) { 256 | ESP_LOGE(TAG_ENCODER, "Encoder install interrupt handler for unit %d failed", unit); 257 | } 258 | 259 | if (always_interrupt){ 260 | pcnt_set_event_value(unit, PCNT_EVT_THRES_0, -1); 261 | pcnt_set_event_value(unit, PCNT_EVT_THRES_1, 1); 262 | pcnt_event_enable(unit, PCNT_EVT_THRES_0); 263 | pcnt_event_enable(unit, PCNT_EVT_THRES_1); 264 | } 265 | pcnt_counter_clear(unit); 266 | pcnt_intr_enable(unit); 267 | pcnt_counter_resume(unit); 268 | 269 | attached = true; 270 | 271 | } 272 | 273 | void ESP32Encoder::attachHalfQuad(int aPintNumber, int bPinNumber) { 274 | attach(aPintNumber, bPinNumber, encType::half); 275 | 276 | } 277 | void ESP32Encoder::attachSingleEdge(int aPintNumber, int bPinNumber) { 278 | attach(aPintNumber, bPinNumber, encType::single); 279 | } 280 | void ESP32Encoder::attachFullQuad(int aPintNumber, int bPinNumber) { 281 | attach(aPintNumber, bPinNumber, encType::full); 282 | } 283 | 284 | void ESP32Encoder::setCount(int64_t value) { 285 | _ENTER_CRITICAL(); 286 | count = value - getCountRaw(); 287 | _EXIT_CRITICAL(); 288 | } 289 | 290 | int64_t ESP32Encoder::getCountRaw() { 291 | int16_t c; 292 | int64_t compensate = 0; 293 | _ENTER_CRITICAL(); 294 | pcnt_get_counter_value(unit, &c); 295 | // check if counter overflowed, if so re-read and compensate 296 | // see https://github.com/espressif/esp-idf/blob/v4.4.1/tools/unit-test-app/components/test_utils/ref_clock_impl_rmt_pcnt.c#L168-L172 297 | if (PCNT.int_st.val & BIT(unit)) { 298 | pcnt_get_counter_value(unit, &c); 299 | if(PCNT.status_unit[unit].COUNTER_H_LIM){ 300 | compensate = r_enc_config.counter_h_lim; 301 | } else if (PCNT.status_unit[unit].COUNTER_L_LIM) { 302 | compensate = r_enc_config.counter_l_lim; 303 | } 304 | } 305 | _EXIT_CRITICAL(); 306 | return compensate + c; 307 | } 308 | 309 | int64_t ESP32Encoder::getCount() { 310 | _ENTER_CRITICAL(); 311 | int64_t result = count + getCountRaw(); 312 | _EXIT_CRITICAL(); 313 | return result; 314 | } 315 | 316 | int64_t ESP32Encoder::clearCount() { 317 | _ENTER_CRITICAL(); 318 | count = 0; 319 | _EXIT_CRITICAL(); 320 | return pcnt_counter_clear(unit); 321 | } 322 | 323 | int64_t ESP32Encoder::pauseCount() { 324 | return pcnt_counter_pause(unit); 325 | } 326 | 327 | int64_t ESP32Encoder::resumeCount() { 328 | return pcnt_counter_resume(unit); 329 | } 330 | 331 | void ESP32Encoder::setFilter(uint16_t value) { 332 | if(value>1023)value=1023; 333 | if(value==0) { 334 | pcnt_filter_disable(unit); 335 | } else { 336 | pcnt_set_filter_value(unit, value); 337 | pcnt_filter_enable(unit); 338 | } 339 | 340 | } 341 | #else 342 | #warning PCNT not supported on this SoC, this will likely lead to linker errors when using ESP32Encoder 343 | #endif // SOC_PCNT_SUPPORTED 344 | -------------------------------------------------------------------------------- /doxy.doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.11 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "ESP32Encoder" 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 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = 122 | 123 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124 | # doxygen will generate a detailed section even if there is only a brief 125 | # description. 126 | # The default value is: NO. 127 | 128 | ALWAYS_DETAILED_SEC = NO 129 | 130 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131 | # inherited members of a class in the documentation of that class as if those 132 | # members were ordinary class members. Constructors, destructors and assignment 133 | # operators of the base classes will not be shown. 134 | # The default value is: NO. 135 | 136 | INLINE_INHERITED_MEMB = NO 137 | 138 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 139 | # before files name in the file list and in the header files. If set to NO the 140 | # shortest path that makes the file name unique will be used 141 | # The default value is: YES. 142 | 143 | FULL_PATH_NAMES = YES 144 | 145 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146 | # Stripping is only done if one of the specified strings matches the left-hand 147 | # part of the path. The tag can be used to show relative paths in the file list. 148 | # If left blank the directory from which doxygen is run is used as the path to 149 | # strip. 150 | # 151 | # Note that you can specify absolute paths here, but also relative paths, which 152 | # will be relative from the directory where doxygen is started. 153 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 154 | 155 | STRIP_FROM_PATH = 156 | 157 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 158 | # path mentioned in the documentation of a class, which tells the reader which 159 | # header file to include in order to use a class. If left blank only the name of 160 | # the header file containing the class definition is used. Otherwise one should 161 | # specify the list of include paths that are normally passed to the compiler 162 | # using the -I flag. 163 | 164 | STRIP_FROM_INC_PATH = 165 | 166 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167 | # less readable) file names. This can be useful is your file systems doesn't 168 | # support long names like on DOS, Mac, or CD-ROM. 169 | # The default value is: NO. 170 | 171 | SHORT_NAMES = NO 172 | 173 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174 | # first line (until the first dot) of a Javadoc-style comment as the brief 175 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 176 | # style comments (thus requiring an explicit @brief command for a brief 177 | # description.) 178 | # The default value is: NO. 179 | 180 | JAVADOC_AUTOBRIEF = NO 181 | 182 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 | # line (until the first dot) of a Qt-style comment as the brief description. If 184 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185 | # requiring an explicit \brief command for a brief description.) 186 | # The default value is: NO. 187 | 188 | QT_AUTOBRIEF = NO 189 | 190 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 192 | # a brief description. This used to be the default behavior. The new default is 193 | # to treat a multi-line C++ comment block as a detailed description. Set this 194 | # tag to YES if you prefer the old behavior instead. 195 | # 196 | # Note that setting this tag to YES also means that rational rose comments are 197 | # not recognized any more. 198 | # The default value is: NO. 199 | 200 | MULTILINE_CPP_IS_BRIEF = NO 201 | 202 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 | # documentation from any documented member that it re-implements. 204 | # The default value is: YES. 205 | 206 | INHERIT_DOCS = YES 207 | 208 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 209 | # page for each member. If set to NO, the documentation of a member will be part 210 | # of the file/class/namespace that contains it. 211 | # The default value is: NO. 212 | 213 | SEPARATE_MEMBER_PAGES = NO 214 | 215 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216 | # uses this value to replace tabs by spaces in code fragments. 217 | # Minimum value: 1, maximum value: 16, default value: 4. 218 | 219 | TAB_SIZE = 4 220 | 221 | # This tag can be used to specify a number of aliases that act as commands in 222 | # the documentation. An alias has the form: 223 | # name=value 224 | # For example adding 225 | # "sideeffect=@par Side Effects:\n" 226 | # will allow you to put the command \sideeffect (or @sideeffect) in the 227 | # documentation, which will result in a user-defined paragraph with heading 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert 229 | # newlines. 230 | 231 | ALIASES = 232 | 233 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 234 | # A mapping has the form "name=value". For example adding "class=itcl::class" 235 | # will allow you to use the command class in the itcl::class meaning. 236 | 237 | TCL_SUBST = 238 | 239 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 240 | # only. Doxygen will then generate output that is more tailored for C. For 241 | # instance, some of the names that are used will be different. The list of all 242 | # members will be omitted, etc. 243 | # The default value is: NO. 244 | 245 | OPTIMIZE_OUTPUT_FOR_C = YES 246 | 247 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 248 | # Python sources only. Doxygen will then generate output that is more tailored 249 | # for that language. For instance, namespaces will be presented as packages, 250 | # qualified scopes will look different, etc. 251 | # The default value is: NO. 252 | 253 | OPTIMIZE_OUTPUT_JAVA = NO 254 | 255 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 256 | # sources. Doxygen will then generate output that is tailored for Fortran. 257 | # The default value is: NO. 258 | 259 | OPTIMIZE_FOR_FORTRAN = NO 260 | 261 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 262 | # sources. Doxygen will then generate output that is tailored for VHDL. 263 | # The default value is: NO. 264 | 265 | OPTIMIZE_OUTPUT_VHDL = NO 266 | 267 | # Doxygen selects the parser to use depending on the extension of the files it 268 | # parses. With this tag you can assign which parser to use for a given 269 | # extension. Doxygen has a built-in mapping, but you can override or extend it 270 | # using this tag. The format is ext=language, where ext is a file extension, and 271 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 272 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 273 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 274 | # Fortran. In the later case the parser tries to guess whether the code is fixed 275 | # or free formatted code, this is the default for Fortran type files), VHDL. For 276 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 277 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 278 | # 279 | # Note: For files without extension you can use no_extension as a placeholder. 280 | # 281 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 282 | # the files are not read by doxygen. 283 | 284 | EXTENSION_MAPPING = ino=c 285 | 286 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 287 | # according to the Markdown format, which allows for more readable 288 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 289 | # The output of markdown processing is further processed by doxygen, so you can 290 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 291 | # case of backward compatibilities issues. 292 | # The default value is: YES. 293 | 294 | MARKDOWN_SUPPORT = YES 295 | 296 | # When enabled doxygen tries to link words that correspond to documented 297 | # classes, or namespaces to their corresponding documentation. Such a link can 298 | # be prevented in individual cases by putting a % sign in front of the word or 299 | # globally by setting AUTOLINK_SUPPORT to NO. 300 | # The default value is: YES. 301 | 302 | AUTOLINK_SUPPORT = YES 303 | 304 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 305 | # to include (a tag file for) the STL sources as input, then you should set this 306 | # tag to YES in order to let doxygen match functions declarations and 307 | # definitions whose arguments contain STL classes (e.g. func(std::string); 308 | # versus func(std::string) {}). This also make the inheritance and collaboration 309 | # diagrams that involve STL classes more complete and accurate. 310 | # The default value is: NO. 311 | 312 | BUILTIN_STL_SUPPORT = NO 313 | 314 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 315 | # enable parsing support. 316 | # The default value is: NO. 317 | 318 | CPP_CLI_SUPPORT = NO 319 | 320 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 321 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 322 | # will parse them like normal C++ but will assume all classes use public instead 323 | # of private inheritance when no explicit protection keyword is present. 324 | # The default value is: NO. 325 | 326 | SIP_SUPPORT = NO 327 | 328 | # For Microsoft's IDL there are propget and propput attributes to indicate 329 | # getter and setter methods for a property. Setting this option to YES will make 330 | # doxygen to replace the get and set methods by a property in the documentation. 331 | # This will only work if the methods are indeed getting or setting a simple 332 | # type. If this is not the case, or you want to show the methods anyway, you 333 | # should set this option to NO. 334 | # The default value is: YES. 335 | 336 | IDL_PROPERTY_SUPPORT = YES 337 | 338 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 339 | # tag is set to YES then doxygen will reuse the documentation of the first 340 | # member in the group (if any) for the other members of the group. By default 341 | # all members of a group must be documented explicitly. 342 | # The default value is: NO. 343 | 344 | DISTRIBUTE_GROUP_DOC = NO 345 | 346 | # If one adds a struct or class to a group and this option is enabled, then also 347 | # any nested class or struct is added to the same group. By default this option 348 | # is disabled and one has to add nested compounds explicitly via \ingroup. 349 | # The default value is: NO. 350 | 351 | GROUP_NESTED_COMPOUNDS = NO 352 | 353 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 354 | # (for instance a group of public functions) to be put as a subgroup of that 355 | # type (e.g. under the Public Functions section). Set it to NO to prevent 356 | # subgrouping. Alternatively, this can be done per class using the 357 | # \nosubgrouping command. 358 | # The default value is: YES. 359 | 360 | SUBGROUPING = YES 361 | 362 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 363 | # are shown inside the group in which they are included (e.g. using \ingroup) 364 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 365 | # and RTF). 366 | # 367 | # Note that this feature does not work in combination with 368 | # SEPARATE_MEMBER_PAGES. 369 | # The default value is: NO. 370 | 371 | INLINE_GROUPED_CLASSES = NO 372 | 373 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 374 | # with only public data fields or simple typedef fields will be shown inline in 375 | # the documentation of the scope in which they are defined (i.e. file, 376 | # namespace, or group documentation), provided this scope is documented. If set 377 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 378 | # Man pages) or section (for LaTeX and RTF). 379 | # The default value is: NO. 380 | 381 | INLINE_SIMPLE_STRUCTS = NO 382 | 383 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 384 | # enum is documented as struct, union, or enum with the name of the typedef. So 385 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 386 | # with name TypeT. When disabled the typedef will appear as a member of a file, 387 | # namespace, or class. And the struct will be named TypeS. This can typically be 388 | # useful for C code in case the coding convention dictates that all compound 389 | # types are typedef'ed and only the typedef is referenced, never the tag name. 390 | # The default value is: NO. 391 | 392 | TYPEDEF_HIDES_STRUCT = NO 393 | 394 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 395 | # cache is used to resolve symbols given their name and scope. Since this can be 396 | # an expensive process and often the same symbol appears multiple times in the 397 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 398 | # doxygen will become slower. If the cache is too large, memory is wasted. The 399 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 400 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 401 | # symbols. At the end of a run doxygen will report the cache usage and suggest 402 | # the optimal cache size from a speed point of view. 403 | # Minimum value: 0, maximum value: 9, default value: 0. 404 | 405 | LOOKUP_CACHE_SIZE = 0 406 | 407 | #--------------------------------------------------------------------------- 408 | # Build related configuration options 409 | #--------------------------------------------------------------------------- 410 | 411 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 412 | # documentation are documented, even if no documentation was available. Private 413 | # class members and static file members will be hidden unless the 414 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 415 | # Note: This will also disable the warnings about undocumented members that are 416 | # normally produced when WARNINGS is set to YES. 417 | # The default value is: NO. 418 | 419 | EXTRACT_ALL = YES 420 | 421 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 422 | # be included in the documentation. 423 | # The default value is: NO. 424 | 425 | EXTRACT_PRIVATE = YES 426 | 427 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 428 | # scope will be included in the documentation. 429 | # The default value is: NO. 430 | 431 | EXTRACT_PACKAGE = NO 432 | 433 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 434 | # included in the documentation. 435 | # The default value is: NO. 436 | 437 | EXTRACT_STATIC = YES 438 | 439 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 440 | # locally in source files will be included in the documentation. If set to NO, 441 | # only classes defined in header files are included. Does not have any effect 442 | # for Java sources. 443 | # The default value is: YES. 444 | 445 | EXTRACT_LOCAL_CLASSES = YES 446 | 447 | # This flag is only useful for Objective-C code. If set to YES, local methods, 448 | # which are defined in the implementation section but not in the interface are 449 | # included in the documentation. If set to NO, only methods in the interface are 450 | # included. 451 | # The default value is: NO. 452 | 453 | EXTRACT_LOCAL_METHODS = NO 454 | 455 | # If this flag is set to YES, the members of anonymous namespaces will be 456 | # extracted and appear in the documentation as a namespace called 457 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 458 | # the file that contains the anonymous namespace. By default anonymous namespace 459 | # are hidden. 460 | # The default value is: NO. 461 | 462 | EXTRACT_ANON_NSPACES = NO 463 | 464 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 465 | # undocumented members inside documented classes or files. If set to NO these 466 | # members will be included in the various overviews, but no documentation 467 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 468 | # The default value is: NO. 469 | 470 | HIDE_UNDOC_MEMBERS = NO 471 | 472 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 473 | # undocumented classes that are normally visible in the class hierarchy. If set 474 | # to NO, these classes will be included in the various overviews. This option 475 | # has no effect if EXTRACT_ALL is enabled. 476 | # The default value is: NO. 477 | 478 | HIDE_UNDOC_CLASSES = NO 479 | 480 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 481 | # (class|struct|union) declarations. If set to NO, these declarations will be 482 | # included in the documentation. 483 | # The default value is: NO. 484 | 485 | HIDE_FRIEND_COMPOUNDS = NO 486 | 487 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 488 | # documentation blocks found inside the body of a function. If set to NO, these 489 | # blocks will be appended to the function's detailed documentation block. 490 | # The default value is: NO. 491 | 492 | HIDE_IN_BODY_DOCS = NO 493 | 494 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 495 | # \internal command is included. If the tag is set to NO then the documentation 496 | # will be excluded. Set it to YES to include the internal documentation. 497 | # The default value is: NO. 498 | 499 | INTERNAL_DOCS = NO 500 | 501 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 502 | # names in lower-case letters. If set to YES, upper-case letters are also 503 | # allowed. This is useful if you have classes or files whose names only differ 504 | # in case and if your file system supports case sensitive file names. Windows 505 | # and Mac users are advised to set this option to NO. 506 | # The default value is: system dependent. 507 | 508 | CASE_SENSE_NAMES = YES 509 | 510 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 511 | # their full class and namespace scopes in the documentation. If set to YES, the 512 | # scope will be hidden. 513 | # The default value is: NO. 514 | 515 | HIDE_SCOPE_NAMES = NO 516 | 517 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 518 | # append additional text to a page's title, such as Class Reference. If set to 519 | # YES the compound reference will be hidden. 520 | # The default value is: NO. 521 | 522 | HIDE_COMPOUND_REFERENCE= NO 523 | 524 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 525 | # the files that are included by a file in the documentation of that file. 526 | # The default value is: YES. 527 | 528 | SHOW_INCLUDE_FILES = YES 529 | 530 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 531 | # grouped member an include statement to the documentation, telling the reader 532 | # which file to include in order to use the member. 533 | # The default value is: NO. 534 | 535 | SHOW_GROUPED_MEMB_INC = NO 536 | 537 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 538 | # files with double quotes in the documentation rather than with sharp brackets. 539 | # The default value is: NO. 540 | 541 | FORCE_LOCAL_INCLUDES = NO 542 | 543 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 544 | # documentation for inline members. 545 | # The default value is: YES. 546 | 547 | INLINE_INFO = YES 548 | 549 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 550 | # (detailed) documentation of file and class members alphabetically by member 551 | # name. If set to NO, the members will appear in declaration order. 552 | # The default value is: YES. 553 | 554 | SORT_MEMBER_DOCS = YES 555 | 556 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 557 | # descriptions of file, namespace and class members alphabetically by member 558 | # name. If set to NO, the members will appear in declaration order. Note that 559 | # this will also influence the order of the classes in the class list. 560 | # The default value is: NO. 561 | 562 | SORT_BRIEF_DOCS = NO 563 | 564 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 565 | # (brief and detailed) documentation of class members so that constructors and 566 | # destructors are listed first. If set to NO the constructors will appear in the 567 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 568 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 569 | # member documentation. 570 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 571 | # detailed member documentation. 572 | # The default value is: NO. 573 | 574 | SORT_MEMBERS_CTORS_1ST = NO 575 | 576 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 577 | # of group names into alphabetical order. If set to NO the group names will 578 | # appear in their defined order. 579 | # The default value is: NO. 580 | 581 | SORT_GROUP_NAMES = NO 582 | 583 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 584 | # fully-qualified names, including namespaces. If set to NO, the class list will 585 | # be sorted only by class name, not including the namespace part. 586 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 587 | # Note: This option applies only to the class list, not to the alphabetical 588 | # list. 589 | # The default value is: NO. 590 | 591 | SORT_BY_SCOPE_NAME = NO 592 | 593 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 594 | # type resolution of all parameters of a function it will reject a match between 595 | # the prototype and the implementation of a member function even if there is 596 | # only one candidate or it is obvious which candidate to choose by doing a 597 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 598 | # accept a match between prototype and implementation in such cases. 599 | # The default value is: NO. 600 | 601 | STRICT_PROTO_MATCHING = NO 602 | 603 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 604 | # list. This list is created by putting \todo commands in the documentation. 605 | # The default value is: YES. 606 | 607 | GENERATE_TODOLIST = YES 608 | 609 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 610 | # list. This list is created by putting \test commands in the documentation. 611 | # The default value is: YES. 612 | 613 | GENERATE_TESTLIST = YES 614 | 615 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 616 | # list. This list is created by putting \bug commands in the documentation. 617 | # The default value is: YES. 618 | 619 | GENERATE_BUGLIST = YES 620 | 621 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 622 | # the deprecated list. This list is created by putting \deprecated commands in 623 | # the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_DEPRECATEDLIST= YES 627 | 628 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 629 | # sections, marked by \if ... \endif and \cond 630 | # ... \endcond blocks. 631 | 632 | ENABLED_SECTIONS = 633 | 634 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 635 | # initial value of a variable or macro / define can have for it to appear in the 636 | # documentation. If the initializer consists of more lines than specified here 637 | # it will be hidden. Use a value of 0 to hide initializers completely. The 638 | # appearance of the value of individual variables and macros / defines can be 639 | # controlled using \showinitializer or \hideinitializer command in the 640 | # documentation regardless of this setting. 641 | # Minimum value: 0, maximum value: 10000, default value: 30. 642 | 643 | MAX_INITIALIZER_LINES = 30 644 | 645 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 646 | # the bottom of the documentation of classes and structs. If set to YES, the 647 | # list will mention the files that were used to generate the documentation. 648 | # The default value is: YES. 649 | 650 | SHOW_USED_FILES = YES 651 | 652 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 653 | # will remove the Files entry from the Quick Index and from the Folder Tree View 654 | # (if specified). 655 | # The default value is: YES. 656 | 657 | SHOW_FILES = YES 658 | 659 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 660 | # page. This will remove the Namespaces entry from the Quick Index and from the 661 | # Folder Tree View (if specified). 662 | # The default value is: YES. 663 | 664 | SHOW_NAMESPACES = YES 665 | 666 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 667 | # doxygen should invoke to get the current version for each file (typically from 668 | # the version control system). Doxygen will invoke the program by executing (via 669 | # popen()) the command command input-file, where command is the value of the 670 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 671 | # by doxygen. Whatever the program writes to standard output is used as the file 672 | # version. For an example see the documentation. 673 | 674 | FILE_VERSION_FILTER = 675 | 676 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 677 | # by doxygen. The layout file controls the global structure of the generated 678 | # output files in an output format independent way. To create the layout file 679 | # that represents doxygen's defaults, run doxygen with the -l option. You can 680 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 681 | # will be used as the name of the layout file. 682 | # 683 | # Note that if you run doxygen from a directory containing a file called 684 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 685 | # tag is left empty. 686 | 687 | LAYOUT_FILE = 688 | 689 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 690 | # the reference definitions. This must be a list of .bib files. The .bib 691 | # extension is automatically appended if omitted. This requires the bibtex tool 692 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 693 | # For LaTeX the style of the bibliography can be controlled using 694 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 695 | # search path. See also \cite for info how to create references. 696 | 697 | CITE_BIB_FILES = 698 | 699 | #--------------------------------------------------------------------------- 700 | # Configuration options related to warning and progress messages 701 | #--------------------------------------------------------------------------- 702 | 703 | # The QUIET tag can be used to turn on/off the messages that are generated to 704 | # standard output by doxygen. If QUIET is set to YES this implies that the 705 | # messages are off. 706 | # The default value is: NO. 707 | 708 | QUIET = NO 709 | 710 | # The WARNINGS tag can be used to turn on/off the warning messages that are 711 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 712 | # this implies that the warnings are on. 713 | # 714 | # Tip: Turn warnings on while writing the documentation. 715 | # The default value is: YES. 716 | 717 | WARNINGS = YES 718 | 719 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 720 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 721 | # will automatically be disabled. 722 | # The default value is: YES. 723 | 724 | WARN_IF_UNDOCUMENTED = YES 725 | 726 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 727 | # potential errors in the documentation, such as not documenting some parameters 728 | # in a documented function, or documenting parameters that don't exist or using 729 | # markup commands wrongly. 730 | # The default value is: YES. 731 | 732 | WARN_IF_DOC_ERROR = YES 733 | 734 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 735 | # are documented, but have no documentation for their parameters or return 736 | # value. If set to NO, doxygen will only warn about wrong or incomplete 737 | # parameter documentation, but not about the absence of documentation. 738 | # The default value is: NO. 739 | 740 | WARN_NO_PARAMDOC = NO 741 | 742 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 743 | # a warning is encountered. 744 | # The default value is: NO. 745 | 746 | WARN_AS_ERROR = NO 747 | 748 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 749 | # can produce. The string should contain the $file, $line, and $text tags, which 750 | # will be replaced by the file and line number from which the warning originated 751 | # and the warning text. Optionally the format may contain $version, which will 752 | # be replaced by the version of the file (if it could be obtained via 753 | # FILE_VERSION_FILTER) 754 | # The default value is: $file:$line: $text. 755 | 756 | WARN_FORMAT = "$file:$line: $text" 757 | 758 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 759 | # messages should be written. If left blank the output is written to standard 760 | # error (stderr). 761 | 762 | WARN_LOGFILE = 763 | 764 | #--------------------------------------------------------------------------- 765 | # Configuration options related to the input files 766 | #--------------------------------------------------------------------------- 767 | 768 | # The INPUT tag is used to specify the files and/or directories that contain 769 | # documented source files. You may enter file names like myfile.cpp or 770 | # directories like /usr/src/myproject. Separate the files or directories with 771 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 772 | # Note: If this tag is empty the current directory is searched. 773 | 774 | INPUT = 775 | 776 | # This tag can be used to specify the character encoding of the source files 777 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 778 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 779 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 780 | # possible encodings. 781 | # The default value is: UTF-8. 782 | 783 | INPUT_ENCODING = UTF-8 784 | 785 | # If the value of the INPUT tag contains directories, you can use the 786 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 787 | # *.h) to filter out the source-files in the directories. 788 | # 789 | # Note that for custom extensions or not directly supported extensions you also 790 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 791 | # read by doxygen. 792 | # 793 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 794 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 795 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 796 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, 797 | # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. 798 | 799 | FILE_PATTERNS = *.cpp *.h *.ino 800 | 801 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 802 | # be searched for input files as well. 803 | # The default value is: NO. 804 | 805 | RECURSIVE = YES 806 | 807 | # The EXCLUDE tag can be used to specify files and/or directories that should be 808 | # excluded from the INPUT source files. This way you can easily exclude a 809 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 810 | # 811 | # Note that relative paths are relative to the directory from which doxygen is 812 | # run. 813 | 814 | EXCLUDE = 815 | 816 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 817 | # directories that are symbolic links (a Unix file system feature) are excluded 818 | # from the input. 819 | # The default value is: NO. 820 | 821 | EXCLUDE_SYMLINKS = NO 822 | 823 | # If the value of the INPUT tag contains directories, you can use the 824 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 825 | # certain files from those directories. 826 | # 827 | # Note that the wildcards are matched against the file with absolute path, so to 828 | # exclude all test directories for example use the pattern */test/* 829 | 830 | EXCLUDE_PATTERNS = */html/* */doc/* */Release/* *licence.txt* sloeber.ino.cpp *.sh* 831 | 832 | 833 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 834 | # (namespaces, classes, functions, etc.) that should be excluded from the 835 | # output. The symbol name can be a fully qualified name, a word, or if the 836 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 837 | # AClass::ANamespace, ANamespace::*Test 838 | # 839 | # Note that the wildcards are matched against the file with absolute path, so to 840 | # exclude all test directories use the pattern */test/* 841 | 842 | EXCLUDE_SYMBOLS = 843 | 844 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 845 | # that contain example code fragments that are included (see the \include 846 | # command). 847 | 848 | EXAMPLE_PATH = 849 | 850 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 851 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 852 | # *.h) to filter out the source-files in the directories. If left blank all 853 | # files are included. 854 | 855 | EXAMPLE_PATTERNS = 856 | 857 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 858 | # searched for input files to be used with the \include or \dontinclude commands 859 | # irrespective of the value of the RECURSIVE tag. 860 | # The default value is: NO. 861 | 862 | EXAMPLE_RECURSIVE = NO 863 | 864 | # The IMAGE_PATH tag can be used to specify one or more files or directories 865 | # that contain images that are to be included in the documentation (see the 866 | # \image command). 867 | 868 | IMAGE_PATH = 869 | 870 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 871 | # invoke to filter for each input file. Doxygen will invoke the filter program 872 | # by executing (via popen()) the command: 873 | # 874 | # 875 | # 876 | # where is the value of the INPUT_FILTER tag, and is the 877 | # name of an input file. Doxygen will then use the output that the filter 878 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 879 | # will be ignored. 880 | # 881 | # Note that the filter must not add or remove lines; it is applied before the 882 | # code is scanned, but not when the output code is generated. If lines are added 883 | # or removed, the anchors will not be placed correctly. 884 | # 885 | # Note that for custom extensions or not directly supported extensions you also 886 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 887 | # properly processed by doxygen. 888 | 889 | INPUT_FILTER = 890 | 891 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 892 | # basis. Doxygen will compare the file name with each pattern and apply the 893 | # filter if there is a match. The filters are a list of the form: pattern=filter 894 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 895 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 896 | # patterns match the file name, INPUT_FILTER is applied. 897 | # 898 | # Note that for custom extensions or not directly supported extensions you also 899 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 900 | # properly processed by doxygen. 901 | 902 | FILTER_PATTERNS = *.cpp *.h *.ino 903 | 904 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 905 | # INPUT_FILTER) will also be used to filter the input files that are used for 906 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 907 | # The default value is: NO. 908 | 909 | FILTER_SOURCE_FILES = YES 910 | 911 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 912 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 913 | # it is also possible to disable source filtering for a specific pattern using 914 | # *.ext= (so without naming a filter). 915 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 916 | 917 | FILTER_SOURCE_PATTERNS = 918 | 919 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 920 | # is part of the input, its contents will be placed on the main page 921 | # (index.html). This can be useful if you have a project on for instance GitHub 922 | # and want to reuse the introduction page also for the doxygen output. 923 | 924 | USE_MDFILE_AS_MAINPAGE = 925 | 926 | #--------------------------------------------------------------------------- 927 | # Configuration options related to source browsing 928 | #--------------------------------------------------------------------------- 929 | 930 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 931 | # generated. Documented entities will be cross-referenced with these sources. 932 | # 933 | # Note: To get rid of all source code in the generated output, make sure that 934 | # also VERBATIM_HEADERS is set to NO. 935 | # The default value is: NO. 936 | 937 | SOURCE_BROWSER = YES 938 | 939 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 940 | # classes and enums directly into the documentation. 941 | # The default value is: NO. 942 | 943 | INLINE_SOURCES = NO 944 | 945 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 946 | # special comment blocks from generated source code fragments. Normal C, C++ and 947 | # Fortran comments will always remain visible. 948 | # The default value is: YES. 949 | 950 | STRIP_CODE_COMMENTS = YES 951 | 952 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 953 | # function all documented functions referencing it will be listed. 954 | # The default value is: NO. 955 | 956 | REFERENCED_BY_RELATION = YES 957 | 958 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 959 | # all documented entities called/used by that function will be listed. 960 | # The default value is: NO. 961 | 962 | REFERENCES_RELATION = YES 963 | 964 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 965 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 966 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 967 | # link to the documentation. 968 | # The default value is: YES. 969 | 970 | REFERENCES_LINK_SOURCE = YES 971 | 972 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 973 | # source code will show a tooltip with additional information such as prototype, 974 | # brief description and links to the definition and documentation. Since this 975 | # will make the HTML file larger and loading of large files a bit slower, you 976 | # can opt to disable this feature. 977 | # The default value is: YES. 978 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 979 | 980 | SOURCE_TOOLTIPS = YES 981 | 982 | # If the USE_HTAGS tag is set to YES then the references to source code will 983 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 984 | # source browser. The htags tool is part of GNU's global source tagging system 985 | # (see http://www.gnu.org/software/global/global.html). You will need version 986 | # 4.8.6 or higher. 987 | # 988 | # To use it do the following: 989 | # - Install the latest version of global 990 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 991 | # - Make sure the INPUT points to the root of the source tree 992 | # - Run doxygen as normal 993 | # 994 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 995 | # tools must be available from the command line (i.e. in the search path). 996 | # 997 | # The result: instead of the source browser generated by doxygen, the links to 998 | # source code will now point to the output of htags. 999 | # The default value is: NO. 1000 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1001 | 1002 | USE_HTAGS = NO 1003 | 1004 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1005 | # verbatim copy of the header file for each class for which an include is 1006 | # specified. Set to NO to disable this. 1007 | # See also: Section \class. 1008 | # The default value is: YES. 1009 | 1010 | VERBATIM_HEADERS = YES 1011 | 1012 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1013 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1014 | # cost of reduced performance. This can be particularly helpful with template 1015 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1016 | # information. 1017 | # Note: The availability of this option depends on whether or not doxygen was 1018 | # generated with the -Duse-libclang=ON option for CMake. 1019 | # The default value is: NO. 1020 | 1021 | CLANG_ASSISTED_PARSING = NO 1022 | 1023 | # If clang assisted parsing is enabled you can provide the compiler with command 1024 | # line options that you would normally use when invoking the compiler. Note that 1025 | # the include paths will already be set by doxygen for the files and directories 1026 | # specified with INPUT and INCLUDE_PATH. 1027 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1028 | 1029 | CLANG_OPTIONS = 1030 | 1031 | #--------------------------------------------------------------------------- 1032 | # Configuration options related to the alphabetical class index 1033 | #--------------------------------------------------------------------------- 1034 | 1035 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1036 | # compounds will be generated. Enable this if the project contains a lot of 1037 | # classes, structs, unions or interfaces. 1038 | # The default value is: YES. 1039 | 1040 | ALPHABETICAL_INDEX = YES 1041 | 1042 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1043 | # which the alphabetical index list will be split. 1044 | # Minimum value: 1, maximum value: 20, default value: 5. 1045 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1046 | 1047 | COLS_IN_ALPHA_INDEX = 5 1048 | 1049 | # In case all classes in a project start with a common prefix, all classes will 1050 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1051 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1052 | # while generating the index headers. 1053 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1054 | 1055 | IGNORE_PREFIX = 1056 | 1057 | #--------------------------------------------------------------------------- 1058 | # Configuration options related to the HTML output 1059 | #--------------------------------------------------------------------------- 1060 | 1061 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1062 | # The default value is: YES. 1063 | 1064 | GENERATE_HTML = YES 1065 | 1066 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1067 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1068 | # it. 1069 | # The default directory is: html. 1070 | # This tag requires that the tag GENERATE_HTML is set to YES. 1071 | 1072 | HTML_OUTPUT = html 1073 | 1074 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1075 | # generated HTML page (for example: .htm, .php, .asp). 1076 | # The default value is: .html. 1077 | # This tag requires that the tag GENERATE_HTML is set to YES. 1078 | 1079 | HTML_FILE_EXTENSION = .html 1080 | 1081 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1082 | # each generated HTML page. If the tag is left blank doxygen will generate a 1083 | # standard header. 1084 | # 1085 | # To get valid HTML the header file that includes any scripts and style sheets 1086 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1087 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1088 | # default header using 1089 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1090 | # YourConfigFile 1091 | # and then modify the file new_header.html. See also section "Doxygen usage" 1092 | # for information on how to generate the default header that doxygen normally 1093 | # uses. 1094 | # Note: The header is subject to change so you typically have to regenerate the 1095 | # default header when upgrading to a newer version of doxygen. For a description 1096 | # of the possible markers and block names see the documentation. 1097 | # This tag requires that the tag GENERATE_HTML is set to YES. 1098 | 1099 | HTML_HEADER = 1100 | 1101 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1102 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1103 | # footer. See HTML_HEADER for more information on how to generate a default 1104 | # footer and what special commands can be used inside the footer. See also 1105 | # section "Doxygen usage" for information on how to generate the default footer 1106 | # that doxygen normally uses. 1107 | # This tag requires that the tag GENERATE_HTML is set to YES. 1108 | 1109 | HTML_FOOTER = 1110 | 1111 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1112 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1113 | # the HTML output. If left blank doxygen will generate a default style sheet. 1114 | # See also section "Doxygen usage" for information on how to generate the style 1115 | # sheet that doxygen normally uses. 1116 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1117 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1118 | # obsolete. 1119 | # This tag requires that the tag GENERATE_HTML is set to YES. 1120 | 1121 | HTML_STYLESHEET = 1122 | 1123 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1124 | # cascading style sheets that are included after the standard style sheets 1125 | # created by doxygen. Using this option one can overrule certain style aspects. 1126 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1127 | # standard style sheet and is therefore more robust against future updates. 1128 | # Doxygen will copy the style sheet files to the output directory. 1129 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1130 | # style sheet in the list overrules the setting of the previous ones in the 1131 | # list). For an example see the documentation. 1132 | # This tag requires that the tag GENERATE_HTML is set to YES. 1133 | 1134 | HTML_EXTRA_STYLESHEET = 1135 | 1136 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1137 | # other source files which should be copied to the HTML output directory. Note 1138 | # that these files will be copied to the base HTML output directory. Use the 1139 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1140 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1141 | # files will be copied as-is; there are no commands or markers available. 1142 | # This tag requires that the tag GENERATE_HTML is set to YES. 1143 | 1144 | HTML_EXTRA_FILES = 1145 | 1146 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1147 | # will adjust the colors in the style sheet and background images according to 1148 | # this color. Hue is specified as an angle on a colorwheel, see 1149 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1150 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1151 | # purple, and 360 is red again. 1152 | # Minimum value: 0, maximum value: 359, default value: 220. 1153 | # This tag requires that the tag GENERATE_HTML is set to YES. 1154 | 1155 | HTML_COLORSTYLE_HUE = 220 1156 | 1157 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1158 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1159 | # value of 255 will produce the most vivid colors. 1160 | # Minimum value: 0, maximum value: 255, default value: 100. 1161 | # This tag requires that the tag GENERATE_HTML is set to YES. 1162 | 1163 | HTML_COLORSTYLE_SAT = 100 1164 | 1165 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1166 | # luminance component of the colors in the HTML output. Values below 100 1167 | # gradually make the output lighter, whereas values above 100 make the output 1168 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1169 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1170 | # change the gamma. 1171 | # Minimum value: 40, maximum value: 240, default value: 80. 1172 | # This tag requires that the tag GENERATE_HTML is set to YES. 1173 | 1174 | HTML_COLORSTYLE_GAMMA = 80 1175 | 1176 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1177 | # page will contain the date and time when the page was generated. Setting this 1178 | # to YES can help to show when doxygen was last run and thus if the 1179 | # documentation is up to date. 1180 | # The default value is: NO. 1181 | # This tag requires that the tag GENERATE_HTML is set to YES. 1182 | 1183 | HTML_TIMESTAMP = NO 1184 | 1185 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1186 | # documentation will contain sections that can be hidden and shown after the 1187 | # page has loaded. 1188 | # The default value is: NO. 1189 | # This tag requires that the tag GENERATE_HTML is set to YES. 1190 | 1191 | HTML_DYNAMIC_SECTIONS = NO 1192 | 1193 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1194 | # shown in the various tree structured indices initially; the user can expand 1195 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1196 | # such a level that at most the specified number of entries are visible (unless 1197 | # a fully collapsed tree already exceeds this amount). So setting the number of 1198 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1199 | # representing an infinite number of entries and will result in a full expanded 1200 | # tree by default. 1201 | # Minimum value: 0, maximum value: 9999, default value: 100. 1202 | # This tag requires that the tag GENERATE_HTML is set to YES. 1203 | 1204 | HTML_INDEX_NUM_ENTRIES = 100 1205 | 1206 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1207 | # generated that can be used as input for Apple's Xcode 3 integrated development 1208 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1209 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1210 | # Makefile in the HTML output directory. Running make will produce the docset in 1211 | # that directory and running make install will install the docset in 1212 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1213 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1214 | # for more information. 1215 | # The default value is: NO. 1216 | # This tag requires that the tag GENERATE_HTML is set to YES. 1217 | 1218 | GENERATE_DOCSET = NO 1219 | 1220 | # This tag determines the name of the docset feed. A documentation feed provides 1221 | # an umbrella under which multiple documentation sets from a single provider 1222 | # (such as a company or product suite) can be grouped. 1223 | # The default value is: Doxygen generated docs. 1224 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1225 | 1226 | DOCSET_FEEDNAME = "Doxygen generated docs" 1227 | 1228 | # This tag specifies a string that should uniquely identify the documentation 1229 | # set bundle. This should be a reverse domain-name style string, e.g. 1230 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1231 | # The default value is: org.doxygen.Project. 1232 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1233 | 1234 | DOCSET_BUNDLE_ID = org.doxygen.Project 1235 | 1236 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1237 | # the documentation publisher. This should be a reverse domain-name style 1238 | # string, e.g. com.mycompany.MyDocSet.documentation. 1239 | # The default value is: org.doxygen.Publisher. 1240 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1241 | 1242 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1243 | 1244 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1245 | # The default value is: Publisher. 1246 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1247 | 1248 | DOCSET_PUBLISHER_NAME = Publisher 1249 | 1250 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1251 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1252 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1253 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1254 | # Windows. 1255 | # 1256 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1257 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1258 | # files are now used as the Windows 98 help format, and will replace the old 1259 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1260 | # HTML files also contain an index, a table of contents, and you can search for 1261 | # words in the documentation. The HTML workshop also contains a viewer for 1262 | # compressed HTML files. 1263 | # The default value is: NO. 1264 | # This tag requires that the tag GENERATE_HTML is set to YES. 1265 | 1266 | GENERATE_HTMLHELP = NO 1267 | 1268 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1269 | # file. You can add a path in front of the file if the result should not be 1270 | # written to the html output directory. 1271 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1272 | 1273 | CHM_FILE = 1274 | 1275 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1276 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1277 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1278 | # The file has to be specified with full path. 1279 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1280 | 1281 | HHC_LOCATION = 1282 | 1283 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1284 | # (YES) or that it should be included in the master .chm file (NO). 1285 | # The default value is: NO. 1286 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1287 | 1288 | GENERATE_CHI = NO 1289 | 1290 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1291 | # and project file content. 1292 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1293 | 1294 | CHM_INDEX_ENCODING = 1295 | 1296 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1297 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1298 | # enables the Previous and Next buttons. 1299 | # The default value is: NO. 1300 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1301 | 1302 | BINARY_TOC = NO 1303 | 1304 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1305 | # the table of contents of the HTML help documentation and to the tree view. 1306 | # The default value is: NO. 1307 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1308 | 1309 | TOC_EXPAND = NO 1310 | 1311 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1312 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1313 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1314 | # (.qch) of the generated HTML documentation. 1315 | # The default value is: NO. 1316 | # This tag requires that the tag GENERATE_HTML is set to YES. 1317 | 1318 | GENERATE_QHP = NO 1319 | 1320 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1321 | # the file name of the resulting .qch file. The path specified is relative to 1322 | # the HTML output folder. 1323 | # This tag requires that the tag GENERATE_QHP is set to YES. 1324 | 1325 | QCH_FILE = 1326 | 1327 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1328 | # Project output. For more information please see Qt Help Project / Namespace 1329 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1330 | # The default value is: org.doxygen.Project. 1331 | # This tag requires that the tag GENERATE_QHP is set to YES. 1332 | 1333 | QHP_NAMESPACE = org.doxygen.Project 1334 | 1335 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1336 | # Help Project output. For more information please see Qt Help Project / Virtual 1337 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1338 | # folders). 1339 | # The default value is: doc. 1340 | # This tag requires that the tag GENERATE_QHP is set to YES. 1341 | 1342 | QHP_VIRTUAL_FOLDER = doc 1343 | 1344 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1345 | # filter to add. For more information please see Qt Help Project / Custom 1346 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1347 | # filters). 1348 | # This tag requires that the tag GENERATE_QHP is set to YES. 1349 | 1350 | QHP_CUST_FILTER_NAME = 1351 | 1352 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1353 | # custom filter to add. For more information please see Qt Help Project / Custom 1354 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1355 | # filters). 1356 | # This tag requires that the tag GENERATE_QHP is set to YES. 1357 | 1358 | QHP_CUST_FILTER_ATTRS = 1359 | 1360 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1361 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1362 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1363 | # This tag requires that the tag GENERATE_QHP is set to YES. 1364 | 1365 | QHP_SECT_FILTER_ATTRS = 1366 | 1367 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1368 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1369 | # generated .qhp file. 1370 | # This tag requires that the tag GENERATE_QHP is set to YES. 1371 | 1372 | QHG_LOCATION = 1373 | 1374 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1375 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1376 | # install this plugin and make it available under the help contents menu in 1377 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1378 | # to be copied into the plugins directory of eclipse. The name of the directory 1379 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1380 | # After copying Eclipse needs to be restarted before the help appears. 1381 | # The default value is: NO. 1382 | # This tag requires that the tag GENERATE_HTML is set to YES. 1383 | 1384 | GENERATE_ECLIPSEHELP = NO 1385 | 1386 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1387 | # the directory name containing the HTML and XML files should also have this 1388 | # name. Each documentation set should have its own identifier. 1389 | # The default value is: org.doxygen.Project. 1390 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1391 | 1392 | ECLIPSE_DOC_ID = org.doxygen.Project 1393 | 1394 | # If you want full control over the layout of the generated HTML pages it might 1395 | # be necessary to disable the index and replace it with your own. The 1396 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1397 | # of each HTML page. A value of NO enables the index and the value YES disables 1398 | # it. Since the tabs in the index contain the same information as the navigation 1399 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1400 | # The default value is: NO. 1401 | # This tag requires that the tag GENERATE_HTML is set to YES. 1402 | 1403 | DISABLE_INDEX = NO 1404 | 1405 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1406 | # structure should be generated to display hierarchical information. If the tag 1407 | # value is set to YES, a side panel will be generated containing a tree-like 1408 | # index structure (just like the one that is generated for HTML Help). For this 1409 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1410 | # (i.e. any modern browser). Windows users are probably better off using the 1411 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1412 | # further fine-tune the look of the index. As an example, the default style 1413 | # sheet generated by doxygen has an example that shows how to put an image at 1414 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1415 | # the same information as the tab index, you could consider setting 1416 | # DISABLE_INDEX to YES when enabling this option. 1417 | # The default value is: NO. 1418 | # This tag requires that the tag GENERATE_HTML is set to YES. 1419 | 1420 | GENERATE_TREEVIEW = NO 1421 | 1422 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1423 | # doxygen will group on one line in the generated HTML documentation. 1424 | # 1425 | # Note that a value of 0 will completely suppress the enum values from appearing 1426 | # in the overview section. 1427 | # Minimum value: 0, maximum value: 20, default value: 4. 1428 | # This tag requires that the tag GENERATE_HTML is set to YES. 1429 | 1430 | ENUM_VALUES_PER_LINE = 4 1431 | 1432 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1433 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1434 | # Minimum value: 0, maximum value: 1500, default value: 250. 1435 | # This tag requires that the tag GENERATE_HTML is set to YES. 1436 | 1437 | TREEVIEW_WIDTH = 250 1438 | 1439 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1440 | # external symbols imported via tag files in a separate window. 1441 | # The default value is: NO. 1442 | # This tag requires that the tag GENERATE_HTML is set to YES. 1443 | 1444 | EXT_LINKS_IN_WINDOW = NO 1445 | 1446 | # Use this tag to change the font size of LaTeX formulas included as images in 1447 | # the HTML documentation. When you change the font size after a successful 1448 | # doxygen run you need to manually remove any form_*.png images from the HTML 1449 | # output directory to force them to be regenerated. 1450 | # Minimum value: 8, maximum value: 50, default value: 10. 1451 | # This tag requires that the tag GENERATE_HTML is set to YES. 1452 | 1453 | FORMULA_FONTSIZE = 10 1454 | 1455 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1456 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1457 | # supported properly for IE 6.0, but are supported on all modern browsers. 1458 | # 1459 | # Note that when changing this option you need to delete any form_*.png files in 1460 | # the HTML output directory before the changes have effect. 1461 | # The default value is: YES. 1462 | # This tag requires that the tag GENERATE_HTML is set to YES. 1463 | 1464 | FORMULA_TRANSPARENT = YES 1465 | 1466 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1467 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1468 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1469 | # installed or if you want to formulas look prettier in the HTML output. When 1470 | # enabled you may also need to install MathJax separately and configure the path 1471 | # to it using the MATHJAX_RELPATH option. 1472 | # The default value is: NO. 1473 | # This tag requires that the tag GENERATE_HTML is set to YES. 1474 | 1475 | USE_MATHJAX = NO 1476 | 1477 | # When MathJax is enabled you can set the default output format to be used for 1478 | # the MathJax output. See the MathJax site (see: 1479 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1480 | # Possible values are: HTML-CSS (which is slower, but has the best 1481 | # compatibility), NativeMML (i.e. MathML) and SVG. 1482 | # The default value is: HTML-CSS. 1483 | # This tag requires that the tag USE_MATHJAX is set to YES. 1484 | 1485 | MATHJAX_FORMAT = HTML-CSS 1486 | 1487 | # When MathJax is enabled you need to specify the location relative to the HTML 1488 | # output directory using the MATHJAX_RELPATH option. The destination directory 1489 | # should contain the MathJax.js script. For instance, if the mathjax directory 1490 | # is located at the same level as the HTML output directory, then 1491 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1492 | # Content Delivery Network so you can quickly see the result without installing 1493 | # MathJax. However, it is strongly recommended to install a local copy of 1494 | # MathJax from http://www.mathjax.org before deployment. 1495 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1496 | # This tag requires that the tag USE_MATHJAX is set to YES. 1497 | 1498 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1499 | 1500 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1501 | # extension names that should be enabled during MathJax rendering. For example 1502 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1503 | # This tag requires that the tag USE_MATHJAX is set to YES. 1504 | 1505 | MATHJAX_EXTENSIONS = 1506 | 1507 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1508 | # of code that will be used on startup of the MathJax code. See the MathJax site 1509 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1510 | # example see the documentation. 1511 | # This tag requires that the tag USE_MATHJAX is set to YES. 1512 | 1513 | MATHJAX_CODEFILE = 1514 | 1515 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1516 | # the HTML output. The underlying search engine uses javascript and DHTML and 1517 | # should work on any modern browser. Note that when using HTML help 1518 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1519 | # there is already a search function so this one should typically be disabled. 1520 | # For large projects the javascript based search engine can be slow, then 1521 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1522 | # search using the keyboard; to jump to the search box use + S 1523 | # (what the is depends on the OS and browser, but it is typically 1524 | # , /