forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[SX127x] Added missing Doxygen comments

Browse source
This commit is contained in:
jgromes 2022-07-10 19:54:57 +02:00
parent ce26892567
commit d8c11fa8c9
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/modules/SX127x/SX127x.h
View file

@ -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);
/*!