From 926f56c7c7da2d9271ba61c66eda08193db29b12 Mon Sep 17 00:00:00 2001
From: Matthias Clasen <mclasen@redhat.com>
Date: Tue, 26 Sep 2023 21:03:11 -0400
Subject: [PATCH] docs: Move the GCredentials SECTION

Move contents to struct docs.

Helps: #3037
---
 gio/gcredentials.c | 82 ++++++++++++++++++++--------------------------
 1 file changed, 36 insertions(+), 46 deletions(-)

diff --git a/gio/gcredentials.c b/gio/gcredentials.c
index ba5be63a6..5d943e8c1 100644
--- a/gio/gcredentials.c
+++ b/gio/gcredentials.c
@@ -35,58 +35,48 @@
 
 #include "glibintl.h"
 
-/**
- * SECTION:gcredentials
- * @short_description: An object containing credentials
- * @include: gio/gio.h
- *
- * The #GCredentials type is a reference-counted wrapper for native
- * credentials. This information is typically used for identifying,
- * authenticating and authorizing other processes.
- *
- * Some operating systems supports looking up the credentials of the
- * remote peer of a communication endpoint - see e.g.
- * g_socket_get_credentials().
- *
- * Some operating systems supports securely sending and receiving
- * credentials over a Unix Domain Socket, see
- * #GUnixCredentialsMessage, g_unix_connection_send_credentials() and
- * g_unix_connection_receive_credentials() for details.
- *
- * On Linux, the native credential type is a `struct ucred` - see the
- * unix(7) man page for details. This corresponds to
- * %G_CREDENTIALS_TYPE_LINUX_UCRED.
- *
- * On Apple operating systems (including iOS, tvOS, and macOS),
- * the native credential type is a `struct xucred`.
- * This corresponds to %G_CREDENTIALS_TYPE_APPLE_XUCRED.
- *
- * On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native
- * credential type is a `struct cmsgcred`. This corresponds
- * to %G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED.
- *
- * On NetBSD, the native credential type is a `struct unpcbid`.
- * This corresponds to %G_CREDENTIALS_TYPE_NETBSD_UNPCBID.
- *
- * On OpenBSD, the native credential type is a `struct sockpeercred`.
- * This corresponds to %G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED.
- *
- * On Solaris (including OpenSolaris and its derivatives), the native
- * credential type is a `ucred_t`. This corresponds to
- * %G_CREDENTIALS_TYPE_SOLARIS_UCRED.
- *
- * Since GLib 2.72, on Windows, the native credentials may contain the PID of a
- * process. This corresponds to %G_CREDENTIALS_TYPE_WIN32_PID.
- */
-
 /**
  * GCredentials:
  *
- * The #GCredentials structure contains only private data and
- * should only be accessed using the provided API.
+ * The `GCredentials` type is a reference-counted wrapper for native
+ * credentials.
+ *
+ * The information in `GCredentials` is typically used for identifying,
+ * authenticating and authorizing other processes.
+ *
+ * Some operating systems supports looking up the credentials of the remote
+ * peer of a communication endpoint - see e.g. [method@Gio.Socket.get_credentials].
+ *
+ * Some operating systems supports securely sending and receiving
+ * credentials over a Unix Domain Socket, see [struct@Gio.UnixCredentialsMessage],
+ * [method@Gio.UnixConnection.send_credentials] and
+ * [method@Gio.UnixConnection.receive_credentials] for details.
+ *
+ * On Linux, the native credential type is a `struct ucred` - see the
+ * [`unix(7)` man page](man:unix(7)) for details. This corresponds to
+ * `G_CREDENTIALS_TYPE_LINUX_UCRED`.
+ *
+ * On Apple operating systems (including iOS, tvOS, and macOS), the native credential
+ * type is a `struct xucred`. This corresponds to `G_CREDENTIALS_TYPE_APPLE_XUCRED`.
+ *
+ * On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native credential type is a
+ * `struct cmsgcred`. This corresponds to `G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED`.
+ *
+ * On NetBSD, the native credential type is a `struct unpcbid`.
+ * This corresponds to `G_CREDENTIALS_TYPE_NETBSD_UNPCBID`.
+ *
+ * On OpenBSD, the native credential type is a `struct sockpeercred`.
+ * This corresponds to `G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED`.
+ *
+ * On Solaris (including OpenSolaris and its derivatives), the native credential type
+ * is a `ucred_t`. This corresponds to `G_CREDENTIALS_TYPE_SOLARIS_UCRED`.
+ *
+ * Since GLib 2.72, on Windows, the native credentials may contain the PID of a
+ * process. This corresponds to `G_CREDENTIALS_TYPE_WIN32_PID`.
  *
  * Since: 2.26
  */
+
 struct _GCredentials
 {
   /*< private >*/