From e42bfcb9ae6f97185687e4fc3d41b977c7de5531 Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Tue, 14 Nov 2023 14:27:18 +0000 Subject: [PATCH] docs: Move the GSocketConnectable SECTION Move it to the struct docs. Signed-off-by: Philip Withnall Helps: #3037 --- gio/gsocketconnectable.c | 16 +++++++--------- gio/gsocketconnectable.h | 5 ----- 2 files changed, 7 insertions(+), 14 deletions(-) diff --git a/gio/gsocketconnectable.c b/gio/gsocketconnectable.c index 1efde657a..728992b83 100644 --- a/gio/gsocketconnectable.c +++ b/gio/gsocketconnectable.c @@ -24,17 +24,15 @@ /** - * SECTION:gsocketconnectable - * @short_description: Interface for potential socket endpoints - * @include: gio/gio.h + * GSocketConnectable: * * Objects that describe one or more potential socket endpoints - * implement #GSocketConnectable. Callers can then use - * g_socket_connectable_enumerate() to get a #GSocketAddressEnumerator - * to try out each socket address in turn until one succeeds, as shown - * in the sample code below. + * implement `GSocketConnectable`. Callers can then use + * [method@Gio.SocketConnectable.enumerate] to get a + * [class@Gio.SocketAddressEnumerator] to try out each socket address in turn + * until one succeeds, as shown in the sample code below. * - * |[ + * ```c * MyConnectionType * * connect_to_host (const char *hostname, * guint16 port, @@ -84,7 +82,7 @@ * return NULL; * } * } - * ]| + * ``` */ diff --git a/gio/gsocketconnectable.h b/gio/gsocketconnectable.h index ed2cad9fc..bedef569e 100644 --- a/gio/gsocketconnectable.h +++ b/gio/gsocketconnectable.h @@ -34,11 +34,6 @@ G_BEGIN_DECLS #define G_IS_SOCKET_CONNECTABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SOCKET_CONNECTABLE)) #define G_SOCKET_CONNECTABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SOCKET_CONNECTABLE, GSocketConnectableIface)) -/** - * GSocketConnectable: - * - * Interface for objects that contain or generate a #GSocketAddress. - */ typedef struct _GSocketConnectableIface GSocketConnectableIface; /**