hotfix for ucx_buffer_seek documentation

Mon, 05 May 2014 14:52:40 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 05 May 2014 14:52:40 +0200
changeset 165
4d85da1f98db
parent 164
1fa3f13f774c
child 166
350a0e3898bd

hotfix for ucx_buffer_seek documentation

ucx/buffer.h file | annotate | diff | comparison | revisions
--- a/ucx/buffer.h	Mon May 05 13:53:27 2014 +0200
+++ b/ucx/buffer.h	Mon May 05 14:52:40 2014 +0200
@@ -145,7 +145,11 @@
  *
  * SEEK_SET marks the start of the buffer.
  * SEEK_CUR marks the current position.
- * SEEK_END marks the first 0-byte in the buffer.
+ * SEEK_END marks the end of the buffer.
+ * 
+ * With an offset of zero, this function sets the buffer position to zero
+ * (SEEK_SET), the buffer size (SEEK_END) or leaves the buffer position
+ * unchanged (SEEK_CUR).
  * 
  * @param buffer
  * @param offset position offset relative to <code>whence</code>

mercurial