Mention GVariant format string docs from iter docs
authorRyan Lortie <desrt@desrt.ca>
Thu, 10 Jun 2010 12:06:32 +0000 (08:06 -0400)
committerRyan Lortie <desrt@desrt.ca>
Thu, 10 Jun 2010 12:07:34 +0000 (08:07 -0400)
It's not entirely clear what @format_string in iter_next() and
iter_loop() should be.  Include a link to the GVariant format string
docs as a hint.

glib/gvariant.c

index 47b6fbe..3b5fd8c 100644 (file)
@@ -4023,6 +4023,9 @@ g_variant_get_child (GVariant    *value,
  * responsibility of the caller to free all of the values returned by
  * the unpacking process.
  *
+ * See the section on <link linkend='gvariant-format-strings'>GVariant
+ * Format Strings</link>.
+ *
  * <example>
  *  <title>Memory management with g_variant_iter_next()</title>
  *  <programlisting>
@@ -4107,6 +4110,9 @@ g_variant_iter_next (GVariantIter *iter,
  * function and g_variant_iter_next() or g_variant_iter_next_value() on
  * the same iterator is not recommended.
  *
+ * See the section on <link linkend='gvariant-format-strings'>GVariant
+ * Format Strings</link>.
+ *
  * <example>
  *  <title>Memory management with g_variant_iter_loop()</title>
  *  <programlisting>