diff --git a/gio/gdbusauthobserver.c b/gio/gdbusauthobserver.c index c695e1a38..a84053211 100644 --- a/gio/gdbusauthobserver.c +++ b/gio/gdbusauthobserver.c @@ -32,26 +32,25 @@ #include "gmarshal-internal.h" /** - * SECTION:gdbusauthobserver - * @short_description: Object used for authenticating connections - * @include: gio/gio.h + * GDBusAuthObserver: * - * The #GDBusAuthObserver type provides a mechanism for participating - * in how a #GDBusServer (or a #GDBusConnection) authenticates remote - * peers. Simply instantiate a #GDBusAuthObserver and connect to the + * `GDBusAuthObserver` provides a mechanism for participating + * in how a [class@Gio.DBusServer] (or a [class@Gio.DBusConnection]) + * authenticates remote peers. + * + * Simply instantiate a `GDBusAuthObserver` and connect to the * signals you are interested in. Note that new signals may be added - * in the future + * in the future. * * ## Controlling Authentication Mechanisms * - * By default, a #GDBusServer or server-side #GDBusConnection will allow - * any authentication mechanism to be used. If you only - * want to allow D-Bus connections with the `EXTERNAL` mechanism, - * which makes use of credentials passing and is the recommended - * mechanism for modern Unix platforms such as Linux and the BSD family, - * you would use a signal handler like this: + * By default, a `GDBusServer` or server-side `GDBusConnection` will allow + * any authentication mechanism to be used. If you only want to allow D-Bus + * connections with the `EXTERNAL` mechanism, which makes use of credentials + * passing and is the recommended mechanism for modern Unix platforms such + * as Linux and the BSD family, you would use a signal handler like this: * - * |[ + * ```c * static gboolean * on_allow_mechanism (GDBusAuthObserver *observer, * const gchar *mechanism, @@ -64,19 +63,19 @@ * * return FALSE; * } - * ]| + * ``` * - * ## Controlling Authorization # {#auth-observer} + * ## Controlling Authorization * - * By default, a #GDBusServer or server-side #GDBusConnection will accept + * By default, a `GDBusServer` or server-side `GDBusConnection` will accept * connections from any successfully authenticated user (but not from * anonymous connections using the `ANONYMOUS` mechanism). If you only * want to allow D-Bus connections from processes owned by the same uid * as the server, since GLib 2.68, you should use the - * %G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER flag. It’s equivalent + * `G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER` flag. It’s equivalent * to the following signal handler: - * - * |[ + * + * ```c * static gboolean * on_authorize_authenticated_peer (GDBusAuthObserver *observer, * GIOStream *stream, @@ -97,7 +96,9 @@ * * return authorized; * } - * ]| + * ``` + * + * Since: 2.26 */ typedef struct _GDBusAuthObserverClass GDBusAuthObserverClass; @@ -126,14 +127,6 @@ struct _GDBusAuthObserverClass const gchar *mechanism); }; -/** - * GDBusAuthObserver: - * - * The #GDBusAuthObserver structure contains only private data and - * should only be accessed using the provided API. - * - * Since: 2.26 - */ struct _GDBusAuthObserver { GObject parent_instance;