g_input_stream_read[_finish]: document returning 0 on EOF

g_input_stream_read() does state that it returns 0 on end of file, but
not in the Returns: line, so it's easy to miss on a quick skim-read.

g_input_stream_read_async() documents that g_input_stream_read_finish()
returns 0 on end of file, but g_input_stream_read_finish() itself does
not.

https://bugzilla.gnome.org/show_bug.cgi?id=673174

diff --git a/gio/ginputstream.c b/gio/ginputstream.c
index e46f2df07dfd5f4974f7394bf819986e30a4d03e..da578bd46c05fe90998d27c032b342d7c0c4c581 100644 (file)
--- a/gio/ginputstream.c
+++ b/gio/ginputstream.c
@@ -161,7 +161,7 @@ g_input_stream_init (GInputStream *stream)
  *
  * On error -1 is returned and @error is set accordingly.
  * 
- * Return value: Number of bytes read, or -1 on error
+ * Return value: Number of bytes read, or -1 on error, or 0 on end of file.
  **/
 gssize
 g_input_stream_read  (GInputStream  *stream,
@@ -583,7 +583,7 @@ g_input_stream_read_async (GInputStream        *stream,
  * 
  * Finishes an asynchronous stream read operation. 
  * 
- * Returns: number of bytes read in, or -1 on error.
+ * Returns: number of bytes read in, or -1 on error, or 0 on end of file.
  **/
 gssize
 g_input_stream_read_finish (GInputStream  *stream,