docs: Move the GSocketConnectable SECTION

Move it to the struct docs.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-14 14:27:18 +00:00
parent b480a733c0
commit e42bfcb9ae
2 changed files with 7 additions and 14 deletions

View File

@ -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.
*
* |[<!-- language="C" -->
* ```c
* MyConnectionType *
* connect_to_host (const char *hostname,
* guint16 port,
@ -84,7 +82,7 @@
* return NULL;
* }
* }
* ]|
* ```
*/

View File

@ -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;
/**