diff options
| author | Elliott Sales de Andrade <quantum.analyst@gmail.com> | 2022-11-04 00:20:18 -0500 |
|---|---|---|
| committer | Elliott Sales de Andrade <quantum.analyst@gmail.com> | 2022-11-04 00:20:18 -0500 |
| commit | a55f31aa6ed09f8ca4426cb6caa05d920555332e (patch) | |
| tree | c077c365197f6a13d1e319d3a2631ced306f85e5 /libpurple/purplesqlite3.h | |
| parent | 5b988dbefcf850d3f8faf0992a42be2fda31e776 (diff) | |
| download | pidgin-a55f31aa6ed09f8ca4426cb6caa05d920555332e.tar.gz | |
Fix error parameter annotations
The `(optional)` annotation causes a warning because the parameter is not marked as `(out)`. Additionally, the annotations have no effect on the generated documentation.
When a function takes `GError **error`, then the GObject introspection data includes `throws="1"`.
When gi-docgen sees that annotation, it inserts a standard text about it, so what we write there doesn't matter too much. It will only be seen by people reading the header file directly, so I have inserted a consistent text in those places.
Testing Done:
Compiled and saw fewer warnings from gobject-introspection.
Reviewed at https://reviews.imfreedom.org/r/2019/
Diffstat (limited to 'libpurple/purplesqlite3.h')
| -rw-r--r-- | libpurple/purplesqlite3.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/libpurple/purplesqlite3.h b/libpurple/purplesqlite3.h index 6c4ff1d685..1c7b105a07 100644 --- a/libpurple/purplesqlite3.h +++ b/libpurple/purplesqlite3.h @@ -58,7 +58,7 @@ typedef sqlite3 PurpleSqlite3; /** * purple_sqlite3_get_schema_version: * @db: The sqlite3 connection. - * @error: (nullable): A return address for a [type@GLib.Error]. + * @error: Return address for a #GError, or %NULL. * * Attempts to read the result of `PRAGMA user_version` which this API uses to * store the schema version. @@ -74,7 +74,7 @@ int purple_sqlite3_get_schema_version(PurpleSqlite3 *db, GError **error); * @db: The sqlite3 connection. * @migrations: (array zero-terminated=1): A list of SQL statements, each item * being its own migration. - * @error: (nullable): A return address for a [type@GLib.Error]. + * @error: Return address for a #GError, or %NULL. * * Runs the given migrations in the order they are given. The index of each * migration plus 1 is assumed is to be the version number of the migration, @@ -116,7 +116,7 @@ gboolean purple_sqlite3_run_migrations_from_strings(PurpleSqlite3 *db, const cha * @path: The base path in @resource to use. * @migrations: (array zero-terminated=1): The list of migrations in the order * to run them. - * @error: (nullable): A return address for a [type@GLib.Error]. + * @error: Return address for a #GError, or %NULL. * * Runs the given migrations in the order they are given. The index of each * migration plus 1 is assumed to be the version number of the migration, which |