diff options
| author | Philip Withnall <withnall@endlessm.com> | 2017-04-28 12:29:44 +0100 |
|---|---|---|
| committer | Philip Withnall <withnall@endlessm.com> | 2017-04-28 12:32:12 +0100 |
| commit | b63469d7261a3d98207647a7f05167f21f22dbc1 (patch) | |
| tree | f7cd21979f7fa80a6737dd22e884bee3c25cb154 /glib/gconvert.c | |
| parent | 88ad0dab214799f17f0ddc463d10f44c00587dbf (diff) | |
| download | glib-b63469d7261a3d98207647a7f05167f21f22dbc1.tar.gz | |
docs: Fix (nullable) (optional) annotations
There are a few places where commit 18a33f72 replaced valid (nullable)
(optional) annotations with just (optional). That has a different
meaning.
(nullable) (optional) can only be applied to gpointer* parameters, and
means that both the gpointer* and returned gpointer can be NULL. i.e.
The caller can pass in NULL to ignore the return value; and the returned
value can be NULL.
(optional) can be applied to anything* parameters, and means that the
anything* can be NULL. i.e. The caller can pass in NULL to ignore the
return value. The return value cannot be NULL.
Signed-off-by: Philip Withnall <withnall@endlessm.com>
Diffstat (limited to 'glib/gconvert.c')
| -rw-r--r-- | glib/gconvert.c | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/glib/gconvert.c b/glib/gconvert.c index 0d8f47d13..6e5a7cf9d 100644 --- a/glib/gconvert.c +++ b/glib/gconvert.c @@ -1477,7 +1477,7 @@ hostname_validate (const char *hostname) /** * g_filename_from_uri: * @uri: a uri describing a filename (escaped, encoded in ASCII). - * @hostname: (out) (optional): Location to store hostname for the URI. + * @hostname: (out) (optional) (nullable): Location to store hostname for the URI. * If there is no hostname in the URI, %NULL will be * stored in this location. * @error: location to store the error occurring, or %NULL to ignore |