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

GVariant format string docs: fix maybe types

Browse Source 
The documentation for maybe types failed to mention 'a' as one of the
types that was handled with a single pointer for which NULL means
"nothing".  Correct that omission.

Problem caught by Shaun McCance.
This commit is contained in:
Ryan Lortie 2011-10-21 15:00:24 -04:00
parent e52437982c
commit 3d13ee1b5f
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -671,11 +671,12 @@ g_variant_unref (value);]]></programlisting></informalexample>
</para>
<para>
The first way is used with format strings starting with '<literal>s</literal>', '<literal>o</literal>',
'<literal>g</literal>', '<literal>v</literal>', '<literal>@</literal>', '<literal>*</literal>',
'<literal>?</literal>', '<literal>r</literal>', '<literal>&amp;</literal>', or '<literal>^</literal>'. In all of
these cases, for non-maybe types, <link linkend='g-variant-new'><function>g_variant_new()</function></link> takes
a pointer to a non-<link linkend='NULL:CAPS'><literal>NULL</literal></link> value and
The first way is used with format strings starting with '<literal>a</literal>', '<literal>s</literal>',
'<literal>o</literal>', '<literal>g</literal>', '<literal>v</literal>', '<literal>@</literal>',
'<literal>*</literal>', '<literal>?</literal>', '<literal>r</literal>', '<literal>&amp;</literal>', or
'<literal>^</literal>'. In all of these cases, for non-maybe types,
<link linkend='g-variant-new'><function>g_variant_new()</function></link> takes a pointer to a
non-<link linkend='NULL:CAPS'><literal>NULL</literal></link> value and
<link linkend='g-variant-get'><function>g_variant_get()</function></link> returns (by reference) a
non-<link linkend='NULL:CAPS'><literal>NULL</literal></link> pointer. When any of these format strings are
prefixed with an '<literal>m</literal>', the type of arguments that are collected does not change in any way, but