summaryrefslogtreecommitdiff
path: root/gio/gbufferedinputstream.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2023-09-25 21:23:51 -0400
committerPhilip Withnall <pwithnall@endlessos.org>2023-10-17 11:19:27 +0100
commit08990badb68ae60a0850fa1497010ee495d3f753 (patch)
treecf659f0f8f60f939f1ed154e6295de7161133fe4 /gio/gbufferedinputstream.c
parentf7b5e3b37e7e817b19115e803c82d6dd205b6729 (diff)
docs: Move the GBufferedInputStream SECTION
Move the contents to the struct docs. Helps: #3037
Diffstat (limited to 'gio/gbufferedinputstream.c')
-rw-r--r--gio/gbufferedinputstream.c18
1 files changed, 7 insertions, 11 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.
*/