[glib] docs: Tell which function to use to avoid errors.



commit 14677e16d8ac6b7bdb22885ef94ae889f67751ee
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 99bbdad..fe1ba84 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]