From d8c11fa8c993fd2463d2f5f6d92352a7ce0cbe36 Mon Sep 17 00:00:00 2001 From: jgromes Date: Sun, 10 Jul 2022 19:54:57 +0200 Subject: [PATCH] [SX127x] Added missing Doxygen comments --- src/modules/SX127x/SX127x.h | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/modules/SX127x/SX127x.h b/src/modules/SX127x/SX127x.h index 07a6e654..d77d321f 100644 --- a/src/modules/SX127x/SX127x.h +++ b/src/modules/SX127x/SX127x.h @@ -728,12 +728,27 @@ class SX127x: public PhysicalLayer { /*! \brief Set interrupt service routine function to call when FIFO is empty. - \param func Pointer to interrupt service routine. + \param data Pointer to the transmission buffer. + + \param totalLen Total number of bytes to transmit. + + \param remLen Pointer to a counter holding the number of bytes that have been transmitted so far. \returns True when a complete packet is sent, false if more data is needed. */ bool fifoAdd(uint8_t* data, int totalLen, volatile int* remLen); + /*! + \brief Set interrupt service routine function to call when FIFO is sufficently full to read. + + \param data Pointer to a buffer that stores the receive data. + + \param totalLen Total number of bytes to receive. + + \param rcvLen Pointer to a counter holding the number of bytes that have been received so far. + + \returns True when a complete packet is received, false if more data is needed. + */ bool fifoGet(volatile uint8_t* data, int totalLen, volatile int* rcvLen); /*!