docs: Misc documentation fixing

This commit is contained in:
Thibault Saunier 2012-05-09 12:12:38 -04:00
parent 8fbe9c90b6
commit 1e3e7c5276
8 changed files with 31 additions and 7 deletions

View file

@ -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
</SECTION>
<SECTION>
<FILE>ges-track</FILE>
<TITLE>GESTrack</TITLE>
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
<SUBSECTION Standard>
GES_TIMELINE_OBJECT_DURATION
GES_TIMELINE_OBJECT_INPOINT

View file

@ -17,6 +17,11 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION: ges-pitivi-formatter
* @short_description: A formatter for the PiTiVi project file format
*/
#include <libxml/xmlreader.h>
#include <libxml/tree.h>
#include <libxml/parser.h>

View file

@ -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;

View file

@ -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)
{

View file

@ -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
*

View file

@ -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

View file

@ -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
*/

View file

@ -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