Fixup doxygen comments (#1089)

jgromes · May 15, 2024 · 63ef9e0 · 63ef9e0
1 parent b336dd5
commit 63ef9e0
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 5 deletions.
diff --git a/src/modules/LR11x0/LR11x0.h b/src/modules/LR11x0/LR11x0.h
@@ -766,17 +766,21 @@ 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")
       or to false to discard current configuration ("cold start"). Defaults to true.
       \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
@@ -545,14 +545,20 @@ 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().
       \param retainConfig Set to true to retain configuration of the currently active modem ("warm start")
       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
@@ -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