Add GI annotations to GBufferedInputStream

This commit is contained in:
Pavel Holejsovsky 2010-12-21 18:19:16 +01:00
parent 5ea4fa75bd
commit 86b250019a

View File

@ -360,7 +360,7 @@ g_buffered_input_stream_new_sized (GInputStream *base_stream,
* g_buffered_input_stream_fill: * g_buffered_input_stream_fill:
* @stream: a #GBufferedInputStream * @stream: a #GBufferedInputStream
* @count: the number of bytes that will be read from the stream * @count: the number of bytes that will be read from the stream
* @cancellable: optional #GCancellable object, %NULL to ignore * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
* @error: location to store the error occuring, or %NULL to ignore * @error: location to store the error occuring, or %NULL to ignore
* *
* Tries to read @count bytes from the stream into the buffer. * Tries to read @count bytes from the stream into the buffer.
@ -447,9 +447,9 @@ async_fill_callback_wrapper (GObject *source_object,
* @count: the number of bytes that will be read from the stream * @count: the number of bytes that will be read from the stream
* @io_priority: the <link linkend="io-priority">I/O priority</link> * @io_priority: the <link linkend="io-priority">I/O priority</link>
* of the request * of the request
* @cancellable: optional #GCancellable object * @cancellable: (allow-none): optional #GCancellable object
* @callback: a #GAsyncReadyCallback * @callback: (scope async): a #GAsyncReadyCallback
* @user_data: a #gpointer * @user_data: (closure): a #gpointer
* *
* Reads data into @stream's buffer asynchronously, up to @count size. * Reads data into @stream's buffer asynchronously, up to @count size.
* @io_priority can be used to prioritize reads. For the synchronous * @io_priority can be used to prioritize reads. For the synchronous
@ -602,13 +602,14 @@ g_buffered_input_stream_peek (GBufferedInputStream *stream,
/** /**
* g_buffered_input_stream_peek_buffer: * g_buffered_input_stream_peek_buffer:
* @stream: a #GBufferedInputStream * @stream: a #GBufferedInputStream
* @count: a #gsize to get the number of bytes available in the buffer * @count: (out): a #gsize to get the number of bytes available in the buffer
* *
* Returns the buffer with the currently available bytes. The returned * Returns the buffer with the currently available bytes. The returned
* buffer must not be modified and will become invalid when reading from * buffer must not be modified and will become invalid when reading from
* the stream or filling the buffer. * the stream or filling the buffer.
* *
* Returns: read-only buffer * Returns: (array length=count) (element-type guint8) (transfer none):
* read-only buffer
*/ */
const void* const void*
g_buffered_input_stream_peek_buffer (GBufferedInputStream *stream, g_buffered_input_stream_peek_buffer (GBufferedInputStream *stream,
@ -839,7 +840,7 @@ g_buffered_input_stream_read (GInputStream *stream,
/** /**
* g_buffered_input_stream_read_byte: * g_buffered_input_stream_read_byte:
* @stream: a #GBufferedInputStream * @stream: a #GBufferedInputStream
* @cancellable: optional #GCancellable object, %NULL to ignore * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
* @error: location to store the error occuring, or %NULL to ignore * @error: location to store the error occuring, or %NULL to ignore
* *
* Tries to read a single byte from the stream or the buffer. Will block * Tries to read a single byte from the stream or the buffer. Will block