[SX127x] Added parameter doc and keyword

jgromes · Nov 3, 2024 · fe52311 · fe52311
1 parent cb45f4f
commit fe52311
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/keywords.txt b/keywords.txt
@@ -197,6 +197,7 @@ randomByte	KEYWORD2
 getPacketLength	KEYWORD2
 setFifoEmptyAction	KEYWORD2
 clearFifoEmptyAction	KEYWORD2
+setFifoThreshold	KEYWORD2
 setFifoFullAction	KEYWORD2
 clearFifoFullAction	KEYWORD2
 fifoAdd	KEYWORD2

diff --git a/src/modules/RF69/RF69.h b/src/modules/RF69/RF69.h
@@ -652,7 +652,7 @@ class RF69: public PhysicalLayer {
       \brief Set FIFO threshold level.
       Be aware that threshold is also set in setFifoFullAction method.
       setFifoThreshold method must be called AFTER calling setFifoFullAction!
-      \param Threshold level.
+      \param threshold Threshold level in bytes.
     */
     void setFifoThreshold(uint8_t threshold);
 

diff --git a/src/modules/SX127x/SX127x.h b/src/modules/SX127x/SX127x.h
@@ -765,7 +765,7 @@ class SX127x: public PhysicalLayer {
       \brief Set FIFO threshold level.
       Be aware that threshold is also set in setFifoFullAction method.
       setFifoThreshold method must be called AFTER calling setFifoFullAction!
-      \param Threshold level.
+      \param threshold Threshold level in bytes.
     */
     void setFifoThreshold(uint8_t threshold);