diff options
author | Federico Mena Quintero <federico@gnome.org> | 2019-07-24 12:35:37 -0500 |
---|---|---|
committer | Federico Mena Quintero <federico@gnome.org> | 2019-07-24 12:35:46 -0500 |
commit | d82683029dff8ff47862fe9c77e2327f88dfe911 (patch) | |
tree | 0b0eb07f7bfbaf0a6a7985af1b9c65c01ca39ad4 /librsvg/rsvg-handle.c | |
parent | 62d877e46c2ed28f79016f4c88e96d3eb2867698 (diff) | |
download | librsvg-d82683029dff8ff47862fe9c77e2327f88dfe911.tar.gz |
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).
Diffstat (limited to 'librsvg/rsvg-handle.c')
-rw-r--r-- | librsvg/rsvg-handle.c | 6 |
1 files 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(). |