docs: clarify that return value of gst_filename_to_uri() must be freed

https://bugzilla.gnome.org/show_bug.cgi?id=747104

diff --git a/gst/gsturi.c b/gst/gsturi.c
index 9a04dcb8b4c9db6e3558ca539e00c35a13fca066..3d78562656b703ec67c1b4c55d9d81fccd0c3491 100644 (file)
--- a/gst/gsturi.c
+++ b/gst/gsturi.c
@@ -927,6 +927,9 @@ file_path_contains_relatives (const gchar * path)
  * will be canonicalised so that it doesn't contain any './' or '../' segments.
  *
  * On Windows #filename should be in UTF-8 encoding.
+ *
+ * Returns: newly-allocated URI string, or NULL on error. The caller must
+ *   free the URI string with g_free() when no longer needed.
  */
 gchar *
 gst_filename_to_uri (const gchar * filename, GError ** error)