luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-26 12:12:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

gvariant: Clarify type and format strings in the docs

Browse Source 
'@' 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
This commit is contained in:
Philip Withnall 2014-05-27 15:50:00 +01:00
parent de1c0722b9
commit fd9120dc50
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/glib/gvariant-varargs.xml
View File

@ -221,7 +221,8 @@
</entry> </entry>
<entry colsep='1' rowsep='1'> <entry colsep='1' rowsep='1'>
<para> <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='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 <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> non-<link linkend='NULL:CAPS'><literal>NULL</literal></link> <code>(<link linkend='GVariant'>GVariant</link>
@ -260,7 +261,9 @@
</entry> </entry>
<entry colsep='1' rowsep='1'> <entry colsep='1' rowsep='1'>
<para> <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>&amp;s</literal> is
a valid format string but <literal>&amp;@s</literal> is not).
Denotes that a C pointer to serialised data
should be used in place of the normal C type. See should be used in place of the normal C type. See
<link linkend='gvariant-format-strings-pointers'>Pointers</link> below. <link linkend='gvariant-format-strings-pointers'>Pointers</link> below.
</para> </para>