gst-editing-services: docs: Update documentation

Thibault Saunier tsaunier at kemper.freedesktop.org
Wed Jan 11 07:04:33 PST 2012


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

Author: Thibault Saunier <thibault.saunier at collabora.com>
Date:   Tue Dec  6 23:11:25 2011 -0300

docs: Update documentation

---

 docs/libs/ges-sections.txt |   10 ++++++++++
 ges/ges-formatter.c        |    2 +-
 ges/ges-timeline-layer.c   |    4 ++--
 ges/ges-timeline-object.c  |    2 +-
 ges/ges-timeline-object.h  |    2 +-
 ges/ges-timeline.c         |    6 +++---
 ges/ges-track.c            |   15 ++++++++++++---
 7 files changed, 30 insertions(+), 11 deletions(-)

diff --git a/docs/libs/ges-sections.txt b/docs/libs/ges-sections.txt
index f6e74b4..32686fc 100644
--- a/docs/libs/ges-sections.txt
+++ b/docs/libs/ges-sections.txt
@@ -51,6 +51,8 @@ ges_track_add_object
 ges_track_remove_object
 ges_track_set_caps
 ges_track_get_caps
+ges_track_enable_update
+ges_track_get_objects
 <SUBSECTION Standard>
 GESTrackClass
 GESTrackPrivate
@@ -242,6 +244,7 @@ ges_timeline_add_track
 ges_timeline_remove_track
 ges_timeline_load_from_uri
 ges_timeline_save_to_uri
+ges_timeline_enable_update
 <SUBSECTION usage>
 ges_timeline_get_tracks
 ges_timeline_get_layers
@@ -270,6 +273,8 @@ ges_timeline_layer_remove_object
 ges_timeline_layer_set_priority
 ges_timeline_layer_get_priority
 ges_timeline_layer_get_objects
+ges_timeline_layer_get_auto_transition
+ges_timeline_layer_set_auto_transition
 <SUBSECTION Standard>
 GESTimelineLayerPrivate
 ges_timeline_layer_set_timeline
@@ -303,6 +308,7 @@ ges_timeline_object_move_to_layer
 ges_timeline_object_set_top_effect_priority
 ges_timeline_object_set_supported_formats
 ges_timeline_object_get_supported_formats
+ges_timeline_object_split
 <SUBSECTION Standard>
 GES_TIMELINE_OBJECT_DURATION
 GES_TIMELINE_OBJECT_INPOINT
@@ -344,6 +350,10 @@ ges_timeline_pipeline_preview_set_video_sink
 ges_timeline_pipeline_get_thumbnail_buffer
 ges_timeline_pipeline_get_thumbnail_rgb24
 ges_timeline_pipeline_save_thumbnail
+ges_timeline_pipeline_preview_get_audio_sink
+ges_timeline_pipeline_preview_get_video_sink
+ges_timeline_pipeline_preview_set_audio_sink
+ges_timeline_pipeline_preview_set_video_sink
 <SUBSECTION Standard>
 GESTimelinePipelineClass
 GESTimelinePipelinePrivate
diff --git a/ges/ges-formatter.c b/ges/ges-formatter.c
index 1c2cbff..530733b 100644
--- a/ges/ges-formatter.c
+++ b/ges/ges-formatter.c
@@ -237,7 +237,7 @@ ges_formatter_set_data (GESFormatter * formatter, void *data, gsize length)
  *
  * Lets you get the data @formatter used for loading.
  *
- * Returns: a pointer to the data.
+ * Returns: (transfer none): a pointer to the data.
  */
 void *
 ges_formatter_get_data (GESFormatter * formatter, gsize * length)
