diff options
author | Rico Tzschichholz <ricotz@ubuntu.com> | 2018-01-02 11:35:35 +0100 |
---|---|---|
committer | Rico Tzschichholz <ricotz@ubuntu.com> | 2018-01-02 11:35:35 +0100 |
commit | fd78c996bb204525b217c5baf6704f777ef8c5fa (patch) | |
tree | 9605af594e9cc6970bfb1fc163cdfd89d1383555 /gir | |
parent | 8cf3e8e5cf6d0d49db359f50c6eb0bc9ca22fbef (diff) | |
download | gobject-introspection-fd78c996bb204525b217c5baf6704f777ef8c5fa.tar.gz |
gir: Update annotations from GLib git master
Diffstat (limited to 'gir')
-rw-r--r-- | gir/glib-2.0.c | 92 | ||||
-rw-r--r-- | gir/gobject-2.0.c | 4 |
2 files changed, 89 insertions, 7 deletions
diff --git a/gir/glib-2.0.c b/gir/glib-2.0.c index 17d30b09..2999e4c3 100644 --- a/gir/glib-2.0.c +++ b/gir/glib-2.0.c @@ -10618,6 +10618,35 @@ /** + * g_autolist: + * @TypeName: a supported variable type + * + * Helper to declare a list variable with automatic deep cleanup. + * + * The list is deeply freed, in a way appropriate to the specified type, when the + * variable goes out of scope. The type must support this. + * + * This feature is only supported on GCC and clang. This macro is not + * defined on other compilers and should not be used in programs that + * are intended to be portable to those compilers. + * + * This is meant to be used to declare lists of a type with a cleanup + * function. The type of the variable is a GList *. You + * must not add your own '*'. + * + * This macro can be used to avoid having to do explicit cleanups of + * local variables when exiting functions. It often vastly simplifies + * handling of error conditions, removing the need for various tricks + * such as 'goto out' or repeating of cleanup code. It is also helpful + * for non-error cases. + * + * See also g_autoslist(), g_autoptr() and g_steal_pointer(). + * + * Since: 2.56 + */ + + +/** * g_autoptr: * @TypeName: a supported variable type * @@ -10678,6 +10707,35 @@ /** + * g_autoslist: + * @TypeName: a supported variable type + * + * Helper to declare a singly linked list variable with automatic deep cleanup. + * + * The list is deeply freed, in a way appropriate to the specified type, when the + * variable goes out of scope. The type must support this. + * + * This feature is only supported on GCC and clang. This macro is not + * defined on other compilers and should not be used in programs that + * are intended to be portable to those compilers. + * + * This is meant to be used to declare lists of a type with a cleanup + * function. The type of the variable is a GSList *. You + * must not add your own '*'. + * + * This macro can be used to avoid having to do explicit cleanups of + * local variables when exiting functions. It often vastly simplifies + * handling of error conditions, removing the need for various tricks + * such as 'goto out' or repeating of cleanup code. It is also helpful + * for non-error cases. + * + * See also g_autolist(), g_autoptr() and g_steal_pointer(). + * + * Since: 2.56 + */ + + +/** * g_base64_decode: * @text: zero-terminated string with base64 text to decode * @out_len: (out): The length of the decoded data is written here @@ -30519,15 +30577,16 @@ * be skipped (ie, a test whose name contains "/subprocess"). * - `-m {perf|slow|thorough|quick|undefined|no-undefined}`: Execute tests according to these test modes: * - * `perf`: Performance tests, may take long and report results. + * `perf`: Performance tests, may take long and report results (off by default). * - * `slow`, `thorough`: Slow and thorough tests, may take quite long and maximize coverage. + * `slow`, `thorough`: Slow and thorough tests, may take quite long and maximize coverage + * (off by default). * - * `quick`: Quick tests, should run really quickly and give good coverage. + * `quick`: Quick tests, should run really quickly and give good coverage (the default). * * `undefined`: Tests for undefined behaviour, may provoke programming errors * under g_test_trap_subprocess() or g_test_expect_message() to check - * that appropriate assertions or warnings are given + * that appropriate assertions or warnings are given (the default). * * `no-undefined`: Avoid tests for undefined behaviour * @@ -30661,6 +30720,10 @@ * * Returns %TRUE if tests are run in performance mode. * + * By default, tests are run in quick mode. In tests that use + * g_test_init(), the option `-m perf` enables performance tests, while + * `-m quick` disables them. + * * Returns: %TRUE if in performance mode */ @@ -30712,6 +30775,10 @@ * Exactly one of g_test_quick() and g_test_slow() is active in any run; * there is no "medium speed". * + * By default, tests are run in quick mode. In tests that use + * g_test_init(), the options `-m quick`, `-m slow` and `-m thorough` + * can be used to change this. + * * Returns: %TRUE if in quick mode */ @@ -30720,6 +30787,8 @@ * g_test_quiet: * * Returns %TRUE if tests are run in quiet mode. + * In tests that use g_test_init(), the option `-q` or `--quiet` enables + * this, while `--verbose` disables it. * The default is neither g_test_verbose() nor g_test_quiet(). * * Returns: %TRUE if in quiet mode @@ -30895,6 +30964,10 @@ * Exactly one of g_test_quick() and g_test_slow() is active in any run; * there is no "medium speed". * + * By default, tests are run in quick mode. In tests that use + * g_test_init(), the options `-m quick`, `-m slow` and `-m thorough` + * can be used to change this. + * * Returns: the opposite of g_test_quick() */ @@ -30939,6 +31012,10 @@ * Returns %TRUE if tests are run in thorough mode, equivalent to * g_test_slow(). * + * By default, tests are run in quick mode. In tests that use + * g_test_init(), the options `-m quick`, `-m slow` and `-m thorough` + * can be used to change this. + * * Returns: the same thing as g_test_slow() */ @@ -31189,7 +31266,10 @@ * * Returns %TRUE if tests may provoke assertions and other formally-undefined * behaviour, to verify that appropriate warnings are given. It might, in some - * cases, be useful to turn this off if running tests under valgrind. + * cases, be useful to turn this off with if running tests under valgrind; + * in tests that use g_test_init(), the option `-m no-undefined` disables + * those tests, while `-m undefined` explicitly enables them (the default + * behaviour). * * Returns: %TRUE if tests may provoke programming errors */ @@ -31199,6 +31279,8 @@ * g_test_verbose: * * Returns %TRUE if tests are run in verbose mode. + * In tests that use g_test_init(), the option `--verbose` enables this, + * while `-q` or `--quiet` disables it. * The default is neither g_test_verbose() nor g_test_quiet(). * * Returns: %TRUE if in verbose mode diff --git a/gir/gobject-2.0.c b/gir/gobject-2.0.c index 596e2685..a825994a 100644 --- a/gir/gobject-2.0.c +++ b/gir/gobject-2.0.c @@ -2451,8 +2451,8 @@ * from the @target to the @source, or %NULL to use the default * @user_data: custom data to be passed to the transformation functions, * or %NULL - * @notify: function to be called when disposing the binding, to free the - * resources used by the transformation functions + * @notify: (nullable): a function to call when disposing the binding, to free + * resources used by the transformation functions, or %NULL if not required * * Complete version of g_object_bind_property(). * |