docs: Move the GInetAddress 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-10-23 14:38:29 +01:00
parent ca505f34f2
commit d424383877

View File

@ -44,27 +44,19 @@ struct _GInetAddressPrivate
} addr;
};
/**
* SECTION:ginetaddress
* @short_description: An IPv4/IPv6 address
* @include: gio/gio.h
*
* #GInetAddress represents an IPv4 or IPv6 internet address. Use
* g_resolver_lookup_by_name() or g_resolver_lookup_by_name_async() to
* look up the #GInetAddress for a hostname. Use
* g_resolver_lookup_by_address() or
* g_resolver_lookup_by_address_async() to look up the hostname for a
* #GInetAddress.
*
* To actually connect to a remote host, you will need a
* #GInetSocketAddress (which includes a #GInetAddress as well as a
* port number).
*/
/**
* GInetAddress:
*
* An IPv4 or IPv6 internet address.
* `GInetAddress` represents an IPv4 or IPv6 internet address. Use
* [method@Gio.Resolver.lookup_by_name] or
* [method@Gio.Resolver.lookup_by_name_async] to look up the `GInetAddress` for
* a hostname. Use [method@Gio.Resolver.lookup_by_address] or
* [method@Gio.Resolver.lookup_by_address_async] to look up the hostname for a
* `GInetAddress`.
*
* To actually connect to a remote host, you will need a
* [class@Gio.InetSocketAddress] (which includes a `GInetAddress` as well as a
* port number).
*/
G_DEFINE_TYPE_WITH_CODE (GInetAddress, g_inet_address, G_TYPE_OBJECT,