├── README.md ├── examples ├── FrskySP_airspeed_sensor_eagletree │ └── FrskySP_airspeed_sensor_eagletree.ino ├── FrskySP_rpm_sensor_freqcount │ ├── EagleTree_RPM_sensors.fzz │ ├── EagleTree_RPM_sensors_bb.png │ └── FrskySP_rpm_sensor_freqcount.ino ├── FrskySP_rpm_sensor_interrupt │ ├── EagleTree_RPM_sensors.fzz │ ├── EagleTree_RPM_sensors_bb.png │ ├── FrskySP_rpm_sensor_interrupt.ino │ └── Gas RPM sensor.fzz ├── FrskySP_sensor_demo │ └── FrskySP_sensor_demo.ino └── FrskySP_sniffer │ └── FrskySP_sniffer.ino ├── extras └── LICENSE.txt ├── library.properties └── src ├── Doxyfile ├── FrskySP.cpp └── FrskySP.h /README.md: -------------------------------------------------------------------------------- 1 | # arduino-frskysp 2 | FrskySP (SmartPort) protocol library for Arduino - Arduino 1.5 compliant repository of [frsky-arduino](https://github.com/jcheger/frsky-arduino) 3 | 4 | This library is in beta stage. All known sensors were tested and seem to work. 5 | 6 | # documentation 7 | Documentation was removed out of the repository. It is available on: https://www.ordinoscope.net/static/arduino-frskysp/docs/html/ 8 | 9 | You can also build it this way (must install doxygen obviously) 10 | 11 | ````sh 12 | cd src 13 | doxygen 14 | ```` 15 | 16 | The documentation will be built in "docs", at the root of the library. 17 | -------------------------------------------------------------------------------- /examples/FrskySP_airspeed_sensor_eagletree/FrskySP_airspeed_sensor_eagletree.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * This code is not ready for production yet ! 3 | * 4 | * Pinout 5 | * ------ 6 | * Red - VCC (3-16V) 7 | * White - GND 8 | * Yellow - SDA 9 | * Brown - SCL 10 | * 11 | * Remarks 12 | * ------- 13 | * The Wire library is not really respective of the standards, and there is no popular replacement of it. 14 | * Anyway it works with the EagleTree sensors. The Wire.begin function enables the internal pull-ups, so 15 | * the is no need to add some external ones. 16 | * 17 | * Documentation 18 | * ------------- 19 | * http://www.eagletreesystems.com/Manuals/microsensor-i2c.pdf 20 | * 21 | * 22 | * origin: https://github.com/jcheger/frsky-arduino 23 | * author: Jean-Christophe Heger 24 | */ 25 | 26 | #include 27 | #include 28 | #include 29 | #include 30 | 31 | #define ASP_V3 0xEA >> 1 32 | 33 | FrskySP FrskySP (10); 34 | 35 | void setup () { 36 | Serial.begin (115200); 37 | Serial.println ("BEGIN"); 38 | 39 | Wire.begin(); 40 | } 41 | 42 | void loop () { 43 | static float mph = 0; 44 | static unsigned long sensor_millis = millis (); 45 | 46 | if ((millis() - sensor_millis) >= 100) { 47 | mph = read_sensor (ASP_V3); // In third party I2C mode, the airspeed sensor returns mph 48 | sensor_millis = millis (); 49 | Serial.println (mph); 50 | } 51 | 52 | while (FrskySP.available ()) { 53 | 54 | if (FrskySP.read () == 0x7E) { 55 | 56 | while (!FrskySP.available ()); // wait for the next byte 57 | 58 | switch (FrskySP.read ()) { 59 | 60 | case 0x67: // Physical ID 7 61 | /* 62 | * The is a little drift on OpenTX, that was discussed here: 63 | * https://github.com/opentx/opentx/issues/1422 64 | * 65 | * Although, the value will be recored correctly, as so in Companion. 66 | * Don't try to resolve the shown value on the transmitter if you want 67 | * to rely on the logged values. 68 | * 69 | * real conversion | value shown OpenTX 70 | * -------------------------|---------------------- 71 | * 1 mph = 1.15077945 knots | 23 / 20 = 1.15 (up to 2.0.5: 31 / 27 = 1.148148148) 72 | * 1 kph = 1.852 knots | 50 / 27 = 1.851851852 73 | */ 74 | FrskySP.sendData (FRSKY_SP_AIR_SPEED, mph * 10 / 1.15077945 + 0.5); 75 | break; 76 | } 77 | } 78 | } 79 | } 80 | 81 | /* 82 | * Airspeed sensor answers in 756 us 83 | */ 84 | int16_t read_sensor (int16_t id) { 85 | int16_t raw; 86 | 87 | Wire.beginTransmission (ASP_V3); 88 | Wire.write (0x07); 89 | Wire.endTransmission (); 90 | 91 | Wire.beginTransmission (ASP_V3); 92 | Wire.requestFrom (ASP_V3, 2); 93 | if (Wire.available ()) raw = Wire.read (); 94 | else Serial.println ("ERROR on byte 1"); 95 | 96 | if (Wire.available ()) raw |= (int) Wire.read () << 8; 97 | else Serial.println ("ERROR on byte 2"); 98 | Wire.endTransmission (); 99 | 100 | return raw; 101 | } 102 | 103 | -------------------------------------------------------------------------------- /examples/FrskySP_rpm_sensor_freqcount/EagleTree_RPM_sensors.fzz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jcheger/arduino-frskysp/dd764398f74bef561d9d1c00c6c4baa77ad612c0/examples/FrskySP_rpm_sensor_freqcount/EagleTree_RPM_sensors.fzz -------------------------------------------------------------------------------- /examples/FrskySP_rpm_sensor_freqcount/EagleTree_RPM_sensors_bb.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jcheger/arduino-frskysp/dd764398f74bef561d9d1c00c6c4baa77ad612c0/examples/FrskySP_rpm_sensor_freqcount/EagleTree_RPM_sensors_bb.png -------------------------------------------------------------------------------- /examples/FrskySP_rpm_sensor_freqcount/FrskySP_rpm_sensor_freqcount.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * RPM sensor for Frsky Smart Port protocol. 3 | * 4 | * Requirements 5 | * ------------ 6 | * - FrskySP library: https://github.com/jcheger/frsky-arduino 7 | * - FreqCount library: https://www.pjrc.com/teensy/td_libs_FreqCount.html 8 | * 9 | * The RPM pin is 5 and cannot be changed (defined by the FreqCount library). The RPMs are refreshed once per second. 10 | * 11 | * See the the images in the example folder to see the pinout. 12 | * 13 | * EagleTree sensors 14 | * ----------------- 15 | * Be very cautious, the pinout is not standard ! Any mistake will make the optical sensor to blow up instantly ! 16 | * - red: GND !!! 17 | * - black: VCC for optical sensor IR LED. Must have a 100 Ω @ 5V. No more, no less. 18 | * - white: Signal. Must have a pull-up resistor (see below) 19 | * 20 | * Tests with: 21 | * - EagleTree Brushless RPM Sensor V2 - pull-up: 1 kΩ 22 | * - EagleTree Optical RPM Sensor - pull-up: 10 kΩ 23 | * - EagleTree Hall RPM Sensor - pull-up: 1 kΩ or 10 kΩ 24 | * 25 | * 26 | * origin: https://github.com/jcheger/frsky-arduino 27 | * author: Jean-Christophe Heger 28 | */ 29 | 30 | #include 31 | #include 32 | #include 33 | 34 | // Use DEBUG 1 to compile the serial debug support 35 | #define DEBUG 1 36 | 37 | FrskySP FrskySP (10); 38 | 39 | /* 40 | * This is the ratio between the sensor and the final stage. 41 | * - if the sensor is measuring the final stage, the ratio is oviously 1.0 42 | * - if the ratio is an integer, you may cheat by declaring the ratio as the number of blades in OpenTX (up to 102) 43 | * - if the ratio is a float (reducer, helicopter), you will have to modify this value 44 | */ 45 | float rpm_ratio = 1.0; 46 | 47 | void setup () { 48 | #if DEBUG 49 | Serial.begin (115200); 50 | Serial.println ("FrskySP rpm sensor freqcount"); 51 | #endif 52 | FreqCount.begin(1000); 53 | } 54 | 55 | void loop () { 56 | static unsigned int i = 0; 57 | 58 | static unsigned long rpm_freq = 0; 59 | uint32_t rpm_send = 0; 60 | 61 | while (FrskySP.available ()) { 62 | 63 | if (FrskySP.read () == 0x7E) { 64 | 65 | while (!FrskySP.available ()); // wait for the next byte 66 | 67 | switch (FrskySP.read ()) { 68 | 69 | case 0xE4: 70 | rpm_freq = FreqCount.read(); 71 | // The brushless sensor triggers 1~10 pulses per second when no RPM is detected. Erase them. 72 | rpm_send = (rpm_freq > 10) ? rpm_freq * 60.0 / rpm_ratio : 0; 73 | #if DEBUG 74 | Serial.print ("rpm_freq: "); 75 | Serial.print (rpm_freq); 76 | Serial.print (", rpm_send: "); 77 | Serial.println (rpm_send); 78 | #endif 79 | FrskySP.sendData (FRSKY_SP_RPM, rpm_send); 80 | break; 81 | } 82 | } 83 | } 84 | } 85 | 86 | -------------------------------------------------------------------------------- /examples/FrskySP_rpm_sensor_interrupt/EagleTree_RPM_sensors.fzz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jcheger/arduino-frskysp/dd764398f74bef561d9d1c00c6c4baa77ad612c0/examples/FrskySP_rpm_sensor_interrupt/EagleTree_RPM_sensors.fzz -------------------------------------------------------------------------------- /examples/FrskySP_rpm_sensor_interrupt/EagleTree_RPM_sensors_bb.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jcheger/arduino-frskysp/dd764398f74bef561d9d1c00c6c4baa77ad612c0/examples/FrskySP_rpm_sensor_interrupt/EagleTree_RPM_sensors_bb.png -------------------------------------------------------------------------------- /examples/FrskySP_rpm_sensor_interrupt/FrskySP_rpm_sensor_interrupt.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * RPM sensor for Frsky Smart Port protocol. 3 | * 4 | * The RPM pin is 2 and cannot be changed (interrupt 0). The RPMs is refreshed once per second. 5 | * 6 | * Requirements 7 | * ------------ 8 | * - FrskySP library: https://github.com/jcheger/frsky-arduino 9 | * 10 | * See the the images in the example folder to see the pinout. 11 | * 12 | * EagleTree sensors 13 | * ----------------- 14 | * Be very cautious, the pinout is not standard ! Any mistake will make the optical sensor to blow up instantly ! 15 | * - red: GND !!! 16 | * - black: VCC for optical sensor IR LED. Must have a 100 Ω @ 5V. No more, no less. 17 | * - white: Signal. Must have a pull-up resistor (see below) 18 | * 19 | * Tests with: 20 | * - EagleTree Brushless RPM Sensor V2 - pull-up: 1 kΩ 21 | * - EagleTree Optical RPM Sensor - pull-up: 10 kΩ 22 | * - EagleTree Hall RPM Sensor - pull-up: 1 kΩ or 10 kΩ 23 | * 24 | * 25 | * origin: https://github.com/jcheger/frsky-arduino 26 | * author: Jean-Christophe Heger 27 | */ 28 | 29 | #include 30 | #include 31 | 32 | // Use DEBUG 1 to compile the serial debug support 33 | #define DEBUG 1 34 | 35 | FrskySP FrskySP (10); 36 | 37 | unsigned long rpm_count = 0; 38 | unsigned long rpm_micros = micros (); 39 | 40 | /* 41 | * This is the ratio between the sensor and the final stage. 42 | * - if the sensor is measuring the final stage, the ratio is oviously 1.0 43 | * - if the ratio is an integer, you may cheat by declaring the ratio as the number of blades in OpenTX (up to 102) 44 | * - if the ratio is a float (reducer, helicopter), you will have to modify this value 45 | */ 46 | float rpm_ratio = 1.0; 47 | 48 | void setup () { 49 | #if DEBUG 50 | Serial.begin (115200); 51 | Serial.println ("FrskySP rpm sensor interrupt"); 52 | #endif 53 | 54 | attachInterrupt (0, rpmISR, FALLING); 55 | } 56 | 57 | void loop () { 58 | static unsigned int i = 0; 59 | 60 | static float rpm_freq = 0; 61 | float rpm_period = 0; 62 | static uint32_t rpm_send = 0; 63 | 64 | rpm_period = (micros () - rpm_micros) / 1000000; 65 | if (rpm_period >= 1) { 66 | rpm_freq = rpm_count / rpm_period; 67 | // The brushless sensor triggers 1~10 pulses per second when no RPM is detected. Erase them. 68 | rpm_send = (rpm_freq > 10) ? rpm_freq * 60 / rpm_ratio : 0; 69 | rpm_micros = micros (); 70 | rpm_count = 0; 71 | } 72 | 73 | while (FrskySP.available ()) { 74 | 75 | if (FrskySP.read () == 0x7E) { 76 | 77 | while (!FrskySP.available ()); // wait for the next byte 78 | 79 | switch (FrskySP.read ()) { 80 | 81 | case 0xE4: 82 | #if DEBUG 83 | Serial.print ("rpm_freq: "); 84 | Serial.print (rpm_freq); 85 | Serial.print (", rpm_out: "); 86 | Serial.print (rpm_send); 87 | Serial.print (", rpm_send: "); 88 | Serial.println (rpm_send); 89 | #endif 90 | 91 | FrskySP.sendData (FRSKY_SP_RPM, rpm_send); 92 | break; 93 | } 94 | } 95 | } 96 | } 97 | 98 | void rpmISR () { 99 | rpm_count++; 100 | } 101 | -------------------------------------------------------------------------------- /examples/FrskySP_rpm_sensor_interrupt/Gas RPM sensor.fzz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jcheger/arduino-frskysp/dd764398f74bef561d9d1c00c6c4baa77ad612c0/examples/FrskySP_rpm_sensor_interrupt/Gas RPM sensor.fzz -------------------------------------------------------------------------------- /examples/FrskySP_sensor_demo/FrskySP_sensor_demo.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * Requirements 3 | * ------------ 4 | * - FrskySP library - https://github.com/jcheger/frsky-arduino 5 | * - Recent version of Arduino's IDE (ex. 1.6.1), else SoftwareSerial will fail at 57600 bds. 6 | * 7 | * origin: https://github.com/jcheger/frsky-arduino 8 | * author: Jean-Christophe Heger 9 | */ 10 | 11 | #include 12 | #include 13 | 14 | FrskySP FrskySP (10); 15 | 16 | void setup () { 17 | FrskySP.ledSet (13); 18 | } 19 | 20 | void loop () { 21 | // increment used when several values must be sent within the same physical ID - only one per cycle 22 | static unsigned int i[29] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}; 23 | 24 | while (FrskySP.available ()) { 25 | 26 | if (FrskySP.read () == 0x7E) { 27 | while (!FrskySP.available ()); // wait for the next byte 28 | switch (FrskySP.read ()) { 29 | 30 | case 0x00: // Physical ID 1 - Vario2 (altimeter high precision) 31 | FrskySP.sendData (FRSKY_SP_ALT, 222.2 * 100); // 222.2m - warning: OpenTX will automatically apply an auto offset at detection (can be disabled) 32 | i[1]++; 33 | break; 34 | 35 | case 0xA1: // Physical ID 2 - FLVSS Lipo sensor (can be sent with one or two cell voltages) 36 | // 1st FLVSS 37 | if (i[2] % 6 == 0) FrskySP.sendData (FRSKY_SP_CELLS, FrskySP.lipoCell (0, 3.50, 3.51)); 38 | if (i[2] % 6 == 1) FrskySP.sendData (FRSKY_SP_CELLS, FrskySP.lipoCell (2, 3.52, 3.53)); 39 | if (i[2] % 6 == 2) FrskySP.sendData (FRSKY_SP_CELLS, FrskySP.lipoCell (4, 3.54, 3.55)); 40 | 41 | // 2nd FLVSS by using logical ID + 1 - could use another physical ID as well 42 | if (i[3] % 6 == 3) FrskySP.sendData (FRSKY_SP_CELLS+1, FrskySP.lipoCell (0, 3.56, 3.57)); 43 | if (i[3] % 6 == 4) FrskySP.sendData (FRSKY_SP_CELLS+1, FrskySP.lipoCell (2, 3.58, 3.59)); 44 | if (i[3] % 6 == 5) FrskySP.sendData (FRSKY_SP_CELLS+1, FrskySP.lipoCell (4, 3.60, 3.61)); 45 | 46 | i[2]++; 47 | break; 48 | 49 | case 0x22: // Physical ID 3 - FAS-40S current sensor 50 | if (i[3] % 2 == 0) FrskySP.sendData (FRSKY_SP_CURR, 11.5 * 10); // 11.5A 51 | if (i[3] % 2 == 1) FrskySP.sendData (FRSKY_SP_VFAS, 22.22 * 100); // 22.22V 52 | i[3]++; 53 | break; 54 | 55 | case 0x83: // Physical ID 4 - GPS / altimeter (normal precision) 56 | if (i[4] % 3 == 0) FrskySP.sendData (FRSKY_SP_GPS_ALT, 234.5 * 100); // 234.5m 57 | if (i[4] % 3 == 1) FrskySP.sendData (FRSKY_SP_GPS_SPEED, (float) 100 / 1.852 * 1000); // 53.9 kts, 99.9 km/h 58 | if (i[4] % 3 == 2) FrskySP.sendData (FRSKY_SP_ALT, 111.1 * 100); // 111.1m - warning: OpenTX will automatically apply an auto offset at detection (can be disabled) 59 | i[4]++; 60 | break; 61 | 62 | case 0xE4: // Physical ID 5 - RPM 63 | FrskySP.sendData (FRSKY_SP_RPM, 11111); // 11111 rpm 64 | i[5]++; 65 | break; 66 | 67 | case 0x45: // Physical ID 6 - SP2UART(Host) 68 | if (i[6] % 3 == 0) FrskySP.sendData (FRSKY_SP_A2, 1.1 * 10); // 0.6 V - set ratio to « - » to get the correct value (one decimal precision only) 69 | if (i[6] % 3 == 1) FrskySP.sendData (FRSKY_SP_A3, 11.11 * 100); // 11.11 V 70 | if (i[6] % 3 == 2) FrskySP.sendData (FRSKY_SP_A4, 111.11 * 100); // 111.11 V 71 | i[6]++; 72 | break; 73 | 74 | case 0xC6: // Physical ID 7 - SPUART(Remote) 75 | i[7]++; 76 | break; 77 | 78 | case 0x67: // Physical ID 8 - 79 | i[8]++; 80 | break; 81 | 82 | case 0x48: // Physical ID 9 - 83 | i[9]++; 84 | break; 85 | 86 | case 0xE9: // Physical ID 10 - 87 | i[10]++; 88 | break; 89 | 90 | case 0x6A: // Physical ID 11 - 91 | i[11]++; 92 | break; 93 | 94 | case 0xCB: // Physical ID 12 - 95 | i[12]++; 96 | break; 97 | 98 | case 0xAC: // Physical ID 13 - 99 | i[13]++; 100 | break; 101 | 102 | case 0x0D: // Physical ID 14 - 103 | i[14]++; 104 | break; 105 | 106 | case 0x8E: // Physical ID 15 - 107 | i[15]++; 108 | break; 109 | 110 | case 0x2F: // Physical ID 16 - 111 | i[16]++; 112 | break; 113 | 114 | case 0xD0: // Physical ID 17 - 115 | i[17]++; 116 | break; 117 | 118 | case 0x71: // Physical ID 18 - 119 | i[18]++; 120 | break; 121 | 122 | case 0xF2: // Physical ID 19 - 123 | i[19]++; 124 | break; 125 | 126 | case 0x53: // Physical ID 20 - 127 | i[20]++; 128 | break; 129 | 130 | case 0x34: // Physical ID 21 - 131 | i[21]++; 132 | break; 133 | 134 | case 0x95: // Physical ID 22 - 135 | i[22]++; 136 | break; 137 | 138 | case 0x16: // Physical ID 23 - 139 | i[23]++; 140 | break; 141 | 142 | case 0xB7: // Physical ID 24 - 143 | if (i[24] % 3 == 0) FrskySP.sendData (FRSKY_SP_ACCX, 1.11 * 100); // 1.11g 144 | if (i[24] % 3 == 1) FrskySP.sendData (FRSKY_SP_ACCY, -2.22 * 100); // -2.22g 145 | if (i[24] % 3 == 2) FrskySP.sendData (FRSKY_SP_ACCZ, 3.33 * 100); // 3.33g 146 | i[24]++; 147 | break; 148 | 149 | case 0x98: // Physical ID 25 - 150 | i[25]++; 151 | break; 152 | 153 | case 0x39: // Physical ID 26 - Power Box 154 | i[26]++; 155 | break; 156 | 157 | case 0xBA: // Physical ID 27 - 158 | if (i[27] % 2 == 0) FrskySP.sendData (FRSKY_SP_T1, 28); // 28 °C 159 | if (i[27] % 2 == 1) FrskySP.sendData (FRSKY_SP_T2, 18); // 18 °C 160 | i[27]++; 161 | break; 162 | 163 | case 0x1B: // Physical ID 28 - 164 | if (i[28] % 2 == 0) FrskySP.sendData (FRSKY_SP_FUEL, 41); // 41% 165 | if (i[28] % 2 == 1) FrskySP.sendData (FRSKY_SP_FUEL_QTY, 14 * 100); // 14 ml 166 | i[28]++; 167 | break; 168 | } 169 | } 170 | } 171 | } 172 | -------------------------------------------------------------------------------- /examples/FrskySP_sniffer/FrskySP_sniffer.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * origin: https://github.com/jcheger/frsky-arduino 3 | * author: Jean-Christophe Heger 4 | */ 5 | #include 6 | #include 7 | #include 8 | 9 | FrskySP FrskySP (10); 10 | 11 | /* 12 | * Physical IDs + CRC 13 | */ 14 | uint8_t ids[28] = {0x00,0xA1,0x22,0x83,0xE4,0x45,0xC6,0x67,0x48,0xE9,0x6A,0xCB,0xAC,0x0D,0x8E,0x2F,0xD0,0x71,0xF2,0x53,0x34,0x95,0x16,0xB7,0x98,0x39,0xBA,0x1B}; 15 | 16 | void setup () { 17 | Serial.begin (115200); 18 | Serial.println ("FrSky Smart Port active sniffer"); 19 | } 20 | 21 | void loop () { 22 | static int i = 0; 23 | 24 | union packet_tag { 25 | uint8_t byte[8]; 26 | uint64_t uint64; 27 | } packet; 28 | 29 | packet.uint64 = 0; 30 | 31 | FrskySP.write (0x7E); 32 | FrskySP.write (ids[i]); 33 | 34 | Serial << "(" << i << ") " << _HEX(0x7E) << " " << _HEX(ids[i]) << " - "; 35 | 36 | delay (11); // wait for 11ms 37 | 38 | if (FrskySP.available () == 8) { 39 | Serial << "sensor found - "; 40 | for (int j=0; j<=7; j++) { 41 | packet.byte[j] = FrskySP.read (); 42 | Serial << _HEX(packet.byte[j]) << " "; 43 | } 44 | Serial << endl; 45 | decode (packet.byte); 46 | } else if (FrskySP.available () > 8) { 47 | Serial << "buffer overflow (" << FrskySP.available () << ") - too many sensors on the same physical ID ?" << endl; 48 | } else if (FrskySP.available () == 0) { 49 | //Serial << "no sensor" << endl; 50 | } else { 51 | Serial << "buffer underflow - sensor too slow ?" << endl; 52 | } 53 | 54 | while (FrskySP.available ()) { 55 | Serial << FrskySP.read (); 56 | } 57 | Serial << endl; 58 | 59 | i++; 60 | if (i >= sizeof (ids)) i = 0; 61 | delay (100); 62 | } 63 | 64 | void decode (byte *packet) { 65 | uint16_t lid = packet[2] << 8 | packet[1]; 66 | //uint32_t val = packet[6] << 24 | packet[5] << 16 | packet[4] << 8 | packet[3]; 67 | uint32_t val = packet[3] << 24 | packet[4] << 16 | packet[5] << 8 | packet[6]; 68 | 69 | switch (lid & 0xfff0) { 70 | case 0x0100: 71 | Serial << _HEX(lid) << " (Altitude): " << val << endl; 72 | break; 73 | case 0x0110: 74 | Serial << _HEX(lid) << " (Vario): " << val << endl; 75 | break; 76 | case 0x0200: 77 | Serial << _HEX(lid) << " (Current): " << val << endl; 78 | break; 79 | case 0x0210: 80 | Serial << _HEX(lid) << " (VFAS): " << val << endl; 81 | break; 82 | case 0x0300: 83 | Serial << _HEX(lid) << " (Lipo Cells): " << val << endl; 84 | break; 85 | case 0x0400: 86 | Serial << _HEX(lid) << " (Temp1): " << val << endl; 87 | break; 88 | case 0x0410: 89 | Serial << _HEX(lid) << " (Temp2): " << val << endl; 90 | break; 91 | case 0x0500: 92 | Serial << _HEX(lid) << " (RPM): " << val << endl; 93 | break; 94 | case 0x0600: 95 | Serial << _HEX(lid) << " (Fuel level): " << val << endl; 96 | break; 97 | case 0x0700: 98 | Serial << _HEX(lid) << " (AccX): " << val << endl; 99 | break; 100 | case 0x0710: 101 | Serial << _HEX(lid) << " (AccY): " << val << endl; 102 | break; 103 | case 0x0720: 104 | Serial << _HEX(lid) << " (AccZ): " << val << endl; 105 | break; 106 | case 0x0800: 107 | Serial << _HEX(lid) << " (GPS Long Lati): " << val << endl; 108 | break; 109 | case 0x0820: 110 | Serial << _HEX(lid) << " (GPS Altitude): " << val << endl; 111 | break; 112 | case 0x0830: 113 | Serial << _HEX(lid) << " (GPS Speed): " << val << endl; 114 | break; 115 | case 0x0840: 116 | Serial << _HEX(lid) << " (GPS Course): " << val << endl; 117 | break; 118 | case 0x0850: 119 | Serial << _HEX(lid) << " (GPS Date Time): " << val << endl; 120 | break; 121 | case 0x0900: 122 | Serial << _HEX(lid) << " (A3): " << val << endl; 123 | break; 124 | case 0x0910: 125 | Serial << _HEX(lid) << " (A4): " << val << endl; 126 | break; 127 | case 0x0a00: 128 | Serial << _HEX(lid) << " (Air Speed): " << val << endl; 129 | break; 130 | case 0xf100: 131 | switch (lid) { 132 | case 0xd101: 133 | Serial << _HEX(lid) << " (RSSI): " << endl; 134 | break; 135 | case 0xd102: 136 | Serial << _HEX(lid) << " (A1): " << endl; 137 | break; 138 | case 0xd103: 139 | Serial << _HEX(lid) << " (A2): " << endl; 140 | break; 141 | case 0xd104: 142 | Serial << _HEX(lid) << " (BATT): " << endl; 143 | break; 144 | case 0xd105: 145 | Serial << _HEX(lid) << " (SWR): " << endl; 146 | break; 147 | } 148 | break; 149 | } 150 | } 151 | 152 | -------------------------------------------------------------------------------- /extras/LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=FrskySP 2 | version=1.0 3 | author=Jean-Christophe Heger 4 | maintainer=Jean-Christophe Heger 5 | sentence=FrSky SP (Smart Port) protocol library 6 | paragraph=Talk with a FrSky SP (X Series) receiver 7 | category=Communication 8 | url=https://github.com/jcheger/arduino-frskysp 9 | architectures=avr 10 | -------------------------------------------------------------------------------- /src/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.7 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 = FrskySP 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 = "Frsky SmartPort protocol library" 48 | 49 | # With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50 | # the documentation. The maximum height of the logo should not exceed 55 pixels 51 | # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52 | # 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 = ../docs 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = "The $name class" \ 122 | "The $name widget" \ 123 | "The $name file" \ 124 | is \ 125 | provides \ 126 | specifies \ 127 | contains \ 128 | represents \ 129 | a \ 130 | an \ 131 | the 132 | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 | # doxygen will generate a detailed section even if there is only a brief 135 | # description. 136 | # The default value is: NO. 137 | 138 | ALWAYS_DETAILED_SEC = NO 139 | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 | # inherited members of a class in the documentation of that class as if those 142 | # members were ordinary class members. Constructors, destructors and assignment 143 | # operators of the base classes will not be shown. 144 | # The default value is: NO. 145 | 146 | INLINE_INHERITED_MEMB = NO 147 | 148 | # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 149 | # before files name in the file list and in the header files. If set to NO the 150 | # shortest path that makes the file name unique will be used 151 | # The default value is: YES. 152 | 153 | FULL_PATH_NAMES = YES 154 | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 | # Stripping is only done if one of the specified strings matches the left-hand 157 | # part of the path. The tag can be used to show relative paths in the file list. 158 | # If left blank the directory from which doxygen is run is used as the path to 159 | # strip. 160 | # 161 | # Note that you can specify absolute paths here, but also relative paths, which 162 | # will be relative from the directory where doxygen is started. 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 | 165 | STRIP_FROM_PATH = 166 | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 | # path mentioned in the documentation of a class, which tells the reader which 169 | # header file to include in order to use a class. If left blank only the name of 170 | # the header file containing the class definition is used. Otherwise one should 171 | # specify the list of include paths that are normally passed to the compiler 172 | # using the -I flag. 173 | 174 | STRIP_FROM_INC_PATH = 175 | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 | # less readable) file names. This can be useful is your file systems doesn't 178 | # support long names like on DOS, Mac, or CD-ROM. 179 | # The default value is: NO. 180 | 181 | SHORT_NAMES = NO 182 | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 | # first line (until the first dot) of a Javadoc-style comment as the brief 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 | # style comments (thus requiring an explicit @brief command for a brief 187 | # description.) 188 | # The default value is: NO. 189 | 190 | JAVADOC_AUTOBRIEF = NO 191 | 192 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193 | # line (until the first dot) of a Qt-style comment as the brief description. If 194 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195 | # requiring an explicit \brief command for a brief description.) 196 | # The default value is: NO. 197 | 198 | QT_AUTOBRIEF = NO 199 | 200 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202 | # a brief description. This used to be the default behavior. The new default is 203 | # to treat a multi-line C++ comment block as a detailed description. Set this 204 | # tag to YES if you prefer the old behavior instead. 205 | # 206 | # Note that setting this tag to YES also means that rational rose comments are 207 | # not recognized any more. 208 | # The default value is: NO. 209 | 210 | MULTILINE_CPP_IS_BRIEF = NO 211 | 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213 | # documentation from any documented member that it re-implements. 214 | # The default value is: YES. 215 | 216 | INHERIT_DOCS = YES 217 | 218 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 219 | # new page for each member. If set to NO, the documentation of a member will be 220 | # part of the file/class/namespace that contains it. 221 | # The default value is: NO. 222 | 223 | SEPARATE_MEMBER_PAGES = NO 224 | 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226 | # uses this value to replace tabs by spaces in code fragments. 227 | # Minimum value: 1, maximum value: 16, default value: 4. 228 | 229 | TAB_SIZE = 4 230 | 231 | # This tag can be used to specify a number of aliases that act as commands in 232 | # the documentation. An alias has the form: 233 | # name=value 234 | # For example adding 235 | # "sideeffect=@par Side Effects:\n" 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the 237 | # documentation, which will result in a user-defined paragraph with heading 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert 239 | # newlines. 240 | 241 | ALIASES = "ChangeLog=\xrefitem ChangeLogs \"ChangeLog\" \"ChangeLogs\" " 242 | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" 245 | # will allow you to use the command class in the itcl::class meaning. 246 | 247 | TCL_SUBST = 248 | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 | # only. Doxygen will then generate output that is more tailored for C. For 251 | # instance, some of the names that are used will be different. The list of all 252 | # members will be omitted, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_FOR_C = NO 256 | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 | # Python sources only. Doxygen will then generate output that is more tailored 259 | # for that language. For instance, namespaces will be presented as packages, 260 | # qualified scopes will look different, etc. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_OUTPUT_JAVA = NO 264 | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 | # sources. Doxygen will then generate output that is tailored for Fortran. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_FOR_FORTRAN = NO 270 | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 | # sources. Doxygen will then generate output that is tailored for VHDL. 273 | # The default value is: NO. 274 | 275 | OPTIMIZE_OUTPUT_VHDL = NO 276 | 277 | # Doxygen selects the parser to use depending on the extension of the files it 278 | # parses. With this tag you can assign which parser to use for a given 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it 280 | # using this tag. The format is ext=language, where ext is a file extension, and 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 | # 289 | # Note For files without extension you can use no_extension as a placeholder. 290 | # 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 | # the files are not read by doxygen. 293 | 294 | EXTENSION_MAPPING = 295 | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 | # according to the Markdown format, which allows for more readable 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 | # The output of markdown processing is further processed by doxygen, so you can 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 | # case of backward compatibilities issues. 302 | # The default value is: YES. 303 | 304 | MARKDOWN_SUPPORT = YES 305 | 306 | # When enabled doxygen tries to link words that correspond to documented 307 | # classes, or namespaces to their corresponding documentation. Such a link can 308 | # be prevented in individual cases by by putting a % sign in front of the word 309 | # or globally by setting AUTOLINK_SUPPORT to NO. 310 | # The default value is: YES. 311 | 312 | AUTOLINK_SUPPORT = YES 313 | 314 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 315 | # to include (a tag file for) the STL sources as input, then you should set this 316 | # tag to YES in order to let doxygen match functions declarations and 317 | # definitions whose arguments contain STL classes (e.g. func(std::string); 318 | # versus func(std::string) {}). This also make the inheritance and collaboration 319 | # diagrams that involve STL classes more complete and accurate. 320 | # The default value is: NO. 321 | 322 | BUILTIN_STL_SUPPORT = NO 323 | 324 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 325 | # enable parsing support. 326 | # The default value is: NO. 327 | 328 | CPP_CLI_SUPPORT = NO 329 | 330 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 331 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 332 | # will parse them like normal C++ but will assume all classes use public instead 333 | # of private inheritance when no explicit protection keyword is present. 334 | # The default value is: NO. 335 | 336 | SIP_SUPPORT = NO 337 | 338 | # For Microsoft's IDL there are propget and propput attributes to indicate 339 | # getter and setter methods for a property. Setting this option to YES will make 340 | # doxygen to replace the get and set methods by a property in the documentation. 341 | # This will only work if the methods are indeed getting or setting a simple 342 | # type. If this is not the case, or you want to show the methods anyway, you 343 | # should set this option to NO. 344 | # The default value is: YES. 345 | 346 | IDL_PROPERTY_SUPPORT = YES 347 | 348 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 349 | # tag is set to YES, then doxygen will reuse the documentation of the first 350 | # member in the group (if any) for the other members of the group. By default 351 | # all members of a group must be documented explicitly. 352 | # The default value is: NO. 353 | 354 | DISTRIBUTE_GROUP_DOC = NO 355 | 356 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 357 | # (for instance a group of public functions) to be put as a subgroup of that 358 | # type (e.g. under the Public Functions section). Set it to NO to prevent 359 | # subgrouping. Alternatively, this can be done per class using the 360 | # \nosubgrouping command. 361 | # The default value is: YES. 362 | 363 | SUBGROUPING = YES 364 | 365 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 366 | # are shown inside the group in which they are included (e.g. using \ingroup) 367 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 368 | # and RTF). 369 | # 370 | # Note that this feature does not work in combination with 371 | # SEPARATE_MEMBER_PAGES. 372 | # The default value is: NO. 373 | 374 | INLINE_GROUPED_CLASSES = NO 375 | 376 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 377 | # with only public data fields or simple typedef fields will be shown inline in 378 | # the documentation of the scope in which they are defined (i.e. file, 379 | # namespace, or group documentation), provided this scope is documented. If set 380 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 381 | # Man pages) or section (for LaTeX and RTF). 382 | # The default value is: NO. 383 | 384 | INLINE_SIMPLE_STRUCTS = NO 385 | 386 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 387 | # enum is documented as struct, union, or enum with the name of the typedef. So 388 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 389 | # with name TypeT. When disabled the typedef will appear as a member of a file, 390 | # namespace, or class. And the struct will be named TypeS. This can typically be 391 | # useful for C code in case the coding convention dictates that all compound 392 | # types are typedef'ed and only the typedef is referenced, never the tag name. 393 | # The default value is: NO. 394 | 395 | TYPEDEF_HIDES_STRUCT = NO 396 | 397 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 398 | # cache is used to resolve symbols given their name and scope. Since this can be 399 | # an expensive process and often the same symbol appears multiple times in the 400 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 401 | # doxygen will become slower. If the cache is too large, memory is wasted. The 402 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 403 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 404 | # symbols. At the end of a run doxygen will report the cache usage and suggest 405 | # the optimal cache size from a speed point of view. 406 | # Minimum value: 0, maximum value: 9, default value: 0. 407 | 408 | LOOKUP_CACHE_SIZE = 0 409 | 410 | #--------------------------------------------------------------------------- 411 | # Build related configuration options 412 | #--------------------------------------------------------------------------- 413 | 414 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 415 | # documentation are documented, even if no documentation was available. Private 416 | # class members and static file members will be hidden unless the 417 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 418 | # Note: This will also disable the warnings about undocumented members that are 419 | # normally produced when WARNINGS is set to YES. 420 | # The default value is: NO. 421 | 422 | EXTRACT_ALL = NO 423 | 424 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 425 | # be included in the documentation. 426 | # The default value is: NO. 427 | 428 | EXTRACT_PRIVATE = NO 429 | 430 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 431 | # scope will be included in the documentation. 432 | # The default value is: NO. 433 | 434 | EXTRACT_PACKAGE = NO 435 | 436 | # If the EXTRACT_STATIC tag is set to YES all static members of a file will be 437 | # included in the documentation. 438 | # The default value is: NO. 439 | 440 | EXTRACT_STATIC = NO 441 | 442 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 443 | # locally in source files will be included in the documentation. If set to NO 444 | # only classes defined in header files are included. Does not have any effect 445 | # for Java sources. 446 | # The default value is: YES. 447 | 448 | EXTRACT_LOCAL_CLASSES = YES 449 | 450 | # This flag is only useful for Objective-C code. When set to YES local methods, 451 | # which are defined in the implementation section but not in the interface are 452 | # included in the documentation. If set to NO only methods in the interface are 453 | # included. 454 | # The default value is: NO. 455 | 456 | EXTRACT_LOCAL_METHODS = NO 457 | 458 | # If this flag is set to YES, the members of anonymous namespaces will be 459 | # extracted and appear in the documentation as a namespace called 460 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 461 | # the file that contains the anonymous namespace. By default anonymous namespace 462 | # are hidden. 463 | # The default value is: NO. 464 | 465 | EXTRACT_ANON_NSPACES = NO 466 | 467 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 468 | # undocumented members inside documented classes or files. If set to NO these 469 | # members will be included in the various overviews, but no documentation 470 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 471 | # The default value is: NO. 472 | 473 | HIDE_UNDOC_MEMBERS = NO 474 | 475 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 476 | # undocumented classes that are normally visible in the class hierarchy. If set 477 | # to NO these classes will be included in the various overviews. This option has 478 | # no effect if EXTRACT_ALL is enabled. 479 | # The default value is: NO. 480 | 481 | HIDE_UNDOC_CLASSES = NO 482 | 483 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 484 | # (class|struct|union) declarations. If set to NO these declarations will be 485 | # included in the documentation. 486 | # The default value is: NO. 487 | 488 | HIDE_FRIEND_COMPOUNDS = NO 489 | 490 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 491 | # documentation blocks found inside the body of a function. If set to NO these 492 | # blocks will be appended to the function's detailed documentation block. 493 | # The default value is: NO. 494 | 495 | HIDE_IN_BODY_DOCS = NO 496 | 497 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 498 | # \internal command is included. If the tag is set to NO then the documentation 499 | # will be excluded. Set it to YES to include the internal documentation. 500 | # The default value is: NO. 501 | 502 | INTERNAL_DOCS = NO 503 | 504 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 505 | # names in lower-case letters. If set to YES upper-case letters are also 506 | # allowed. This is useful if you have classes or files whose names only differ 507 | # in case and if your file system supports case sensitive file names. Windows 508 | # and Mac users are advised to set this option to NO. 509 | # The default value is: system dependent. 510 | 511 | CASE_SENSE_NAMES = NO 512 | 513 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 514 | # their full class and namespace scopes in the documentation. If set to YES the 515 | # scope will be hidden. 516 | # The default value is: NO. 517 | 518 | HIDE_SCOPE_NAMES = NO 519 | 520 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 521 | # the files that are included by a file in the documentation of that file. 522 | # The default value is: YES. 523 | 524 | SHOW_INCLUDE_FILES = YES 525 | 526 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 527 | # grouped member an include statement to the documentation, telling the reader 528 | # which file to include in order to use the member. 529 | # The default value is: NO. 530 | 531 | SHOW_GROUPED_MEMB_INC = NO 532 | 533 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 534 | # files with double quotes in the documentation rather than with sharp brackets. 535 | # The default value is: NO. 536 | 537 | FORCE_LOCAL_INCLUDES = NO 538 | 539 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 540 | # documentation for inline members. 541 | # The default value is: YES. 542 | 543 | INLINE_INFO = YES 544 | 545 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 546 | # (detailed) documentation of file and class members alphabetically by member 547 | # name. If set to NO the members will appear in declaration order. 548 | # The default value is: YES. 549 | 550 | SORT_MEMBER_DOCS = YES 551 | 552 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 553 | # descriptions of file, namespace and class members alphabetically by member 554 | # name. If set to NO the members will appear in declaration order. Note that 555 | # this will also influence the order of the classes in the class list. 556 | # The default value is: NO. 557 | 558 | SORT_BRIEF_DOCS = NO 559 | 560 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 561 | # (brief and detailed) documentation of class members so that constructors and 562 | # destructors are listed first. If set to NO the constructors will appear in the 563 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 564 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 565 | # member documentation. 566 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 567 | # detailed member documentation. 568 | # The default value is: NO. 569 | 570 | SORT_MEMBERS_CTORS_1ST = NO 571 | 572 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 573 | # of group names into alphabetical order. If set to NO the group names will 574 | # appear in their defined order. 575 | # The default value is: NO. 576 | 577 | SORT_GROUP_NAMES = NO 578 | 579 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 580 | # fully-qualified names, including namespaces. If set to NO, the class list will 581 | # be sorted only by class name, not including the namespace part. 582 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 583 | # Note: This option applies only to the class list, not to the alphabetical 584 | # list. 585 | # The default value is: NO. 586 | 587 | SORT_BY_SCOPE_NAME = NO 588 | 589 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 590 | # type resolution of all parameters of a function it will reject a match between 591 | # the prototype and the implementation of a member function even if there is 592 | # only one candidate or it is obvious which candidate to choose by doing a 593 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 594 | # accept a match between prototype and implementation in such cases. 595 | # The default value is: NO. 596 | 597 | STRICT_PROTO_MATCHING = NO 598 | 599 | # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 600 | # todo list. This list is created by putting \todo commands in the 601 | # documentation. 602 | # The default value is: YES. 603 | 604 | GENERATE_TODOLIST = YES 605 | 606 | # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 607 | # test list. This list is created by putting \test commands in the 608 | # documentation. 609 | # The default value is: YES. 610 | 611 | GENERATE_TESTLIST = YES 612 | 613 | # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 614 | # list. This list is created by putting \bug commands in the documentation. 615 | # The default value is: YES. 616 | 617 | GENERATE_BUGLIST = YES 618 | 619 | # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 620 | # the deprecated list. This list is created by putting \deprecated commands in 621 | # the documentation. 622 | # The default value is: YES. 623 | 624 | GENERATE_DEPRECATEDLIST= YES 625 | 626 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 627 | # sections, marked by \if ... \endif and \cond 628 | # ... \endcond blocks. 629 | 630 | ENABLED_SECTIONS = 631 | 632 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 633 | # initial value of a variable or macro / define can have for it to appear in the 634 | # documentation. If the initializer consists of more lines than specified here 635 | # it will be hidden. Use a value of 0 to hide initializers completely. The 636 | # appearance of the value of individual variables and macros / defines can be 637 | # controlled using \showinitializer or \hideinitializer command in the 638 | # documentation regardless of this setting. 639 | # Minimum value: 0, maximum value: 10000, default value: 30. 640 | 641 | MAX_INITIALIZER_LINES = 30 642 | 643 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 644 | # the bottom of the documentation of classes and structs. If set to YES the list 645 | # will mention the files that were used to generate the documentation. 646 | # The default value is: YES. 647 | 648 | SHOW_USED_FILES = YES 649 | 650 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 651 | # will remove the Files entry from the Quick Index and from the Folder Tree View 652 | # (if specified). 653 | # The default value is: YES. 654 | 655 | SHOW_FILES = YES 656 | 657 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 658 | # page. This will remove the Namespaces entry from the Quick Index and from the 659 | # Folder Tree View (if specified). 660 | # The default value is: YES. 661 | 662 | SHOW_NAMESPACES = YES 663 | 664 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 665 | # doxygen should invoke to get the current version for each file (typically from 666 | # the version control system). Doxygen will invoke the program by executing (via 667 | # popen()) the command command input-file, where command is the value of the 668 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 669 | # by doxygen. Whatever the program writes to standard output is used as the file 670 | # version. For an example see the documentation. 671 | 672 | FILE_VERSION_FILTER = 673 | 674 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 675 | # by doxygen. The layout file controls the global structure of the generated 676 | # output files in an output format independent way. To create the layout file 677 | # that represents doxygen's defaults, run doxygen with the -l option. You can 678 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 679 | # will be used as the name of the layout file. 680 | # 681 | # Note that if you run doxygen from a directory containing a file called 682 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 683 | # tag is left empty. 684 | 685 | LAYOUT_FILE = 686 | 687 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 688 | # the reference definitions. This must be a list of .bib files. The .bib 689 | # extension is automatically appended if omitted. This requires the bibtex tool 690 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 691 | # For LaTeX the style of the bibliography can be controlled using 692 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 693 | # search path. Do not use file names with spaces, bibtex cannot handle them. See 694 | # also \cite for info how to create references. 695 | 696 | CITE_BIB_FILES = 697 | 698 | #--------------------------------------------------------------------------- 699 | # Configuration options related to warning and progress messages 700 | #--------------------------------------------------------------------------- 701 | 702 | # The QUIET tag can be used to turn on/off the messages that are generated to 703 | # standard output by doxygen. If QUIET is set to YES this implies that the 704 | # messages are off. 705 | # The default value is: NO. 706 | 707 | QUIET = NO 708 | 709 | # The WARNINGS tag can be used to turn on/off the warning messages that are 710 | # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 711 | # this implies that the warnings are on. 712 | # 713 | # Tip: Turn warnings on while writing the documentation. 714 | # The default value is: YES. 715 | 716 | WARNINGS = YES 717 | 718 | # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 719 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 720 | # will automatically be disabled. 721 | # The default value is: YES. 722 | 723 | WARN_IF_UNDOCUMENTED = YES 724 | 725 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 726 | # potential errors in the documentation, such as not documenting some parameters 727 | # in a documented function, or documenting parameters that don't exist or using 728 | # markup commands wrongly. 729 | # The default value is: YES. 730 | 731 | WARN_IF_DOC_ERROR = YES 732 | 733 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 734 | # are documented, but have no documentation for their parameters or return 735 | # value. If set to NO doxygen will only warn about wrong or incomplete parameter 736 | # documentation, but not about the absence of documentation. 737 | # The default value is: NO. 738 | 739 | WARN_NO_PARAMDOC = NO 740 | 741 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 742 | # can produce. The string should contain the $file, $line, and $text tags, which 743 | # will be replaced by the file and line number from which the warning originated 744 | # and the warning text. Optionally the format may contain $version, which will 745 | # be replaced by the version of the file (if it could be obtained via 746 | # FILE_VERSION_FILTER) 747 | # The default value is: $file:$line: $text. 748 | 749 | WARN_FORMAT = "$file:$line: $text" 750 | 751 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 752 | # messages should be written. If left blank the output is written to standard 753 | # error (stderr). 754 | 755 | WARN_LOGFILE = 756 | 757 | #--------------------------------------------------------------------------- 758 | # Configuration options related to the input files 759 | #--------------------------------------------------------------------------- 760 | 761 | # The INPUT tag is used to specify the files and/or directories that contain 762 | # documented source files. You may enter file names like myfile.cpp or 763 | # directories like /usr/src/myproject. Separate the files or directories with 764 | # spaces. 765 | # Note: If this tag is empty the current directory is searched. 766 | 767 | INPUT = 768 | 769 | # This tag can be used to specify the character encoding of the source files 770 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 771 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 772 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 773 | # possible encodings. 774 | # The default value is: UTF-8. 775 | 776 | INPUT_ENCODING = UTF-8 777 | 778 | # If the value of the INPUT tag contains directories, you can use the 779 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 780 | # *.h) to filter out the source-files in the directories. If left blank the 781 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 782 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 783 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 784 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 785 | # *.qsf, *.as and *.js. 786 | 787 | FILE_PATTERNS = *.c \ 788 | *.cc \ 789 | *.cxx \ 790 | *.cpp \ 791 | *.c++ \ 792 | *.java \ 793 | *.ii \ 794 | *.ino \ 795 | *.ixx \ 796 | *.ipp \ 797 | *.i++ \ 798 | *.inl \ 799 | *.idl \ 800 | *.ddl \ 801 | *.odl \ 802 | *.h \ 803 | *.hh \ 804 | *.hxx \ 805 | *.hpp \ 806 | *.h++ \ 807 | *.cs \ 808 | *.d \ 809 | *.pde \ 810 | *.php \ 811 | *.php4 \ 812 | *.php5 \ 813 | *.phtml \ 814 | *.inc \ 815 | *.m \ 816 | *.markdown \ 817 | *.md \ 818 | *.mm \ 819 | *.dox \ 820 | *.py \ 821 | *.f90 \ 822 | *.f \ 823 | *.for \ 824 | *.tcl \ 825 | *.vhd \ 826 | *.vhdl \ 827 | *.ucf \ 828 | *.qsf \ 829 | *.as \ 830 | *.js 831 | 832 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 833 | # be searched for input files as well. 834 | # The default value is: NO. 835 | 836 | RECURSIVE = NO 837 | 838 | # The EXCLUDE tag can be used to specify files and/or directories that should be 839 | # excluded from the INPUT source files. This way you can easily exclude a 840 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 841 | # 842 | # Note that relative paths are relative to the directory from which doxygen is 843 | # run. 844 | 845 | EXCLUDE = 846 | 847 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 848 | # directories that are symbolic links (a Unix file system feature) are excluded 849 | # from the input. 850 | # The default value is: NO. 851 | 852 | EXCLUDE_SYMLINKS = NO 853 | 854 | # If the value of the INPUT tag contains directories, you can use the 855 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 856 | # certain files from those directories. 857 | # 858 | # Note that the wildcards are matched against the file with absolute path, so to 859 | # exclude all test directories for example use the pattern */test/* 860 | 861 | EXCLUDE_PATTERNS = 862 | 863 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 864 | # (namespaces, classes, functions, etc.) that should be excluded from the 865 | # output. The symbol name can be a fully qualified name, a word, or if the 866 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 867 | # AClass::ANamespace, ANamespace::*Test 868 | # 869 | # Note that the wildcards are matched against the file with absolute path, so to 870 | # exclude all test directories use the pattern */test/* 871 | 872 | EXCLUDE_SYMBOLS = 873 | 874 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 875 | # that contain example code fragments that are included (see the \include 876 | # command). 877 | 878 | EXAMPLE_PATH = ../examples 879 | 880 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 881 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 882 | # *.h) to filter out the source-files in the directories. If left blank all 883 | # files are included. 884 | 885 | EXAMPLE_PATTERNS = * 886 | 887 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 888 | # searched for input files to be used with the \include or \dontinclude commands 889 | # irrespective of the value of the RECURSIVE tag. 890 | # The default value is: NO. 891 | 892 | EXAMPLE_RECURSIVE = YES 893 | 894 | # The IMAGE_PATH tag can be used to specify one or more files or directories 895 | # that contain images that are to be included in the documentation (see the 896 | # \image command). 897 | 898 | IMAGE_PATH = ../extras 899 | 900 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 901 | # invoke to filter for each input file. Doxygen will invoke the filter program 902 | # by executing (via popen()) the command: 903 | # 904 | # 905 | # 906 | # where is the value of the INPUT_FILTER tag, and is the 907 | # name of an input file. Doxygen will then use the output that the filter 908 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 909 | # will be ignored. 910 | # 911 | # Note that the filter must not add or remove lines; it is applied before the 912 | # code is scanned, but not when the output code is generated. If lines are added 913 | # or removed, the anchors will not be placed correctly. 914 | 915 | INPUT_FILTER = 916 | 917 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 918 | # basis. Doxygen will compare the file name with each pattern and apply the 919 | # filter if there is a match. The filters are a list of the form: pattern=filter 920 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 921 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 922 | # patterns match the file name, INPUT_FILTER is applied. 923 | 924 | FILTER_PATTERNS = 925 | 926 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 927 | # INPUT_FILTER ) will also be used to filter the input files that are used for 928 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 929 | # The default value is: NO. 930 | 931 | FILTER_SOURCE_FILES = NO 932 | 933 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 934 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 935 | # it is also possible to disable source filtering for a specific pattern using 936 | # *.ext= (so without naming a filter). 937 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 938 | 939 | FILTER_SOURCE_PATTERNS = 940 | 941 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 942 | # is part of the input, its contents will be placed on the main page 943 | # (index.html). This can be useful if you have a project on for instance GitHub 944 | # and want to reuse the introduction page also for the doxygen output. 945 | 946 | USE_MDFILE_AS_MAINPAGE = 947 | 948 | #--------------------------------------------------------------------------- 949 | # Configuration options related to source browsing 950 | #--------------------------------------------------------------------------- 951 | 952 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 953 | # generated. Documented entities will be cross-referenced with these sources. 954 | # 955 | # Note: To get rid of all source code in the generated output, make sure that 956 | # also VERBATIM_HEADERS is set to NO. 957 | # The default value is: NO. 958 | 959 | SOURCE_BROWSER = NO 960 | 961 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 962 | # classes and enums directly into the documentation. 963 | # The default value is: NO. 964 | 965 | INLINE_SOURCES = NO 966 | 967 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 968 | # special comment blocks from generated source code fragments. Normal C, C++ and 969 | # Fortran comments will always remain visible. 970 | # The default value is: YES. 971 | 972 | STRIP_CODE_COMMENTS = YES 973 | 974 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 975 | # function all documented functions referencing it will be listed. 976 | # The default value is: NO. 977 | 978 | REFERENCED_BY_RELATION = NO 979 | 980 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 981 | # all documented entities called/used by that function will be listed. 982 | # The default value is: NO. 983 | 984 | REFERENCES_RELATION = NO 985 | 986 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 987 | # to YES, then the hyperlinks from functions in REFERENCES_RELATION and 988 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 989 | # link to the documentation. 990 | # The default value is: YES. 991 | 992 | REFERENCES_LINK_SOURCE = YES 993 | 994 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 995 | # source code will show a tooltip with additional information such as prototype, 996 | # brief description and links to the definition and documentation. Since this 997 | # will make the HTML file larger and loading of large files a bit slower, you 998 | # can opt to disable this feature. 999 | # The default value is: YES. 1000 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1001 | 1002 | SOURCE_TOOLTIPS = YES 1003 | 1004 | # If the USE_HTAGS tag is set to YES then the references to source code will 1005 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1006 | # source browser. The htags tool is part of GNU's global source tagging system 1007 | # (see http://www.gnu.org/software/global/global.html). You will need version 1008 | # 4.8.6 or higher. 1009 | # 1010 | # To use it do the following: 1011 | # - Install the latest version of global 1012 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1013 | # - Make sure the INPUT points to the root of the source tree 1014 | # - Run doxygen as normal 1015 | # 1016 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1017 | # tools must be available from the command line (i.e. in the search path). 1018 | # 1019 | # The result: instead of the source browser generated by doxygen, the links to 1020 | # source code will now point to the output of htags. 1021 | # The default value is: NO. 1022 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1023 | 1024 | USE_HTAGS = NO 1025 | 1026 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1027 | # verbatim copy of the header file for each class for which an include is 1028 | # specified. Set to NO to disable this. 1029 | # See also: Section \class. 1030 | # The default value is: YES. 1031 | 1032 | VERBATIM_HEADERS = YES 1033 | 1034 | #--------------------------------------------------------------------------- 1035 | # Configuration options related to the alphabetical class index 1036 | #--------------------------------------------------------------------------- 1037 | 1038 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1039 | # compounds will be generated. Enable this if the project contains a lot of 1040 | # classes, structs, unions or interfaces. 1041 | # The default value is: YES. 1042 | 1043 | ALPHABETICAL_INDEX = YES 1044 | 1045 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1046 | # which the alphabetical index list will be split. 1047 | # Minimum value: 1, maximum value: 20, default value: 5. 1048 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1049 | 1050 | COLS_IN_ALPHA_INDEX = 5 1051 | 1052 | # In case all classes in a project start with a common prefix, all classes will 1053 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1054 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1055 | # while generating the index headers. 1056 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1057 | 1058 | IGNORE_PREFIX = 1059 | 1060 | #--------------------------------------------------------------------------- 1061 | # Configuration options related to the HTML output 1062 | #--------------------------------------------------------------------------- 1063 | 1064 | # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 1065 | # The default value is: YES. 1066 | 1067 | GENERATE_HTML = YES 1068 | 1069 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1070 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1071 | # it. 1072 | # The default directory is: html. 1073 | # This tag requires that the tag GENERATE_HTML is set to YES. 1074 | 1075 | HTML_OUTPUT = html 1076 | 1077 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1078 | # generated HTML page (for example: .htm, .php, .asp). 1079 | # The default value is: .html. 1080 | # This tag requires that the tag GENERATE_HTML is set to YES. 1081 | 1082 | HTML_FILE_EXTENSION = .html 1083 | 1084 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1085 | # each generated HTML page. If the tag is left blank doxygen will generate a 1086 | # standard header. 1087 | # 1088 | # To get valid HTML the header file that includes any scripts and style sheets 1089 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1090 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1091 | # default header using 1092 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1093 | # YourConfigFile 1094 | # and then modify the file new_header.html. See also section "Doxygen usage" 1095 | # for information on how to generate the default header that doxygen normally 1096 | # uses. 1097 | # Note: The header is subject to change so you typically have to regenerate the 1098 | # default header when upgrading to a newer version of doxygen. For a description 1099 | # of the possible markers and block names see the documentation. 1100 | # This tag requires that the tag GENERATE_HTML is set to YES. 1101 | 1102 | HTML_HEADER = 1103 | 1104 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1105 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1106 | # footer. See HTML_HEADER for more information on how to generate a default 1107 | # footer and what special commands can be used inside the footer. See also 1108 | # section "Doxygen usage" for information on how to generate the default footer 1109 | # that doxygen normally uses. 1110 | # This tag requires that the tag GENERATE_HTML is set to YES. 1111 | 1112 | HTML_FOOTER = 1113 | 1114 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1115 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1116 | # the HTML output. If left blank doxygen will generate a default style sheet. 1117 | # See also section "Doxygen usage" for information on how to generate the style 1118 | # sheet that doxygen normally uses. 1119 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1120 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1121 | # obsolete. 1122 | # This tag requires that the tag GENERATE_HTML is set to YES. 1123 | 1124 | HTML_STYLESHEET = 1125 | 1126 | # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- 1127 | # defined cascading style sheet that is included after the standard style sheets 1128 | # created by doxygen. Using this option one can overrule certain style aspects. 1129 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1130 | # standard style sheet and is therefor more robust against future updates. 1131 | # Doxygen will copy the style sheet file to the output directory. For an example 1132 | # see the documentation. 1133 | # This tag requires that the tag GENERATE_HTML is set to YES. 1134 | 1135 | HTML_EXTRA_STYLESHEET = 1136 | 1137 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1138 | # other source files which should be copied to the HTML output directory. Note 1139 | # that these files will be copied to the base HTML output directory. Use the 1140 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1141 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1142 | # files will be copied as-is; there are no commands or markers available. 1143 | # This tag requires that the tag GENERATE_HTML is set to YES. 1144 | 1145 | HTML_EXTRA_FILES = 1146 | 1147 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1148 | # will adjust the colors in the stylesheet and background images according to 1149 | # this color. Hue is specified as an angle on a colorwheel, see 1150 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1151 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1152 | # purple, and 360 is red again. 1153 | # Minimum value: 0, maximum value: 359, default value: 220. 1154 | # This tag requires that the tag GENERATE_HTML is set to YES. 1155 | 1156 | HTML_COLORSTYLE_HUE = 220 1157 | 1158 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1159 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1160 | # value of 255 will produce the most vivid colors. 1161 | # Minimum value: 0, maximum value: 255, default value: 100. 1162 | # This tag requires that the tag GENERATE_HTML is set to YES. 1163 | 1164 | HTML_COLORSTYLE_SAT = 100 1165 | 1166 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1167 | # luminance component of the colors in the HTML output. Values below 100 1168 | # gradually make the output lighter, whereas values above 100 make the output 1169 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1170 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1171 | # change the gamma. 1172 | # Minimum value: 40, maximum value: 240, default value: 80. 1173 | # This tag requires that the tag GENERATE_HTML is set to YES. 1174 | 1175 | HTML_COLORSTYLE_GAMMA = 80 1176 | 1177 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1178 | # page will contain the date and time when the page was generated. Setting this 1179 | # to NO can help when comparing the output of multiple runs. 1180 | # The default value is: YES. 1181 | # This tag requires that the tag GENERATE_HTML is set to YES. 1182 | 1183 | HTML_TIMESTAMP = YES 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 stylesheets (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 | # When 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 prerendered 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 | # , /