luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-12 07:26:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Drop the GQuark SECTION

Browse Source 
Move the content to the struct docs.

Helps: #3037
This commit is contained in:
Matthias Clasen 2023-09-25 13:20:02 -04:00 committed by Philip Withnall
parent 5a2a0aeaf9
commit f679a784d2
1 changed files with 16 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
glib/gquark.c
View File

@ -67,40 +67,34 @@ g_quark_init (void)
} }
/** /**
* SECTION:quarks * GQuark:
* @title: Quarks
* @short_description: a 2-way association between a string and a
* unique integer identifier
* *
* Quarks are associations between strings and integer identifiers. * A GQuark is a non-zero integer which uniquely identifies a
* Given either the string or the #GQuark identifier it is possible to * 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. * retrieve the other.
* *
* Quarks are used for both [datasets][glib-Datasets] and * Quarks are used for both [datasets][glib-Datasets] and
* [keyed data lists][glib-Keyed-Data-Lists]. * [keyed data lists][glib-Keyed-Data-Lists].
* *
* To create a new quark from a string, use g_quark_from_string() or * To create a new quark from a string, use [func@GLib.quark_from_string]
* g_quark_from_static_string(). * or [func@GLib.quark_from_static_string].
* *
* To find the string corresponding to a given #GQuark, use * To find the string corresponding to a given `GQuark`, use
* g_quark_to_string(). * [func@GLib.quark_to_string].
* *
* To find the #GQuark corresponding to a given string, use * To find the `GQuark` corresponding to a given string, use
* g_quark_try_string(). * [func@GLib.quark_try_string].
* *
* Another use for the string pool maintained for the quark functions * Another use for the string pool maintained for the quark functions
* is string interning, using g_intern_string() or * is string interning, using [func@GLib.intern_string] or
* g_intern_static_string(). An interned string is a canonical * [func@GLib.intern_static_string]. An interned string is a canonical
* representation for a string. One important advantage of interned * representation for a string. One important advantage of interned
* strings is that they can be compared for equality by a simple * strings is that they can be compared for equality by a simple
* pointer comparison, rather than using strcmp(). * 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.
*/ */
/** /**