From 89d89f3c0d34af6ccfdf6970fa1aacbd2f04b406 Mon Sep 17 00:00:00 2001 From: Bryan Biedenkapp Date: Sun, 8 May 2022 21:31:55 -0400 Subject: [PATCH] code cleanup; --- CWIdTX.cpp | 1 + CalRSSI.cpp | 1 + IO.cpp | 1 + IODue.cpp | 2 ++ IOSTM.cpp | 2 ++ RSSIBuffer.cpp | 1 + STM_UART.cpp | 1 + SampleBuffer.cpp | 1 + SerialBuffer.cpp | 1 + SerialDue.cpp | 1 + SerialPort.cpp | 2 ++ SerialSTM.cpp | 1 + dmr/CalDMR.cpp | 1 + dmr/DMRDMORX.cpp | 2 ++ dmr/DMRDMOTX.cpp | 2 ++ dmr/DMRIdleRX.cpp | 2 ++ dmr/DMRRX.cpp | 1 + dmr/DMRSlotRX.cpp | 2 ++ dmr/DMRSlotType.cpp | 2 ++ dmr/DMRTX.cpp | 2 ++ p25/CalP25.cpp | 1 + p25/P25RX.cpp | 2 ++ p25/P25TX.cpp | 2 ++ 23 files changed, 34 insertions(+) diff --git a/CWIdTX.cpp b/CWIdTX.cpp index 2fa4a6f..73de0df 100644 --- a/CWIdTX.cpp +++ b/CWIdTX.cpp @@ -99,6 +99,7 @@ const struct { // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the CWIdTX class. /// diff --git a/CalRSSI.cpp b/CalRSSI.cpp index befe47d..a153a19 100644 --- a/CalRSSI.cpp +++ b/CalRSSI.cpp @@ -34,6 +34,7 @@ // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the CalRSSI class. /// diff --git a/IO.cpp b/IO.cpp index 1261f9e..1dca959 100644 --- a/IO.cpp +++ b/IO.cpp @@ -62,6 +62,7 @@ const uint16_t DC_OFFSET = 2048U; // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the IO class. /// diff --git a/IODue.cpp b/IODue.cpp index 1a3e8c2..901bbbe 100644 --- a/IODue.cpp +++ b/IODue.cpp @@ -87,6 +87,7 @@ extern "C" { // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Hardware interrupt handler. /// @@ -151,6 +152,7 @@ void IO::getUDID(uint8_t* buffer) // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// Initializes hardware interrupts. /// diff --git a/IOSTM.cpp b/IOSTM.cpp index c25f7ba..67d6444 100644 --- a/IOSTM.cpp +++ b/IOSTM.cpp @@ -249,6 +249,7 @@ extern "C" { // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Hardware interrupt handler. /// @@ -306,6 +307,7 @@ void IO::getUDID(uint8_t* buffer) // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// Initializes hardware interrupts. /// diff --git a/RSSIBuffer.cpp b/RSSIBuffer.cpp index a08763b..57d4e27 100644 --- a/RSSIBuffer.cpp +++ b/RSSIBuffer.cpp @@ -35,6 +35,7 @@ // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the RSSIBuffer class. /// diff --git a/STM_UART.cpp b/STM_UART.cpp index 7196a79..b2e972e 100644 --- a/STM_UART.cpp +++ b/STM_UART.cpp @@ -36,6 +36,7 @@ // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the STM_UART class. /// diff --git a/SampleBuffer.cpp b/SampleBuffer.cpp index fea47a0..91a397f 100644 --- a/SampleBuffer.cpp +++ b/SampleBuffer.cpp @@ -35,6 +35,7 @@ // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the SampleBuffer class. /// diff --git a/SerialBuffer.cpp b/SerialBuffer.cpp index 900e17c..ff88e01 100644 --- a/SerialBuffer.cpp +++ b/SerialBuffer.cpp @@ -35,6 +35,7 @@ // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the SerialBuffer class. /// diff --git a/SerialDue.cpp b/SerialDue.cpp index 6626a4b..6863af6 100644 --- a/SerialDue.cpp +++ b/SerialDue.cpp @@ -34,6 +34,7 @@ // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + #if (defined(__SAM3X8E__) || defined(__MK20DX256__) || defined(__MK64FX512__) || defined(__MK66FX1M0__)) && defined(ARDUINO_SAM_DUE) /// /// diff --git a/SerialPort.cpp b/SerialPort.cpp index 22fb84b..758b6d6 100644 --- a/SerialPort.cpp +++ b/SerialPort.cpp @@ -69,6 +69,7 @@ const uint8_t PROTOCOL_VERSION = 2U; // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the SerialPort class. /// @@ -671,6 +672,7 @@ void SerialPort::writeDump(const uint8_t* data, uint16_t length) // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// Write acknowlegement. /// diff --git a/SerialSTM.cpp b/SerialSTM.cpp index 439dac1..872039b 100644 --- a/SerialSTM.cpp +++ b/SerialSTM.cpp @@ -199,6 +199,7 @@ void InitUART5(int speed) // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// /// diff --git a/dmr/CalDMR.cpp b/dmr/CalDMR.cpp index 19178db..c62b778 100644 --- a/dmr/CalDMR.cpp +++ b/dmr/CalDMR.cpp @@ -94,6 +94,7 @@ const uint8_t SHORTLC_1K[] = { 0x33U, 0x3AU, 0xA0U, 0x30U, 0x00U, 0x55U, 0xA6U, // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the CalDMR class. /// diff --git a/dmr/DMRDMORX.cpp b/dmr/DMRDMORX.cpp index 8ab616b..09362ad 100644 --- a/dmr/DMRDMORX.cpp +++ b/dmr/DMRDMORX.cpp @@ -54,6 +54,7 @@ const uint8_t CONTROL_DATA = 0x40U; // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the DMRDMORX class. /// @@ -122,6 +123,7 @@ void DMRDMORX::setColorCode(uint8_t colorCode) // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// Helper to perform sample processing. /// diff --git a/dmr/DMRDMOTX.cpp b/dmr/DMRDMOTX.cpp index e47235e..03ef0e0 100644 --- a/dmr/DMRDMOTX.cpp +++ b/dmr/DMRDMOTX.cpp @@ -62,6 +62,7 @@ const uint8_t PR_FILL[] = // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the DMRDMOTX class. /// @@ -204,6 +205,7 @@ uint8_t DMRDMOTX::getSpace() const // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// /// diff --git a/dmr/DMRIdleRX.cpp b/dmr/DMRIdleRX.cpp index 9ca3811..f68912e 100644 --- a/dmr/DMRIdleRX.cpp +++ b/dmr/DMRIdleRX.cpp @@ -51,6 +51,7 @@ const uint8_t CONTROL_DATA = 0x40U; // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the DMRIdleRX class. /// @@ -104,6 +105,7 @@ void DMRIdleRX::setColorCode(uint8_t colorCode) // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// Helper to perform sample processing. /// diff --git a/dmr/DMRRX.cpp b/dmr/DMRRX.cpp index 899b873..b618cfe 100644 --- a/dmr/DMRRX.cpp +++ b/dmr/DMRRX.cpp @@ -35,6 +35,7 @@ using namespace dmr; // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the DMRRX class. /// diff --git a/dmr/DMRSlotRX.cpp b/dmr/DMRSlotRX.cpp index 91eb20e..505aba5 100644 --- a/dmr/DMRSlotRX.cpp +++ b/dmr/DMRSlotRX.cpp @@ -57,6 +57,7 @@ const uint8_t CONTROL_DATA = 0x40U; // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the DMRSlotRX class. /// @@ -287,6 +288,7 @@ void DMRSlotRX::setRxDelay(uint8_t delay) // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// Frame synchronization correlator. /// diff --git a/dmr/DMRSlotType.cpp b/dmr/DMRSlotType.cpp index f2f4514..36b7dcf 100644 --- a/dmr/DMRSlotType.cpp +++ b/dmr/DMRSlotType.cpp @@ -228,6 +228,7 @@ const uint32_t DECODING_TABLE_1987[] = { // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the DMRSlotType class. /// @@ -286,6 +287,7 @@ void DMRSlotType::encode(uint8_t colorCode, uint8_t dataType, uint8_t* frame) co // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// /// diff --git a/dmr/DMRTX.cpp b/dmr/DMRTX.cpp index ea090a6..6988182 100644 --- a/dmr/DMRTX.cpp +++ b/dmr/DMRTX.cpp @@ -75,6 +75,7 @@ const uint32_t ABORT_COUNT = 6U; // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the DMRTX class. /// @@ -398,6 +399,7 @@ uint32_t DMRTX::getFrameCount() // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// /// diff --git a/p25/CalP25.cpp b/p25/CalP25.cpp index 58ec70e..3ae5805 100644 --- a/p25/CalP25.cpp +++ b/p25/CalP25.cpp @@ -69,6 +69,7 @@ unsigned char LDU2_1K[] = { 0x00, // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the CalP25 class. /// diff --git a/p25/P25RX.cpp b/p25/P25RX.cpp index d8d5df1..0b3d20f 100644 --- a/p25/P25RX.cpp +++ b/p25/P25RX.cpp @@ -54,6 +54,7 @@ const uint8_t NOAVEPTR = 99U; // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the P25RX class. /// @@ -213,6 +214,7 @@ void P25RX::setCorrCount(uint8_t count) // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// Helper to process P25 samples. /// diff --git a/p25/P25TX.cpp b/p25/P25TX.cpp index b03ad94..f7b4643 100644 --- a/p25/P25TX.cpp +++ b/p25/P25TX.cpp @@ -66,6 +66,7 @@ const q15_t P25_LEVELD = -1220; // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- + /// /// Initializes a new instance of the P25TX class. /// @@ -271,6 +272,7 @@ uint8_t P25TX::getSpace() const // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- + /// /// ///