Skip to content

Commit 69ebac9

Browse files
committed
Update comments
1 parent 67f4da5 commit 69ebac9

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

src/SparkFun_SiT5358.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ double SfeSiT5358Driver::getFrequencyHz(void)
200200
/// @return true if the write is successful
201201
/// Note: The frequency change will be limited by the pull range capabilities of the device.
202202
/// Call getFrequencyHz to read the frequency set.
203-
/// Note: setFrequencyHz ignores _maxFrequencyChangePPB. It applies freq if it is in range.
203+
/// Note: setFrequencyHz ignores _maxFrequencyChangePPB.
204204
bool SfeSiT5358Driver::setFrequencyHz(double freq)
205205
{
206206
// Calculate the frequency offset from the base frequency

src/SparkFun_SiT5358.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ class SfeSiT5358Driver
165165

166166
/// @brief Set the base oscillator frequency in Hz - set the driver's internal _baseFrequencyHz
167167
/// @param freq the base frequency in Hz
168+
/// @return true if the write is successful
168169
void setBaseFrequencyHz(double freq);
169170

170171

@@ -177,7 +178,7 @@ class SfeSiT5358Driver
177178
/// @return true if the write is successful
178179
/// Note: The frequency change will be limited by the pull range capabilities of the device.
179180
/// Call getFrequencyHz to read the frequency set.
180-
/// Note: setFrequencyHz ignores _maxFrequencyChangePPB. It applies freq if it is in range.
181+
/// Note: setFrequencyHz ignores _maxFrequencyChangePPB.
181182
bool setFrequencyHz(double freq);
182183

183184

0 commit comments

Comments
 (0)