From: Frank Mori Hess <fmhess@speakeasy.net>
Date: Mon, 17 Dec 2007 00:06:39 +0000 (+0000)
Subject: Added a little more description of return value from
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=624228b8fea737894ed25b1fa1b723d2ebd4d025;p=comedilib.git

Added a little more description of return value from
comedi_mark_buffer_read(), from Jan Gukelberger <g.u.g.i@gmx.de>.
---

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