permissions: add Since tags and example for new API

This commit is contained in:
Mathieu Duponchelle 2018-03-02 16:24:23 +01:00
parent e356cf33f2
commit 1288faeae7
2 changed files with 11 additions and 1 deletions

View file

@ -500,6 +500,8 @@ gst_rtsp_media_factory_add_role (GstRTSPMediaFactory * factory,
* A convenience wrapper around gst_rtsp_permissions_add_role_from_structure().
* If @factory had no permissions, new permissions will be created and the
* role will be added to it.
*
* Since: 1.14
*/
void
gst_rtsp_media_factory_add_role_from_structure (GstRTSPMediaFactory * factory,

View file

@ -250,7 +250,15 @@ gst_rtsp_permissions_add_role_valist (GstRTSPPermissions * permissions,
/**
* gst_rtsp_permissions_add_role_from_structure:
*
* Add a new role to @permissions based on @structure
* Add a new role to @permissions based on @structure, for example
* given a role named `tester`, which should be granted a permission named
* `permission1`, the structure could be created with:
*
* ```
* gst_structure_new ("tester", "permission1", G_TYPE_BOOLEAN, TRUE, NULL);
* ```
*
* Since: 1.14
*/
void
gst_rtsp_permissions_add_role_from_structure (GstRTSPPermissions * permissions,