From e97755a68becc43f8982479ba847c03262a60093 Mon Sep 17 00:00:00 2001 From: jgromes Date: Fri, 10 Jul 2020 08:51:05 +0200 Subject: [PATCH] [SX126x] Added Doxygen TODO --- src/modules/SX126x/SX1261.cpp | 2 +- src/modules/SX126x/SX1262.cpp | 2 +- src/modules/SX126x/SX1268.cpp | 5 +++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/modules/SX126x/SX1261.cpp b/src/modules/SX126x/SX1261.cpp index b0b626c2..1e035651 100644 --- a/src/modules/SX126x/SX1261.cpp +++ b/src/modules/SX126x/SX1261.cpp @@ -18,7 +18,7 @@ int16_t SX1261::setOutputPower(int8_t power) { RADIOLIB_ASSERT(state); // set output power - // TODO power ramp time configuration + /// \todo power ramp time configuration state = SX126x::setTxParams(power); RADIOLIB_ASSERT(state); diff --git a/src/modules/SX126x/SX1262.cpp b/src/modules/SX126x/SX1262.cpp index a73cebe6..0d78eea5 100644 --- a/src/modules/SX126x/SX1262.cpp +++ b/src/modules/SX126x/SX1262.cpp @@ -84,7 +84,7 @@ int16_t SX1262::setOutputPower(int8_t power) { RADIOLIB_ASSERT(state); // set output power - // TODO power ramp time configuration + /// \todo power ramp time configuration state = SX126x::setTxParams(power); RADIOLIB_ASSERT(state); diff --git a/src/modules/SX126x/SX1268.cpp b/src/modules/SX126x/SX1268.cpp index 673f5853..0addddf8 100644 --- a/src/modules/SX126x/SX1268.cpp +++ b/src/modules/SX126x/SX1268.cpp @@ -23,7 +23,7 @@ int16_t SX1268::begin(float freq, float bw, uint8_t sf, uint8_t cr, uint8_t sync return(state); } -int16_t SX1268::beginFSK(float freq, float br, float freqDev, float rxBw, int8_t power, uint16_t preambleLength,float tcxoVoltage, bool useRegulatorLDO) { +int16_t SX1268::beginFSK(float freq, float br, float freqDev, float rxBw, int8_t power, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO) { // execute common part int16_t state = SX126x::beginFSK(br, freqDev, rxBw, preambleLength, tcxoVoltage, useRegulatorLDO); RADIOLIB_ASSERT(state); @@ -41,6 +41,7 @@ int16_t SX1268::beginFSK(float freq, float br, float freqDev, float rxBw, int8_t return(state); } +/// \todo integers only (all modules - frequency, data rate, bandwidth etc.) int16_t SX1268::setFrequency(float freq, bool calibrate) { RADIOLIB_CHECK_RANGE(freq, 410.0, 810.0, ERR_INVALID_FREQUENCY); @@ -78,7 +79,7 @@ int16_t SX1268::setOutputPower(int8_t power) { RADIOLIB_ASSERT(state); // set output power - // TODO power ramp time configuration + /// \todo power ramp time configuration state = SX126x::setTxParams(power); RADIOLIB_ASSERT(state);