mirror/libserialport
mirror/libserialport
1
0
Fork 0
mirror of git://sigrok.org/libserialport synced 2023-08-10 21:13:24 +03:00
Code Issues Projects Releases Wiki Activity

Fix error in documentation.

Browse Source
This commit is contained in:
Martin Ling 2013-11-27 14:12:04 +00:00
parent 2007ce5e14
commit 859874648e
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
libserialport.h.in
View File

@ -818,10 +818,10 @@ enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count
* @param count Requested number of bytes to write.
* @param timeout Timeout in milliseconds, or zero to wait indefinitely.
*
* @return The number of bytes read on success, or a negative error code. If
* the number of bytes returned is less than that requested, the
* @return The number of bytes written on success, or a negative error code.
* If the number of bytes returned is less than that requested, the
* timeout was reached before the requested number of bytes was
* sent. If timeout is zero, the function will always return
* written. If timeout is zero, the function will always return
* either the requested number of bytes or a negative error code. In
* the event of an error there is no way to determine how many bytes
* were sent before the error occured.