From: Guillaume Desmottes <guillaume.desmottes@collabora.co.uk>
Date: Fri, 27 Apr 2012 08:02:54 +0000 (+0200)
Subject: Link to gvariant-format-strings-pointers in getter API
X-Git-Tag: 2.33.2~21
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ae421c9f6ca58ba18494619dc89ed1d2b60948eb;p=platform%2Fupstream%2Fglib.git

Link to gvariant-format-strings-pointers in getter API

https://bugzilla.gnome.org/show_bug.cgi?id=674777
---

diff --git a/glib/gvariant.c b/glib/gvariant.c
index 3526f12..6ff7714 100644
--- a/glib/gvariant.c
+++ b/glib/gvariant.c
@@ -954,7 +954,10 @@ g_variant_new_dict_entry (GVariant *key,
  * this function returns %FALSE.  Otherwise, it unpacks the returned
  * value and returns %TRUE.
  *
- * See g_variant_get() for information about @format_string.
+ * @format_string determines the C types that are used for unpacking
+ * the values and also determines if the values are copied or borrowed,
+ * see the section on
+ * <link linkend='gvariant-format-strings-pointers'>GVariant Format Strings</link>.
  *
  * Returns: %TRUE if a value was unpacked
  *
@@ -4614,6 +4617,11 @@ g_variant_new_va (const gchar  *format_string,
  * Please note that the syntax of the format string is very likely to be
  * extended in the future.
  *
+ * @format_string determines the C types that are used for unpacking
+ * the values and also determines if the values are copied or borrowed,
+ * see the section on
+ * <link linkend='gvariant-format-strings-pointers'>GVariant Format Strings</link>.
+ *
  * Since: 2.24
  **/
 void
@@ -4662,6 +4670,11 @@ g_variant_get (GVariant    *value,
  * g_variant_new_va() and g_variant_get_va() within a single actual
  * varargs call by the user.
  *
+ * @format_string determines the C types that are used for unpacking
+ * the values and also determines if the values are copied or borrowed,
+ * see the section on
+ * <link linkend='gvariant-format-strings-pointers'>GVariant Format Strings</link>.
+ *
  * Since: 2.24
  **/
 void
@@ -4748,6 +4761,11 @@ g_variant_builder_add (GVariantBuilder *builder,
  * essentially a combination of g_variant_get_child_value() and
  * g_variant_get().
  *
+ * @format_string determines the C types that are used for unpacking
+ * the values and also determines if the values are copied or borrowed,
+ * see the section on
+ * <link linkend='gvariant-format-strings-pointers'>GVariant Format Strings</link>.
+ *
  * Since: 2.24
  **/
 void
@@ -4816,6 +4834,11 @@ g_variant_get_child (GVariant    *value,
  * For a solution that is likely to be more convenient to C programmers
  * when dealing with loops, see g_variant_iter_loop().
  *
+ * @format_string determines the C types that are used for unpacking
+ * the values and also determines if the values are copied or borrowed,
+ * see the section on
+ * <link linkend='gvariant-format-strings-pointers'>GVariant Format Strings</link>.
+ *
  * Returns: %TRUE if a value was unpacked, or %FALSE if there as no value
  *
  * Since: 2.24
@@ -4914,6 +4937,11 @@ g_variant_iter_next (GVariantIter *iter,
  * types, use the '&' prefix to avoid allocating any memory at all (and
  * thereby avoiding the need to free anything as well).
  *
+ * @format_string determines the C types that are used for unpacking
+ * the values and also determines if the values are copied or borrowed,
+ * see the section on
+ * <link linkend='gvariant-format-strings-pointers'>GVariant Format Strings</link>.
+ *
  * Returns: %TRUE if a value was unpacked, or %FALSE if there was no
  *          value
  *