[glib/glib-2-30] docs: Tell which function to use to avoid errors.
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib/glib-2-30] docs: Tell which function to use to avoid errors.
- Date: Fri, 11 Nov 2011 21:23:01 +0000 (UTC)
commit 44ca0df0af5ddc25c4d140efd792f7547317107f
Author: Benjamin Otte <otte redhat com>
Date: Mon Jul 25 13:08:59 2011 +0200
docs: Tell which function to use to avoid errors.
glib/gvarianttype.h | 3 ++-
1 files changed, 2 insertions(+), 1 deletions(-)
---
diff --git a/glib/gvarianttype.h b/glib/gvarianttype.h
index be9555e..676a96b 100644
--- a/glib/gvarianttype.h
+++ b/glib/gvarianttype.h
@@ -282,7 +282,8 @@ typedef struct _GVariantType GVariantType;
* to ensure that @string is a valid GVariant type string.
*
* It is always a programmer error to use this macro with an invalid
- * type string.
+ * type string. If in doubt, use g_variant_type_string_is_valid() to
+ * check if the string is valid.
*
* Since 2.24
**/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]