mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-24 14:36:13 +01:00
docs: Move the GOutputStream SECTION
Move it to the struct docs. Signed-off-by: Philip Withnall <philip@tecnocode.co.uk> Helps: #3037
This commit is contained in:
parent
08a16e9143
commit
b45c554da5
@ -33,21 +33,25 @@
|
||||
#include "gpollableoutputstream.h"
|
||||
|
||||
/**
|
||||
* SECTION:goutputstream
|
||||
* @short_description: Base class for implementing streaming output
|
||||
* @include: gio/gio.h
|
||||
* GOutputStream:
|
||||
*
|
||||
* #GOutputStream has functions to write to a stream (g_output_stream_write()),
|
||||
* to close a stream (g_output_stream_close()) and to flush pending writes
|
||||
* (g_output_stream_flush()).
|
||||
* `GOutputStream` is a base class for implementing streaming output.
|
||||
*
|
||||
* It has functions to write to a stream ([method@Gio.OutputStream.write]),
|
||||
* to close a stream ([method@Gio.OutputStream.close]) and to flush pending
|
||||
* writes ([method@Gio.OutputStream.flush]).
|
||||
*
|
||||
* To copy the content of an input stream to an output stream without
|
||||
* manually handling the reads and writes, use g_output_stream_splice().
|
||||
* manually handling the reads and writes, use [method@Gio.OutputStream.splice].
|
||||
*
|
||||
* See the documentation for #GIOStream for details of thread safety of
|
||||
* streaming APIs.
|
||||
* See the documentation for [class@Gio.IOStream] for details of thread safety
|
||||
* of streaming APIs.
|
||||
*
|
||||
* All of these functions have async variants too.
|
||||
*
|
||||
* All classes derived from `GOutputStream` *should* implement synchronous
|
||||
* writing, splicing, flushing and closing streams, but *may* implement
|
||||
* asynchronous versions.
|
||||
**/
|
||||
|
||||
struct _GOutputStreamPrivate {
|
||||
|
@ -38,15 +38,6 @@ G_BEGIN_DECLS
|
||||
#define G_IS_OUTPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_OUTPUT_STREAM))
|
||||
#define G_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_OUTPUT_STREAM, GOutputStreamClass))
|
||||
|
||||
/**
|
||||
* GOutputStream:
|
||||
*
|
||||
* Base class for writing output.
|
||||
*
|
||||
* All classes derived from GOutputStream should implement synchronous
|
||||
* writing, splicing, flushing and closing streams, but may implement
|
||||
* asynchronous versions.
|
||||
**/
|
||||
typedef struct _GOutputStreamClass GOutputStreamClass;
|
||||
typedef struct _GOutputStreamPrivate GOutputStreamPrivate;
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user