Skip to content

Commit e084641

Browse files
committed
Enhance documentation
1 parent 5423dc9 commit e084641

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/NiclaSenseEnv.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,11 +243,13 @@ class NiclaSenseEnv : public I2CDevice {
243243
private:
244244
/**
245245
* @brief Converts the given baud rate to its native value.
246+
* The native value is the value that is written to the corresponding register.
247+
* It's not the baud rate itself but an index representing the baud rate.
246248
*
247249
* This function takes a baud rate as input and returns its corresponding native value.
248250
*
249251
* @param baudRate The baud rate to convert. The possible values are 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200
250-
* @return The native value of the baud rate.
252+
* @return The native value of the baud rate or -1 if the baud rate is invalid.
251253
*/
252254
int baudRateNativeValue(int baudRate);
253255

0 commit comments

Comments
 (0)