luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 06:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'port-gbufferedoutputstream.c-comments' into 'main'

Browse Source 
gbufferedoutputstream.c: Port doc comments to gi-docgen

See merge request GNOME/glib!4148
This commit is contained in:
Philip Withnall 2024-07-09 17:01:46 +00:00
commit 325a9af5e0
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
gio/gbufferedoutputstream.c
View File

@ -175,7 +175,7 @@ g_buffered_output_stream_class_init (GBufferedOutputStreamClass *klass)
/** /**
* g_buffered_output_stream_get_buffer_size: * g_buffered_output_stream_get_buffer_size:
* @stream: a #GBufferedOutputStream. * @stream: a [class@Gio.BufferedOutputStream].
* *
* Gets the size of the buffer in the @stream. * Gets the size of the buffer in the @stream.
* *
@ -191,7 +191,7 @@ g_buffered_output_stream_get_buffer_size (GBufferedOutputStream *stream)
/** /**
* g_buffered_output_stream_set_buffer_size: * g_buffered_output_stream_set_buffer_size:
* @stream: a #GBufferedOutputStream. * @stream: a [class@Gio.BufferedOutputStream].
* @size: a #gsize. * @size: a #gsize.
* *
* Sets the size of the internal buffer to @size. * Sets the size of the internal buffer to @size.
@ -233,12 +233,12 @@ g_buffered_output_stream_set_buffer_size (GBufferedOutputStream *stream,
/** /**
* g_buffered_output_stream_get_auto_grow: * g_buffered_output_stream_get_auto_grow:
* @stream: a #GBufferedOutputStream. * @stream: a [class@Gio.BufferedOutputStream].
* *
* Checks if the buffer automatically grows as data is added. * Checks if the buffer automatically grows as data is added.
* *
* Returns: %TRUE if the @stream's buffer automatically grows, * Returns: `TRUE` if the @stream's buffer automatically grows,
* %FALSE otherwise. * `FALSE` otherwise.
**/ **/
gboolean gboolean
g_buffered_output_stream_get_auto_grow (GBufferedOutputStream *stream) g_buffered_output_stream_get_auto_grow (GBufferedOutputStream *stream)
@ -250,7 +250,7 @@ g_buffered_output_stream_get_auto_grow (GBufferedOutputStream *stream)
/** /**
* g_buffered_output_stream_set_auto_grow: * g_buffered_output_stream_set_auto_grow:
* @stream: a #GBufferedOutputStream. * @stream: a [class@Gio.BufferedOutputStream].
* @auto_grow: a #gboolean. * @auto_grow: a #gboolean.
* *
* Sets whether or not the @stream's buffer should automatically grow. * Sets whether or not the @stream's buffer should automatically grow.
@ -361,11 +361,11 @@ g_buffered_output_stream_seekable_iface_init (GSeekableIface *iface)
/** /**
* g_buffered_output_stream_new: * g_buffered_output_stream_new:
* @base_stream: a #GOutputStream. * @base_stream: a [class@Gio.OutputStream].
* *
* Creates a new buffered output stream for a base stream. * Creates a new buffered output stream for a base stream.
* *
* Returns: a #GOutputStream for the given @base_stream. * Returns: a [class@Gio.OutputStream] for the given @base_stream.
**/ **/
GOutputStream * GOutputStream *
g_buffered_output_stream_new (GOutputStream *base_stream) g_buffered_output_stream_new (GOutputStream *base_stream)
@ -383,12 +383,12 @@ g_buffered_output_stream_new (GOutputStream *base_stream)
/** /**
* g_buffered_output_stream_new_sized: * g_buffered_output_stream_new_sized:
* @base_stream: a #GOutputStream. * @base_stream: a [class@Gio.OutputStream].
* @size: a #gsize. * @size: a #gsize.
* *
* Creates a new buffered output stream with a given buffer size. * Creates a new buffered output stream with a given buffer size.
* *
* Returns: a #GOutputStream with an internal buffer set to @size. * Returns: a [class@Gio.OutputStream] with an internal buffer set to @size.
**/ **/
GOutputStream * GOutputStream *
g_buffered_output_stream_new_sized (GOutputStream *base_stream, g_buffered_output_stream_new_sized (GOutputStream *base_stream,