From f679a784d29e81da5dbe6b6c5c65626e2e53d194 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 25 Sep 2023 13:20:02 -0400 Subject: [PATCH] docs: Drop the GQuark SECTION Move the content to the struct docs. Helps: #3037 --- glib/gquark.c | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/glib/gquark.c b/glib/gquark.c index 42cb39364..9c1d221a1 100644 --- a/glib/gquark.c +++ b/glib/gquark.c @@ -67,40 +67,34 @@ g_quark_init (void) } /** - * SECTION:quarks - * @title: Quarks - * @short_description: a 2-way association between a string and a - * unique integer identifier + * GQuark: * - * Quarks are associations between strings and integer identifiers. - * Given either the string or the #GQuark identifier it is possible to + * A GQuark is a non-zero integer which uniquely identifies a + * particular string. + * + * A GQuark value of zero is associated to `NULL`. + * + * Given either the string or the `GQuark` identifier it is possible to * retrieve the other. * * Quarks are used for both [datasets][glib-Datasets] and * [keyed data lists][glib-Keyed-Data-Lists]. * - * To create a new quark from a string, use g_quark_from_string() or - * g_quark_from_static_string(). + * To create a new quark from a string, use [func@GLib.quark_from_string] + * or [func@GLib.quark_from_static_string]. * - * To find the string corresponding to a given #GQuark, use - * g_quark_to_string(). + * To find the string corresponding to a given `GQuark`, use + * [func@GLib.quark_to_string]. * - * To find the #GQuark corresponding to a given string, use - * g_quark_try_string(). + * To find the `GQuark` corresponding to a given string, use + * [func@GLib.quark_try_string]. * * Another use for the string pool maintained for the quark functions - * is string interning, using g_intern_string() or - * g_intern_static_string(). An interned string is a canonical + * is string interning, using [func@GLib.intern_string] or + * [func@GLib.intern_static_string]. An interned string is a canonical * representation for a string. One important advantage of interned * strings is that they can be compared for equality by a simple - * pointer comparison, rather than using strcmp(). - */ - -/** - * GQuark: - * - * A GQuark is a non-zero integer which uniquely identifies a - * particular string. A GQuark value of zero is associated to %NULL. + * pointer comparison, rather than using `strcmp()`. */ /**