From 624228b8fea737894ed25b1fa1b723d2ebd4d025 Mon Sep 17 00:00:00 2001 From: Frank Mori Hess Date: Mon, 17 Dec 2007 00:06:39 +0000 Subject: [PATCH] Added a little more description of return value from comedi_mark_buffer_read(), from Jan Gukelberger . --- doc/funcref | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/funcref b/doc/funcref index a700325..d77d15d 100644 --- a/doc/funcref +++ b/doc/funcref @@ -1023,7 +1023,10 @@ Description: transferred via read() calls. This function is used to indicate that the next num_bytes bytes in the buffer are no longer needed and may be discarded. - If there is an error, -1 is returned. +Returns: + A return value ret greater than 0 indicates that the read offset in + the streaming buffer, as returned by comedi_get_buffer_offset, has been + incremented by ret bytes. If there is an error, -1 is returned. Function: comedi_mark_buffer_written -- streaming buffer control Retval: int -- 2.26.2