Add doxygen comments

modm-io · Aug 7, 2023 · 59d35f5 · 59d35f5
1 parent 8179386
commit 59d35f5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/modm/driver/radio/sx128x.hpp b/src/modm/driver/radio/sx128x.hpp
@@ -171,10 +171,13 @@ class Sx128x : public sx128x, public Transport
 
     /// Retrieve information about the last received packet
     /// @attention The returned parameters are frame-dependent
+    /// @attention Actual signal power is -(rssiSync) / 2 (dBm)
+    /// @attention Actual SNR is (snr) / 4 (dBm)
     modm::ResumableResult<bool>
     getPacketStatus(PacketStatus *packetStatus);
 
     /// Get the instantaneous RSSI value during reception of the packet
+    /// @attention Actual signal power is -(rssiSync) / 2 (dBm)
     modm::ResumableResult<bool>
     getRssiInst(uint8_t *rssiInst);
 
@@ -216,6 +219,7 @@ class Sx128x : public sx128x, public Transport
     /// Set UART speed
     /// @warning UART only
     /// @attention UART communication must be initiated with 115.2 kbps
+    /// @attention The UartDividerRatio is given by UartDividerRatio = (Baud Rate * 2^20) / fClk
     modm::ResumableResult<bool>
     setUartSpeed(UartDividerRatio uartDividerRatio);