[librsvg: 2/9] Mention which functions create RsvgHandle without flags
- From: Federico Mena Quintero <federico src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [librsvg: 2/9] Mention which functions create RsvgHandle without flags
- Date: Wed, 24 Jul 2019 17:56:34 +0000 (UTC)
commit 62d877e46c2ed28f79016f4c88e96d3eb2867698
Author: Federico Mena Quintero <federico gnome org>
Date: Wed Jul 24 12:35:01 2019 -0500
Mention which functions create RsvgHandle without flags
librsvg/rsvg-handle.c | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
---
diff --git a/librsvg/rsvg-handle.c b/librsvg/rsvg-handle.c
index 4732cf06..ecbbca6b 100644
--- a/librsvg/rsvg-handle.c
+++ b/librsvg/rsvg-handle.c
@@ -435,9 +435,10 @@ rsvg_handle_free (RsvgHandle *handle)
* a GdkPixbuf from it. When finished, free the handle with g_object_unref(). No
* more than one image can be loaded with one handle.
*
- * Note that this function creates an #RsvgHandle with no flags set. If you require
- * any of #RsvgHandleFlags to be set, use rsvg_handle_new_with_flags() or the stream
- * functions listed above.
+ * Note that this function creates an #RsvgHandle with no flags set. If you
+ * require any of #RsvgHandleFlags to be set, use any of
+ * rsvg_handle_new_with_flags(), rsvg_handle_new_from_stream_sync(), or
+ * rsvg_handle_new_from_gfile_sync().
*
* Returns: A new #RsvgHandle with no flags set.
**/
@@ -476,7 +477,10 @@ rsvg_handle_new_from_data (const guint8 *data, gsize data_len, GError **error)
* @filename: The file name to load, or a URI.
* @error: return location for errors
*
- * Loads the SVG specified by @file_name.
+ * Loads the SVG specified by @file_name. Note that this function, like
+ * rsvg_handle_new(), does not specify any loading flags for the resulting
+ * handle. If you require the use of #RsvgHandleFlags, use
+ * rsvg_handle_new_from_gfile_sync().
*
* Returns: A #RsvgHandle or %NULL if an error occurs.
* Since: 2.14
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]