reword priority documentation comments

diff --git a/ges/ges-track-object.c b/ges/ges-track-object.c
index ff64ea7..3378b41 100644 (file)
--- a/ges/ges-track-object.c
+++ b/ges/ges-track-object.c
@@ -216,8 +216,7 @@ ges_track_object_class_init (GESTrackObjectClass * klass)
   /**
    * GESTrackObject:priority-offset
    *
-   * A value added to the "priority" value. Needed for timeline objects
-   * that create multiple track objects per track.
+   * The priority of the object relative to its parent track object.
    */
   g_object_class_install_property (object_class, PROP_PRIORITY_OFFSET,
       g_param_spec_uint ("priority-offset", "Priority Offset",

diff --git a/ges/ges-track-object.h b/ges/ges-track-object.h
index 71cd720..d2a1338 100644 (file)
--- a/ges/ges-track-object.h
+++ b/ges/ges-track-object.h
@@ -74,20 +74,29 @@ G_BEGIN_DECLS
  * GES_TRACK_OBJECT_PRIORITY:
  * @obj: a #GESTrackObject
  *
- * The priority of the object (in nanoseconds).
+ * The base priority of the object.
  */
 #define GES_TRACK_OBJECT_PRIORITY(obj) (((GESTrackObject*)obj)->base_priority)
 
 /**
+ * GES_TRACK_OBJECT_PRIORITY_OFFSET:
+ * @obj: a #GESTrackObject
+ *
+ * The priority of the object relative to its parent timeline object.
+ */
+#define GES_TRACK_OBJECT_PRIORITY_OFFSET(obj)\
+    (((GESTrackObject*)obj)->priority_offset)
+
+/**
  * GESTrackObject:
  * @timelineobj: The #GESTimelineObject to which this object belongs.
  * @track: The #GESTrack in which this object is.
  * @valid: #TRUE if the content of the @gnlobject is valid.
  * @start: Position (in nanoseconds) of the object the track.
  * @inpoint: in-point (in nanoseconds) of the object in the track.
- * @duration: Duration of the object
+ * @duration: Duration of the object.
  * @base_priority: base priority of the object in the track (0:top priority)
- * @priority_offset: added to the track object (0:top priority)
+ * @priority_offset: priority relative to its parent timeline object.
  * @gnl_priority: the cached gnl priority (base + offset)
  * @active: Whether the object is to be used or not.
  *