From: Edward Hervey <edward.hervey@collabora.co.uk>
Date: Fri, 26 Nov 2010 17:38:49 +0000 (+0100)
Subject: Timeline: Add doc and more comments/fixmes
X-Git-Tag: 1.19.3~493^2~2535
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2ff3d8ce12214e819ff780001d441ac1e7418a32;p=platform%2Fupstream%2Fgstreamer.git

Timeline: Add doc and more comments/fixmes
---

diff --git a/ges/ges-timeline.c b/ges/ges-timeline.c
index 7e9e1a6c9e..d190370bdf 100644
--- a/ges/ges-timeline.c
+++ b/ges/ges-timeline.c
@@ -29,6 +29,11 @@
  *
  * The output type is determined by the #GESTrack that are set on
  * the #GESTimeline.
+ *
+ * To save/load a timeline, you can use the ges_timeline_load_from_uri() and
+ * ges_timeline_save_to_uri() methods to use the default format. If you wish
+ * to specify the format to save/load the timeline from, please consult the
+ * documentation about #GESFormatter.
  */
 
 #include "gesmarshal.h"
@@ -237,6 +242,10 @@ ges_timeline_new_from_uri (gchar * uri)
 {
   GESTimeline *ret;
 
+  /* FIXME : we should have a GError** argument so the user can know why
+   * it wasn't able to load the uri 
+   */
+
   ret = ges_timeline_new ();
 
   if (!ges_timeline_load_from_uri (ret, uri)) {
@@ -265,6 +274,10 @@ ges_timeline_load_from_uri (GESTimeline * timeline, gchar * uri)
   GESFormatter *p = NULL;
   gboolean ret = FALSE;
 
+  /* FIXME : we should have a GError** argument so the user can know why
+   * it wasn't able to load the uri 
+   */
+
   if (!(p = ges_formatter_new_for_uri (uri))) {
     GST_ERROR ("unsupported uri '%s'", uri);
     goto fail;
@@ -300,6 +313,17 @@ ges_timeline_save_to_uri (GESTimeline * timeline, gchar * uri)
   GESFormatter *p = NULL;
   gboolean ret = FALSE;
 
+  /* FIXME : How will the user be able to chose the format he
+   * wishes to store to ? */
+
+  /* FIXME : How will we ensure a timeline loaded with a certain format
+   * will be saved with the same one by default ? We need to make this
+   * easy from an API perspective */
+
+  /* FIXME : we should have a GError** argument so the user can know why
+   * it wasn't able to save
+   */
+
   if (!(p = ges_formatter_new_for_uri (uri))) {
     GST_ERROR ("unsupported uri '%s'", uri);
     goto fail;