From 08990badb68ae60a0850fa1497010ee495d3f753 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 25 Sep 2023 21:23:51 -0400 Subject: [PATCH] docs: Move the GBufferedInputStream SECTION Move the contents to the struct docs. Helps: #3037 --- gio/gbufferedinputstream.c | 18 +++++++----------- gio/gbufferedinputstream.h | 5 ----- 2 files changed, 7 insertions(+), 16 deletions(-) diff --git a/gio/gbufferedinputstream.c b/gio/gbufferedinputstream.c index 1729ebde6..429edc0af 100644 --- a/gio/gbufferedinputstream.c +++ b/gio/gbufferedinputstream.c @@ -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. */ diff --git a/gio/gbufferedinputstream.h b/gio/gbufferedinputstream.h index c6b1deadc..eced51f5e 100644 --- a/gio/gbufferedinputstream.h +++ b/gio/gbufferedinputstream.h @@ -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;