From: Stefan Sauer <ensonic@users.sf.net>
Date: Wed, 18 Jan 2017 21:39:33 +0000 (+0100)
Subject: bin: update the docs for the event forwarding
X-Git-Tag: 1.12.0~106
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a533b6c2f91aa83ff0a7ef2e1a58ed64bb683066;p=platform%2Fupstream%2Fgstreamer.git

bin: update the docs for the event forwarding

First this sends the events not only to the sources and 2nd this is not only
for seek events.
---

diff --git a/gst/gstbin.c b/gst/gstbin.c
index bcc163e..9e67089 100644
--- a/gst/gstbin.c
+++ b/gst/gstbin.c
@@ -147,9 +147,12 @@
  *   </varlistentry>
  * </variablelist>
  *
- * A #GstBin will by default forward any event sent to it to all sink elements.
- * If all the sinks return %TRUE, the bin will also return %TRUE, else %FALSE is
- * returned. If no sinks are in the bin, the event handler will return %TRUE.
+ * A #GstBin will by default forward any event sent to it to all sink
+ * (#GST_EVENT_TYPE_DOWNSTREAM) or source (#GST_EVENT_TYPE_UPSTREAM) elements
+ * depending on the event type.
+ * If all the elements return %TRUE, the bin will also return %TRUE, else %FALSE
+ * is returned. If no elements of the required type are in the bin, the event
+ * handler will return %TRUE.
  *
  * </para>
  * </refsect2>
@@ -3129,13 +3132,11 @@ undo:
 }
 
 /*
- * This function is a utility event handler for seek events.
- * It will send the event to all sinks or sources and appropriate
- * ghost pads depending on the event-direction.
+ * This function is a utility event handler. It will send the event to all sinks
+ * or sources and appropriate ghost pads depending on the event-direction.
  *
- * Applications are free to override this behaviour and
- * implement their own seek handler, but this will work for
- * pretty much all cases in practice.
+ * Applications are free to override this behaviour and implement their own
+ * handler, but this will work for pretty much all cases in practice.
  */
 static gboolean
 gst_bin_send_event (GstElement * element, GstEvent * event)