From 859874648ee98385a9d8be76182157a40eca69c0 Mon Sep 17 00:00:00 2001 From: Martin Ling Date: Wed, 27 Nov 2013 14:12:04 +0000 Subject: [PATCH] Fix error in documentation. --- libserialport.h.in | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/libserialport.h.in b/libserialport.h.in index e1f670d..9eb7662 100644 --- a/libserialport.h.in +++ b/libserialport.h.in @@ -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.