From fd9120dc505773faf3ace728c8ad8c503824ee9f Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Tue, 27 May 2014 15:50:00 +0100 Subject: [PATCH] gvariant: Clarify type and format strings in the docs '@' and '&' are only used in format strings as prefixes to type strings and not to full format strings. https://bugzilla.gnome.org/show_bug.cgi?id=729269 --- docs/reference/glib/gvariant-varargs.xml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/reference/glib/gvariant-varargs.xml b/docs/reference/glib/gvariant-varargs.xml index 77cc2715b..2e1eed64f 100644 --- a/docs/reference/glib/gvariant-varargs.xml +++ b/docs/reference/glib/gvariant-varargs.xml @@ -221,7 +221,8 @@ - Used as a prefix on a GVariant type string (not format string). Denotes that a pointer to a + Used as a prefix for a GVariant type string (not a prefix for a format string, so @as is + a valid format string but @^as is not). Denotes that a pointer to a GVariant should be used in place of the normal C type or types. For g_variant_new() this means that you must pass a non-NULL (GVariant @@ -260,7 +261,9 @@ - Used as a prefix on a GVariant type string (not format string). Denotes that a C pointer to serialised data + Used as a prefix for a GVariant type string (not a prefix for a format string, so &s is + a valid format string but &@s is not). + Denotes that a C pointer to serialised data should be used in place of the normal C type. See Pointers below.