From: Stefan Kost <ensonic@users.sf.net>
Date: Mon, 14 Dec 2009 14:22:16 +0000 (+0200)
Subject: docs: link bus and tasks
X-Git-Tag: RELEASE-0.10.26~94
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0b7f75c20552970f43a11d880ee0aa7dc2f99b83;p=platform%2Fupstream%2Fgstreamer.git

docs: link bus and tasks

Add a link from bus section docs to the task docs. Add a paragraph to task docs
to tell about messages and the bus.
---

diff --git a/gst/gstbus.c b/gst/gstbus.c
index 486ee97..0e20136 100644
--- a/gst/gstbus.c
+++ b/gst/gstbus.c
@@ -25,7 +25,8 @@
  * @see_also: #GstMessage, #GstElement
  *
  * The #GstBus is an object responsible for delivering #GstMessage packets in
- * a first-in first-out way from the streaming threads to the application.
+ * a first-in first-out way from the streaming threads (see #GstTask) to the
+ * application.
  *
  * Since the application typically only wants to deal with delivery of these
  * messages from one thread, the GstBus will marshall the messages between
diff --git a/gst/gsttask.c b/gst/gsttask.c
index e55fa58..9026502 100644
--- a/gst/gsttask.c
+++ b/gst/gsttask.c
@@ -56,6 +56,10 @@
  * After creating a #GstTask, use gst_object_unref() to free its resources. This can
  * only be done it the task is not running anymore.
  *
+ * Task functions can send a #GstMessage to send out-of-band data to the
+ * application. The application can receive messages from the #GstBus in its
+ * mainloop.
+ *
  * Last reviewed on 2006-02-13 (0.10.4)
  */