[glib] gquark: clarify G_DEFINE_QUARK docs about the use of quotes
- From: Cosimo Cecchi <cosimoc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] gquark: clarify G_DEFINE_QUARK docs about the use of quotes
- Date: Tue, 28 Aug 2012 17:17:34 +0000 (UTC)
commit daae12710a890b974e57cc806b275248760ce131
Author: Cosimo Cecchi <cosimoc gnome org>
Date: Tue Aug 28 13:14:35 2012 -0400
gquark: clarify G_DEFINE_QUARK docs about the use of quotes
Use the term "name" instead of "string" in the documentation, and add a
note explaining double quotes shouldn't be used for the quark name.
glib/gquark.c | 6 ++++--
1 files changed, 4 insertions(+), 2 deletions(-)
---
diff --git a/glib/gquark.c b/glib/gquark.c
index 782388a..9762dd6 100644
--- a/glib/gquark.c
+++ b/glib/gquark.c
@@ -94,12 +94,14 @@ static gint quark_block_offset = 0;
/**
* G_DEFINE_QUARK:
- * @QN: the string to return a #GQuark for
+ * @QN: the name to return a #GQuark for
* @q_n: prefix for the function name
*
* A convenience macro which defines a function returning the
- * #GQuark for the string @QN. The function will be named
+ * #GQuark for the name @QN. The function will be named
* @q_n<!-- -->_quark().
+ * Note that the quark name will be stringified automatically in the
+ * macro, so you shouldn't use double quotes.
*
* Since: 2.34
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]