glib r7632 - trunk/gio

[cosimoc svn gnome org]

Author: cosimoc
Date: Tue Oct 28 14:51:56 2008
New Revision: 7632
URL: http://svn.gnome.org/viewvc/glib?rev=7632&view=rev

Log:
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.


Modified:
   trunk/gio/ChangeLog
   trunk/gio/gdatainputstream.c

Modified: trunk/gio/gdatainputstream.c
==============================================================================
--- trunk/gio/gdatainputstream.c	(original)
+++ trunk/gio/gdatainputstream.c	Tue Oct 28 14:51:56 2008
@@ -740,7 +740,9 @@
  * 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,