reviewed by: Alexander Larsson <alexl@redhat.com>

2008-10-28  Cosimo Cecchi  <cosimoc@gnome.org>

	reviewed by: Alexander Larsson <alexl@redhat.com>

	* gdatainputstream.c: Make the docs of g_dada_input_stream_read_line ()
	clearer about the behavior when there's no more content to read.

svn path=/trunk/; revision=7632

diff --git a/gio/ChangeLog b/gio/ChangeLog
index cdac28c..8da10d3 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,10 @@
+2008-10-28  Cosimo Cecchi  <cosimoc@gnome.org>
+
+       reviewed by: Alexander Larsson <alexl@redhat.com>
+
+       * gdatainputstream.c: Make the docs of g_dada_input_stream_read_line ()
+       clearer about the behavior when there's no more content to read.
+
 2008-10-27  Federico Mena Quintero  <federico@novell.com>
 
        * glocalfile.c (g_local_file_get_parse_name): Don't leak roundtripped_filename.

diff --git a/gio/gdatainputstream.c b/gio/gdatainputstream.c
index 0bf716f..2c8bcde 100644 (file)
--- a/gio/gdatainputstream.c
+++ b/gio/gdatainputstream.c
@@ -740,7 +740,9 @@ scan_for_newline (GDataInputStream *stream,
  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. 
  * 
  * Returns: a string with the line that was read in (including the newlines).
- * Set @length to a #gsize to get the length of the read line. Returns %NULL on an error.
+ * Set @length to a #gsize to get the length of the read line.
+ * On an error, it will return %NULL and @error will be set. If there's no
+ * content to read, it will still return %NULL, but @error won't be set.
  **/
 char *
 g_data_input_stream_read_line (GDataInputStream  *stream,