Skip to content

Commit 60d6a17

Browse files
committed
📝 docs(serial): Improve function description
1 parent 9ac6a58 commit 60d6a17

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

‎include/libserial/serial.hpp‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,10 @@ int getAvailableData() const;
196196
* timing out. A value of 0 means no timeout (blocking).
197197
*
198198
* @param timeout Timeout in milliseconds
199-
* @throws SerialException if setting cannot be applied
199+
*
200+
* @note The system timeout is set in deciseconds (100ms units), so the value
201+
* will be rounded down to the nearest multiple of 100ms. For example,
202+
* 1549ms will be set as 1500ms.
200203
*/
201204
void setReadTimeout(std::chrono::milliseconds timeout);
202205

0 commit comments

Comments
 (0)