[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[freetype2] master 7be364c6a: * include/freetype/ftsystem.h (FT_Stream_I
From: |
Werner Lemberg |
Subject: |
[freetype2] master 7be364c6a: * include/freetype/ftsystem.h (FT_Stream_IoFunc): Improve documentation. |
Date: |
Thu, 16 Mar 2023 00:28:01 -0400 (EDT) |
branch: master
commit 7be364c6a22c5a4a0087d1ac2c40b695b16e1907
Author: Werner Lemberg <wl@gnu.org>
Commit: Werner Lemberg <wl@gnu.org>
* include/freetype/ftsystem.h (FT_Stream_IoFunc): Improve documentation.
Fixes #1208.
---
include/freetype/ftsystem.h | 16 ++++------------
1 file changed, 4 insertions(+), 12 deletions(-)
diff --git a/include/freetype/ftsystem.h b/include/freetype/ftsystem.h
index a995b078d..3a08f4912 100644
--- a/include/freetype/ftsystem.h
+++ b/include/freetype/ftsystem.h
@@ -229,8 +229,7 @@ FT_BEGIN_HEADER
* A handle to the source stream.
*
* offset ::
- * The offset from the start of the stream to seek to if this is a seek
- * operation (see note).
+ * The offset from the start of the stream to seek to.
*
* buffer ::
* The address of the read buffer.
@@ -239,16 +238,9 @@ FT_BEGIN_HEADER
* The number of bytes to read from the stream.
*
* @return:
- * The number of bytes effectively read by the stream.
- *
- * @note:
- * This function performs a seek *or* a read operation depending on the
- * argument values. If `count` is zero, the operation is a seek to
- * `offset` bytes. If `count` is >~0, the operation is a read of `count`
- * bytes from the current position in the stream, and the `offset` value
- * should be ignored.
- *
- * For seek operations, a non-zero return value indicates an error.
+ * If count >~0, return the number of bytes effectively read by the
+ * stream (after seeking to `offset`). If count ==~0, return the status
+ * of the seek operation (non-zero indicates an error).
*
*/
typedef unsigned long
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [freetype2] master 7be364c6a: * include/freetype/ftsystem.h (FT_Stream_IoFunc): Improve documentation.,
Werner Lemberg <=