From: Brandon Lewis Date: Thu, 1 Jul 2010 14:48:45 +0000 (+0200) Subject: massive documentation updates X-Git-Tag: 1.19.3~493^2~2810 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=aec1fbd88c12eff2fc75cb7280377cec96e7773a;p=platform%2Fupstream%2Fgstreamer.git massive documentation updates --- diff --git a/docs/libs/ges-docs.sgml b/docs/libs/ges-docs.sgml index fe14bf3e24..17c73fea27 100644 --- a/docs/libs/ges-docs.sgml +++ b/docs/libs/ges-docs.sgml @@ -37,31 +37,32 @@ platform as well as Windows. It is released under the GNU Library General Public - + + Timeline objects - - + + + Track objects - + + + - - - - + diff --git a/docs/libs/ges-sections.txt b/docs/libs/ges-sections.txt index 8955f07a2e..f496bf5bc6 100644 --- a/docs/libs/ges-sections.txt +++ b/docs/libs/ges-sections.txt @@ -290,6 +290,21 @@ GES_TIMELINE_FILE_SOURCE_GET_CLASS GES_TYPE_TIMELINE_FILE_SOURCE +
+ges-timeline-overlay +GESTimelineOverlay +GESTimelineOverlay +GESTimelineOverlayClass +ges_timeline_overlay_get_type +ges_timeline_overlay_new + +GES_IS_TIMELINE_OVERLAY +GES_IS_TIMELINE_OVERLAY_CLASS +GES_TIMELINE_OVERLAY +GES_TIMELINE_OVERLAY_CLASS +GES_TIMELINE_OVERLAY_GET_CLASS +GES_TYPE_TIMELINE_OVERLAY +
ges-timeline-transition @@ -454,7 +469,7 @@ GES_IS_TRACK_TITLE_SOURCE_CLASS
ges-track-text-overlay -GESTrackOverlay +GESTrackTextOverlay GESTrackTextOverlay GESTrackTextOverlayClass ges_track_text_overlay_get_type diff --git a/ges/ges-timeline-overlay.c b/ges/ges-timeline-overlay.c index 541cd4561c..e132cd032f 100644 --- a/ges/ges-timeline-overlay.c +++ b/ges/ges-timeline-overlay.c @@ -20,7 +20,7 @@ /** * SECTION:ges-timeline-overlay - * @short_description: Base Class for overlays of a #GESTimelineLayer + * @short_description: Base Class for overlays in a #GESTimelineLayer * * Overlays are objects which modify the underlying layer(s). Examples of * overlays include text, image watermarks, or audio dubbing. Transitions, diff --git a/ges/ges-timeline-overlay.h b/ges/ges-timeline-overlay.h index ddb225747c..b5e6c41fbb 100644 --- a/ges/ges-timeline-overlay.h +++ b/ges/ges-timeline-overlay.h @@ -46,7 +46,7 @@ G_BEGIN_DECLS /** * GESTimelineOverlay: - * + * @parent: parent object */ struct _GESTimelineOverlay { diff --git a/ges/ges-timeline-test-source.c b/ges/ges-timeline-test-source.c index 789273e501..4b54c1e114 100644 --- a/ges/ges-timeline-test-source.c +++ b/ges/ges-timeline-test-source.c @@ -20,10 +20,11 @@ /** * SECTION:ges-timeline-test-source - * @short_description: An object for manipulating media files in a GESTimeline + * @short_description: Render video and audio test patterns in a + * #GESTimelineLayer * - * Represents all the output treams from a particular uri. It is assumed that - * the URI points to a file of some type. + * Useful for testing purposes or for filling gaps between media in + * a #GESTimelineLayer. */ #include "ges-internal.h" diff --git a/ges/ges-timeline-text-overlay.c b/ges/ges-timeline-text-overlay.c index 239012d349..e6ad942b21 100644 --- a/ges/ges-timeline-text-overlay.c +++ b/ges/ges-timeline-text-overlay.c @@ -20,10 +20,9 @@ /** * SECTION:ges-timeline-text-overlay - * @short_description: An object for manipulating media files in a GESTimeline + * @short_description: Render text onto another stream in a #GESTimelineLayer * - * Represents all the output treams from a particular uri. It is assumed that - * the URI points to a file of some type. + * Renders text onto the next lower priority stream using textrender. */ #include "ges-internal.h" diff --git a/ges/ges-timeline-title-source.c b/ges/ges-timeline-title-source.c index 89e23bc27b..2658a19c17 100644 --- a/ges/ges-timeline-title-source.c +++ b/ges/ges-timeline-title-source.c @@ -20,10 +20,12 @@ /** * SECTION:ges-timeline-title-source - * @short_description: An object for manipulating media files in a GESTimeline + * @short_description: Render stand-alone titles in GESTimelineLayer. * - * Represents all the output treams from a particular uri. It is assumed that - * the URI points to a file of some type. + * Renders the given text in the specified font, at specified position, and + * with the specified background pattern. + * + * Note: creates a silent #GESTrackAudioTestSource to fill audio tracks */ #include "ges-internal.h" diff --git a/ges/ges-timeline-transition.c b/ges/ges-timeline-transition.c index 251a6d21ba..ec76dca3c7 100644 --- a/ges/ges-timeline-transition.c +++ b/ges/ges-timeline-transition.c @@ -20,7 +20,21 @@ /** * SECTION: ges-timeline-transition - * @short_description: Base Class for transitions in a #GESTimelineLayer + * @short_description: Transition from one clip to another in a + * #GESTimelineLayer + * + * Creates an object that mixes together the two underlying objects, A and B. + * The A object is assumed to have a higher prioirity (lower number) than the + * B object. At the transition in point, only A will be visible, and by the + * end only B will be visible. + * + * The shape of the video transition depends on the value of the "vtype" + * property. The default value is "crossfade". For audio, only "crossfade" is + * supported. + * + * #GESSimpleTimelineLayer will automatically manage the priorities of sources + * and transitions. If you use #GESTimelineTransitions in another type of + * #GESTimelineLayer, you will need to manage priorities yourself. */ #include "ges-internal.h" diff --git a/ges/ges-track-audio-test-source.c b/ges/ges-track-audio-test-source.c index 119811b31a..0988cd45e0 100644 --- a/ges/ges-track-audio-test-source.c +++ b/ges/ges-track-audio-test-source.c @@ -20,7 +20,11 @@ /** * SECTION:ges-track-audio-test-source - * @short_description: Base Class for single-media sources + * @short_description: produce a simple test waveform or silence + * + * Outputs a test audio stream using audiotestsrc. The default property values + * output silence. Useful for testing pipelines, or to fill gaps in an audio + * track. */ #include "ges-internal.h" diff --git a/ges/ges-track-audio-transition.c b/ges/ges-track-audio-transition.c index 7f923439fc..77723fbfdc 100644 --- a/ges/ges-track-audio-transition.c +++ b/ges/ges-track-audio-transition.c @@ -20,7 +20,7 @@ /** * SECTION:ges-track-audio-transition - * @short_description: implements audio crossfade transitino + * @short_description: implements audio crossfade transition */ #include "ges-internal.h" diff --git a/ges/ges-track-filesource.c b/ges/ges-track-filesource.c index 3cf6653a87..4ddb80b7ca 100644 --- a/ges/ges-track-filesource.c +++ b/ges/ges-track-filesource.c @@ -19,8 +19,11 @@ */ /** - * SECTION:ges-track-source - * @short_description: Base Class for single-media sources + * SECTION:ges-track-filesource + * @short_description: outputs a single media stream from a given file + * + * Outputs a single media stream from a given file. The stream chosen depends on + * the type of the track which contains the object. */ #include "ges-internal.h" diff --git a/ges/ges-track-object.c b/ges/ges-track-object.c index eb55653469..6680ce5a21 100644 --- a/ges/ges-track-object.c +++ b/ges/ges-track-object.c @@ -206,7 +206,7 @@ ges_track_object_class_init (GESTrackObjectClass * klass) /** * GESTrackObject:active * - * Whether the object should be taken into account in the #GEStrack output. + * Whether the object should be taken into account in the #GESTrack output. * If #FALSE, then its contents will not be used in the resulting track. */ g_object_class_install_property (object_class, PROP_ACTIVE, diff --git a/ges/ges-track-operation.c b/ges/ges-track-operation.c index a856bcab37..15331ba403 100644 --- a/ges/ges-track-operation.c +++ b/ges/ges-track-operation.c @@ -20,7 +20,7 @@ /** * SECTION:ges-track-operation - * @short_description: Base Class for single-media operations + * @short_description: Base Class for effects and overlays */ #include "ges-internal.h" diff --git a/ges/ges-track-operation.h b/ges/ges-track-operation.h index 001ffbe598..ba3a02a491 100644 --- a/ges/ges-track-operation.h +++ b/ges/ges-track-operation.h @@ -63,11 +63,8 @@ struct _GESTrackOperation { /** * GESTrackOperationClass: * @parent_class: the parent class - * @create_element: method to create the gstreamer element which fills the - * gnlobject - * - * Base class for track objects which produce data but do not consuem it. - * + * @create_element: virtual method which creates the GStreamer element for + * this object */ struct _GESTrackOperationClass { diff --git a/ges/ges-track-source.h b/ges/ges-track-source.h index c400db030c..cd172a49d0 100644 --- a/ges/ges-track-source.h +++ b/ges/ges-track-source.h @@ -63,10 +63,8 @@ struct _GESTrackSource { /** * GESTrackSourceClass: * @parent_class: the parent class - * @create_element: method to create the gstreamer element which fills the - * gnlobject - * - * Base class for track objects which produce data but do not consuem it. + * @create_element: virtual method which creates the GStreamer element for + * this object * */ diff --git a/ges/ges-track-text-overlay.c b/ges/ges-track-text-overlay.c index 80103e29c7..c30ff6273e 100644 --- a/ges/ges-track-text-overlay.c +++ b/ges/ges-track-text-overlay.c @@ -19,8 +19,10 @@ */ /** - * SECTION:ges-track-source - * @short_description: Base Class for single-media sources + * SECTION:ges-track-text-overlay + * @short_description: render text onto another video stream in a + * #GESTimelineLayer + * */ #include "ges-internal.h" diff --git a/ges/ges-track-title-source.c b/ges/ges-track-title-source.c index 6eec3c19a4..4ff731b686 100644 --- a/ges/ges-track-title-source.c +++ b/ges/ges-track-title-source.c @@ -19,8 +19,9 @@ */ /** - * SECTION:ges-track-source - * @short_description: Base Class for single-media sources + * SECTION:ges-track-title-source + * @short_description: render stand-alone text titles + * */ #include "ges-internal.h" diff --git a/ges/ges-track-transition.c b/ges/ges-track-transition.c index 7141ba5d93..a46006997c 100644 --- a/ges/ges-track-transition.c +++ b/ges/ges-track-transition.c @@ -20,8 +20,8 @@ /** * SECTION:ges-track-transition - * @short_description: Concrete, track-level implemenation of audio and video - * transitinos. + * @short_description: base class for audio and video transitions + * */ #include "ges-internal.h" diff --git a/ges/ges-track-video-test-source.c b/ges/ges-track-video-test-source.c index ddb8d427d6..b4af6bdea1 100644 --- a/ges/ges-track-video-test-source.c +++ b/ges/ges-track-video-test-source.c @@ -20,7 +20,7 @@ /** * SECTION:ges-track-video-test-source - * @short_description: implements solid colors and patterns with videotestsrc + * @short_description: produce solid colors and patterns */ #include "ges-internal.h" diff --git a/ges/ges-track-video-transition.c b/ges/ges-track-video-transition.c index 81d31864ad..a72d5e9f8d 100644 --- a/ges/ges-track-video-transition.c +++ b/ges/ges-track-video-transition.c @@ -20,7 +20,7 @@ /** * SECTION:ges-track-video-transition - * @short_description: implements video crossfade transitino + * @short_description: implements video crossfade transition */ #include "ges-internal.h"