From 243184fd75e7043643478c2cdb2e0ddeffa4b862 Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Sat, 8 Nov 2025 03:30:32 -0800 Subject: [PATCH 01/42] Tear out mesh class refactor, KISS fix to follow --- examples/simple_repeater/main.cpp | 16 +++++++---- src/Mesh.cpp | 17 ------------ src/Mesh.h | 35 ------------------------- src/helpers/ArduinoHelpers.h | 2 +- src/helpers/AutoDiscoverRTCClock.h | 2 +- src/helpers/CommonCLI.cpp | 4 +-- src/helpers/CommonCLI.h | 8 +++--- src/helpers/esp32/ESPNOWRadio.h | 2 +- src/helpers/radiolib/RadioLibWrappers.h | 2 +- 9 files changed, 21 insertions(+), 67 deletions(-) delete mode 100644 src/Mesh.cpp delete mode 100644 src/Mesh.h diff --git a/examples/simple_repeater/main.cpp b/examples/simple_repeater/main.cpp index 02219912..3e15ca76 100644 --- a/examples/simple_repeater/main.cpp +++ b/examples/simple_repeater/main.cpp @@ -1,6 +1,6 @@ #include // needed for PlatformIO #include -#include +#include #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) #include @@ -67,8 +67,9 @@ #define CLI_REPLY_DELAY_MILLIS 600 -class MyMesh : public mesh::Mesh, public CommonCLICallbacks { - +class MyMesh : public mesh::Dispatcher, public CommonCLICallbacks { + mesh::RTCClock* _rtc; + mesh::RNG* _rng; FILESYSTEM* _fs; CommonCLI _cli; bool _logging; @@ -118,10 +119,13 @@ class MyMesh : public mesh::Mesh, public CommonCLICallbacks { return ((int)_prefs.agc_reset_interval) * 4000; // milliseconds } + mesh::DispatcherAction onRecvPacket(mesh::Packet* pkt) override { + return 0; + } public: MyMesh(mesh::MainBoard& board, mesh::Radio& radio, mesh::MillisecondClock& ms, mesh::RNG& rng, mesh::RTCClock& rtc) - : mesh::Mesh(radio, ms, *new StaticPoolPacketManager(32)), _cli(board, rtc, &_prefs, this, this) + : mesh::Dispatcher(radio, ms, *new StaticPoolPacketManager(32)), _cli(board, rtc, &_prefs, this, this) { set_radio_at = revert_radio_at = 0; _logging = false; @@ -146,7 +150,7 @@ class MyMesh : public mesh::Mesh, public CommonCLICallbacks { } void begin(FILESYSTEM* fs) { - mesh::Mesh::begin(); + Dispatcher::begin(); _fs = fs; _cli.loadPrefs(_fs); @@ -154,6 +158,8 @@ class MyMesh : public mesh::Mesh, public CommonCLICallbacks { radio_set_tx_power(_prefs.tx_power_dbm); } + mesh::RNG* getRNG() const { return _rng; } + mesh::RTCClock* getRTCClock() const { return _rtc; } const char* getFirmwareVer() override { return FIRMWARE_VERSION; } const char* getBuildDate() override { return FIRMWARE_BUILD_DATE; } const char* getNodeName() { return _prefs.node_name; } diff --git a/src/Mesh.cpp b/src/Mesh.cpp deleted file mode 100644 index 3fb32070..00000000 --- a/src/Mesh.cpp +++ /dev/null @@ -1,17 +0,0 @@ -#include "Mesh.h" - -namespace mesh { - -void Mesh::begin() { - Dispatcher::begin(); -} - -void Mesh::loop() { - Dispatcher::loop(); -} - -DispatcherAction Mesh::onRecvPacket(Packet* pkt) { - return 0; -} - -} \ No newline at end of file diff --git a/src/Mesh.h b/src/Mesh.h deleted file mode 100644 index e0a3486e..00000000 --- a/src/Mesh.h +++ /dev/null @@ -1,35 +0,0 @@ -#pragma once - -#include -#include - - - -namespace mesh { - -/** - * \brief The next layer in the basic Dispatcher task, Mesh recognises the particular Payload TYPES, - * and provides virtual methods for sub-classes on handling incoming, and also preparing outbound Packets. -*/ -class Mesh : public Dispatcher { - RTCClock* _rtc; - RNG* _rng; - -protected: - DispatcherAction onRecvPacket(Packet* pkt) override; - - Mesh(Radio& radio, MillisecondClock& ms, PacketManager& mgr) - : Dispatcher(radio, ms, mgr) - { - } - -public: - void begin(); - void loop(); - - RNG* getRNG() const { return _rng; } - RTCClock* getRTCClock() const { return _rtc; } - -}; - -} \ No newline at end of file diff --git a/src/helpers/ArduinoHelpers.h b/src/helpers/ArduinoHelpers.h index a736c9b0..f7b920d8 100644 --- a/src/helpers/ArduinoHelpers.h +++ b/src/helpers/ArduinoHelpers.h @@ -1,6 +1,6 @@ #pragma once -#include +#include #include class VolatileRTCClock : public mesh::RTCClock { diff --git a/src/helpers/AutoDiscoverRTCClock.h b/src/helpers/AutoDiscoverRTCClock.h index 02eedf52..2efafaff 100644 --- a/src/helpers/AutoDiscoverRTCClock.h +++ b/src/helpers/AutoDiscoverRTCClock.h @@ -1,6 +1,6 @@ #pragma once -#include +#include #include #include diff --git a/src/helpers/CommonCLI.cpp b/src/helpers/CommonCLI.cpp index 31d641a0..1a45b116 100644 --- a/src/helpers/CommonCLI.cpp +++ b/src/helpers/CommonCLI.cpp @@ -169,7 +169,7 @@ void CommonCLI::handleCLICommand( } else if (memcmp(command, "txraw ", 6) == 0) { const char* tx_hex = &command[6]; - mesh::Packet* pkt = _mesh->obtainNewPacket(); + mesh::Packet* pkt = _dispatcher->obtainNewPacket(); uint8_t tx_buf[MAX_PACKET_PAYLOAD]; uint8_t len_buf = 0; char tmp[3]; @@ -184,7 +184,7 @@ void CommonCLI::handleCLICommand( } pkt->readFrom(tx_buf, len_buf); mesh::Utils::printHex(Serial, tx_buf, len_buf); - _mesh->sendPacket(pkt, 1); + _dispatcher->sendPacket(pkt, 1); strcpy(resp, "OK"); } else if (memcmp(command, "clock sync", 10) == 0) { uint32_t curr = getRTCClock()->getCurrentTime(); diff --git a/src/helpers/CommonCLI.h b/src/helpers/CommonCLI.h index 276a058d..90967581 100644 --- a/src/helpers/CommonCLI.h +++ b/src/helpers/CommonCLI.h @@ -1,6 +1,6 @@ #pragma once -#include +#include #include "KISS.h" #if defined(ESP32) || defined(RP2040_PLATFORM) @@ -53,7 +53,7 @@ class CommonCLICallbacks { class CommonCLI { mesh::RTCClock* _rtc; NodePrefs* _prefs; - mesh::Mesh* _mesh; + mesh::Dispatcher* _dispatcher; CommonCLICallbacks* _callbacks; mesh::MainBoard* _board; CLIMode _cli_mode = CLIMode::CLI; @@ -68,8 +68,8 @@ class CommonCLI { void handleCLICommand(uint32_t sender_timestamp, const char* command, char* resp); public: - CommonCLI(mesh::MainBoard& board, mesh::RTCClock& rtc, NodePrefs* prefs, CommonCLICallbacks* callbacks, mesh::Mesh* mesh) - : _board(&board), _rtc(&rtc), _prefs(prefs), _callbacks(callbacks), _mesh(mesh), _kiss(&_cli_mode, mesh) { + CommonCLI(mesh::MainBoard& board, mesh::RTCClock& rtc, NodePrefs* prefs, CommonCLICallbacks* callbacks, mesh::Dispatcher* dispatcher) + : _board(&board), _rtc(&rtc), _prefs(prefs), _callbacks(callbacks), _dispatcher(dispatcher), _kiss(&_cli_mode, dispatcher) { _cmd[0] = 0; } diff --git a/src/helpers/esp32/ESPNOWRadio.h b/src/helpers/esp32/ESPNOWRadio.h index c696da3a..90ba1938 100644 --- a/src/helpers/esp32/ESPNOWRadio.h +++ b/src/helpers/esp32/ESPNOWRadio.h @@ -1,6 +1,6 @@ #pragma once -#include +#include class ESPNOWRadio : public mesh::Radio { protected: diff --git a/src/helpers/radiolib/RadioLibWrappers.h b/src/helpers/radiolib/RadioLibWrappers.h index 25cc5358..033cfbe4 100644 --- a/src/helpers/radiolib/RadioLibWrappers.h +++ b/src/helpers/radiolib/RadioLibWrappers.h @@ -1,6 +1,6 @@ #pragma once -#include +#include #include class RadioLibWrapper : public mesh::Radio { From 4fd8b8ceaee71aa66b41e7020275f73b0e749e2c Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Sat, 8 Nov 2025 03:33:04 -0800 Subject: [PATCH 02/42] begin implementing kiss vendor commands (meshtnc specific) --- src/helpers/KISS.cpp | 59 ++++++++++++++++++++++++++++++++++++-------- src/helpers/KISS.h | 39 +++++++++++++++++++++++------ 2 files changed, 80 insertions(+), 18 deletions(-) diff --git a/src/helpers/KISS.cpp b/src/helpers/KISS.cpp index 65b653f0..aab46062 100644 --- a/src/helpers/KISS.cpp +++ b/src/helpers/KISS.cpp @@ -1,7 +1,13 @@ #include "KISS.h" +// https://www.ax25.net/kiss.aspx // https://en.wikipedia.org/wiki/KISS_(amateur_radio_protocol) +void KISSModem::reset() { + memset(_cmd, 0, sizeof(_cmd)); + _len = 0; +} + uint16_t KISSModem::encodeKISSFrame( const KISSCmd cmd, const uint8_t* data, const int data_len, @@ -104,7 +110,6 @@ void KISSModem::parseSerialKISS() { } } -// https://www.ax25.net/kiss.aspx void KISSModem::handleKISSCommand( uint32_t sender_timestamp, const char* kiss_data, @@ -135,17 +140,51 @@ void KISSModem::handleKISSCommand( // this KISS data is from the host to our KISS port number if (kiss_port == _port) { switch (kiss_cmd) { - case KISSCmd::TxDelay: - // TX delay is specified in 10ms units - if (kiss_data_len > 0) _txdelay = atoi(&kiss_data[0]) * 10; + case KISSCmd::TxDelay: { + // TX delay is specified in 10ms units + if (kiss_data_len > 0) _txdelay = atoi(&kiss_data[0]) * 10; + } break; - case KISSCmd::Data: - if (kiss_data_len == 0) break; - const uint8_t* tx_buf = reinterpret_cast(kiss_data); - mesh::Packet* pkt = _mesh->obtainNewPacket(); - pkt->readFrom(tx_buf, kiss_data_len); - _mesh->sendPacket(pkt, 1, _txdelay); + case KISSCmd::Data: { + if (kiss_data_len == 1) break; // only got cmd byte, no data to send + const uint8_t* tx_buf = reinterpret_cast(kiss_data); + mesh::Packet* pkt = _dispatcher->obtainNewPacket(); + pkt->readFrom(tx_buf, kiss_data_len); + _dispatcher->sendPacket(pkt, 1, _txdelay); + } + break; + case KISSCmd::Vendor: { + if (kiss_data_len == 1) break; // no vendor command provided + kiss_data++; + const uint16_t vendor_data_len = kiss_data_len - 1; + handleVendorCommand(sender_timestamp, kiss_data, vendor_data_len); + } break; } } +} + +void KISSModem::handleVendorCommand( + uint32_t sender_timestamp, + const char* vendor_data, + const uint16_t len +){ + const uint8_t vend_cmd = static_cast(vendor_data[0]); + + const uint16_t vendor_data_len = len - 1; + vendor_data++; + + uint8_t response[CMD_BUF_LEN_MAX]; + + switch (vend_cmd) { + case KISSVendorCmd::GetRadioStats: + //RadioStats stats {}; + break; + + default: + uint8_t error[1] = {0xFF}; + uint16_t len = encodeKISSFrame(KISSCmd::Vendor, error, 1, response, sizeof(response)); + Serial.write(response, len); + break; + } } \ No newline at end of file diff --git a/src/helpers/KISS.h b/src/helpers/KISS.h index 73a607f4..97c9bd2f 100644 --- a/src/helpers/KISS.h +++ b/src/helpers/KISS.h @@ -1,7 +1,7 @@ #pragma once #include -#include +#include enum CLIMode { CLI, KISS }; @@ -29,6 +29,27 @@ enum KISSCmd: uint8_t { Return = 0xF }; +enum KISSVendorCmd: uint16_t { + GetRadioStats = 0x01, // retrieve radio stats, takes no additional arguments + SignalReporting = 0x80, // enable SNR and RSSI reporting by setting the following byte to anything other than 0 +}; + +struct RadioStats { + uint8_t noise; + uint32_t rx_count; + uint32_t tx_count; + uint32_t rx_airtime; + uint32_t tx_airtime; + uint32_t uptime; +}; + +struct SignalReport { + long long unsigned int timestamp; + uint8_t rssi; + int8_t snr; + uint16_t pkt_len; +}; + class KISSModem { uint16_t _len; bool _esc; @@ -36,20 +57,22 @@ class KISSModem { uint8_t _port; char _cmd[CMD_BUF_LEN_MAX]; - mesh::Mesh* _mesh; + mesh::Dispatcher* _dispatcher; CLIMode* _cli_mode; + void handleVendorCommand(uint32_t sender_timestamp, const char* vendor_data, uint16_t len); + public: - KISSModem(CLIMode* cli_mode, mesh::Mesh* mesh) : _cli_mode(cli_mode), _mesh(mesh) { - _len = 0; - _esc = false; - _txdelay = 0; + KISSModem(CLIMode* cli_mode, mesh::Dispatcher* dispatcher) : _cli_mode(cli_mode), _dispatcher(dispatcher) { + _len = 0; + _esc = false; + _txdelay = 0; } uint8_t getPort() { return _port; }; void setPort(uint8_t port) { _port = port; }; - void reset() {_len = 0; }; + void reset(); void parseSerialKISS(); - void handleKISSCommand(uint32_t sender_timestamp, const char* kiss_data, uint16_t len); + void handleKISSCommand(uint32_t sender_timestamp, const char* kiss_data, const uint16_t len); uint16_t encodeKISSFrame( const KISSCmd cmd, const uint8_t* data, const int data_len, From 49f90b507f171763784c9f16bd9bb8a85d966936 Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Sat, 8 Nov 2025 04:09:47 -0800 Subject: [PATCH 03/42] first untested whack at radio stats kiss vendor cmd --- examples/simple_repeater/main.cpp | 3 +-- src/Dispatcher.h | 2 ++ src/helpers/KISS.cpp | 30 ++++++++++++++++++++++++------ src/helpers/KISS.h | 9 +++++---- 4 files changed, 32 insertions(+), 12 deletions(-) diff --git a/examples/simple_repeater/main.cpp b/examples/simple_repeater/main.cpp index 3e15ca76..7ec4c936 100644 --- a/examples/simple_repeater/main.cpp +++ b/examples/simple_repeater/main.cpp @@ -125,12 +125,11 @@ class MyMesh : public mesh::Dispatcher, public CommonCLICallbacks { public: MyMesh(mesh::MainBoard& board, mesh::Radio& radio, mesh::MillisecondClock& ms, mesh::RNG& rng, mesh::RTCClock& rtc) - : mesh::Dispatcher(radio, ms, *new StaticPoolPacketManager(32)), _cli(board, rtc, &_prefs, this, this) + : mesh::Dispatcher(radio, ms, *new StaticPoolPacketManager(32)), _cli(board, rtc, &_prefs, this, this) { set_radio_at = revert_radio_at = 0; _logging = false; - // defaults memset(&_prefs, 0, sizeof(_prefs)); _prefs.airtime_factor = 1.0; // one half diff --git a/src/Dispatcher.h b/src/Dispatcher.h index 6835b742..12952b5b 100644 --- a/src/Dispatcher.h +++ b/src/Dispatcher.h @@ -165,6 +165,8 @@ class Dispatcher { void releasePacket(Packet* packet); void sendPacket(Packet* packet, uint8_t priority, uint32_t delay_millis=0); + Radio* getRadio() { return _radio; } + uint32_t getSysUptime() { return _ms->getMillis(); } // in milliseconds unsigned long getTotalAirTime() const { return total_air_time; } // in milliseconds uint32_t getNumSentFlood() const { return n_sent_flood; } uint32_t getNumSentDirect() const { return n_sent_direct; } diff --git a/src/helpers/KISS.cpp b/src/helpers/KISS.cpp index aab46062..1c75c17d 100644 --- a/src/helpers/KISS.cpp +++ b/src/helpers/KISS.cpp @@ -177,14 +177,32 @@ void KISSModem::handleVendorCommand( uint8_t response[CMD_BUF_LEN_MAX]; switch (vend_cmd) { - case KISSVendorCmd::GetRadioStats: - //RadioStats stats {}; + case KISSVendorCmd::GetRadioStats: { + RadioStats stats { + _dispatcher->getRadio()->getNoiseFloor(), + _dispatcher->getNumRecvDirect(), + _dispatcher->getNumSentDirect(), + _dispatcher->getTotalAirTime(), + _dispatcher->getSysUptime() + }; + uint8_t* raw_stats = reinterpret_cast(&stats); + uint16_t data_len = sizeof(stats) + 1; // larger for vendor cmd prefix + uint8_t data[data_len] = {KISSVendorCmd::GetRadioStats}; + memcpy(&data[1], raw_stats, sizeof(stats)); + uint16_t len = encodeKISSFrame( + KISSCmd::Vendor, data, data_len, response, sizeof(response) + ); + Serial.write(response, len); + } break; - default: - uint8_t error[1] = {0xFF}; - uint16_t len = encodeKISSFrame(KISSCmd::Vendor, error, 1, response, sizeof(response)); - Serial.write(response, len); + default: { + uint8_t error[1] = {0xFF}; + uint16_t len = encodeKISSFrame( + KISSCmd::Vendor, error, 1, response, sizeof(response) + ); + Serial.write(response, len); + } break; } } \ No newline at end of file diff --git a/src/helpers/KISS.h b/src/helpers/KISS.h index 97c9bd2f..6840be58 100644 --- a/src/helpers/KISS.h +++ b/src/helpers/KISS.h @@ -38,13 +38,12 @@ struct RadioStats { uint8_t noise; uint32_t rx_count; uint32_t tx_count; - uint32_t rx_airtime; - uint32_t tx_airtime; + unsigned long tx_airtime; uint32_t uptime; }; struct SignalReport { - long long unsigned int timestamp; + unsigned long long timestamp; uint8_t rssi; int8_t snr; uint16_t pkt_len; @@ -63,7 +62,9 @@ class KISSModem { void handleVendorCommand(uint32_t sender_timestamp, const char* vendor_data, uint16_t len); public: - KISSModem(CLIMode* cli_mode, mesh::Dispatcher* dispatcher) : _cli_mode(cli_mode), _dispatcher(dispatcher) { + KISSModem(CLIMode* cli_mode, mesh::Dispatcher* dispatcher) + : _cli_mode(cli_mode), _dispatcher(dispatcher) + { _len = 0; _esc = false; _txdelay = 0; From 5d3db9f3684582968ee4159d2a312543a433ffb1 Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Tue, 11 Nov 2025 23:40:31 -0800 Subject: [PATCH 04/42] KISS.cpp: small code cleanup --- src/helpers/KISS.cpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/helpers/KISS.cpp b/src/helpers/KISS.cpp index 1c75c17d..b0239c84 100644 --- a/src/helpers/KISS.cpp +++ b/src/helpers/KISS.cpp @@ -171,6 +171,8 @@ void KISSModem::handleVendorCommand( ){ const uint8_t vend_cmd = static_cast(vendor_data[0]); + // vendor cmd is one byte, now that we have it stored above, + // decrement length of data and increment data pointer const uint16_t vendor_data_len = len - 1; vendor_data++; @@ -186,8 +188,8 @@ void KISSModem::handleVendorCommand( _dispatcher->getSysUptime() }; uint8_t* raw_stats = reinterpret_cast(&stats); - uint16_t data_len = sizeof(stats) + 1; // larger for vendor cmd prefix - uint8_t data[data_len] = {KISSVendorCmd::GetRadioStats}; + uint16_t data_len = sizeof(stats); + uint8_t data[data_len++] = {KISSVendorCmd::GetRadioStats}; memcpy(&data[1], raw_stats, sizeof(stats)); uint16_t len = encodeKISSFrame( KISSCmd::Vendor, data, data_len, response, sizeof(response) From f035ab77fd94e07baa840a2e632b3fa73dcecf8c Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Tue, 11 Nov 2025 23:41:27 -0800 Subject: [PATCH 05/42] tests: beginning of multiplatform test client --- .gitignore | 1 + tests/.vscode/c_cpp_properties.json | 23 ++++++ tests/.vscode/launch.json | 22 ++++++ tests/.vscode/settings.json | 118 ++++++++++++++++++++++++++++ tests/CMakeLists.txt | 35 +++++++++ tests/run_tests.sh | 21 +++++ tests/src/KISSTest.cpp | 79 +++++++++++++++++++ 7 files changed, 299 insertions(+) create mode 100644 tests/.vscode/c_cpp_properties.json create mode 100644 tests/.vscode/launch.json create mode 100644 tests/.vscode/settings.json create mode 100644 tests/CMakeLists.txt create mode 100644 tests/run_tests.sh create mode 100644 tests/src/KISSTest.cpp diff --git a/.gitignore b/.gitignore index 7e9d7b0a..de0427fb 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ out/ .vscode/settings.json .vscode/extensions.json .idea/ +tests/build* \ No newline at end of file diff --git a/tests/.vscode/c_cpp_properties.json b/tests/.vscode/c_cpp_properties.json new file mode 100644 index 00000000..37b42b1a --- /dev/null +++ b/tests/.vscode/c_cpp_properties.json @@ -0,0 +1,23 @@ +{ + "configurations": [ + { + "name": "Win32", + "includePath": [ + "${workspaceFolder}/**", + "C:/local/boost_1_89_0" + ], + "defines": [ + "_DEBUG", + "UNICODE", + "_UNICODE" + ], + "windowsSdkVersion": "10.0.26100.0", + "compilerPath": "cl.exe", + "cStandard": "c17", + "cppStandard": "c++17", + "intelliSenseMode": "windows-msvc-x64", + "configurationProvider": "ms-vscode.cmake-tools" + } + ], + "version": 4 +} \ No newline at end of file diff --git a/tests/.vscode/launch.json b/tests/.vscode/launch.json new file mode 100644 index 00000000..fe5a555f --- /dev/null +++ b/tests/.vscode/launch.json @@ -0,0 +1,22 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": "C++ Launch (Windows)", + "type": "cppvsdbg", + "request": "launch", + "program": "${workspaceFolder}/build/Debug/KISSTest.exe", + "symbolSearchPath": "${workspaceFolder}/build/Debug/", + "externalConsole": true, + "logging": { + "moduleLoad": false, + "trace": true + }, + "visualizerFile": "${workspaceFolder}/build/my.natvis", + "showDisplayString": true + } + ] +} \ No newline at end of file diff --git a/tests/.vscode/settings.json b/tests/.vscode/settings.json new file mode 100644 index 00000000..1a3744f6 --- /dev/null +++ b/tests/.vscode/settings.json @@ -0,0 +1,118 @@ +{ + "files.associations": { + "algorithm": "cpp", + "any": "cpp", + "array": "cpp", + "atomic": "cpp", + "barrier": "cpp", + "bit": "cpp", + "bitset": "cpp", + "cctype": "cpp", + "cfenv": "cpp", + "charconv": "cpp", + "chrono": "cpp", + "cinttypes": "cpp", + "clocale": "cpp", + "cmath": "cpp", + "codecvt": "cpp", + "compare": "cpp", + "complex": "cpp", + "concepts": "cpp", + "condition_variable": "cpp", + "coroutine": "cpp", + "csetjmp": "cpp", + "csignal": "cpp", + "cstdarg": "cpp", + "cstddef": "cpp", + "cstdint": "cpp", + "cstdio": "cpp", + "cstdlib": "cpp", + "cstring": "cpp", + "ctime": "cpp", + "cwchar": "cpp", + "cwctype": "cpp", + "deque": "cpp", + "exception": "cpp", + "execution": "cpp", + "expected": "cpp", + "resumable": "cpp", + "filesystem": "cpp", + "format": "cpp", + "forward_list": "cpp", + "fstream": "cpp", + "functional": "cpp", + "future": "cpp", + "generator": "cpp", + "initializer_list": "cpp", + "iomanip": "cpp", + "ios": "cpp", + "iosfwd": "cpp", + "iostream": "cpp", + "istream": "cpp", + "iterator": "cpp", + "latch": "cpp", + "limits": "cpp", + "list": "cpp", + "locale": "cpp", + "map": "cpp", + "mdspan": "cpp", + "memory": "cpp", + "memory_resource": "cpp", + "mutex": "cpp", + "new": "cpp", + "numbers": "cpp", + "numeric": "cpp", + "optional": "cpp", + "ostream": "cpp", + "print": "cpp", + "queue": "cpp", + "random": "cpp", + "ranges": "cpp", + "ratio": "cpp", + "regex": "cpp", + "scoped_allocator": "cpp", + "semaphore": "cpp", + "set": "cpp", + "shared_mutex": "cpp", + "source_location": "cpp", + "span": "cpp", + "spanstream": "cpp", + "sstream": "cpp", + "stack": "cpp", + "stacktrace": "cpp", + "stdexcept": "cpp", + "stdfloat": "cpp", + "stop_token": "cpp", + "streambuf": "cpp", + "string": "cpp", + "strstream": "cpp", + "syncstream": "cpp", + "system_error": "cpp", + "thread": "cpp", + "tuple": "cpp", + "type_traits": "cpp", + "typeindex": "cpp", + "typeinfo": "cpp", + "unordered_map": "cpp", + "unordered_set": "cpp", + "utility": "cpp", + "valarray": "cpp", + "variant": "cpp", + "vector": "cpp", + "xfacet": "cpp", + "xhash": "cpp", + "xiosbase": "cpp", + "xlocale": "cpp", + "xlocbuf": "cpp", + "xlocinfo": "cpp", + "xlocmes": "cpp", + "xlocmon": "cpp", + "xlocnum": "cpp", + "xloctime": "cpp", + "xmemory": "cpp", + "xstring": "cpp", + "xtr1common": "cpp", + "xtree": "cpp", + "xutility": "cpp" + } +} \ No newline at end of file diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt new file mode 100644 index 00000000..cfe44748 --- /dev/null +++ b/tests/CMakeLists.txt @@ -0,0 +1,35 @@ +cmake_minimum_required(VERSION 3.10) +project(MeshTNC_Tests) + +############################################################################### +## file globbing ############################################################## +############################################################################### + +# these instructions search the directory tree when CMake is +# invoked and put all files that match the pattern in the variables +# `sources` and `data` +file(GLOB_RECURSE sources src/*.cpp src/*.h) +file(GLOB_RECURSE data "") +# you can use set(sources src/main.cpp) etc if you don't want to +# use globbing to find files automatically + +find_package(Boost 1.8.3 REQUIRED) + +############################################################################### +## target definitions ######################################################### +############################################################################### + +# add the data to the target, so it becomes visible in some IDE +add_executable(KISSTest ${sources} ${data}) + +# just for example add some compiler flags +target_compile_options(KISSTest PUBLIC -std=c++1y -Wall) + +# this lets me include files relative to the root source directory with a <> pair +target_include_directories(KISSTest PUBLIC src/ ${Boost_INCLUDE_DIRS}) + +target_link_libraries(KISSTest ${Boost_LIBRARIES}) + +# this copies all resource files in the build directory +# we need this, because we want to work with paths relative to the executable +file(COPY ${data} DESTINATION resources) \ No newline at end of file diff --git a/tests/run_tests.sh b/tests/run_tests.sh new file mode 100644 index 00000000..5b94c92d --- /dev/null +++ b/tests/run_tests.sh @@ -0,0 +1,21 @@ +#!/bin/sh + +set -x + +BUILDDIR="build/" + +if [ ! -d ${BUILDDIR} ]; then + mkdir ${BUILDDIR} +fi + +cd ${BUILDDIR} + +if [ -f "KISSTest" ]; then + make clean && + make +else + cmake .. && + make +fi + +./KISSTest diff --git a/tests/src/KISSTest.cpp b/tests/src/KISSTest.cpp new file mode 100644 index 00000000..7302705a --- /dev/null +++ b/tests/src/KISSTest.cpp @@ -0,0 +1,79 @@ +#include +#include +#include +#include +#include +#include + +#define DEBUG true + +#ifdef __linux__ +#define SERIAL_PORT "/dev/ttyACM0" +#elif _WIN32 +#define SERIAL_PORT "\\\\.\\COM4" +#else +#define SERIAL_PORT "" +#endif + +using boost::system::error_code; +using boost::asio::io_context; +using boost::asio::serial_port; +using boost::asio::serial_port_base; +using boost::asio::buffer; +using boost::asio::const_buffer; +using boost::asio::mutable_buffer; + +int main () { + std::vector input(4096); + + #if defined(DEBUG) && defined(BOOST_ASIO_HAS_SERIAL_PORT) + printf("Boost has serial port!\r\n"); + #endif + + io_context ctx; + + serial_port serial(ctx); + try { + serial.open(SERIAL_PORT); + if (!serial.is_open()) { + printf("FATAL: Failed to open serial port '%s'", SERIAL_PORT); + std::exit(1); + } + serial.set_option(serial_port_base::baud_rate(115200)); + serial.set_option(serial_port_base::character_size(8)); + serial.set_option(serial_port_base::parity(serial_port_base::parity::none)); + serial.set_option(serial_port_base::stop_bits(serial_port_base::stop_bits::one)); + serial.set_option(serial_port_base::flow_control(serial_port_base::flow_control::none)); + } catch (std::exception e) { + printf("FATAL: Failed to initialize serial port '%s': %s", SERIAL_PORT, e.what()); + std::exit(1); + } + + if (serial.is_open()) { + error_code ec; + + std::string command("get radio\r\n"); + const_buffer wr_buf(command.data(), command.length()); + size_t wr_len; + try { + wr_len = serial.write_some(wr_buf, ec); + } catch(std::exception e) { + printf("FATAL: writing serial port: %s\r\n", ec.message()); + } + printf("wrote to serial port: %s\r\n", command.c_str()); + + mutable_buffer rd_buf(buffer(input)); + size_t rd_len; + while (true) { + try { + rd_len = serial.read_some(rd_buf, ec); + } catch(std::exception e) { + printf("error reading serial port: %s", ec.message()); + } + printf("%s {%i}\r\n", rd_buf.data(), rd_len); + } + serial.close(); + } else { + + } +} \ No newline at end of file From 58240905b70c2e3bf7680b387af7e39d0e8cfb67 Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Tue, 11 Nov 2025 23:59:24 -0800 Subject: [PATCH 06/42] tests/KISSTest.cpp: refactor into `openSerialPort` method --- tests/src/KISSTest.cpp | 69 ++++++++++++++++++++++-------------------- 1 file changed, 36 insertions(+), 33 deletions(-) diff --git a/tests/src/KISSTest.cpp b/tests/src/KISSTest.cpp index 7302705a..a2c93f64 100644 --- a/tests/src/KISSTest.cpp +++ b/tests/src/KISSTest.cpp @@ -23,20 +23,13 @@ using boost::asio::buffer; using boost::asio::const_buffer; using boost::asio::mutable_buffer; -int main () { - std::vector input(4096); - - #if defined(DEBUG) && defined(BOOST_ASIO_HAS_SERIAL_PORT) - printf("Boost has serial port!\r\n"); - #endif - - io_context ctx; +serial_port openSerialPort(io_context &ctx, char* port) { serial_port serial(ctx); try { - serial.open(SERIAL_PORT); + serial.open(port); if (!serial.is_open()) { - printf("FATAL: Failed to open serial port '%s'", SERIAL_PORT); + printf("FATAL: Failed to open serial port '%s'\r\n", port); std::exit(1); } serial.set_option(serial_port_base::baud_rate(115200)); @@ -45,35 +38,45 @@ int main () { serial.set_option(serial_port_base::stop_bits(serial_port_base::stop_bits::one)); serial.set_option(serial_port_base::flow_control(serial_port_base::flow_control::none)); } catch (std::exception e) { - printf("FATAL: Failed to initialize serial port '%s': %s", SERIAL_PORT, e.what()); + printf("FATAL: Failed to initialize serial port " + "'%s':\r\n%s\r\n", port, e.what()); std::exit(1); } + return serial; +} + +int main () { + std::vector input(4096); + + #if defined(DEBUG) && defined(BOOST_ASIO_HAS_SERIAL_PORT) + printf("Boost has serial port!\r\n"); + #endif + + io_context ctx; + serial_port serial = openSerialPort(ctx, SERIAL_PORT); - if (serial.is_open()) { - error_code ec; + error_code ec; + + std::string command("get radio\r\n"); + const_buffer wr_buf(command.data(), command.length()); + size_t wr_len; + try { + wr_len = serial.write_some(wr_buf, ec); + } catch(std::exception e) { + printf("FATAL: writing serial port: %s\r\n", ec.message()); + } + printf("wrote to serial port: %s\r\n", command.c_str()); - std::string command("get radio\r\n"); - const_buffer wr_buf(command.data(), command.length()); - size_t wr_len; + mutable_buffer rd_buf(buffer(input)); + size_t rd_len; + while (true) { try { - wr_len = serial.write_some(wr_buf, ec); + rd_len = serial.read_some(rd_buf, ec); } catch(std::exception e) { - printf("FATAL: writing serial port: %s\r\n", ec.message()); - } - printf("wrote to serial port: %s\r\n", command.c_str()); - - mutable_buffer rd_buf(buffer(input)); - size_t rd_len; - while (true) { - try { - rd_len = serial.read_some(rd_buf, ec); - } catch(std::exception e) { - printf("error reading serial port: %s", ec.message()); - } - printf("%s {%i}\r\n", rd_buf.data(), rd_len); + printf("error reading serial port: %s\r\n", ec.message()); } - serial.close(); - } else { - + printf("%s {%i}\r\n", rd_buf.data(), rd_len); } + serial.close(); + } \ No newline at end of file From 018078257316970c12105072f361a4f5f86cd1b3 Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Fri, 14 Nov 2025 20:07:07 -0800 Subject: [PATCH 07/42] tests/: attempt library split, lingering link errors --- tests/.vscode/settings.json | 3 +- tests/.vscode/tasks.json | 12 ++++++++ tests/CMakeLists.txt | 31 ++++++++++++++++++-- tests/lib/SerialPort.cpp | 58 +++++++++++++++++++++++++++++++++++++ tests/lib/SerialPort.h | 45 ++++++++++++++++++++++++++++ tests/src/KISSTest.cpp | 56 +++++------------------------------ 6 files changed, 152 insertions(+), 53 deletions(-) create mode 100644 tests/.vscode/tasks.json create mode 100644 tests/lib/SerialPort.cpp create mode 100644 tests/lib/SerialPort.h diff --git a/tests/.vscode/settings.json b/tests/.vscode/settings.json index 1a3744f6..5b83f5c8 100644 --- a/tests/.vscode/settings.json +++ b/tests/.vscode/settings.json @@ -113,6 +113,7 @@ "xstring": "cpp", "xtr1common": "cpp", "xtree": "cpp", - "xutility": "cpp" + "xutility": "cpp", + "cassert": "cpp" } } \ No newline at end of file diff --git a/tests/.vscode/tasks.json b/tests/.vscode/tasks.json new file mode 100644 index 00000000..d27efc94 --- /dev/null +++ b/tests/.vscode/tasks.json @@ -0,0 +1,12 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "type": "cmake", + "label": "CMake: configure", + "command": "configure", + "problemMatcher": [], + "detail": "CMake template configure task" + } + ] +} \ No newline at end of file diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index cfe44748..4179613f 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -1,4 +1,7 @@ cmake_minimum_required(VERSION 3.10) + +include(GenerateExportHeader) + project(MeshTNC_Tests) ############################################################################### @@ -8,7 +11,7 @@ project(MeshTNC_Tests) # these instructions search the directory tree when CMake is # invoked and put all files that match the pattern in the variables # `sources` and `data` -file(GLOB_RECURSE sources src/*.cpp src/*.h) +file(GLOB_RECURSE sources src/*.cpp src/*.h lib/*.cpp lib/*.h) file(GLOB_RECURSE data "") # you can use set(sources src/main.cpp) etc if you don't want to # use globbing to find files automatically @@ -19,6 +22,25 @@ find_package(Boost 1.8.3 REQUIRED) ## target definitions ######################################################### ############################################################################### +## libMeshTNC section +INCLUDE_DIRECTORIES("${CMAKE_CURRENT_BINARY_DIR}") + +add_library(libMeshTNC SHARED + lib/SerialPort.cpp + ) + +GENERATE_EXPORT_HEADER(libMeshTNC + BASE_NAME libMeshTNC + EXPORT_MACRO_NAME LIBTNC_EXPORTS + EXPORT_FILE_NAME lib/libtnc_exports.h + STATIC_DEFINE SHARED_EXPORTS_BUILT_AS_STATIC) + +target_include_directories(libMeshTNC PUBLIC lib/ ${Boost_INCLUDE_DIRS}) + +target_link_libraries(libMeshTNC ${Boost_LIBRARIES}) + + +## Main section # add the data to the target, so it becomes visible in some IDE add_executable(KISSTest ${sources} ${data}) @@ -26,9 +48,12 @@ add_executable(KISSTest ${sources} ${data}) target_compile_options(KISSTest PUBLIC -std=c++1y -Wall) # this lets me include files relative to the root source directory with a <> pair -target_include_directories(KISSTest PUBLIC src/ ${Boost_INCLUDE_DIRS}) +target_include_directories(KISSTest PUBLIC src/ lib/ ${Boost_INCLUDE_DIRS}) -target_link_libraries(KISSTest ${Boost_LIBRARIES}) +target_link_libraries(KISSTest + libMeshTNC + ${Boost_LIBRARIES} + ) # this copies all resource files in the build directory # we need this, because we want to work with paths relative to the executable diff --git a/tests/lib/SerialPort.cpp b/tests/lib/SerialPort.cpp new file mode 100644 index 00000000..8aaabd2d --- /dev/null +++ b/tests/lib/SerialPort.cpp @@ -0,0 +1,58 @@ +#include "SerialPort.h" + +void SerialPort::open() { + try { + _serial.open(_port); + if (!_serial.is_open()) { + printf("FATAL: Failed to open serial port '%s'\r\n", _port); + throw std::exception("Serial port cannot be opened!"); + } + _serial.set_option(serial_port_base::baud_rate(115200)); + _serial.set_option(serial_port_base::character_size(8)); + _serial.set_option(serial_port_base::parity(serial_port_base::parity::none)); + _serial.set_option(serial_port_base::stop_bits(serial_port_base::stop_bits::one)); + _serial.set_option(serial_port_base::flow_control(serial_port_base::flow_control::none)); + } catch(std::exception e) { +#ifdef DEBUG + printf("error, failed to open serial port: %s\r\n", __addgsbyte +#endif + throw e; + } +} + +size_t SerialPort::write(const std::string command) { + const_buffer wr_buf(command.data(), command.length()); + size_t wr_len; + try { + wr_len = _serial.write_some(wr_buf, _ec); + } catch (std::exception e) { +#ifdef DEBUG + printf("error writing to serial port: %s\r\n", _ec.message().c_str()); +#else + throw e; +#endif + } +#ifdef DEBUG + printf("wrote to serial port: %s\r\n", command.c_str()); +#endif + return wr_len; +} + +size_t SerialPort::read(mutable_buffer& buf) { + size_t rd_len; + while (true) { + try { + rd_len = _serial.read_some(buf, _ec); + } catch(std::exception e) { +#ifdef DEBUG + printf("error reading serial port: %s\r\n", _ec.message().c_str()); +#else + throw e; +#endif + } +#ifdef DEBUG + printf("%s {%i}\r\n", rd_buf.data(), rd_len); +#endif + return rd_len; + } +} \ No newline at end of file diff --git a/tests/lib/SerialPort.h b/tests/lib/SerialPort.h new file mode 100644 index 00000000..f0796997 --- /dev/null +++ b/tests/lib/SerialPort.h @@ -0,0 +1,45 @@ +#pragma once + +#ifdef BUILDING_LIBMESHTNC +#define MESHTNC_API __declspec(dllexport) +#else +#define MESHTNC_API __declspec(dllimport) +#endif + +#include "libtnc_exports.h" + +#include +#include + +#include + +using boost::system::error_code; +using boost::asio::io_context; +using boost::asio::serial_port; +using boost::asio::serial_port_base; +using boost::asio::buffer; +using boost::asio::const_buffer; +using boost::asio::mutable_buffer; + +extern "C" class LIBTNC_EXPORTS SerialPort { + // Constructor set + io_context& _ctx; + const char* _port; + + // Ephemeral + error_code _ec; + + // Structural + serial_port _serial; + + public: + SerialPort(io_context &ctx, const char* port) + : _ctx(ctx), _port(port), _serial(_ctx) + { + + } + void open(); + void close() { _serial.close(); }; + size_t write(const std::string command); + size_t read(mutable_buffer& buf); +}; diff --git a/tests/src/KISSTest.cpp b/tests/src/KISSTest.cpp index a2c93f64..a4c446d1 100644 --- a/tests/src/KISSTest.cpp +++ b/tests/src/KISSTest.cpp @@ -1,11 +1,11 @@ -#include -#include -#include #include #include #include +#include #define DEBUG true +#define BUILDING_LIBMESHTNC + #ifdef __linux__ #define SERIAL_PORT "/dev/ttyACM0" @@ -15,36 +15,10 @@ #define SERIAL_PORT "" #endif -using boost::system::error_code; using boost::asio::io_context; -using boost::asio::serial_port; -using boost::asio::serial_port_base; using boost::asio::buffer; -using boost::asio::const_buffer; using boost::asio::mutable_buffer; - -serial_port openSerialPort(io_context &ctx, char* port) { - serial_port serial(ctx); - try { - serial.open(port); - if (!serial.is_open()) { - printf("FATAL: Failed to open serial port '%s'\r\n", port); - std::exit(1); - } - serial.set_option(serial_port_base::baud_rate(115200)); - serial.set_option(serial_port_base::character_size(8)); - serial.set_option(serial_port_base::parity(serial_port_base::parity::none)); - serial.set_option(serial_port_base::stop_bits(serial_port_base::stop_bits::one)); - serial.set_option(serial_port_base::flow_control(serial_port_base::flow_control::none)); - } catch (std::exception e) { - printf("FATAL: Failed to initialize serial port " - "'%s':\r\n%s\r\n", port, e.what()); - std::exit(1); - } - return serial; -} - int main () { std::vector input(4096); @@ -53,30 +27,14 @@ int main () { #endif io_context ctx; - serial_port serial = openSerialPort(ctx, SERIAL_PORT); + SerialPort serial(ctx, SERIAL_PORT); + serial.open(); - error_code ec; - std::string command("get radio\r\n"); - const_buffer wr_buf(command.data(), command.length()); - size_t wr_len; - try { - wr_len = serial.write_some(wr_buf, ec); - } catch(std::exception e) { - printf("FATAL: writing serial port: %s\r\n", ec.message()); - } - printf("wrote to serial port: %s\r\n", command.c_str()); + serial.write(command); mutable_buffer rd_buf(buffer(input)); - size_t rd_len; - while (true) { - try { - rd_len = serial.read_some(rd_buf, ec); - } catch(std::exception e) { - printf("error reading serial port: %s\r\n", ec.message()); - } - printf("%s {%i}\r\n", rd_buf.data(), rd_len); - } + serial.read(rd_buf); serial.close(); } \ No newline at end of file From 9ff7f4fa69895a3567bfbcf30c6dec32432fd6f8 Mon Sep 17 00:00:00 2001 From: Henri Vasserman Date: Sat, 15 Nov 2025 17:42:35 +0200 Subject: [PATCH 08/42] fixes to make it compile Tried on Windows MSVC and MSYS2 (UCRT64 at least). --- tests/CMakeLists.txt | 54 ++++++++++++++-------------------------- tests/lib/SerialPort.cpp | 40 ++++++++++++++--------------- tests/src/KISSTest.cpp | 2 -- 3 files changed, 37 insertions(+), 59 deletions(-) diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 4179613f..56c03909 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -4,30 +4,23 @@ include(GenerateExportHeader) project(MeshTNC_Tests) -############################################################################### -## file globbing ############################################################## -############################################################################### - -# these instructions search the directory tree when CMake is -# invoked and put all files that match the pattern in the variables -# `sources` and `data` -file(GLOB_RECURSE sources src/*.cpp src/*.h lib/*.cpp lib/*.h) -file(GLOB_RECURSE data "") -# you can use set(sources src/main.cpp) etc if you don't want to -# use globbing to find files automatically +set(CMAKE_CXX_STANDARD 11) -find_package(Boost 1.8.3 REQUIRED) +if (MSVC) + # warning level 4 + add_compile_options(/W4) +else() + # additional warnings + add_compile_options(-Wall -Wextra) +endif() -############################################################################### -## target definitions ######################################################### -############################################################################### +find_package(Boost 1.8.3 REQUIRED) ## libMeshTNC section -INCLUDE_DIRECTORIES("${CMAKE_CURRENT_BINARY_DIR}") - add_library(libMeshTNC SHARED - lib/SerialPort.cpp - ) + lib/SerialPort.cpp + lib/SerialPort.h +) GENERATE_EXPORT_HEADER(libMeshTNC BASE_NAME libMeshTNC @@ -35,26 +28,15 @@ GENERATE_EXPORT_HEADER(libMeshTNC EXPORT_FILE_NAME lib/libtnc_exports.h STATIC_DEFINE SHARED_EXPORTS_BUILT_AS_STATIC) -target_include_directories(libMeshTNC PUBLIC lib/ ${Boost_INCLUDE_DIRS}) +target_include_directories(libMeshTNC PUBLIC lib/ "${CMAKE_CURRENT_BINARY_DIR}/lib" ${Boost_INCLUDE_DIRS}) target_link_libraries(libMeshTNC ${Boost_LIBRARIES}) - ## Main section -# add the data to the target, so it becomes visible in some IDE -add_executable(KISSTest ${sources} ${data}) - -# just for example add some compiler flags -target_compile_options(KISSTest PUBLIC -std=c++1y -Wall) - -# this lets me include files relative to the root source directory with a <> pair -target_include_directories(KISSTest PUBLIC src/ lib/ ${Boost_INCLUDE_DIRS}) +add_executable(KISSTest + src/KISSTest.cpp +) target_link_libraries(KISSTest - libMeshTNC - ${Boost_LIBRARIES} - ) - -# this copies all resource files in the build directory -# we need this, because we want to work with paths relative to the executable -file(COPY ${data} DESTINATION resources) \ No newline at end of file + libMeshTNC +) diff --git a/tests/lib/SerialPort.cpp b/tests/lib/SerialPort.cpp index 8aaabd2d..78cefb56 100644 --- a/tests/lib/SerialPort.cpp +++ b/tests/lib/SerialPort.cpp @@ -1,22 +1,20 @@ #include "SerialPort.h" +#include + void SerialPort::open() { try { - _serial.open(_port); - if (!_serial.is_open()) { - printf("FATAL: Failed to open serial port '%s'\r\n", _port); - throw std::exception("Serial port cannot be opened!"); - } + _serial.open(_port, _ec); _serial.set_option(serial_port_base::baud_rate(115200)); _serial.set_option(serial_port_base::character_size(8)); _serial.set_option(serial_port_base::parity(serial_port_base::parity::none)); _serial.set_option(serial_port_base::stop_bits(serial_port_base::stop_bits::one)); _serial.set_option(serial_port_base::flow_control(serial_port_base::flow_control::none)); - } catch(std::exception e) { -#ifdef DEBUG - printf("error, failed to open serial port: %s\r\n", __addgsbyte + } catch(std::exception& e) { +#ifndef NDEBUG + fprintf(stderr, "error, failed to open serial port '%s': %.*s\r\n", _port, (int)_ec.message().size(), _ec.message().data()); #endif - throw e; + throw std::exception(e); } } @@ -25,15 +23,15 @@ size_t SerialPort::write(const std::string command) { size_t wr_len; try { wr_len = _serial.write_some(wr_buf, _ec); - } catch (std::exception e) { -#ifdef DEBUG - printf("error writing to serial port: %s\r\n", _ec.message().c_str()); + } catch (std::exception& e) { +#ifndef NDEBUG + fprintf(stderr, "error writing to serial port: %.*s\r\n", (int)_ec.message().size(), _ec.message().data()); #else - throw e; + throw std::exception(e); #endif } -#ifdef DEBUG - printf("wrote to serial port: %s\r\n", command.c_str()); +#ifndef NDEBUG + fprintf(stderr, "wrote to serial port: %s\r\n", command.c_str()); #endif return wr_len; } @@ -43,15 +41,15 @@ size_t SerialPort::read(mutable_buffer& buf) { while (true) { try { rd_len = _serial.read_some(buf, _ec); - } catch(std::exception e) { -#ifdef DEBUG - printf("error reading serial port: %s\r\n", _ec.message().c_str()); + } catch(std::exception& e) { +#ifndef NDEBUG + fprintf(stderr, "error reading serial port: %.*s\r\n", (int)_ec.message().size(), _ec.message().data()); #else - throw e; + throw std::exception(e); #endif } -#ifdef DEBUG - printf("%s {%i}\r\n", rd_buf.data(), rd_len); +#ifndef NDEBUG + fprintf(stderr, "%.*s {%i}\r\n", (int)rd_len, (const char *)buf.data(), (int)rd_len); #endif return rd_len; } diff --git a/tests/src/KISSTest.cpp b/tests/src/KISSTest.cpp index a4c446d1..bc8ddbf0 100644 --- a/tests/src/KISSTest.cpp +++ b/tests/src/KISSTest.cpp @@ -3,10 +3,8 @@ #include #include -#define DEBUG true #define BUILDING_LIBMESHTNC - #ifdef __linux__ #define SERIAL_PORT "/dev/ttyACM0" #elif _WIN32 From a72584b667d15b56af99e31628faacd6c3696021 Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Sat, 15 Nov 2025 15:43:20 -0800 Subject: [PATCH 09/42] tests/: more cmake cleanup --- tests/CMakeLists.txt | 34 +++++++++++++++++++++------------- tests/lib/SerialPort.h | 6 +++--- tests/src/KISSTest.cpp | 5 +++-- 3 files changed, 27 insertions(+), 18 deletions(-) diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 56c03909..3f826342 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -4,7 +4,7 @@ include(GenerateExportHeader) project(MeshTNC_Tests) -set(CMAKE_CXX_STANDARD 11) +set(CMAKE_CXX_STANDARD 20) if (MSVC) # warning level 4 @@ -16,27 +16,35 @@ endif() find_package(Boost 1.8.3 REQUIRED) -## libMeshTNC section -add_library(libMeshTNC SHARED +## MeshTNC library section +add_library( + MeshTNC SHARED lib/SerialPort.cpp lib/SerialPort.h ) -GENERATE_EXPORT_HEADER(libMeshTNC - BASE_NAME libMeshTNC - EXPORT_MACRO_NAME LIBTNC_EXPORTS - EXPORT_FILE_NAME lib/libtnc_exports.h - STATIC_DEFINE SHARED_EXPORTS_BUILT_AS_STATIC) +GENERATE_EXPORT_HEADER( + MeshTNC + BASE_NAME MeshTNC + EXPORT_MACRO_NAME MESHTNC_EXPORTS + EXPORT_FILE_NAME lib/meshtnc_exports.h + STATIC_DEFINE SHARED_EXPORTS_BUILT_AS_STATIC +) -target_include_directories(libMeshTNC PUBLIC lib/ "${CMAKE_CURRENT_BINARY_DIR}/lib" ${Boost_INCLUDE_DIRS}) +target_include_directories( + MeshTNC PUBLIC lib/ "${CMAKE_CURRENT_BINARY_DIR}/lib" + ${Boost_INCLUDE_DIRS} +) -target_link_libraries(libMeshTNC ${Boost_LIBRARIES}) +target_link_libraries(MeshTNC ${Boost_LIBRARIES}) ## Main section -add_executable(KISSTest +add_executable( + KISSTest src/KISSTest.cpp ) -target_link_libraries(KISSTest - libMeshTNC +target_link_libraries( + KISSTest + MeshTNC ) diff --git a/tests/lib/SerialPort.h b/tests/lib/SerialPort.h index f0796997..9a408316 100644 --- a/tests/lib/SerialPort.h +++ b/tests/lib/SerialPort.h @@ -1,12 +1,12 @@ #pragma once -#ifdef BUILDING_LIBMESHTNC +#ifdef BUILDING_MESHTNC #define MESHTNC_API __declspec(dllexport) #else #define MESHTNC_API __declspec(dllimport) #endif -#include "libtnc_exports.h" +#include "meshtnc_exports.h" #include #include @@ -21,7 +21,7 @@ using boost::asio::buffer; using boost::asio::const_buffer; using boost::asio::mutable_buffer; -extern "C" class LIBTNC_EXPORTS SerialPort { +extern "C" class MESHTNC_EXPORTS SerialPort { // Constructor set io_context& _ctx; const char* _port; diff --git a/tests/src/KISSTest.cpp b/tests/src/KISSTest.cpp index bc8ddbf0..ac7b961a 100644 --- a/tests/src/KISSTest.cpp +++ b/tests/src/KISSTest.cpp @@ -3,7 +3,7 @@ #include #include -#define BUILDING_LIBMESHTNC +#define BUILDING_MESHTNC #ifdef __linux__ #define SERIAL_PORT "/dev/ttyACM0" @@ -20,7 +20,7 @@ using boost::asio::mutable_buffer; int main () { std::vector input(4096); - #if defined(DEBUG) && defined(BOOST_ASIO_HAS_SERIAL_PORT) + #if defined(NDEBUG) && defined(BOOST_ASIO_HAS_SERIAL_PORT) printf("Boost has serial port!\r\n"); #endif @@ -33,6 +33,7 @@ int main () { mutable_buffer rd_buf(buffer(input)); serial.read(rd_buf); + serial.close(); } \ No newline at end of file From 8db0ca429982bd6c744a25093c7858e30ab1d466 Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Sat, 15 Nov 2025 16:50:26 -0800 Subject: [PATCH 10/42] tests/: restructure shared libraries --- tests/CMakeLists.txt | 35 +++++++++++++++++++++++----- tests/lib/{ => duini}/SerialPort.cpp | 0 tests/lib/{ => duini}/SerialPort.h | 10 ++++---- tests/lib/meshtnc/KISS.cpp | 0 tests/lib/meshtnc/KISS.h | 0 tests/src/KISSTest.cpp | 2 +- 6 files changed, 35 insertions(+), 12 deletions(-) rename tests/lib/{ => duini}/SerialPort.cpp (100%) rename tests/lib/{ => duini}/SerialPort.h (79%) create mode 100644 tests/lib/meshtnc/KISS.cpp create mode 100644 tests/lib/meshtnc/KISS.h diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 3f826342..83301581 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -16,11 +16,34 @@ endif() find_package(Boost 1.8.3 REQUIRED) +## duini library section +add_library( + duini SHARED + lib/duini/SerialPort.h + lib/duini/SerialPort.cpp +) + +GENERATE_EXPORT_HEADER( + duini + BASE_NAME duini + EXPORT_MACRO_NAME DUINI_EXPORTS + EXPORT_FILE_NAME lib/duini_exports.h + STATIC_DEFINE SHARED_EXPORTS_BUILT_AS_STATIC +) + +target_include_directories( + duini PUBLIC lib/duini + "${CMAKE_CURRENT_BINARY_DIR}/lib" + ${Boost_INCLUDE_DIRS} +) + +target_link_libraries(duini ${Boost_LIBRARIES}) + ## MeshTNC library section add_library( MeshTNC SHARED - lib/SerialPort.cpp - lib/SerialPort.h + lib/meshtnc/KISS.h + lib/meshtnc/KISS.cpp ) GENERATE_EXPORT_HEADER( @@ -32,11 +55,11 @@ GENERATE_EXPORT_HEADER( ) target_include_directories( - MeshTNC PUBLIC lib/ "${CMAKE_CURRENT_BINARY_DIR}/lib" - ${Boost_INCLUDE_DIRS} + MeshTNC PUBLIC lib/meshtnc + "${CMAKE_CURRENT_BINARY_DIR}/lib" ) -target_link_libraries(MeshTNC ${Boost_LIBRARIES}) +target_link_libraries(MeshTNC) ## Main section add_executable( @@ -46,5 +69,5 @@ add_executable( target_link_libraries( KISSTest - MeshTNC + duini ) diff --git a/tests/lib/SerialPort.cpp b/tests/lib/duini/SerialPort.cpp similarity index 100% rename from tests/lib/SerialPort.cpp rename to tests/lib/duini/SerialPort.cpp diff --git a/tests/lib/SerialPort.h b/tests/lib/duini/SerialPort.h similarity index 79% rename from tests/lib/SerialPort.h rename to tests/lib/duini/SerialPort.h index 9a408316..2fe14962 100644 --- a/tests/lib/SerialPort.h +++ b/tests/lib/duini/SerialPort.h @@ -1,12 +1,12 @@ #pragma once -#ifdef BUILDING_MESHTNC -#define MESHTNC_API __declspec(dllexport) +#ifdef BUILDING_DUINI +#define DUINI_API __declspec(dllexport) #else -#define MESHTNC_API __declspec(dllimport) +#define DUINI_API __declspec(dllimport) #endif -#include "meshtnc_exports.h" +#include "duini_exports.h" #include #include @@ -21,7 +21,7 @@ using boost::asio::buffer; using boost::asio::const_buffer; using boost::asio::mutable_buffer; -extern "C" class MESHTNC_EXPORTS SerialPort { +extern "C" class DUINI_EXPORTS SerialPort { // Constructor set io_context& _ctx; const char* _port; diff --git a/tests/lib/meshtnc/KISS.cpp b/tests/lib/meshtnc/KISS.cpp new file mode 100644 index 00000000..e69de29b diff --git a/tests/lib/meshtnc/KISS.h b/tests/lib/meshtnc/KISS.h new file mode 100644 index 00000000..e69de29b diff --git a/tests/src/KISSTest.cpp b/tests/src/KISSTest.cpp index ac7b961a..6c4ac4a0 100644 --- a/tests/src/KISSTest.cpp +++ b/tests/src/KISSTest.cpp @@ -3,7 +3,7 @@ #include #include -#define BUILDING_MESHTNC +#define BUILDING_DUINI #ifdef __linux__ #define SERIAL_PORT "/dev/ttyACM0" From e004052c73e7314c6f47dbb51435eebb5852a13c Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Sat, 15 Nov 2025 19:51:46 -0800 Subject: [PATCH 11/42] tests/: clean up BOOST_ROOT msvc issues --- tests/.vscode/c_cpp_properties.json | 5 ++--- tests/CMakeLists.txt | 1 + 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/.vscode/c_cpp_properties.json b/tests/.vscode/c_cpp_properties.json index 37b42b1a..2056a482 100644 --- a/tests/.vscode/c_cpp_properties.json +++ b/tests/.vscode/c_cpp_properties.json @@ -3,8 +3,7 @@ { "name": "Win32", "includePath": [ - "${workspaceFolder}/**", - "C:/local/boost_1_89_0" + "${workspaceFolder}/**" ], "defines": [ "_DEBUG", @@ -14,7 +13,7 @@ "windowsSdkVersion": "10.0.26100.0", "compilerPath": "cl.exe", "cStandard": "c17", - "cppStandard": "c++17", + "cppStandard": "c++20", "intelliSenseMode": "windows-msvc-x64", "configurationProvider": "ms-vscode.cmake-tools" } diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 83301581..f56960e5 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -8,6 +8,7 @@ set(CMAKE_CXX_STANDARD 20) if (MSVC) # warning level 4 + set(BOOST_ROOT C:/local/boost_1_89_0) add_compile_options(/W4) else() # additional warnings From 54954c0ac39914792256e4bf10030f4876ebd8fc Mon Sep 17 00:00:00 2001 From: Dan Theisen Date: Sun, 16 Nov 2025 15:06:01 -0800 Subject: [PATCH 12/42] Add Doxygen config --- .gitignore | 4 +- Doxyfile | 3016 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 3019 insertions(+), 1 deletion(-) create mode 100644 Doxyfile diff --git a/.gitignore b/.gitignore index de0427fb..f951b2e3 100644 --- a/.gitignore +++ b/.gitignore @@ -10,4 +10,6 @@ out/ .vscode/settings.json .vscode/extensions.json .idea/ -tests/build* \ No newline at end of file +tests/build* +docs/html +docs/latex diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 00000000..0015dd7f --- /dev/null +++ b/Doxyfile @@ -0,0 +1,3016 @@ +# Doxyfile 1.15.0 + +# This file describes the settings to be used by the documentation system +# Doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use Doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use Doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = MeshTNC + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewers a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where Doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs + +# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding Doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise cause +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by Doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which Doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where Doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but +# less readable) file names. This can be useful if your file system doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the +# first line (until the first dot, question mark or exclamation mark) of a +# Javadoc-style comment as the brief description. If set to NO, the Javadoc- +# style will behave just like regular Qt-style comments (thus requiring an +# explicit @brief command for a brief description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by Doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first +# line (until the first dot, question mark or exclamation mark) of a Qt-style +# comment as the brief description. If set to NO, the Qt-style will behave just +# like regular Qt-style comments (thus requiring an explicit \brief command for +# a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and Doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# Doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as Doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make Doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by Doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by Doxygen, so you can +# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# If the MARKDOWN_STRICT tag is enabled then Doxygen treats text in comments as +# Markdown formatted also in cases where Doxygen's native markup format +# conflicts with that of Markdown. This is only relevant in cases where +# backticks are used. Doxygen's native markup style allows a single quote to end +# a text fragment started with a backtick and then treat it as a piece of quoted +# text, whereas in Markdown such text fragment is treated as verbatim and only +# ends when a second matching backtick is found. Also, Doxygen's native markup +# format requires double quotes to be escaped when they appear in a backtick +# section, whereas this is not needed for Markdown. +# The default value is: YES. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_STRICT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 6. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 6 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled Doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the +# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# This tag specifies a list of words that, when matching the start of a word in +# the documentation, will suppress auto links generation, if it is enabled via +# AUTOLINK_SUPPORT. This list does not affect links explicitly created using \# +# or the \link or commands. +# This tag requires that the tag AUTOLINK_SUPPORT is set to YES. + +AUTOLINK_IGNORE_WORDS = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let Doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also makes the inheritance and +# collaboration diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse +# them like normal C++ but will assume all classes use public instead of private +# inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# Doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then Doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# Doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run Doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use +# during processing. When set to 0 Doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 512, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all +# undocumented namespaces that are normally visible in the namespace hierarchy. +# If set to NO, these namespaces will be included in the various overviews. This +# option has no effect if EXTRACT_ALL is enabled. +# The default value is: YES. + +HIDE_UNDOC_NAMESPACES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and macOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = SYSTEM + +# If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# Doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by Doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by Doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents Doxygen's defaults, run Doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run Doxygen from a directory containing a file called +# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH +# environment variable) so that external tools such as latex and gs can be +# found. +# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the +# path already specified by the PATH variable, and are added in the order +# specified. +# Note: This option is particularly useful for macOS version 14 (Sonoma) and +# higher, when running Doxygen from Doxywizard, because in this case any user- +# defined changes to the PATH are ignored. A typical example on macOS is to set +# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin +# together with the standard path, the full search path used by doxygen when +# launching external tools will then become +# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin + +EXTERNAL_TOOL_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by Doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete +# function parameter documentation. If set to NO, Doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, Doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about +# undocumented enumeration values. If set to NO, Doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If WARN_LAYOUT_FILE option is set to YES, Doxygen will warn about issues found +# while parsing the user defined layout file, such as missing or wrong elements. +# See also LAYOUT_FILE for details. If set to NO, problems with the layout file +# will be suppressed. +# The default value is: YES. + +WARN_LAYOUT_FILE = YES + +# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the Doxygen process Doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that Doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of Doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = . + +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). +# See also: INPUT_ENCODING for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by Doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be +# provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cxxm \ + *.cpp \ + *.cppm \ + *.ccm \ + *.c++ \ + *.c++m \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which Doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that Doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that Doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by Doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by Doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the Doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub- +# directories of the project's root, is used as the documentation for that sub- +# directory, except when the README.md starts with a \dir, \page or \mainpage +# command. If set to NO, the README.md file needs to start with an explicit \dir +# command in order to be used as directory documentation. +# The default value is: YES. + +IMPLICIT_DIR_DOCS = YES + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# multi-line macros, enums or list initialized variables directly into the +# documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of Doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by Doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which Doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not Doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then Doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by Doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not Doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank Doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that Doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that Doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of Doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank Doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that Doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank Doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that Doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by Doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generates light mode output, DARK always +# generates dark mode output, AUTO_LIGHT automatically sets the mode according +# to the user preference, uses light mode if no preference is set (the default), +# AUTO_DARK automatically sets the mode according to the user preference, uses +# dark mode if no preference is set and TOGGLE allows a user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, Doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline (the HTML help workshop was already many +# years in maintenance mode). You can download the HTML help workshop from the +# web archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# Doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by Doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has more details information than the tab index, you +# could consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# When GENERATE_TREEVIEW is set to YES, the PAGE_OUTLINE_PANEL option determines +# if an additional navigation panel is shown at the right hand side of the +# screen, displaying an outline of the contents of the main page, similar to +# e.g. https://developer.android.com/reference If GENERATE_TREEVIEW is set to +# NO, this option has no effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +PAGE_OUTLINE_PANEL = YES + +# When GENERATE_TREEVIEW is set to YES, the FULL_SIDEBAR option determines if +# the side bar is limited to only the treeview area (value NO) or if it should +# extend to the full height of the window (value YES). Setting this to YES gives +# a layout similar to e.g. https://docs.readthedocs.io with more room for +# contents, but less room for the project logo, title, and description. If +# GENERATE_TREEVIEW is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# Doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified +# enumeration values besides the enumeration mnemonics. +# The default value is: NO. + +SHOW_ENUM_VALUES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# Doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2, MathJax_3 and MathJax_4. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# https://docs.mathjax.org/en/v2.7/output.html), MathJax version 3 (see: +# https://docs.mathjax.org/en/v3.2/output/index.html) and MathJax version 4 +# (see: +# https://docs.mathjax.org/en/v4.0/output/index.htm). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. For Mathjax version 2 the +# destination directory should contain the MathJax.js script. For instance, if +# the mathjax directory is located at the same level as the HTML output +# directory, then MATHJAX_RELPATH should be ../mathjax.s For Mathjax versions 3 +# and 4 the destination directory should contain the tex-.js script +# (where is either chtml or svg). The default value points to the +# MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. However, it is strongly recommended to install a local +# copy of MathJax from https://www.mathjax.org before deployment. The default +# value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# - in case of MathJax version 4: https://cdn.jsdelivr.net/npm/mathjax@4 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7/tex.html): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# https://docs.mathjax.org/en/v3.2/input/tex/extensions/): +# MATHJAX_EXTENSIONS = ams +# For example for MathJax version 4 (see +# https://docs.mathjax.org/en/v4.0/input/tex/extensions/): +# MATHJAX_EXTENSIONS = units +# Note that for Mathjax version 4 quite a few extensions are already +# automatically loaded. To disable a package in Mathjax version 4 one can use +# the package name prepended with a minus sign (- like MATHJAX_EXTENSIONS += +# -textmacros) +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces +# of code that will be used on startup of the MathJax code. See the Mathjax site +# for more details: +# - MathJax version 2 (see: +# https://docs.mathjax.org/en/v2.7/) +# - MathJax version 3 (see: +# https://docs.mathjax.org/en/v3.2/) +# - MathJax version 4 (see: +# https://docs.mathjax.org/en/v4.0/) For an example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for +# the HTML output. The underlying search engine uses JavaScript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the JavaScript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /