From d9e35c264b063f74a14737023dc0af317d90d632 Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Tue, 24 Oct 2023 10:54:52 +0100 Subject: [PATCH] docs: Move the GPolllable*Stream SECTIONs Move them to the struct docs. Signed-off-by: Philip Withnall Helps: #3037 --- gio/gpollableinputstream.c | 13 +++++-------- gio/gpollableinputstream.h | 7 ------- gio/gpollableoutputstream.c | 13 +++++-------- gio/gpollableoutputstream.h | 7 ------- 4 files changed, 10 insertions(+), 30 deletions(-) diff --git a/gio/gpollableinputstream.c b/gio/gpollableinputstream.c index 28eedbf6a..a57d5abe2 100644 --- a/gio/gpollableinputstream.c +++ b/gio/gpollableinputstream.c @@ -27,19 +27,16 @@ #include "glibintl.h" /** - * SECTION:gpollableinputstream - * @short_description: Interface for pollable input streams - * @include: gio/gio.h - * @see_also: #GInputStream, #GPollableOutputStream, #GFileDescriptorBased + * GPollableInputStream: * - * #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 * interfacing with a non-GIO API that expects * UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. * - * Some classes may implement #GPollableInputStream but have only certain - * instances of that class be pollable. If g_pollable_input_stream_can_poll() - * returns %FALSE, then the behavior of other #GPollableInputStream methods is + * Some classes may implement `GPollableInputStream` but have only certain + * instances of that class be pollable. If [method@Gio.PollableInputStream.can_poll] + * returns false, then the behavior of other `GPollableInputStream` methods is * undefined. * * Since: 2.28 diff --git a/gio/gpollableinputstream.h b/gio/gpollableinputstream.h index 7b659477c..924b52ee6 100644 --- a/gio/gpollableinputstream.h +++ b/gio/gpollableinputstream.h @@ -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_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; /** diff --git a/gio/gpollableoutputstream.c b/gio/gpollableoutputstream.c index 9a85225ef..f36ac139b 100644 --- a/gio/gpollableoutputstream.c +++ b/gio/gpollableoutputstream.c @@ -28,19 +28,16 @@ #include "glibintl.h" /** - * SECTION:gpollableoutputstream - * @short_description: Interface for pollable output streams - * @include: gio/gio.h - * @see_also: #GOutputStream, #GFileDescriptorBased, #GPollableInputStream + * GPollableOutputStream: * - * #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 * interfacing with a non-GIO API that expects * UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. * - * Some classes may implement #GPollableOutputStream but have only certain - * instances of that class be pollable. If g_pollable_output_stream_can_poll() - * returns %FALSE, then the behavior of other #GPollableOutputStream methods is + * Some classes may implement `GPollableOutputStream` but have only certain + * instances of that class be pollable. If [method@Gio.PollableOutputStream.can_poll] + * returns false, then the behavior of other `GPollableOutputStream` methods is * undefined. * * Since: 2.28 diff --git a/gio/gpollableoutputstream.h b/gio/gpollableoutputstream.h index a98bfa2a8..e20c2f3b8 100644 --- a/gio/gpollableoutputstream.h +++ b/gio/gpollableoutputstream.h @@ -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_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; /**