introspection: use (nullable) or (optional) instead of (allow-none)

If we have an input parameter (or return value) we need to use (nullable).
However, if it is an (inout) or (out) parameter, (optional) is sufficient.

It looks like (nullable) could be used for everything according to the
Annotation documentation, but (optional) is more specific.
This commit is contained in:
Christian Hergert
2016-10-28 18:29:02 -07:00
parent a4012abbdf
commit 18a33f72db
151 changed files with 986 additions and 987 deletions

View File

@@ -1786,7 +1786,7 @@ g_test_fail (void)
/**
* g_test_incomplete:
* @msg: (allow-none): explanation
* @msg: (nullable): explanation
*
* Indicates that a test failed because of some incomplete
* functionality. This function can be called multiple times
@@ -1811,7 +1811,7 @@ g_test_incomplete (const gchar *msg)
/**
* g_test_skip:
* @msg: (allow-none): explanation
* @msg: (nullable): explanation
*
* Indicates that a test was skipped.
*
@@ -2548,8 +2548,8 @@ g_assertion_message_error (const char *domain,
/**
* g_strcmp0:
* @str1: (allow-none): a C string or %NULL
* @str2: (allow-none): another C string or %NULL
* @str1: (nullable): a C string or %NULL
* @str2: (nullable): another C string or %NULL
*
* Compares @str1 and @str2 like strcmp(). Handles %NULL
* gracefully by sorting it before non-%NULL strings.
@@ -2866,7 +2866,7 @@ g_test_trap_fork (guint64 usec_timeout,
/**
* g_test_trap_subprocess:
* @test_path: (allow-none): Test to run in a subprocess
* @test_path: (nullable): Test to run in a subprocess
* @usec_timeout: Timeout for the subprocess test in micro seconds.
* @test_flags: Flags to modify subprocess behaviour.
*