From 6aaab07e0f02e043f149d39a7d2e2012c19cf34f Mon Sep 17 00:00:00 2001 From: Murray Cumming Date: Mon, 21 Jan 2008 13:08:23 +0000 Subject: [PATCH] Documentation: Fixed minor typos and added more mentions of specific 2008-01-21 Murray Cumming,,, * gfileenumerator.c: * gfileinputstream.c: * ginputstream.c: * goutputstream.c: Documentation: Fixed minor typos and added more mentions of specific _finish() functions. svn path=/trunk/; revision=6339 --- gio/ChangeLog | 8 ++++++++ gio/gfileenumerator.c | 4 ++-- gio/gfileinputstream.c | 11 ++++++++--- gio/ginputstream.c | 18 +++++++++++------- gio/goutputstream.c | 27 +++++++++++++++++++-------- 5 files changed, 48 insertions(+), 20 deletions(-) diff --git a/gio/ChangeLog b/gio/ChangeLog index 5b37988c2..ba59c5c8c 100644 --- a/gio/ChangeLog +++ b/gio/ChangeLog @@ -1,3 +1,11 @@ +2008-01-21 Murray Cumming,,, + + * 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 * inotify/Makefile.am: diff --git a/gio/gfileenumerator.c b/gio/gfileenumerator.c index 2c478fa91..9c2af06c2 100644 --- a/gio/gfileenumerator.c +++ b/gio/gfileenumerator.c @@ -191,8 +191,8 @@ g_file_enumerator_next_file (GFileEnumerator *enumerator, * 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. **/ diff --git a/gio/gfileinputstream.c b/gio/gfileinputstream.c index 59c446ed6..75607a5db 100644 --- a/gio/gfileinputstream.c +++ b/gio/gfileinputstream.c @@ -116,7 +116,7 @@ g_file_input_stream_init (GFileInputStream *stream) * @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 @@ -184,8 +184,13 @@ async_ready_callback_wrapper (GObject *source_object, * @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 diff --git a/gio/ginputstream.c b/gio/ginputstream.c index 01fac912e..33497a9bc 100644 --- a/gio/ginputstream.c +++ b/gio/ginputstream.c @@ -405,8 +405,8 @@ g_input_stream_real_skip (GInputStream *stream, * 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 @@ -500,8 +500,9 @@ async_ready_close_callback_wrapper (GObject *source_object, * @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. @@ -624,8 +625,9 @@ g_input_stream_read_finish (GInputStream *stream, * @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. @@ -746,7 +748,9 @@ g_input_stream_skip_finish (GInputStream *stream, * @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(). * diff --git a/gio/goutputstream.c b/gio/goutputstream.c index 8522f0c66..bf9e82a26 100644 --- a/gio/goutputstream.c +++ b/gio/goutputstream.c @@ -342,7 +342,7 @@ g_output_stream_flush (GOutputStream *stream, * * 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, @@ -474,8 +474,8 @@ g_output_stream_real_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 @@ -585,8 +585,9 @@ async_ready_close_callback_wrapper (GObject *source_object, * @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. @@ -737,7 +738,12 @@ async_ready_splice_callback_wrapper (GObject *source_object, * @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, @@ -829,7 +835,11 @@ g_output_stream_splice_finish (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, @@ -922,7 +932,8 @@ g_output_stream_flush_finish (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(). *