diff --git a/ges/ges-timeline-layer.c b/ges/ges-timeline-layer.c
index 7a4f19e..4e635d5 100644
--- a/ges/ges-timeline-layer.c
+++ b/ges/ges-timeline-layer.c
@@ -765,10 +765,10 @@ ges_timeline_layer_get_auto_transition (GESTimelineLayer * layer)
 /**
  * ges_timeline_layer_set_auto_transition:
  * @layer: a #GESTimelineLayer
- * @priority: whether the auto_transition is active
+ * @auto_transition: whether the auto_transition is active
  *
  * Sets the layer to the given @auto_transition. See the documentation of the
- * priority auto_transition for more information.
+ * property auto_transition for more information.
  */
 void
 ges_timeline_layer_set_auto_transition (GESTimelineLayer * layer,
diff --git a/ges/ges-timeline-object.c b/ges/ges-timeline-object.c
index 8938a2f..dc7b693 100644
--- a/ges/ges-timeline-object.c
+++ b/ges/ges-timeline-object.c
@@ -361,7 +361,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
    * @object: the #GESTimelineObject
    * @tckobj: the #GESTrackObject that was removed.
    *
-   * Will be emitted after a track object was added to the object.
+   * Will be emitted after a track object was removed from @object.
    *
    * Since: 0.10.2
    */
diff --git a/ges/ges-timeline-object.h b/ges/ges-timeline-object.h
index f682dfd..024b20e 100644
--- a/ges/ges-timeline-object.h
+++ b/ges/ges-timeline-object.h
@@ -291,7 +291,7 @@ ges_timeline_object_set_supported_formats (GESTimelineObject * self,
 					    GESTrackType supportedformats);
 
 GESTimelineObject *
-ges_timeline_object_split(GESTimelineObject * ref_object, gint64 position);
+ges_timeline_object_split(GESTimelineObject * self, gint64 position);
 
 G_END_DECLS
 
diff --git a/ges/ges-timeline.c b/ges/ges-timeline.c
index cac3145..83986c8 100644
--- a/ges/ges-timeline.c
+++ b/ges/ges-timeline.c
@@ -1110,12 +1110,12 @@ ges_timeline_get_layers (GESTimeline * timeline)
 
 /**
  * ges_timeline_enable_update:
- * @timeline : a #GESTimeline
- * @enabled : TRUE if the timeline must be updated, FALSE otherwise.
+ * @timeline: a #GESTimeline
+ * @enabled: TRUE if the timeline must be updated, FALSE otherwise.
  *
  * Calls the enable_update function of the tracks contained by the timeline.
  *
- * Returns : True if success, FALSE otherwise.
+ * Returns: True if success, FALSE otherwise.
  */
 gboolean
 ges_timeline_enable_update (GESTimeline * timeline, gboolean enabled)
diff --git a/ges/ges-track.c b/ges/ges-track.c
index 2e481f3..dccadb8 100644
--- a/ges/ges-track.c
+++ b/ges/ges-track.c
@@ -483,6 +483,15 @@ ges_track_add_object (GESTrack * track, GESTrackObject * object)
   return TRUE;
 }
 
+/**
+ * ges_track_get_objects:
+ * @track: a #GESTrack
+ *
+ * Gets the #GESTrackObject contained in @track
+ *
+ * Returns: (transfer full) (element-type GESTrackObject): the list of
+ * #GESTrackObject present in the Track sorted by priority and start.
+ */
 GList *
 ges_track_get_objects (GESTrack * track)
 {
@@ -652,12 +661,12 @@ ges_track_get_timeline (GESTrack * track)
 
 /**
  * ges_track_enable_update:
- * @track : a #GESTrack
- * @enabled : TRUE if the composition must be updated, FALSE otherwise.
+ * @track: a #GESTrack
+ * @enabled: %TRUE if the composition must be updated, FALSE otherwise.
  *
  * Sets the @track 's composition update property to @enabled .
  *
- * Returns : True if success, FALSE otherwise.
+ * Returns: True if success, %FALSE otherwise.
  */
 gboolean
 ges_track_enable_update (GESTrack * track, gboolean enabled)



More information about the gstreamer-commits mailing list