[gupnp: 3/3] ServiceInfo: Add examples to type and id




commit 5af5fbaea16423e0128b539d9b3a35bfe020a9e4
Author: Jens Georg <mail jensge org>
Date:   Tue Jun 21 18:14:39 2022 +0200

    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 -.-

 libgupnp/gupnp-service-info.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
---
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.
  **/


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]