summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@aleksander.es>2014-04-10 17:15:35 +0200
committerAleksander Morgado <aleksander@aleksander.es>2014-04-10 17:15:35 +0200
commit23c26c50bec555c4d98b0f5df4fdf9987b1fbc24 (patch)
tree1123215e68bbe7aac9ce984d8fc4ab001e06dd20
parentf7d3ec13cc9b2c5952b7db84f269423a4049e8a9 (diff)
downloadlibmbim-23c26c50bec555c4d98b0f5df4fdf9987b1fbc24.tar.gz
libmbim-glib,uuid: add missing documentation for the new custom service methods
-rw-r--r--src/libmbim-glib/mbim-uuid.c21
1 files changed, 20 insertions, 1 deletions
diff --git a/src/libmbim-glib/mbim-uuid.c b/src/libmbim-glib/mbim-uuid.c
index 3d168c9..8b53ed8 100644
--- a/src/libmbim-glib/mbim-uuid.c
+++ b/src/libmbim-glib/mbim-uuid.c
@@ -233,7 +233,7 @@ typedef struct {
*
* Register a custom service
*
- * Return: TRUE if service has been registered, FALSE if not
+ * Returns: TRUE if service has been registered, FALSE otherwise.
*/
guint
mbim_register_custom_service (const MbimUuid *uuid,
@@ -261,6 +261,14 @@ mbim_register_custom_service (const MbimUuid *uuid,
return s->service_id;
}
+/**
+ * mbim_unregister_custom_service:
+ * @id: ID of the service to unregister.MbimUuid structure corresponding to service
+ *
+ * Unregister a custom service.
+ *
+ * Returns: TRUE if service has been unregistered, FALSE otherwise.
+ */
gboolean
mbim_unregister_custom_service (const guint id)
{
@@ -281,6 +289,14 @@ mbim_unregister_custom_service (const guint id)
return FALSE;
}
+/**
+ * mbim_service_id_is_custom:
+ * @id: ID of the service
+ *
+ * Checks whether @id is a custom or standard service.
+ *
+ * Returns: TRUE if service is custom, FALSE otherwise.
+ */
gboolean
mbim_service_id_is_custom (const guint id)
{
@@ -303,6 +319,9 @@ mbim_service_id_is_custom (const guint id)
*
* Gets the nickname string for the @service.
*
+ * As opposed to mbim_service_get_string(), this methods takes into account
+ * custom services that may have been registered by the user.
+ *
* Returns: (transfer none): a string with the nickname, or %NULL if not found. Do not free the returned value.
*/
const gchar *