glib r7346 - trunk/gio

[matthiasc svn gnome org]

Author: matthiasc
Date: Wed Aug 13 05:35:10 2008
New Revision: 7346
URL: http://svn.gnome.org/viewvc/glib?rev=7346&view=rev

Log:
Add docs


Modified:
   trunk/gio/ChangeLog
   trunk/gio/ginputstream.c
   trunk/gio/goutputstream.c

Modified: trunk/gio/ginputstream.c
==============================================================================
--- trunk/gio/ginputstream.c	(original)
+++ trunk/gio/ginputstream.c	Wed Aug 13 05:35:10 2008
@@ -38,8 +38,14 @@
  * @short_description: Base class for implementing streaming input
  * @include: gio/gio.h
  *
- * 
- * 
+ * GInputStream has functions to read from a stream (g_input_stream_read()),
+ * to close a stream (g_input_stream_close()) and to skip some content
+ * (g_input_stream_skip()). 
+ *
+ * To copy the content of an input stream to an output stream without 
+ * manually handling the reads and writes, use g_output_stream_splice(). 
+ *
+ * All of these functions have async variants too.
  **/
 
 G_DEFINE_TYPE (GInputStream, g_input_stream, G_TYPE_OBJECT);

Modified: trunk/gio/goutputstream.c
==============================================================================
--- trunk/gio/goutputstream.c	(original)
+++ trunk/gio/goutputstream.c	Wed Aug 13 05:35:10 2008
@@ -36,7 +36,14 @@
  * @short_description: Base class for implementing streaming output
  * @include: gio/gio.h
  *
+ * GOutputStream has functions to write to a stream (g_output_stream_write()),
+ * to close a stream (g_output_stream_close()) and to flush pending writes
+ * (g_output_stream_flush()). 
  *
+ * To copy the content of an input stream to an output stream without 
+ * manually handling the reads and writes, use g_output_stream_splice(). 
+ *
+ * All of these functions have async variants too.
  **/
 
 G_DEFINE_TYPE (GOutputStream, g_output_stream, G_TYPE_OBJECT);