More docs
authorMatthias Clasen <matthiasc@src.gnome.org>
Sun, 30 Dec 2007 06:13:12 +0000 (06:13 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Sun, 30 Dec 2007 06:13:12 +0000 (06:13 +0000)
svn path=/trunk/; revision=6216

gio/gfileinputstream.c
gio/gfileoutputstream.c

index a4e81ee..59c446e 100644 (file)
  * 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);
index b3e8979..03963a0 100644 (file)
  * 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);