gquark: clarify G_DEFINE_QUARK docs about the use of quotes
authorCosimo Cecchi <cosimoc@gnome.org>
Tue, 28 Aug 2012 17:14:35 +0000 (13:14 -0400)
committerCosimo Cecchi <cosimoc@gnome.org>
Tue, 28 Aug 2012 17:16:23 +0000 (13:16 -0400)
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

index 782388a..9762dd6 100644 (file)
@@ -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
  */