From 6837c34c84697df50d8300fdf7f32739361f4e7a Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Thu, 7 Mar 2019 17:30:31 +0000 Subject: [PATCH] docs: Fix pluralised links to symbols MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit While gtk-doc can currently detect a link to a symbol which has been pluralised by adding ‘s’, it can’t detect when ‘es’ is added. While that’s being fixed, reword the documentation so the links are generated correctly anyway. gtk-doc fix here: https://gitlab.gnome.org/GNOME/gtk-doc/merge_requests/22 Signed-off-by: Philip Withnall --- gio/gnetworkaddress.c | 2 +- gio/gproxyaddressenumerator.h | 2 +- gio/gsocketaddressenumerator.c | 2 +- gio/gsocketconnectable.c | 2 +- gio/gsocketconnectable.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/gio/gnetworkaddress.c b/gio/gnetworkaddress.c index 24af25c2c..df1bc3158 100644 --- a/gio/gnetworkaddress.c +++ b/gio/gnetworkaddress.c @@ -306,7 +306,7 @@ g_network_address_new (const gchar *hostname, * resolving `localhost`, and an IPv6 address for `localhost6`. * * g_network_address_get_hostname() will always return `localhost` for - * #GNetworkAddresses created with this constructor. + * a #GNetworkAddress created with this constructor. * * Returns: (transfer full) (type GNetworkAddress): the new #GNetworkAddress * diff --git a/gio/gproxyaddressenumerator.h b/gio/gproxyaddressenumerator.h index de9fa833e..470f1dc66 100644 --- a/gio/gproxyaddressenumerator.h +++ b/gio/gproxyaddressenumerator.h @@ -40,7 +40,7 @@ G_BEGIN_DECLS * GProxyAddressEnumerator: * * A subclass of #GSocketAddressEnumerator that takes another address - * enumerator and wraps its results in #GProxyAddresses as + * enumerator and wraps each of its results in a #GProxyAddress as * directed by the default #GProxyResolver. */ diff --git a/gio/gsocketaddressenumerator.c b/gio/gsocketaddressenumerator.c index 3defc7f89..ebbb5decf 100644 --- a/gio/gsocketaddressenumerator.c +++ b/gio/gsocketaddressenumerator.c @@ -30,7 +30,7 @@ * #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 all the #GSocketAddresses which could be used to connect to that + * to list each #GSocketAddress which could be used to connect to that * #GSocketConnectable. * * Enumeration is typically a blocking operation, so the asynchronous methods diff --git a/gio/gsocketconnectable.c b/gio/gsocketconnectable.c index 76f349faf..e999e659c 100644 --- a/gio/gsocketconnectable.c +++ b/gio/gsocketconnectable.c @@ -121,7 +121,7 @@ g_socket_connectable_enumerate (GSocketConnectable *connectable) * @connectable: a #GSocketConnectable * * Creates a #GSocketAddressEnumerator for @connectable that will - * return #GProxyAddresses for addresses that you must connect + * return a #GProxyAddress for each of its addresses that you must connect * to via a proxy. * * If @connectable does not implement diff --git a/gio/gsocketconnectable.h b/gio/gsocketconnectable.h index 6528d4936..da882143a 100644 --- a/gio/gsocketconnectable.h +++ b/gio/gsocketconnectable.h @@ -35,7 +35,7 @@ G_BEGIN_DECLS /** * GSocketConnectable: * - * Interface for objects that contain or generate #GSocketAddresses. + * Interface for objects that contain or generate a #GSocketAddress. */ typedef struct _GSocketConnectableIface GSocketConnectableIface;