Bump gtk-doc dep to 1.20

[platform/upstream/glib.git] / glib / gvariant-parser.c

diff --git a/glib/gvariant-parser.c b/glib/gvariant-parser.c
index 401784c..7536844 100644 (file)
--- a/glib/gvariant-parser.c
+++ b/glib/gvariant-parser.c
@@ -72,6 +72,8 @@
 G_DEFINE_QUARK (g-variant-parse-error-quark, g_variant_parse_error)
 
 /**
+ * g_variant_parser_get_error_quark:
+ *
  * Deprecated: Use g_variant_parse_error_quark() instead.
  */
 GQuark
@@ -2323,7 +2325,7 @@ parse (TokenStream  *stream,
  *
  * A single #GVariant is parsed from the content of @text.
  *
- * The format is described <link linkend='gvariant-text'>here</link>.
+ * The format is described [here][gvariant-text].
  *
  * The memory at @limit will never be accessed and the parser behaves as
  * if the character at @limit is the nul terminator.  This has the
@@ -2426,6 +2428,10 @@ g_variant_parse (const GVariantType  *type,
  * #GVariant pointer will be returned unmodified, without adding any
  * additional references.
  *
+ * Note that the arguments in @app must be of the correct width for their types
+ * specified in @format when collected into the #va_list. See
+ * the [GVariant varargs documentation][gvariant-varargs].
+ *
  * In order to behave correctly in all cases it is necessary for the
  * calling function to g_variant_ref_sink() the return result before
  * returning control to the user that originally provided the pointer.
@@ -2479,15 +2485,19 @@ g_variant_new_parsed_va (const gchar *format,
  * that case, the same arguments are collected from the argument list as
  * g_variant_new() would have collected.
  *
+ * Note that the arguments must be of the correct width for their types
+ * specified in @format. This can be achieved by casting them. See
+ * the [GVariant varargs documentation][gvariant-varargs].
+ *
  * Consider this simple example:
- * |[
+ * |[<!-- language="C" --> 
  *  g_variant_new_parsed ("[('one', 1), ('two', %i), (%s, 3)]", 2, "three");
  * ]|
  *
  * In the example, the variable argument parameters are collected and
  * filled in as if they were part of the original string to produce the
  * result of
- * |[
+ * |[<!-- language="C" --> 
  * [('one', 1), ('two', 2), ('three', 3)]
  * ]|
  *
@@ -2528,9 +2538,13 @@ g_variant_new_parsed (const gchar *format,
  * calling g_variant_new_parsed() followed by
  * g_variant_builder_add_value().
  *
+ * Note that the arguments must be of the correct width for their types
+ * specified in @format_string. This can be achieved by casting them. See
+ * the [GVariant varargs documentation][gvariant-varargs].
+ *
  * This function might be used as follows:
  *
- * |[
+ * |[<!-- language="C" --> 
  * GVariant *
  * make_pointless_dictionary (void)
  * {