gst/gstutils.c: Improve docs for gst_element_{link,unlink}.

Original commit message from CVS:
* gst/gstutils.c:
Improve docs for gst_element_{link,unlink}.

diff --git a/ChangeLog b/ChangeLog
index 81bfaea..d18b77b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-04-29  Stefan Kost  <ensonic@users.sf.net>
+
+       * gst/gstutils.c:
+         Improve docs for gst_element_{link,unlink}.
+
 2007-04-28  Tim-Philipp Müller  <tim at centricular dot net>
 
        * docs/design/part-events.txt:
@@ -1166,6 +1171,14 @@
 
        * configure.ac:
        * docs/gst/Makefile.am:
+       * docs/gst/gstreamer-sections.txt:
+       * docs/libs/Makefile.am:
+         Erm, forgot a bunch of --extra-dir.
+
+2007-02-12  Stefan Kost  <ensonic@users.sf.net>
+
+       * configure.ac:
+       * docs/gst/Makefile.am:
        * docs/libs/Makefile.am:
        * docs/plugins/Makefile.am:
          Add crossreferences to glib/gobject docs.

diff --git a/gst/gstutils.c b/gst/gstutils.c
index 5ab9850..a36f9dc 100644 (file)
--- a/gst/gstutils.c
+++ b/gst/gstutils.c
@@ -1651,6 +1651,7 @@ gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
  * Links @src to @dest. The link must be from source to
  * destination; the other direction will not be tried. The function looks for
  * existing pads that aren't linked yet. It will request new pads if necessary.
+ * Such pads need to be released manualy when unlinking.
  * If multiple links are possible, only one is established.
  *
  * Make sure you have added your elements to a bin or pipeline with
@@ -1800,6 +1801,9 @@ gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
  *
  * Unlinks all source pads of the source element with all sink pads
  * of the sink element to which they are linked.
+ *
+ * If the link has been made using gst_element_link(), it could have created an
+ * requestpad, which has to be released using gst_element_release_request_pad().
  */
 void
 gst_element_unlink (GstElement * src, GstElement * dest)
@@ -2417,7 +2421,7 @@ gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
  * gst_buffer_copy_metadata(@dest, @src, GST_BUFFER_COPY_TIMESTAMPS).
  *
  * Deprecated: use gst_buffer_copy_metadata() instead, it provides more
- * control. 
+ * control.
  */
 void
 gst_buffer_stamp (GstBuffer * dest, const GstBuffer * src)