From: Wim Taymans <wim.taymans@collabora.co.uk>
Date: Mon, 15 Jul 2013 15:12:43 +0000 (+0200)
Subject: permissions: update docs
X-Git-Tag: 1.6.0~417
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5e297ea09397832bba6a9d25008c23a4b9318e8a;p=platform%2Fupstream%2Fgst-rtsp-server.git

permissions: update docs
---

diff --git a/gst/rtsp-server/rtsp-permissions.c b/gst/rtsp-server/rtsp-permissions.c
index 33587c7..eee30e0 100644
--- a/gst/rtsp-server/rtsp-permissions.c
+++ b/gst/rtsp-server/rtsp-permissions.c
@@ -21,10 +21,22 @@
  * @short_description: Roles and associated permissions
  * @see_also: #GstRTSPToken, #GstRTSPAuth
  *
- * Last reviewed on 2013-07-11 (1.0.0)
+ * The #GstRTSPPermission object contains an array of roles and associated
+ * permissions. The roles are represented with a string and the permissions with
+ * a generic #GstStructure.
+ *
+ * The permissions are deliberately kept generic. The possible values of the
+ * roles and #GstStructure keys and values are only determined by the #GstRTSPAuth
+ * object that performs the checks on the permissions and the current
+ * #GstRTSPToken.
+ *
+ * As a convenience function, gst_rtsp_permissions_is_allowed() can be used to
+ * check if the permissions contains a role that contains the boolean value
+ * %TRUE for the the given key.
+ *
+ * Last reviewed on 2013-07-15 (1.0.0)
  */
 
-
 #include <string.h>
 
 #include "rtsp-permissions.h"