luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-11 23:16:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GPermission SECTION

Browse Source 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-10-24 10:54:31 +01:00
parent 723fc46223
commit ed34ddc355
1 changed files with 6 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
gio/gpermission.c
View File

@ -31,13 +31,9 @@
/** /**
* SECTION:gpermission * GPermission:
* @title: GPermission
* @short_description: An object representing the permission
* to perform a certain action
* @include: gio/gio.h
* *
* A #GPermission represents the status of the caller's permission to * A `GPermission` represents the status of the caller’s permission to
* perform a certain action. * perform a certain action.
* *
* You can query if the action is currently allowed and if it is * You can query if the action is currently allowed and if it is
@ -47,20 +43,13 @@
* There is also an API to actually acquire the permission and one to * There is also an API to actually acquire the permission and one to
* release it. * release it.
* *
* As an example, a #GPermission might represent the ability for the * As an example, a `GPermission` might represent the ability for the
* user to write to a #GSettings object. This #GPermission object could * user to write to a [class@Gio.Settings] object. This `GPermission` object
* then be used to decide if it is appropriate to show a "Click here to * could then be used to decide if it is appropriate to show a “Click here to
* unlock" button in a dialog and to provide the mechanism to invoke * unlock” button in a dialog and to provide the mechanism to invoke
* when that button is clicked. * when that button is clicked.
**/ **/
/**
* GPermission:
*
* #GPermission is an opaque data structure and can only be accessed
* using the following functions.
**/
struct _GPermissionPrivate struct _GPermissionPrivate
{ {
gboolean allowed; gboolean allowed;