docs: Move the GInputStream SECTION

Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-10-23 14:39:36 +01:00
parent a8b28e312f
commit 08a16e9143
2 changed files with 9 additions and 14 deletions

View File

@ -33,19 +33,19 @@
#include "gpollableinputstream.h"
/**
* SECTION:ginputstream
* @short_description: Base class for implementing streaming input
* @include: gio/gio.h
* GInputStream:
*
* #GInputStream has functions to read from a stream (g_input_stream_read()),
* to close a stream (g_input_stream_close()) and to skip some content
* (g_input_stream_skip()).
* `GInputStream` is a base class for implementing streaming input.
*
* It has functions to read from a stream ([method@Gio.InputStream.read]),
* to close a stream ([method@Gio.InputStream.close]) and to skip some content
* ([method@Gio.InputStream.skip]).
*
* 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.
**/

View File

@ -38,11 +38,6 @@ G_BEGIN_DECLS
#define G_IS_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_INPUT_STREAM))
#define G_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_INPUT_STREAM, GInputStreamClass))
/**
* GInputStream:
*
* Base class for streaming input operations.
**/
typedef struct _GInputStreamClass GInputStreamClass;
typedef struct _GInputStreamPrivate GInputStreamPrivate;