Add docs

svn path=/trunk/; revision=7346

diff --git a/gio/ChangeLog b/gio/ChangeLog
index 58300f154332f35d885775808d2361ece102496f..5fe43d5e15d47b468749e6e4ec5a69d66ab71a20 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,8 @@
+2008-08-13  Matthias Clasen  <mclasen@redhat.com>
+
+       * ginputstream.c:
+       * goutputstream.c: Add intro docs.
+
 2008-08-13  Tor Lillqvist  <tml@novell.com>
 
        * win32/gwinhttpfileoutputstream.c

diff --git a/gio/ginputstream.c b/gio/ginputstream.c
index 740de34eb4636240535f051c99d2b27ebb7d1ada..663bfde771570b31067e1c8f11bea7c286f94c96 100644 (file)
--- a/gio/ginputstream.c
+++ b/gio/ginputstream.c
@@ -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);

diff --git a/gio/goutputstream.c b/gio/goutputstream.c
index 42c55314ef6661430c14eb2681e5bfdf0bfb986c..3f7155d270fd1e1e9b46453dbb60b1e23299ceb7 100644 (file)
--- a/gio/goutputstream.c
+++ b/gio/goutputstream.c
@@ -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);