From: Umang Jain <mailumangjain@gmail.com>
Date: Wed, 13 Dec 2017 18:33:04 +0000 (+0530)
Subject: docs: GstBus: Provide more information for ref/unref during bus watch.
X-Git-Tag: 1.16.2~546
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=52d2891fe3dea20969bfe5a5791e33d78a4c771d;p=platform%2Fupstream%2Fgstreamer.git

docs: GstBus: Provide more information for ref/unref during bus watch.

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

diff --git a/gst/gstbus.c b/gst/gstbus.c
index 6699e05..55a65cc 100644
--- a/gst/gstbus.c
+++ b/gst/gstbus.c
@@ -974,6 +974,9 @@ gst_bus_add_watch_full_unlocked (GstBus * bus, gint priority,
  * from @func. If the watch was added to the default main context it is also
  * possible to remove the watch using g_source_remove().
  *
+ * The bus watch will take its own reference to the @bus, so it is safe to unref
+ * @bus using gst_object_unref() after setting the bus watch.
+ *
  * MT safe.
  *
  * Returns: The event source id or 0 if @bus already got an event source.
@@ -1015,9 +1018,12 @@ gst_bus_add_watch_full (GstBus * bus, gint priority,
  * from @func. If the watch was added to the default main context it is also
  * possible to remove the watch using g_source_remove().
  *
- * Returns: The event source id or 0 if @bus already got an event source.
+ * The bus watch will take its own reference to the @bus, so it is safe to unref
+ * @bus using gst_object_unref() after setting the bus watch.
  *
  * MT safe.
+ *
+ * Returns: The event source id or 0 if @bus already got an event source.
  */
 guint
 gst_bus_add_watch (GstBus * bus, GstBusFunc func, gpointer user_data)