Mirrors_Framework/c-periphery
1
0
Fork 0
mirror of https://github.com/vsergeev/c-periphery.git synced 2026-10-06 04:59:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs/serial: improve wording in description for serial_poll()

Browse Source
This commit is contained in:
Vanya A. Sergeev
2020-05-28 00:04:13 -05:00
parent a700bd1359
commit d74a3c9774
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/serial.md
+1 -1
View File
@@ -149,7 +149,7 @@ bool serial_poll(serial_t *serial, int timeout_ms);
```
Poll for data available for reading from the serial port.
`serial` should be a valid pointer to a Serial handle opened with `serial_open()` or `serial_open_advanced()`. `timeout_ms` can be positive for a timeout in milliseconds, 0 for a non-blocking poll, or a negative number for a blocking poll.
`serial` should be a valid pointer to a Serial handle opened with `serial_open()` or `serial_open_advanced()`. `timeout_ms` can be positive for a timeout in milliseconds, zero for a non-blocking poll, or negative for a blocking poll.
Returns 1 on success (data available for reading), 0 on timeout, or a negative [Serial error code](#return-value) on failure.