Fix some documentations

docs/libs/ges-sections.txt

@@ -93,14 +93,12 @@ GES_TYPE_TRACK
 <TITLE>GESTrackElement</TITLE>
 GESTrackElement
 GESTrackElementClass
-ges_track_element_set_max_duration
 ges_track_element_set_active
 ges_track_element_set_locked
 ges_track_element_is_locked
 ges_track_element_get_track
 ges_track_element_get_gnlobject
 ges_track_element_get_element
-ges_track_element_get_max_duration
 ges_track_element_is_active
 ges_track_element_lookup_child
 ges_track_element_list_children_properties
@@ -113,7 +111,6 @@ ges_track_element_get_child_properties
 ges_track_element_get_child_property_valist
 ges_track_element_get_child_property_by_pspec
 ges_track_element_edit
-ges_track_element_copy
 <SUBSECTION Standard>
 GESTrackElementPrivate
 ges_track_element_set_track
@@ -397,9 +394,6 @@ ges_clip_set_supported_formats
 ges_clip_get_supported_formats
 ges_clip_split
 ges_clip_edit
-ges_clip_get_max_duration
-ges_clip_objects_set_locked
-ges_clip_set_max_duration
 <SUBSECTION Standard>
 GES_CLIP_HEIGHT
 ges_clip_create_track_elements
@@ -469,12 +463,10 @@ GES_TYPE_SOURCE_CLIP
 <TITLE>GESUriClip</TITLE>
 GESUriClip
 ges_uri_clip_new
-ges_uri_clip_get_max_duration
 ges_uri_clip_get_uri
 ges_uri_clip_is_image
 ges_uri_clip_is_muted
 ges_uri_clip_set_is_image
-ges_uri_clip_set_max_duration
 ges_uri_clip_set_mute
 <SUBSECTION Standard>
 GESUriClipClass

ges/ges-base-xml-formatter.h

