luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-24 14:36:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GSocketAddressEnumerator SECTION

Browse Source 
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-11-02 16:23:37 +00:00
parent 832bf0f90c
commit 1c34680833
2 changed files with 12 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
gio/gsocketaddressenumerator.c
View File

@ -25,23 +25,22 @@
#include "gtask.h"
/**
* SECTION:gsocketaddressenumerator
* @short_description: Enumerator for socket addresses
* @include: gio/gio.h
* GSocketAddressEnumerator:
*
* #GSocketAddressEnumerator is an enumerator type for #GSocketAddress
* instances. It is returned by enumeration functions such as
* g_socket_connectable_enumerate(), which returns a #GSocketAddressEnumerator
* to list each #GSocketAddress which could be used to connect to that
* #GSocketConnectable.
* `GSocketAddressEnumerator` is an enumerator type for
* [class@Gio.SocketAddress] instances. It is returned by enumeration functions
* such as [method@Gio.SocketConnectable.enumerate], which returns a
* `GSocketAddressEnumerator` to list each [class@Gio.SocketAddress] which could
* be used to connect to that [iface@Gio.SocketConnectable].
*
* Enumeration is typically a blocking operation, so the asynchronous methods
* g_socket_address_enumerator_next_async() and
* g_socket_address_enumerator_next_finish() should be used where possible.
* [method@Gio.SocketAddressEnumerator.next_async] and
* [method@Gio.SocketAddressEnumerator.next_finish] should be used where
* possible.
*
* Each #GSocketAddressEnumerator can only be enumerated once. Once
* g_socket_address_enumerator_next() has returned %NULL, further
* enumeration with that #GSocketAddressEnumerator is not possible, and it can
* Each `GSocketAddressEnumerator` can only be enumerated once. Once
* [method@Gio.SocketAddressEnumerator.next] has returned `NULL`, further
* enumeration with that `GSocketAddressEnumerator` is not possible, and it can
* be unreffed.
*/

6
gio/gsocketaddressenumerator.h
View File

@ -36,12 +36,6 @@ G_BEGIN_DECLS
#define G_IS_SOCKET_ADDRESS_ENUMERATOR_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_SOCKET_ADDRESS_ENUMERATOR))
#define G_SOCKET_ADDRESS_ENUMERATOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_SOCKET_ADDRESS_ENUMERATOR, GSocketAddressEnumeratorClass))
/**
* GSocketAddressEnumerator:
*
* Enumerator type for objects that contain or generate
* #GSocketAddress instances.
*/
typedef struct _GSocketAddressEnumeratorClass GSocketAddressEnumeratorClass;
struct _GSocketAddressEnumerator