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

Fixup doxygen comments (#1089)

Browse source
This commit is contained in:
jgromes 2024-05-15 18:43:19 +02:00
parent b336dd59f9
commit 63ef9e0977
3 changed files with 22 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/modules/LR11x0/LR11x0.h
View file

@ -767,6 +767,13 @@ class LR11x0: public PhysicalLayer {
*/ */
int16_t standby(uint8_t mode, bool wakeup = true); 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(). \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") \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. \param sleepTime Sleep duration (enables automatic wakeup), in multiples of 30.52 us. Ignored if set to 0.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t sleep();
int16_t sleep(bool retainConfig, uint32_t sleepTime); int16_t sleep(bool retainConfig, uint32_t sleepTime);
// interrupt methods // interrupt methods

8
src/modules/SX126x/SX126x.h
View file

@ -546,13 +546,19 @@ class SX126x: public PhysicalLayer {
*/ */
int16_t scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin); 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(). \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") \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. or to false to discard current configuration ("cold start"). Defaults to true.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t sleep();
int16_t sleep(bool retainConfig); int16_t sleep(bool retainConfig);
/*! /*!

7
src/modules/SX128x/SX128x.h
View file

@ -457,6 +457,13 @@ class SX128x: public PhysicalLayer {
*/ */
int16_t scanChannel() override; 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(). \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 \param retainConfig Set to true to retain configuration and data buffer or to false