@@ -42,6 +42,7 @@ struct _GESBaseXmlFormatter
 {
   GESFormatter parent;
 
+  /*< public > */
   /* <private> */
   GESBaseXmlFormatterPrivate *priv;
 

ges/ges-container.c

@@ -609,43 +609,43 @@ ges_container_add (GESContainer * container, GESTimelineElement * child)
 /**
  * ges_container_remove:
  * @container: a #GESContainer
- * @element: the #GESTimelineElement to release
+ * @child: the #GESTimelineElement to release
  *
- * Release the @element from the control of @container.
+ * Release the @child from the control of @container.
  *
- * Returns: %TRUE if the @element was properly released, else %FALSE.
+ * Returns: %TRUE if the @child was properly released, else %FALSE.
  */
 gboolean
-ges_container_remove (GESContainer * container, GESTimelineElement * element)
+ges_container_remove (GESContainer * container, GESTimelineElement * child)
 {
   GESContainerClass *klass;
   GESContainerPrivate *priv;
 
   g_return_val_if_fail (GES_IS_CONTAINER (container), FALSE);
-  g_return_val_if_fail (GES_IS_TIMELINE_ELEMENT (element), FALSE);
+  g_return_val_if_fail (GES_IS_TIMELINE_ELEMENT (child), FALSE);
 
-  GST_DEBUG_OBJECT (container, "removing element: %" GST_PTR_FORMAT, element);
+  GST_DEBUG_OBJECT (container, "removing child: %" GST_PTR_FORMAT, child);
 
   klass = GES_CONTAINER_GET_CLASS (container);
   priv = container->priv;
 
-  if (!(g_hash_table_lookup (priv->mappings, element))) {
+  if (!(g_hash_table_lookup (priv->mappings, child))) {
     GST_WARNING_OBJECT (container, "Element isn't controlled by this "
         "container");
     return FALSE;
   }
 
   if (klass->remove_child) {
-    if (klass->remove_child (container, element) == FALSE)
+    if (klass->remove_child (container, child) == FALSE)
       return FALSE;
   }
 
-  container->children = g_list_remove (container->children, element);
+  container->children = g_list_remove (container->children, child);
   /* Let it live removing from our mappings */
-  g_hash_table_remove (priv->mappings, element);
+  g_hash_table_remove (priv->mappings, child);
 
   g_signal_emit (container, ges_container_signals[CHILD_REMOVED_SIGNAL], 0,
-      element);
+      child);
 
   return TRUE;
 }

ges/ges-container.h

@@ -58,6 +58,8 @@ typedef struct _GESContainerPrivate GESContainerPrivate;
  * GESContainer:
  * @children: (element-type GES.TimelineElement): A list of TimelineElement
  * controlled by this Container. NOTE: Do not modify.
+ * @height: The span of priorities this container occupies
+ *
  *
  * The #GESContainer base class.
  */
@@ -65,13 +67,13 @@ struct _GESContainer
 {
   GESTimelineElement parent;
 
+  /*< public > */
   /*< readonly >*/
   GList *children;
 
-  /* We don't add those properties to the priv struct for optimization purposes
+  /* We don't add those properties to the priv struct for optimization and code
-   * start, inpoint, duration and fullduration are in nanoseconds */
+   * readability purposes */
-  guint32 height;               /* the span of priorities this object needs */
+  guint32 height;       /* the span of priorities this object needs */
-  guint64 fullduration;         /* Full usable duration of the object (-1: no duration) */
 
   /*< private >*/
   GESContainerPrivate *priv;
@@ -93,11 +95,10 @@ struct _GESContainerClass
   /*< private > */
   GESTimelineElementClass parent_class;
 
+  /*< public > */
   /* signals */
   void (*child_added)             (GESContainer *container, GESTimelineElement *element);
   void (*child_removed)           (GESContainer *container, GESTimelineElement *element);
-
-  /*< public > */
   gboolean (*add_child)           (GESContainer *container, GESTimelineElement *element);
   gboolean (*remove_child)        (GESContainer *container, GESTimelineElement *element);
   void (*get_priorty_range)       (GESContainer *container, guint32 *min_prio, guint32 *max_prio);

ges/ges-pitivi-formatter.h

@@ -45,10 +45,10 @@ typedef struct _GESPitiviFormatterPrivate GESPitiviFormatterPrivate;
  *
  * Serializes a #GESTimeline to a file using the Xml PiTiVi file format
  */
-
 struct _GESPitiviFormatter {
   GESFormatter parent;
 
+  /*< public > */
   /*< private >*/
   GESPitiviFormatterPrivate *priv;
 

ges/ges-simple-timeline-layer.c

@@ -386,7 +386,6 @@ ges_simple_timeline_layer_nth (GESSimpleTimelineLayer * layer, gint position)
  * Returns: The position of the clip starting from 0, or -1 if the
  * clip was not found.
  */
-
 gint
 ges_simple_timeline_layer_index (GESSimpleTimelineLayer * layer, GESClip * clip)
 {
@@ -406,7 +405,6 @@ ges_simple_timeline_layer_index (GESSimpleTimelineLayer * layer, GESClip * clip)
  *
  * Returns: TRUE if the clip was successfuly moved, else FALSE.
  */
-
 gboolean
 ges_simple_timeline_layer_move_object (GESSimpleTimelineLayer * layer,
     GESClip * clip, gint newposition)

ges/ges-simple-timeline-layer.h

@@ -82,7 +82,7 @@ ges_simple_timeline_layer_add_object (GESSimpleTimelineLayer *layer,
 
 gboolean
 ges_simple_timeline_layer_move_object (GESSimpleTimelineLayer *layer,
-				       GESClip *object, gint newposition);
+				       GESClip *clip, gint newposition);
 
 gboolean
 ges_simple_timeline_layer_is_valid (GESSimpleTimelineLayer *layer);
@@ -93,7 +93,7 @@ ges_simple_timeline_layer_nth (GESSimpleTimelineLayer *layer,
 
 gint
 ges_simple_timeline_layer_index (GESSimpleTimelineLayer *layer,
-				 GESClip *object);
+				 GESClip *clip);
 
 G_END_DECLS
 

ges/ges-timeline-element.h

@@ -92,6 +92,42 @@ typedef struct _GESTimelineElementPrivate GESTimelineElementPrivate;
  */
 #define GES_TIMELINE_ELEMENT_TIMELINE(obj) (((GESTimelineElement*)obj)->timeline)
 
+/**
+ * GESTimelineElement:
+ * @parent: The #GESTimelineElement that controls the object
+ * @asset: The #GESAsset from which the object has been extracted
+ * @start: position (in time) of the object
+ * @inpoint: Position in the media from which the object should be used
+ * @duration: duration of the object to be used
+ * @maxduration: The maximum duration the object can have
+ * @priority: priority of the object in the layer (0:top priority)
+ *
+ * Those filed can be accessed from outside but in no case should
+ * be changed from there. Subclasses can write them but should make
+ * sure to properly call g_object_notify.
+ */
+struct _GESTimelineElement
+{
+  GInitiallyUnowned parent_instance;
+
+  /*< public > */
+  /*< read only >*/
+  GESTimelineElement *parent;
+  GESAsset *asset;
+  GstClockTime start;
+  GstClockTime inpoint;
+  GstClockTime duration;
+  GstClockTime maxduration;
+  guint32 priority;
+  GESTimeline *timeline;
+
+  /*< private >*/
+  GESTimelineElementPrivate *priv;
+
+  /* Padding for API extension */
+  gpointer _ges_reserved[GES_PADDING_LARGE];
+};
+
 /**
  * GESTimelineElementClass:
  * @set_start: method to set the start of a #GESTimelineElement
@@ -114,6 +150,7 @@ struct _GESTimelineElementClass
 {
   GInitiallyUnownedClass parent_class;
 
+  /*< public > */
   gboolean (*set_start)        (GESTimelineElement * self, GstClockTime start);
   gboolean (*set_inpoint)      (GESTimelineElement * self, GstClockTime inpoint);
   gboolean (*set_duration)     (GESTimelineElement * self, GstClockTime duration);
@@ -127,39 +164,7 @@ struct _GESTimelineElementClass
   gboolean (*trim)             (GESTimelineElement *self, guint64  start);
   void (*deep_copy)            (GESTimelineElement *self, GESTimelineElement *copy);
 
-  /* Padding for API extension */
+  /*< private > */
-  gpointer _ges_reserved[GES_PADDING_LARGE];
-};
-
-/**
- * GESTimelineElement:
- * @start: position (in time) of the object
- * @inpoint: Position in the media from which the object should be used
- * @duration: duration of the object to be used
- * @maxduration: The maximum duration the object can have
- * @priority: priority of the object in the layer (0:top priority)
- *
- * Those filed can be accessed from outside but in no case should
- * be changed from there. Subclasses can write them but should make
- * sure to properly call g_object_notify.
- */
-struct _GESTimelineElement
-{
-  GInitiallyUnowned parent_instance;
-
-  /*< read only >*/
-  GESTimelineElement *parent;
-  GESAsset *asset;
-  GstClockTime start;
-  GstClockTime inpoint;
-  GstClockTime duration;
-  GstClockTime maxduration;
-  guint32 priority;
-  GESTimeline *timeline;
-
-  /*< private >*/
-  GESTimelineElementPrivate *priv;
-
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING_LARGE];
 };
@@ -172,7 +177,7 @@ gboolean ges_timeline_element_set_timeline           (GESTimelineElement *self,
 void ges_timeline_element_set_start                  (GESTimelineElement *self, GstClockTime start);
 void ges_timeline_element_set_inpoint                (GESTimelineElement *self, GstClockTime inpoint);
 void ges_timeline_element_set_duration               (GESTimelineElement *self, GstClockTime duration);
-void ges_timeline_element_set_max_duration           (GESTimelineElement *self, GstClockTime duration);
+void ges_timeline_element_set_max_duration           (GESTimelineElement *self, GstClockTime maxduration);
 void ges_timeline_element_set_priority               (GESTimelineElement *self, guint32 priority);
 
 GstClockTime ges_timeline_element_get_start          (GESTimelineElement *self);

ges/ges-timeline-layer.h

@@ -100,8 +100,7 @@ GESTimeline *
 ges_timeline_layer_get_timeline           (GESTimelineLayer * layer);
 
 gboolean ges_timeline_layer_add_clip    (GESTimelineLayer * layer,
-
+					   GESClip * clip);
-					   GESClip * object);
 GESClip * ges_timeline_layer_add_asset   (GESTimelineLayer *layer,
                                                        GESAsset *asset,
                                                        GstClockTime start,
@@ -111,7 +110,7 @@ GESClip * ges_timeline_layer_add_asset   (GESTimelineLayer *layer,
                                                        GESTrackType track_types);
 
 gboolean ges_timeline_layer_remove_clip (GESTimelineLayer * layer,
-					   GESClip * object);
+					   GESClip * clip);
 
 void     ges_timeline_layer_set_priority  (GESTimelineLayer * layer,
 					   guint priority);

ges/ges-timeline.h

@@ -60,14 +60,13 @@ typedef struct _GESTimelinePrivate GESTimelinePrivate;
 
 /**
  * GESTimeline:
- * @layers: (element-type GES.TimelineLayer): A list of #GESTimelineLayer sorted by priority
+ * @layers: (element-type GES.TimelineLayer): A list of #GESTimelineLayer sorted by priority NOTE: Do not modify.
- *                                            NOTE: Do not modify.
+ * @tracks: (element-type GES.Track): A list of #GESTrack sorted by priority NOTE: Do not modify.
- * @tracks: (element-type GES.Track): A list of #GESTrack sorted by priority
- *                                    NOTE: Do not modify.
  */
 struct _GESTimeline {
   GstBin parent;
 
+  /*< public > */
   /* <readonly> */
   GList *layers;
   GList *tracks;