[gssdp] client: Some docimprovements

[Jens Georg <jensgeorg src gnome org>]

commit e198ab36027ba7a2002e66126406675d4ee496aa
Author: Jens Georg <mail jensge org>
Date:   Thu May 13 23:08:19 2021 +0200

    client: Some docimprovements

 libgssdp/gssdp-client.c | 28 ++++++++++++++++++++++++----
 1 file changed, 24 insertions(+), 4 deletions(-)
---
diff --git a/libgssdp/gssdp-client.c b/libgssdp/gssdp-client.c
index f3404b7..e1813f8 100644
--- a/libgssdp/gssdp-client.c
+++ b/libgssdp/gssdp-client.c
@@ -105,6 +105,16 @@ struct _GSSDPClientPrivate {
 
 typedef struct _GSSDPClientPrivate GSSDPClientPrivate;
 
+/**
+ * GSSDPClient:
+ *
+ * A simple SSDP bus handler.
+ *
+ * The GSSDPClient will usually be used by the #GSSDPResourceGroup for announcing
+ * or the #GSSDPResourceBrowser for finding resources on the network.
+ *
+ * A GSSDPClient is required per IP address that you want to use with.
+ */
 G_DEFINE_TYPE_EXTENDED (GSSDPClient,
                         gssdp_client,
                         G_TYPE_OBJECT,
@@ -744,9 +754,14 @@ gssdp_client_class_init (GSSDPClientClass *klass)
 /**
  * gssdp_client_new:
  * @iface: (allow-none): The name of the network interface, or %NULL for auto-detection.
- * @error: Location to store error, or NULL
+ * @error: (allow-none): Location to store error, or %NULL
+ *
+ * Creates a GSSDP client on @iface. GSSDPClient will pick the address it finds
+ * suitable for using.
  *
- * Return value: A new #GSSDPClient object.
+ * Using this utility function, the created client will be using UDA 1.0 and IPv4 only.
+ *
+ * Return value: (nullable): A new #GSSDPClient object.
  **/
 GSSDPClient *
 gssdp_client_new (const char *iface, GError **error)
@@ -766,8 +781,13 @@ gssdp_client_new (const char *iface, GError **error)
  * random.
  * @error: (allow-none): Location to store error, or %NULL.
  *
- * Return value: A new #GSSDPClient object.
- **/
+ * Creates a GSSDP client on @iface. GSSDPClient will pick the address it finds
+ * suitable for using.
+ *
+ * Using this utility function, the created client will be using UDA 1.0 and IPv4 only.
+ *
+ * Return value: (nullable):  A new #GSSDPClient object or %NULL on error.
+ */
 GSSDPClient *
 gssdp_client_new_with_port (const char *iface,
                             guint16     msearch_port,