luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-23 10:42:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GPolllable*Stream SECTIONs

Browse Source 
Move them to the struct docs.

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

Helps: #3037
This commit is contained in:
Philip Withnall 2023-10-24 10:54:52 +01:00
parent ed34ddc355
commit d9e35c264b
4 changed files with 10 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
gio/gpollableinputstream.c
View File

@ -27,19 +27,16 @@
#include "glibintl.h" #include "glibintl.h"
/** /**
* SECTION:gpollableinputstream * GPollableInputStream:
* @short_description: Interface for pollable input streams
* @include: gio/gio.h
* @see_also: #GInputStream, #GPollableOutputStream, #GFileDescriptorBased
* *
* #GPollableInputStream is implemented by #GInputStreams that * `GPollableInputStream` is implemented by [class@Gio.InputStream]s that
* can be polled for readiness to read. This can be used when * can be polled for readiness to read. This can be used when
* interfacing with a non-GIO API that expects * interfacing with a non-GIO API that expects
* UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. * UNIX-file-descriptor-style asynchronous I/O rather than GIO-style.
* *
* Some classes may implement #GPollableInputStream but have only certain * Some classes may implement `GPollableInputStream` but have only certain
* instances of that class be pollable. If g_pollable_input_stream_can_poll() * instances of that class be pollable. If [method@Gio.PollableInputStream.can_poll]
* returns %FALSE, then the behavior of other #GPollableInputStream methods is * returns false, then the behavior of other `GPollableInputStream` methods is
* undefined. * undefined.
* *
* Since: 2.28 * Since: 2.28

7
gio/gpollableinputstream.h
View File

@ -34,13 +34,6 @@ G_BEGIN_DECLS
#define G_IS_POLLABLE_INPUT_STREAM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_POLLABLE_INPUT_STREAM)) #define G_IS_POLLABLE_INPUT_STREAM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_POLLABLE_INPUT_STREAM))
#define G_POLLABLE_INPUT_STREAM_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_POLLABLE_INPUT_STREAM, GPollableInputStreamInterface)) #define G_POLLABLE_INPUT_STREAM_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_POLLABLE_INPUT_STREAM, GPollableInputStreamInterface))
/**
* GPollableInputStream:
*
* An interface for a #GInputStream that can be polled for readability.
*
* Since: 2.28
*/
typedef struct _GPollableInputStreamInterface GPollableInputStreamInterface; typedef struct _GPollableInputStreamInterface GPollableInputStreamInterface;
/** /**

13
gio/gpollableoutputstream.c
View File

@ -28,19 +28,16 @@
#include "glibintl.h" #include "glibintl.h"
/** /**
* SECTION:gpollableoutputstream * GPollableOutputStream:
* @short_description: Interface for pollable output streams
* @include: gio/gio.h
* @see_also: #GOutputStream, #GFileDescriptorBased, #GPollableInputStream
* *
* #GPollableOutputStream is implemented by #GOutputStreams that * `GPollableOutputStream` is implemented by [class@Gio.OutputStream]s that
* can be polled for readiness to write. This can be used when * can be polled for readiness to write. This can be used when
* interfacing with a non-GIO API that expects * interfacing with a non-GIO API that expects
* UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. * UNIX-file-descriptor-style asynchronous I/O rather than GIO-style.
* *
* Some classes may implement #GPollableOutputStream but have only certain * Some classes may implement `GPollableOutputStream` but have only certain
* instances of that class be pollable. If g_pollable_output_stream_can_poll() * instances of that class be pollable. If [method@Gio.PollableOutputStream.can_poll]
* returns %FALSE, then the behavior of other #GPollableOutputStream methods is * returns false, then the behavior of other `GPollableOutputStream` methods is
* undefined. * undefined.
* *
* Since: 2.28 * Since: 2.28

7
gio/gpollableoutputstream.h
View File

@ -34,13 +34,6 @@ G_BEGIN_DECLS
#define G_IS_POLLABLE_OUTPUT_STREAM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_POLLABLE_OUTPUT_STREAM)) #define G_IS_POLLABLE_OUTPUT_STREAM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_POLLABLE_OUTPUT_STREAM))
#define G_POLLABLE_OUTPUT_STREAM_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_POLLABLE_OUTPUT_STREAM, GPollableOutputStreamInterface)) #define G_POLLABLE_OUTPUT_STREAM_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_POLLABLE_OUTPUT_STREAM, GPollableOutputStreamInterface))
/**
* GPollableOutputStream:
*
* An interface for a #GOutputStream that can be polled for writeability.
*
* Since: 2.28
*/
typedef struct _GPollableOutputStreamInterface GPollableOutputStreamInterface; typedef struct _GPollableOutputStreamInterface GPollableOutputStreamInterface;
/** /**