docs: Move the GSocketListener SECTION

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:54 +00:00
parent 1c34680833
commit bf5c0cc2ba

View File

@ -42,26 +42,23 @@
/**
* SECTION:gsocketlistener
* @title: GSocketListener
* @short_description: Helper for accepting network client connections
* @include: gio/gio.h
* @see_also: #GThreadedSocketService, #GSocketService.
* GSocketListener:
*
* A #GSocketListener is an object that keeps track of a set
* A `GSocketListener` is an object that keeps track of a set
* of server sockets and helps you accept sockets from any of the
* socket, either sync or async.
*
* Add addresses and ports to listen on using g_socket_listener_add_address()
* and g_socket_listener_add_inet_port(). These will be listened on until
* g_socket_listener_close() is called. Dropping your final reference to the
* #GSocketListener will not cause g_socket_listener_close() to be called
* implicitly, as some references to the #GSocketListener may be held
* Add addresses and ports to listen on using
* [method@Gio.SocketListener.add_address] and
* [method@Gio.SocketListener.add_inet_port]. These will be listened on until
* [method@Gio.SocketListener.close] is called. Dropping your final reference to
* the `GSocketListener` will not cause [method@Gio.SocketListener.close] to be
* called implicitly, as some references to the `GSocketListener` may be held
* internally.
*
* If you want to implement a network server, also look at #GSocketService
* and #GThreadedSocketService which are subclasses of #GSocketListener
* that make this even easier.
* If you want to implement a network server, also look at
* [class@Gio.SocketService] and [class@Gio.ThreadedSocketService] which are
* subclasses of `GSocketListener` that make this even easier.
*
* Since: 2.22
*/