docs: Move the GBufferedInputStream SECTION

Move the contents to the struct docs.

Helps: #3037
This commit is contained in:
Matthias Clasen 2023-09-25 21:23:51 -04:00 committed by Philip Withnall
parent f7b5e3b37e
commit 08990badb6
2 changed files with 7 additions and 16 deletions

View File

@ -34,25 +34,21 @@
/** /**
* SECTION:gbufferedinputstream * GBufferedInputStream:
* @short_description: Buffered Input Stream
* @include: gio/gio.h
* @see_also: #GFilterInputStream, #GInputStream
* *
* Buffered input stream implements #GFilterInputStream and provides * Buffered input stream implements #GFilterInputStream and provides
* for buffered reads. * 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(), * To create a buffered input stream, use [func@Gio.BufferedInputStream.new],
* or g_buffered_input_stream_new_sized() to specify the buffer's size at * or [func@Gio.BufferedInputStream.new_sized] to specify the buffer's size at
* construction. * construction.
* *
* To get the size of a buffer within a buffered input stream, use * 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 * [method@Gio.BufferedInputStream.get_buffer_size]. To change the size of a
* buffered input stream's buffer, use * buffered input stream's buffer, use [method@Gio.BufferedInputStream.set_buffer_size].
* g_buffered_input_stream_set_buffer_size(). Note that the buffer's size * Note that the buffer's size cannot be reduced below the size of the data within the buffer.
* cannot be reduced below the size of the data within the buffer.
*/ */

View File

@ -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_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)) #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 _GBufferedInputStreamClass GBufferedInputStreamClass;
typedef struct _GBufferedInputStreamPrivate GBufferedInputStreamPrivate; typedef struct _GBufferedInputStreamPrivate GBufferedInputStreamPrivate;