From 63ef9e09777eefdc6b6242a55f0c55a731f086b6 Mon Sep 17 00:00:00 2001
From: jgromes <jan.gromes@gmail.com>
Date: Wed, 15 May 2024 18:43:19 +0200
Subject: [PATCH] Fixup doxygen comments  (#1089)

---
 src/modules/LR11x0/LR11x0.h | 12 ++++++++----
 src/modules/SX126x/SX126x.h |  8 +++++++-
 src/modules/SX128x/SX128x.h |  7 +++++++
 3 files changed, 22 insertions(+), 5 deletions(-)

diff --git a/src/modules/LR11x0/LR11x0.h b/src/modules/LR11x0/LR11x0.h
index 255486056..2ba8d269e 100644
--- a/src/modules/LR11x0/LR11x0.h
+++ b/src/modules/LR11x0/LR11x0.h
@@ -766,7 +766,14 @@ class LR11x0: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t standby(uint8_t mode, bool wakeup = true);
-    
+
+    /*!
+      \brief Sets the module to sleep mode. To wake the device up, call standby().
+      Overload with warm start enabled for PhysicalLayer compatibility.
+      \returns \ref status_codes
+    */
+    int16_t sleep();
+
     /*!
       \brief Sets the module to sleep mode. To wake the device up, call standby().
       \param retainConfig Set to true to retain configuration of the currently active modem ("warm start")
@@ -774,9 +781,6 @@ class LR11x0: public PhysicalLayer {
       \param sleepTime Sleep duration (enables automatic wakeup), in multiples of 30.52 us. Ignored if set to 0.
       \returns \ref status_codes
     */
-
-    int16_t sleep();
-
     int16_t sleep(bool retainConfig, uint32_t sleepTime);
     
     // interrupt methods
diff --git a/src/modules/SX126x/SX126x.h b/src/modules/SX126x/SX126x.h
index 3fd0a4c12..e1297adca 100644
--- a/src/modules/SX126x/SX126x.h
+++ b/src/modules/SX126x/SX126x.h
@@ -545,6 +545,13 @@ class SX126x: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+
+    /*!
+      \brief Sets the module to sleep mode. To wake the device up, call standby().
+      Overload with warm start enabled for PhysicalLayer compatibility.
+      \returns \ref status_codes
+    */
+    int16_t sleep(); 
     
     /*!
       \brief Sets the module to sleep mode. To wake the device up, call standby().
@@ -552,7 +559,6 @@ class SX126x: public PhysicalLayer {
       or to false to discard current configuration ("cold start"). Defaults to true.
       \returns \ref status_codes
     */
-    int16_t sleep(); 
     int16_t sleep(bool retainConfig);
 
     /*!
diff --git a/src/modules/SX128x/SX128x.h b/src/modules/SX128x/SX128x.h
index 69d8f975d..969ab58a1 100644
--- a/src/modules/SX128x/SX128x.h
+++ b/src/modules/SX128x/SX128x.h
@@ -457,6 +457,13 @@ class SX128x: public PhysicalLayer {
     */
     int16_t scanChannel() override;
 
+    /*!
+      \brief Sets the module to sleep mode. To wake the device up, call standby().
+      Overload for PhysicalLayer compatibility.
+      \returns \ref status_codes
+    */
+    int16_t sleep();
+
     /*!
       \brief Sets the module to sleep mode. To wake the device up, call standby().
       \param retainConfig Set to true to retain configuration and data buffer or to false