mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-01-13 07:56:17 +01:00
Fix some gtk-doc stuff
This commit is contained in:
parent
69d6987995
commit
88781d5906
@ -37,7 +37,7 @@
|
|||||||
* @short_description: Base class for implementing streaming input
|
* @short_description: Base class for implementing streaming input
|
||||||
* @include: gio/gio.h
|
* @include: gio/gio.h
|
||||||
*
|
*
|
||||||
* GInputStream has functions to read from a stream (g_input_stream_read()),
|
* #GInputStream has functions to read from a stream (g_input_stream_read()),
|
||||||
* to close a stream (g_input_stream_close()) and to skip some content
|
* to close a stream (g_input_stream_close()) and to skip some content
|
||||||
* (g_input_stream_skip()).
|
* (g_input_stream_skip()).
|
||||||
*
|
*
|
||||||
@ -153,9 +153,9 @@ g_input_stream_init (GInputStream *stream)
|
|||||||
* can happen e.g. near the end of a file. Zero is returned on end of file
|
* can happen e.g. near the end of a file. Zero is returned on end of file
|
||||||
* (or if @count is zero), but never otherwise.
|
* (or if @count is zero), but never otherwise.
|
||||||
*
|
*
|
||||||
* If @cancellable is not NULL, then the operation can be cancelled by
|
* If @cancellable is not %NULL, then the operation can be cancelled by
|
||||||
* triggering the cancellable object from another thread. If the operation
|
* triggering the cancellable object from another thread. If the operation
|
||||||
* was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If an
|
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
|
||||||
* operation was partially finished when the operation was cancelled the
|
* operation was partially finished when the operation was cancelled the
|
||||||
* partial result will be returned, without an error.
|
* partial result will be returned, without an error.
|
||||||
*
|
*
|
||||||
@ -414,7 +414,7 @@ g_input_stream_real_skip (GInputStream *stream,
|
|||||||
* close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
|
* close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
|
||||||
* is important to check and report the error to the user.
|
* is important to check and report the error to the user.
|
||||||
*
|
*
|
||||||
* If @cancellable is not NULL, then the operation can be cancelled by
|
* If @cancellable is not %NULL, then the operation can be cancelled by
|
||||||
* triggering the cancellable object from another thread. If the operation
|
* triggering the cancellable object from another thread. If the operation
|
||||||
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
|
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
|
||||||
* Cancelling a close will still leave the stream closed, but some streams
|
* Cancelling a close will still leave the stream closed, but some streams
|
||||||
|
@ -35,7 +35,7 @@
|
|||||||
* @short_description: Base class for implementing streaming output
|
* @short_description: Base class for implementing streaming output
|
||||||
* @include: gio/gio.h
|
* @include: gio/gio.h
|
||||||
*
|
*
|
||||||
* GOutputStream has functions to write to a stream (g_output_stream_write()),
|
* #GOutputStream has functions to write to a stream (g_output_stream_write()),
|
||||||
* to close a stream (g_output_stream_close()) and to flush pending writes
|
* to close a stream (g_output_stream_close()) and to flush pending writes
|
||||||
* (g_output_stream_flush()).
|
* (g_output_stream_flush()).
|
||||||
*
|
*
|
||||||
@ -169,7 +169,7 @@ g_output_stream_init (GOutputStream *stream)
|
|||||||
* is written or an error occurs; 0 is never returned (unless
|
* is written or an error occurs; 0 is never returned (unless
|
||||||
* @count is 0).
|
* @count is 0).
|
||||||
*
|
*
|
||||||
* If @cancellable is not NULL, then the operation can be cancelled by
|
* If @cancellable is not %NULL, then the operation can be cancelled by
|
||||||
* triggering the cancellable object from another thread. If the operation
|
* triggering the cancellable object from another thread. If the operation
|
||||||
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
|
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
|
||||||
* operation was partially finished when the operation was cancelled the
|
* operation was partially finished when the operation was cancelled the
|
||||||
@ -248,7 +248,7 @@ g_output_stream_write (GOutputStream *stream,
|
|||||||
* On a successful write of @count bytes, %TRUE is returned, and @bytes_written
|
* On a successful write of @count bytes, %TRUE is returned, and @bytes_written
|
||||||
* is set to @count.
|
* is set to @count.
|
||||||
*
|
*
|
||||||
* If there is an error during the operation FALSE is returned and @error
|
* If there is an error during the operation %FALSE is returned and @error
|
||||||
* is set to indicate the error status, @bytes_written is updated to contain
|
* is set to indicate the error status, @bytes_written is updated to contain
|
||||||
* the number of bytes written into the stream before the error occurred.
|
* the number of bytes written into the stream before the error occurred.
|
||||||
*
|
*
|
||||||
@ -551,7 +551,7 @@ _g_output_stream_close_internal (GOutputStream *stream,
|
|||||||
* is important to check and report the error to the user, otherwise
|
* is important to check and report the error to the user, otherwise
|
||||||
* there might be a loss of data as all data might not be written.
|
* there might be a loss of data as all data might not be written.
|
||||||
*
|
*
|
||||||
* If @cancellable is not NULL, then the operation can be cancelled by
|
* If @cancellable is not %NULL, then the operation can be cancelled by
|
||||||
* triggering the cancellable object from another thread. If the operation
|
* triggering the cancellable object from another thread. If the operation
|
||||||
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
|
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
|
||||||
* Cancelling a close will still leave the stream closed, but there some streams
|
* Cancelling a close will still leave the stream closed, but there some streams
|
||||||
|
Loading…
Reference in New Issue
Block a user