[glib] gvariant: Clarify type and format strings in the docs
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] gvariant: Clarify type and format strings in the docs
- Date: Wed, 28 May 2014 10:00:15 +0000 (UTC)
commit fd9120dc505773faf3ace728c8ad8c503824ee9f
Author: Philip Withnall <philip withnall collabora co uk>
Date: Tue May 27 15:50:00 2014 +0100
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 files changed, 5 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/glib/gvariant-varargs.xml b/docs/reference/glib/gvariant-varargs.xml
index 77cc271..2e1eed6 100644
--- a/docs/reference/glib/gvariant-varargs.xml
+++ b/docs/reference/glib/gvariant-varargs.xml
@@ -221,7 +221,8 @@
</entry>
<entry colsep='1' rowsep='1'>
<para>
- 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
<literal>@as</literal> is
+ a valid format string but <literal>@^as</literal> is not). Denotes that a pointer to a
<link linkend='GVariant'>GVariant</link> should be used in place of the normal C type or types. For
<link linkend='g-variant-new'><function>g_variant_new()</function></link> this means that you must
pass a
non-<link linkend='NULL:CAPS'><literal>NULL</literal></link> <code>(<link
linkend='GVariant'>GVariant</link>
@@ -260,7 +261,9 @@
</entry>
<entry colsep='1' rowsep='1'>
<para>
- 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
<literal>&s</literal> is
+ a valid format string but <literal>&@s</literal> is not).
+ Denotes that a C pointer to serialised data
should be used in place of the normal C type. See
<link linkend='gvariant-format-strings-pointers'>Pointers</link> below.
</para>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]