gst-editing-services: docs: Tell users that adding an object to a timeline layer creates media related objects

[Thibault Saunier]

Module: gst-editing-services
Branch: master
Commit: 83dc13c63d202352a86c3946f684b9eae843b6d0
URL:    http://cgit.freedesktop.org/gstreamer/gst-editing-services/commit/?id=83dc13c63d202352a86c3946f684b9eae843b6d0

Author: Thibault Saunier <thibault.saunier at collabora.com>
Date:   Wed Feb  1 20:25:35 2012 -0300

docs: Tell users that adding an object to a timeline layer creates media related objects

---

 ges/ges-timeline-layer.c |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/ges/ges-timeline-layer.c b/ges/ges-timeline-layer.c
index e739895..a06f150 100644
--- a/ges/ges-timeline-layer.c
+++ b/ges/ges-timeline-layer.c
@@ -306,6 +306,11 @@ track_get_by_layer (GESTimelineLayer * layer, GESTrack * track)
  *
  * An object can only be added to one layer.
  *
+ * Calling this method will construct and properly set all the media related
+ * elements on @object. If you need to know when those objects (actually #GESTrackObject)
+ * are constructed, you should connect to the object::track-object-added signal which
+ * is emited right after those elements are ready to be used.
+ *
  * Returns: TRUE if the object was properly added to the layer, or FALSE
  * if the @layer refuses to add the object.
  */