[librsvg: 3/9] Improve the wording around error return values
- From: Federico Mena Quintero <federico src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [librsvg: 3/9] Improve the wording around error return values
- Date: Wed, 24 Jul 2019 17:56:39 +0000 (UTC)
commit d82683029dff8ff47862fe9c77e2327f88dfe911
Author: Federico Mena Quintero <federico gnome org>
Date: Wed Jul 24 12:35:37 2019 -0500
Improve the wording around error return values
For rsvg_handle_write(), this wording indicates the possibility of
that function being able to return FALSE again in the future (maybe if
the accumulation buffer can't grow due to out-of-memory).
librsvg/rsvg-handle.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
---
diff --git a/librsvg/rsvg-handle.c b/librsvg/rsvg-handle.c
index ecbbca6b..0d597c77 100644
--- a/librsvg/rsvg-handle.c
+++ b/librsvg/rsvg-handle.c
@@ -522,7 +522,7 @@ rsvg_handle_new_with_flags (RsvgHandleFlags flags)
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the
* operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
- * returned.
+ * returned in @error.
*
* Returns: a new #RsvgHandle on success, or %NULL with @error filled in
*
@@ -554,7 +554,7 @@ rsvg_handle_new_from_gfile_sync (GFile *file,
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the
* operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
- * returned.
+ * returned in @error.
*
* Returns: a new #RsvgHandle on success, or %NULL with @error filled in
*
@@ -588,7 +588,7 @@ rsvg_handle_new_from_stream_sync (GInputStream *input_stream,
*
* Loads the next @count bytes of the image.
*
- * Returns: This function always returns %TRUE, and does not set the @error.
+ * Returns: %TRUE on success, or %FALSE on error.
*
* Deprecated: 2.46. Use rsvg_handle_read_stream_sync() or the constructor
* functions rsvg_handle_new_from_gfile_sync() or rsvg_handle_new_from_stream_sync().
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]