gst/gstfilter.c: Improve documentation of gst_filter_run(). Fixes #518627.

Original commit message from CVS:
* gst/gstfilter.c:
Improve documentation of gst_filter_run(). Fixes #518627.

diff --git a/ChangeLog b/ChangeLog
index a094c21..c262422 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2008-02-25  Tim-Philipp Müller  <tim at centricular dot net>
+
+       * gst/gstfilter.c:
+         Improve documentation of gst_filter_run(). Fixes #518627.
+
 2008-02-23  Tim-Philipp Müller  <tim at centricular dot net>
 
        * docs/README:

diff --git a/gst/gstfilter.c b/gst/gstfilter.c
index 18f6a41..617d493 100644 (file)
--- a/gst/gstfilter.c
+++ b/gst/gstfilter.c
@@ -51,7 +51,14 @@
  * prepended to the list of results returned.  If @first is true,
  * the search is halted after the first result is found.
  *
- * Returns: the list of results
+ * Since gst_filter_run() knows nothing about the type of @data, no
+ * reference will be taken (if @data refers to an object) and no copy of
+ * @data wil be made in any other way when prepending @data to the list of
+ * results.
+ *
+ * Returns: the list of results. Free with g_list_free() when no longer needed
+ * (the data contained in the list is a flat copy and does need to be
+ * unreferenced or freed).
  */
 GList *
 gst_filter_run (const GList * list, GstFilterFunc func, gboolean first,