From a3b09961565d1e63e7b08b906a96fedf0e757808 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 30 Dec 2007 06:13:12 +0000 Subject: [PATCH] More docs svn path=/trunk/; revision=6216 --- gio/gfileinputstream.c | 10 ++++++++-- gio/gfileoutputstream.c | 14 ++++++++++++-- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/gio/gfileinputstream.c b/gio/gfileinputstream.c index a4e81eee4..59c446ed6 100644 --- a/gio/gfileinputstream.c +++ b/gio/gfileinputstream.c @@ -39,8 +39,14 @@ * GFileInputStream provides input streams that take their * content from a file. * - * GFileInputStream implements #GSeekable, which allows - * the input stream to jump to arbitrary positions in the file. + * GFileInputStream implements #GSeekable, which allows the input + * stream to jump to arbitrary positions in the file, provided the + * filesystem of the file allows it. In addition to the generic + * g_seekable_ API, GFileInputStream has its own API for seeking + * and positioning. To find the position of a file input stream, + * use g_file_input_stream_tell(). To find out if a file input + * stream supports seeking, use g_file_input_stream_can_seek(). + * To position a file input stream, use g_file_input_stream_seek(). **/ static void g_file_input_stream_seekable_iface_init (GSeekableIface *iface); diff --git a/gio/gfileoutputstream.c b/gio/gfileoutputstream.c index b3e89798c..03963a03b 100644 --- a/gio/gfileoutputstream.c +++ b/gio/gfileoutputstream.c @@ -39,8 +39,18 @@ * GFileOutputStream provides output streams that write their * content to a file. * - * GFileOutputStream implements #GSeekable, which allows - * the output stream to jump to arbitrary positions in the file. + * GFileOutputStream implements #GSeekable, which allows the output + * stream to jump to arbitrary positions in the file and to truncate + * the file, provided the filesystem of the file supports these + * operations. In addition to the generic g_seekable_ API, + * GFileOutputStream has its own API for seeking and positioning. + * To find the position of a file output stream, use + * g_file_output_stream_tell(). To find out if a file output + * stream supports seeking, use g_file_output_stream_can_seek(). + * To position a file output stream, use g_file_output_stream_seek(). + * To find out if a file output stream supports truncating, use + * g_file_output_stream_can_truncate(). To truncate a file output + * stream, use g_file_output_stream_truncate(). **/ static void g_file_output_stream_seekable_iface_init (GSeekableIface *iface);