+2008-01-21 Murray Cumming,,, <murrayc@murrayc.com>
+
+ * gfileenumerator.c:
+ * gfileinputstream.c:
+ * ginputstream.c:
+ * goutputstream.c: Documentation: Fixed minor typos
+ and added more mentions of specific _finish() functions.
+
2008-01-21 Alexander Larsson <alexl@redhat.com>
* inotify/Makefile.am:
* enumerator return %G_IO_ERROR_CLOSED on all calls.
*
* This will be automatically called when the last reference
- * is dropped, but you might want to call make sure resources
- * are released as early as possible.
+ * is dropped, but you might want to call this function to make
+ * sure resources are released as early as possible.
*
* Return value: #TRUE on success or #FALSE on error.
**/
* @error: a #GError location to store the error occuring, or %NULL to
* ignore.
*
- * Queries a file input stream the given @attributes.his function blocks
+ * Queries a file input stream the given @attributes. This function blocks
* while querying the stream. For the asynchronous (non-blocking) version
* of this function, see g_file_input_stream_query_info_async(). While the
* stream is blocked, the stream will set the pending flag internally, and
* @callback: callback to call when the request is satisfied
* @user_data: the data to pass to callback function
*
- * Queries the stream information asynchronously. For the synchronous
- * version of this function, see g_file_input_stream_query_info().
+ * Queries the stream information asynchronously.
+ * When the operation is finished @callback will be called.
+ * You can then call g_file_input_stream_query_info_finish()
+ * to get the result of the operation.
+ *
+ * For the synchronous version of this function,
+ * see g_file_input_stream_query_info().
*
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* Closing a stream multiple times will not return an error.
*
* Streams will be automatically closed when the last reference
- * is dropped, but you might want to call make sure resources
- * are released as early as possible.
+ * is dropped, but you might want to call this function to make sure
+ * resources are released as early as possible.
*
* Some streams might keep the backing store of the stream (e.g. a file descriptor)
* open after the stream is closed. See the documentation for the individual
* @user_data: the data to pass to callback function
*
* Request an asynchronous read of @count bytes from the stream into the buffer
- * starting at @buffer. When the operation is finished @callback will be called,
- * giving the results.
+ * starting at @buffer. When the operation is finished @callback will be called.
+ * You can then call g_input_stream_read_finish() to get the result of the
+ * operation.
*
* During an async request no other sync and async calls are allowed, and will
* result in %G_IO_ERROR_PENDING errors.
* @user_data: the data to pass to callback function
*
* Request an asynchronous skip of @count bytes from the stream into the buffer
- * starting at @buffer. When the operation is finished @callback will be called,
- * giving the results.
+ * starting at @buffer. When the operation is finished @callback will be called.
+ * You can then call g_input_stream_skip_finish() to get the result of the
+ * operation.
*
* During an async request no other sync and async calls are allowed, and will
* result in %G_IO_ERROR_PENDING errors.
* @user_data: the data to pass to callback function
*
* Requests an asynchronous closes of the stream, releasing resources related to it.
- * When the operation is finished @callback will be called, giving the results.
+ * When the operation is finished @callback will be called.
+ * You can then call g_input_stream_close_finish() to get the result of the
+ * operation.
*
* For behaviour details see g_input_stream_close().
*
*
* Splices an input stream into an output stream.
*
- * Returns: a #gssize containig the size of the data spliced.
+ * Returns: a #gssize containing the size of the data spliced.
**/
gssize
g_output_stream_splice (GOutputStream *stream,
* stream.
*
* Streams will be automatically closed when the last reference
- * is dropped, but you might want to call make sure resources
- * are released as early as possible.
+ * is dropped, but you might want to call this function to make sure
+ * resources are released as early as possible.
*
* Some streams might keep the backing store of the stream (e.g. a file descriptor)
* open after the stream is closed. See the documentation for the individual
* @user_data: the data to pass to callback function
*
* Request an asynchronous write of @count bytes from @buffer into
- * the stream. When the operation is finished @callback will be called,
- * giving the results.
+ * the stream. When the operation is finished @callback will be called.
+ * You can then call g_output_stream_write_finish() to get the result of the
+ * operation.
*
* During an async request no other sync and async calls are allowed,
* and will result in %G_IO_ERROR_PENDING errors.
* @user_data: user data passed to @callback.
*
* Splices a stream asynchronously.
- *
+ * When the operation is finished @callback will be called.
+ * You can then call g_output_stream_splice_finish() to get the
+ * result of the operation.
+ *
+ * For the synchronous, blocking version of this function, see
+ * g_output_stream_splice().
**/
void
g_output_stream_splice_async (GOutputStream *stream,
* @user_data: the data to pass to callback function
*
* Flushes a stream asynchronously.
- *
+ * For behaviour details see g_output_stream_flush().
+ *
+ * When the operation is finished @callback will be
+ * called. You can then call g_output_stream_flush_finish() to get the
+ * result of the operation.
**/
void
g_output_stream_flush_async (GOutputStream *stream,
*
* Requests an asynchronous close of the stream, releasing resources
* related to it. When the operation is finished @callback will be
- * called, giving the results.
+ * called. You can then call g_output_stream_close_finish() to get
+ * the result of the operation.
*
* For behaviour details see g_output_stream_close().
*