diff options
| author | Ryan Lortie <desrt@desrt.ca> | 2011-10-21 15:00:24 -0400 |
|---|---|---|
| committer | Ryan Lortie <desrt@desrt.ca> | 2011-10-21 15:04:37 -0400 |
| commit | 3d13ee1b5ff2a2ad5f32704cc5f071167a8852a6 (patch) | |
| tree | 1c1723d128385e6c6a82e3bc37a0c451f7f0b7bd | |
| parent | e52437982c4dd1c88459f3eed0d8ad1dc167c0eb (diff) | |
GVariant format string docs: fix maybe types
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.
| -rw-r--r-- | docs/reference/glib/gvariant-varargs.xml | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/reference/glib/gvariant-varargs.xml b/docs/reference/glib/gvariant-varargs.xml index 1b15156af..9b95f87f5 100644 --- a/docs/reference/glib/gvariant-varargs.xml +++ b/docs/reference/glib/gvariant-varargs.xml @@ -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>&</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>&</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 |