mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-24 14:36:13 +01:00
docs: Move the GBufferedInputStream SECTION
Move the contents to the struct docs. Helps: #3037
This commit is contained in:
parent
f7b5e3b37e
commit
08990badb6
@ -34,25 +34,21 @@
|
||||
|
||||
|
||||
/**
|
||||
* SECTION:gbufferedinputstream
|
||||
* @short_description: Buffered Input Stream
|
||||
* @include: gio/gio.h
|
||||
* @see_also: #GFilterInputStream, #GInputStream
|
||||
* GBufferedInputStream:
|
||||
*
|
||||
* Buffered input stream implements #GFilterInputStream and provides
|
||||
* for buffered reads.
|
||||
*
|
||||
* By default, #GBufferedInputStream's buffer size is set at 4 kilobytes.
|
||||
* By default, `GBufferedInputStream`'s buffer size is set at 4 kilobytes.
|
||||
*
|
||||
* To create a buffered input stream, use g_buffered_input_stream_new(),
|
||||
* or g_buffered_input_stream_new_sized() to specify the buffer's size at
|
||||
* To create a buffered input stream, use [func@Gio.BufferedInputStream.new],
|
||||
* or [func@Gio.BufferedInputStream.new_sized] to specify the buffer's size at
|
||||
* construction.
|
||||
*
|
||||
* To get the size of a buffer within a buffered input stream, use
|
||||
* g_buffered_input_stream_get_buffer_size(). To change the size of a
|
||||
* buffered input stream's buffer, use
|
||||
* g_buffered_input_stream_set_buffer_size(). Note that the buffer's size
|
||||
* cannot be reduced below the size of the data within the buffer.
|
||||
* [method@Gio.BufferedInputStream.get_buffer_size]. To change the size of a
|
||||
* buffered input stream's buffer, use [method@Gio.BufferedInputStream.set_buffer_size].
|
||||
* Note that the buffer's size cannot be reduced below the size of the data within the buffer.
|
||||
*/
|
||||
|
||||
|
||||
|
@ -38,11 +38,6 @@ G_BEGIN_DECLS
|
||||
#define G_IS_BUFFERED_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_BUFFERED_INPUT_STREAM))
|
||||
#define G_BUFFERED_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_BUFFERED_INPUT_STREAM, GBufferedInputStreamClass))
|
||||
|
||||
/**
|
||||
* GBufferedInputStream:
|
||||
*
|
||||
* Implements #GFilterInputStream with a sized input buffer.
|
||||
**/
|
||||
typedef struct _GBufferedInputStreamClass GBufferedInputStreamClass;
|
||||
typedef struct _GBufferedInputStreamPrivate GBufferedInputStreamPrivate;
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user