From 32a7095989a234f5fa2d2ae44567deaf8d1c4b55 Mon Sep 17 00:00:00 2001
From: jgromes <jan.gromes@gmail.com>
Date: Mon, 1 Apr 2024 10:44:53 +0200
Subject: [PATCH] [SX126x] Fixed doxygen warnings

---
 src/modules/SX126x/STM32WLx_Module.cpp | 19 +++++++++++++++++++
 src/modules/SX126x/SX126x.h            |  2 +-
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/src/modules/SX126x/STM32WLx_Module.cpp b/src/modules/SX126x/STM32WLx_Module.cpp
index 57d0445c..0e119129 100644
--- a/src/modules/SX126x/STM32WLx_Module.cpp
+++ b/src/modules/SX126x/STM32WLx_Module.cpp
@@ -22,10 +22,19 @@ enum {
   RADIOLIB_STM32WLx_VIRTUAL_PIN_RESET,
 };
 
+/*!
+  \class Stm32wlxHal
+  \brief Hardware Abstraction Layer for STM32WL.
+*/
 class Stm32wlxHal : public ArduinoHal {
   public:
     Stm32wlxHal(): ArduinoHal(SubGhz.SPI, SubGhz.spi_settings) {}
 
+    /*!
+      \brief Pin mode override to handle STM32WL virtual pins.
+      \param dwPin Pin to set.
+      \param dwMode Mode to set.
+    */
     void pinMode(uint32_t dwPin, uint32_t dwMode) {
       switch(dwPin) {
         case RADIOLIB_STM32WLx_VIRTUAL_PIN_NSS:
@@ -40,6 +49,11 @@ class Stm32wlxHal : public ArduinoHal {
       }
     }
 
+    /*!
+      \brief Digital write override to handle STM32WL virtual pins.
+      \param dwPin Pin to set.
+      \param dwVal Value to set.
+    */
     void digitalWrite(uint32_t dwPin, uint32_t dwVal) {
       switch (dwPin) {
         case RADIOLIB_STM32WLx_VIRTUAL_PIN_NSS:
@@ -61,6 +75,11 @@ class Stm32wlxHal : public ArduinoHal {
       }
     }
 
+    /*!
+      \brief Digital read override to handle STM32WL virtual pins.
+      \param dwPin Pin to set.
+      \returns Value read on the pin.
+    */
     uint32_t digitalRead(uint32_t ulPin) {
       switch (ulPin) {
         case RADIOLIB_STM32WLx_VIRTUAL_PIN_BUSY:
diff --git a/src/modules/SX126x/SX126x.h b/src/modules/SX126x/SX126x.h
index 848433b8..4a04fd48 100644
--- a/src/modules/SX126x/SX126x.h
+++ b/src/modules/SX126x/SX126x.h
@@ -964,7 +964,7 @@ class SX126x: public PhysicalLayer {
 
     /*!
       \brief Check whether the IRQ bit for RxTimeout is set
-      \returns \ref RxTimeout IRQ is set
+      \returns Whether RxTimeout IRQ is set
     */
     bool isRxTimeout();