summaryrefslogtreecommitdiff
path: root/gio/gfileiostream.c
diff options
context:
space:
mode:
authorAlexander Larsson <alexl@redhat.com>2009-05-18 13:02:11 +0200
committerAlexander Larsson <alexl@redhat.com>2009-05-18 13:07:43 +0200
commit6ea86cc57f1b8b8c7acc4e08ece8baef5f28a53a (patch)
treef8520496798bc4b99348baed0dcfbd4d4cbe9f95 /gio/gfileiostream.c
parente1afc6e79b9526d68eff0f218ac98a6f0e323513 (diff)
Update the docs for the new network APIs
This imports the network APIs into the gio reference docs, and cleans up a bunch of gtk-doc warnings and documentation issues.
Diffstat (limited to 'gio/gfileiostream.c')
-rw-r--r--gio/gfileiostream.c10
1 files changed, 7 insertions, 3 deletions
diff --git a/gio/gfileiostream.c b/gio/gfileiostream.c
index 3cc72ed76..14cdbfefd 100644
--- a/gio/gfileiostream.c
+++ b/gio/gfileiostream.c
@@ -36,7 +36,7 @@
/**
* SECTION:gfileiostream
- * @short_description: read write streams for File
+ * @short_description: File read and write streaming operations
* @include: gio/gio.h
* @see_also: #GIOStream, #GFileInputStream, #GFileOutputStream, #GSeekable
*
@@ -49,13 +49,17 @@
* operations. In addition to the generic g_seekable_ API,
* GFileIOStream has its own API for seeking and positioning.
* To find the position of a file io stream, use
- * g_file_io_stream_tell(). To find out if a file io
- * stream supports seeking, use g_file_io_stream_can_seek().
+ * g_file_io_stream_tell().
+ *
+ * To find out if a file io stream supports seeking, use g_file_io_stream_can_seek().
* To position a file io stream, use g_file_io_stream_seek().
* To find out if a file io stream supports truncating, use
* g_file_io_stream_can_truncate(). To truncate a file io
* stream, use g_file_io_stream_truncate().
*
+ * The default implementation of all the #GFileIOStream operations
+ * and the implementation of #GSeekable just call into the same operations
+ * on the output stream.
* Since: 2.22
**/