From 1e3e7c5276b4693032ebae84e064b82589b93da0 Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Wed, 9 May 2012 12:12:38 -0400 Subject: [PATCH] docs: Misc documentation fixing --- docs/libs/ges-sections.txt | 9 ++++++++- ges/ges-pitivi-formatter.c | 5 +++++ ges/ges-pitivi-formatter.h | 6 ++++-- ges/ges-screenshot.c | 10 ++++++++++ ges/ges-timeline-object.c | 1 + ges/ges-timeline.c | 3 +-- ges/ges-track-object.c | 2 +- ges/ges-track-video-transition.c | 2 +- 8 files changed, 31 insertions(+), 7 deletions(-) diff --git a/docs/libs/ges-sections.txt b/docs/libs/ges-sections.txt index f443e2ee79..2fc7619d4e 100644 --- a/docs/libs/ges-sections.txt +++ b/docs/libs/ges-sections.txt @@ -45,12 +45,17 @@ GES_VIDEO_TEST_PATTERN_TYPE ges_video_test_pattern_get_type GES_TYPE_PIPELINE_FLAGS ges_pipeline_flags_get_type +GES_TYPE_EDGE +ges_edge_get_type +GES_TYPE_EDIT_MODE +ges_edit_mode_get_type
ges-track GESTrack GESTrack +GESCreateElementForGapFunc ges_track_audio_raw_new ges_track_video_raw_new ges_track_new @@ -323,7 +328,6 @@ ges_timeline_object_set_duration ges_timeline_object_get_layer ges_timeline_object_find_track_object ges_timeline_object_add_track_object -ges_timeline_object_release_track_object ges_timeline_object_get_top_effects ges_timeline_object_get_top_effect_position ges_timeline_object_move_to_layer @@ -337,6 +341,9 @@ ges_timeline_object_ripple_end ges_timeline_object_roll_start ges_timeline_object_roll_end ges_timeline_object_trim_start +ges_timeline_object_get_max_duration +ges_timeline_object_objects_set_locked +ges_timeline_object_set_max_duration GES_TIMELINE_OBJECT_DURATION GES_TIMELINE_OBJECT_INPOINT diff --git a/ges/ges-pitivi-formatter.c b/ges/ges-pitivi-formatter.c index f828eecb70..0ad06f4f0f 100644 --- a/ges/ges-pitivi-formatter.c +++ b/ges/ges-pitivi-formatter.c @@ -17,6 +17,11 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION: ges-pitivi-formatter + * @short_description: A formatter for the PiTiVi project file format + */ + #include #include #include diff --git a/ges/ges-pitivi-formatter.h b/ges/ges-pitivi-formatter.h index 80751aa4d4..987be4b8b1 100644 --- a/ges/ges-pitivi-formatter.h +++ b/ges/ges-pitivi-formatter.h @@ -39,10 +39,11 @@ typedef struct _GESPitiviFormatterPrivate GESPitiviFormatterPrivate; + /** * GESPitiviFormatter: * - * Serializes a #GESTimeline to a file using + * Serializes a #GESTimeline to a file using the Xml PiTiVi file format */ struct _GESPitiviFormatter { @@ -55,7 +56,8 @@ struct _GESPitiviFormatter { gpointer _ges_reserved[GES_PADDING]; }; -struct _GESPitiviFormatterClass { +struct _GESPitiviFormatterClass +{ /*< private >*/ GESFormatterClass parent_class; diff --git a/ges/ges-screenshot.c b/ges/ges-screenshot.c index 9d13af9026..5bac786916 100644 --- a/ges/ges-screenshot.c +++ b/ges/ges-screenshot.c @@ -23,6 +23,16 @@ #include "ges-screenshot.h" #include "ges-internal.h" +/** + * ges_play_sink_convert_frame: + * @playsink: The olaysink to get last frame from + * @caps: The caps defining the format the return value will have + * + * Get the last buffer @playsink showed + * + * Returns: (transfer full): A #GstBuffer containing the last frame from + * @playsink in the format defined by the @caps + */ GstBuffer * ges_play_sink_convert_frame (GstElement * playsink, GstCaps * caps) { diff --git a/ges/ges-timeline-object.c b/ges/ges-timeline-object.c index 1338f33fae..c918c8bbaf 100644 --- a/ges/ges-timeline-object.c +++ b/ges/ges-timeline-object.c @@ -1748,6 +1748,7 @@ ges_timeline_object_ripple_end (GESTimelineObject * object, guint64 end) /** * ges_timeline_object_roll_start: + * @object: The #GESTimelineObject to roll * @start: The new start of @object in roll mode, it will also adapat * the in-point of @object according * diff --git a/ges/ges-timeline.c b/ges/ges-timeline.c index 8ce1e69bb3..a3682373a3 100644 --- a/ges/ges-timeline.c +++ b/ges/ges-timeline.c @@ -56,8 +56,7 @@ G_DEFINE_TYPE (GESTimeline, ges_timeline, GST_TYPE_BIN); #define GES_TIMELINE_PENDINGOBJS_UNLOCK(timeline) \ (g_mutex_unlock(GES_TIMELINE_PENDINGOBJS_GET_LOCK (timeline))) -/** - * The move context is used for the timeline editing modes functions in order to +/* The move context is used for the timeline editing modes functions in order to * + Ripple / Roll / Slide / Move / Trim * * The context aims at avoiding to recalculate values/objects on each call of the diff --git a/ges/ges-track-object.c b/ges/ges-track-object.c index 13461f99f4..b8e420aaee 100644 --- a/ges/ges-track-object.c +++ b/ges/ges-track-object.c @@ -1555,7 +1555,7 @@ ges_track_object_set_max_duration (GESTrackObject * object, guint64 maxduration) * * Copies @object * - * Returns: The newly create #GESTrackObject, copied from @object + * Returns: (transfer full): The newly create #GESTrackObject, copied from @object * * Since: 0.10.XX */ diff --git a/ges/ges-track-video-transition.c b/ges/ges-track-video-transition.c index 295455f755..02b67253b4 100644 --- a/ges/ges-track-video-transition.c +++ b/ges/ges-track-video-transition.c @@ -793,7 +793,7 @@ ges_track_video_transition_get_border (GESTrackVideoTransition * self) /** * ges_track_video_transition_set_inverted: * @self: The #GESTrackVideoTransition to set invert on - * @value: The value of the to set on @object + * @inverted: %TRUE to invert the transition %FALSE otherwise * * Set the invert property of @self, this value represents * the direction of the transition. In case this value does