ges: Documentations fixes
authorThibault Saunier <thibault.saunier@collabora.com>
Fri, 11 Jan 2013 18:26:26 +0000 (15:26 -0300)
committerThibault Saunier <thibault.saunier@collabora.com>
Sat, 12 Jan 2013 13:53:44 +0000 (10:53 -0300)
ges/ges-timeline-object.h
ges/ges-timeline.h

index d955cfe..173f379 100644 (file)
@@ -144,14 +144,14 @@ typedef GList * (*GESCreateTrackObjectsFunc) (GESTimelineObject * object, GESTra
  * GESTimelineObject:
  *
  * The #GESTimelineObject base class.
+ * @trackobjects: (element-type GES.TrackObject): A list of TrackObject
+ * controlled by this TimelineObject sorted by priority. NOTE: Do not modify.
  */
 struct _GESTimelineObject
 {
   GInitiallyUnowned parent;
 
   /*< readonly >*/
-  /* A list of TrackObject controlled by this TimelineObject sorted by
-   * priority */
   GList *trackobjects;
 
   /* We don't add those properties to the priv struct for optimization purposes
@@ -161,7 +161,6 @@ struct _GESTimelineObject
   guint64 duration;             /* duration of the object used in the layer */
   guint32 priority;             /* priority of the object in the layer (0:top priority) */
   guint32 height;               /* the span of priorities this object needs */
-
   guint64 fullduration;         /* Full usable duration of the object (-1: no duration) */
 
   /*< protected >*/
index 5e0d88c..422902a 100644 (file)
@@ -60,15 +60,16 @@ typedef struct _GESTimelinePrivate GESTimelinePrivate;
 
 /**
  * GESTimeline:
- *
+ * @layers: (element-type GES.TimelineLayer): A list of #GESTimelineLayer 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;
 
   /* <readonly> */
-  /* A list of GESTimelineLayer sorted by priority */
   GList *layers;
-  /* A list of private track data */
   GList *tracks;
 
   /*< private >*/