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/queuedoutputstream.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/queuedoutputstream.h')
| -rw-r--r-- | libpurple/queuedoutputstream.h | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/libpurple/queuedoutputstream.h b/libpurple/queuedoutputstream.h index d578773be0..ee62a1b44b 100644 --- a/libpurple/queuedoutputstream.h +++ b/libpurple/queuedoutputstream.h @@ -88,8 +88,7 @@ void purple_queued_output_stream_push_bytes_async(PurpleQueuedOutputStream *stre * purple_queued_output_stream_push_bytes_finish: * @stream: The instance. * @result: The [iface@Gio.AsyncResult] of this operation. - * @error: (nullable): A [type@Glib.Error] location to store the error, or - * %NULL to ignore. + * @error: Return address for a #GError, or %NULL. * * Finishes pushing bytes asynchronously. * |