diff options
author | Emmanuele Bassi <ebassi@gnome.org> | 2021-09-17 16:57:32 +0100 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2021-09-17 16:57:32 +0100 |
commit | c3a03a68bb44589a1d875ff08468f0fa7965be24 (patch) | |
tree | e2ad9d3f9ceb25227599224254a7378d5ee17b2a | |
parent | 7a7f989f83612ea312006702c6483f928fdb04ae (diff) | |
download | gobject-introspection-c3a03a68bb44589a1d875ff08468f0fa7965be24.tar.gz |
Update the annotations for GLib 2.70
GLib 2.70 has just been released, so let's sync up the documentation and
annotations.
Fixes: #402
-rw-r--r-- | gir/gio-2.0.c | 4 | ||||
-rw-r--r-- | gir/glib-2.0.c | 42 | ||||
-rw-r--r-- | gir/gobject-2.0.c | 5 |
3 files changed, 47 insertions, 4 deletions
diff --git a/gir/gio-2.0.c b/gir/gio-2.0.c index eec568cf..956fed09 100644 --- a/gir/gio-2.0.c +++ b/gir/gio-2.0.c @@ -33887,10 +33887,10 @@ * @key: a #GSettingsSchemaKey * @value: the value to check * - * Checks if the given @value is of the correct type and within the + * Checks if the given @value is within the * permitted range for @key. * - * It is a programmer error if @value is not of the correct type -- you + * It is a programmer error if @value is not of the correct type — you * must check for this first. * * Returns: %TRUE if @value is valid for @key diff --git a/gir/glib-2.0.c b/gir/glib-2.0.c index 2880a21a..2d2810ea 100644 --- a/gir/glib-2.0.c +++ b/gir/glib-2.0.c @@ -33513,11 +33513,29 @@ * * If not called from inside a test, this function does nothing. * + * Note that unlike g_test_skip() and g_test_incomplete(), this + * function does not log a message alongside the test failure. + * If details of the test failure are available, either log them with + * g_test_message() before g_test_fail(), or use g_test_fail_printf() + * instead. + * * Since: 2.30 */ /** + * g_test_fail_printf: + * @format: the format string + * @...: printf-like arguments to @format + * + * Equivalent to g_test_fail(), but also record a message like + * g_test_skip_printf(). + * + * Since: 2.70 + */ + + +/** * g_test_failed: * * Returns whether a test has already failed. This will @@ -33620,6 +33638,18 @@ /** + * g_test_incomplete_printf: + * @format: the format string + * @...: printf-like arguments to @format + * + * Equivalent to g_test_incomplete(), but the explanation is formatted + * as if by g_strdup_printf(). + * + * Since: 2.70 + */ + + +/** * g_test_init: * @argc: Address of the @argc parameter of the main() function. * Changed if any arguments were handled. @@ -34039,6 +34069,18 @@ /** + * g_test_skip_printf: + * @format: the format string + * @...: printf-like arguments to @format + * + * Equivalent to g_test_skip(), but the explanation is formatted + * as if by g_strdup_printf(). + * + * Since: 2.70 + */ + + +/** * g_test_slow: * * Returns %TRUE if tests are run in slow mode. diff --git a/gir/gobject-2.0.c b/gir/gobject-2.0.c index 93a4c7d3..8bfce427 100644 --- a/gir/gobject-2.0.c +++ b/gir/gobject-2.0.c @@ -2033,7 +2033,7 @@ /** * g_closure_invoke: * @closure: a #GClosure - * @return_value: (optional) (inout): a #GValue to store the return + * @return_value: (optional) (out): a #GValue to store the return * value. May be %NULL if the callback of @closure * doesn't return a value. * @n_param_values: the length of the @param_values array @@ -4686,7 +4686,8 @@ * @detailed_signal: a string of the form "signal-name::detail". * @...: parameters to be passed to the signal, followed by a * location for the return value. If the return type of the signal - * is #G_TYPE_NONE, the return value location can be omitted. + * is %G_TYPE_NONE, the return value location can be omitted. The + * number of parameters to pass to this function is defined when creating the signal. * * Emits a signal. * |