Document that source keeps a ref on server until it's destroyed

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

diff --git a/gst/rtsp-server/rtsp-server.c b/gst/rtsp-server/rtsp-server.c
index 686ba031215e2f32d9fb1c22af1502d299fe6939..45ae9dbc365bdcb83f77cb0283eeca8b4fa8a65a 100644 (file)
--- a/gst/rtsp-server/rtsp-server.c
+++ b/gst/rtsp-server/rtsp-server.c
@@ -1246,6 +1246,8 @@ watch_destroyed (GstRTSPServer * server)
  * unless cancellation happened at the same time as a condition change). You can
  * check for this in the callback using g_cancellable_is_cancelled().
  *
+ * This takes a reference on @server until @source is destroyed.
+ *
  * Returns: (transfer full): the #GSource for @server or %NULL when an error
  * occurred. Free with g_source_unref ()
  */
@@ -1304,6 +1306,12 @@ no_socket:
  * This function should be called when the server properties and urls are fully
  * configured and the server is ready to start.
  *
+ * This takes a reference on @server until the source is destroyed. Note that
+ * if @context is not the default main context as returned by
+ * g_main_context_default() (or %NULL), g_source_remove() cannot be used to
+ * destroy the source. In that case it is recommended to use
+ * gst_rtsp_server_create_source() and attach it to @context manually.
+ *
  * Returns: the ID (greater than 0) for the source within the GMainContext.
  */
 guint