From cec561c2cdbe5d01f11aef4f293839b06ed30e17 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 13 Aug 2008 05:35:10 +0000 Subject: [PATCH] Add docs svn path=/trunk/; revision=7346 --- gio/ChangeLog | 5 +++++ gio/ginputstream.c | 10 ++++++++-- gio/goutputstream.c | 7 +++++++ 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/gio/ChangeLog b/gio/ChangeLog index 58300f154..5fe43d5e1 100644 --- a/gio/ChangeLog +++ b/gio/ChangeLog @@ -1,3 +1,8 @@ +2008-08-13 Matthias Clasen + + * ginputstream.c: + * goutputstream.c: Add intro docs. + 2008-08-13 Tor Lillqvist * win32/gwinhttpfileoutputstream.c diff --git a/gio/ginputstream.c b/gio/ginputstream.c index 740de34eb..663bfde77 100644 --- 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 42c55314e..3f7155d27 100644 --- 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);