summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJens Georg <mail@jensge.org>2022-06-21 18:14:39 +0200
committerJens Georg <mail@jensge.org>2022-06-21 18:14:39 +0200
commit5af5fbaea16423e0128b539d9b3a35bfe020a9e4 (patch)
tree9eae8fc099a3097feb260ede0335f43ebbcaa70b
parentc6f8d38446a9afbef3ab1a1aace6fc3f31ff664d (diff)
downloadgupnp-5af5fbaea16423e0128b539d9b3a35bfe020a9e4.tar.gz
ServiceInfo: Add examples to type and id
I always mix up what is what, so just add it to the docs so I don't have to check the specs each time -.-
-rw-r--r--libgupnp/gupnp-service-info.c9
1 files changed, 8 insertions, 1 deletions
diff --git a/libgupnp/gupnp-service-info.c b/libgupnp/gupnp-service-info.c
index 4752c3d..bee6c9c 100644
--- a/libgupnp/gupnp-service-info.c
+++ b/libgupnp/gupnp-service-info.c
@@ -418,6 +418,8 @@ gupnp_service_info_get_udn (GUPnPServiceInfo *info)
*
* Get the UPnP service type, or %NULL.
*
+ * Example: `urn:schemas-upnp-org:service:RenderingControl:1`
+ *
* Returns: A constant string.
**/
const char *
@@ -442,7 +444,12 @@ gupnp_service_info_get_service_type (GUPnPServiceInfo *info)
* gupnp_service_info_get_id:
* @info: A #GUPnPServiceInfo
*
- * Get the ID of this service, or %NULL if there is no ID.
+ * Get the serviceID of this service, or %NULL if there is no ID.
+ *
+ * The serviceID should be unique to a device. This makes it possible to provide
+ * the same serviceType multiple times on one device
+ *
+ * Example: `org:serviceId:RenderingControl`
*
* Return value: A string. This string should be freed with g_free() after use.
**/