docs: Move the GPermission SECTION

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

View File

@ -31,13 +31,9 @@
/**
* SECTION:gpermission
* @title: GPermission
* @short_description: An object representing the permission
* to perform a certain action
* @include: gio/gio.h
* GPermission:
*
* A #GPermission represents the status of the caller's permission to
* A `GPermission` represents the status of the callers permission to
* perform a certain action.
*
* 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
* release it.
*
* As an example, a #GPermission might represent the ability for the
* user to write to a #GSettings object. This #GPermission object 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
* As an example, a `GPermission` might represent the ability for the
* user to write to a [class@Gio.Settings] object. This `GPermission` object
* 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
* when that button is clicked.
**/
/**
* GPermission:
*
* #GPermission is an opaque data structure and can only be accessed
* using the following functions.
**/
struct _GPermissionPrivate
{
gboolean allowed;