massive documentation updates

diff --git a/docs/libs/ges-docs.sgml b/docs/libs/ges-docs.sgml
index fe14bf3e24820968ce3dcd7dd2f93f4b71b3a3f9..17c73fea27cf392bd76f1ee1f2fba0ecfbd7601e 100644 (file)
--- 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
     <xi:include href="xml/ges-timeline-layer.xml"/>
     <xi:include href="xml/ges-timeline-object.xml"/>
     <xi:include href="xml/ges-timeline-source.xml"/>
-    <xi:include href="xml/ges-timeline-transition.xml"/>
+    <xi:include href="xml/ges-timeline-overlay.xml"/>
     <xi:include href="xml/ges-track.xml"/>
     <xi:include href="xml/ges-track-object.xml"/>
     <xi:include href="xml/ges-track-source.xml"/>
+    <xi:include href="xml/ges-track-operation.xml"/>
   </chapter>
 
   <chapter>
     <title>Timeline objects</title>
     <xi:include href="xml/ges-timeline-filesource.xml"/>
     <xi:include href="xml/ges-timeline-title-source.xml"/>
-    <xi:include href="xml/ges-timeline-background-source.xml"/>
-    <xi:include href="xml/ges-timeline-overlay.xml"/>
+    <xi:include href="xml/ges-timeline-test-source.xml"/>
+    <xi:include href="xml/ges-timeline-text-overlay.xml"/>
+    <xi:include href="xml/ges-timeline-transition.xml"/>
   </chapter>
 
   <chapter>
     <title>Track objects</title>
     <xi:include href="xml/ges-track-filesource.xml"/>
-    <xi:include href="xml/ges-track-overlay.xml"/>
     <xi:include href="xml/ges-track-title-source.xml"/>
+    <xi:include href="xml/ges-track-audio-test-source.xml"/>
+    <xi:include href="xml/ges-track-video-test-source.xml"/>
+    <xi:include href="xml/ges-track-text-overlay.xml"/>
     <xi:include href="xml/ges-track-transition.xml"/>
-    <xi:include href="xml/ges-track-audio-background-source.xml"/>
-    <xi:include href="xml/ges-track-audio-transition.xml"/>
-    <xi:include href="xml/ges-track-video-background-source.xml"/>
-    <xi:include href="xml/ges-track-video-overlay.xml"/>
     <xi:include href="xml/ges-track-video-transition.xml"/>
+    <xi:include href="xml/ges-track-audio-transition.xml"/>
   </chapter>
 
   <chapter>

diff --git a/docs/libs/ges-sections.txt b/docs/libs/ges-sections.txt
index 8955f07a2e5078c578eef19f31a9cad13468edcf..f496bf5bc6f035e54947597966763c53a43c1371 100644 (file)
--- 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
 </SECTION>
 
+<SECTION>
+<FILE>ges-timeline-overlay</FILE>
+<TITLE>GESTimelineOverlay</TITLE>
+GESTimelineOverlay
+GESTimelineOverlayClass
+ges_timeline_overlay_get_type
+ges_timeline_overlay_new
+<SUBSECTION Standard>
+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
+</SECTION>
 
 <SECTION>
 <FILE>ges-timeline-transition</FILE>
@@ -454,7 +469,7 @@ GES_IS_TRACK_TITLE_SOURCE_CLASS
 
 <SECTION>
 <FILE>ges-track-text-overlay</FILE>
-<TITLE>GESTrackOverlay</TITLE>
+<TITLE>GESTrackTextOverlay</TITLE>
 GESTrackTextOverlay
 GESTrackTextOverlayClass
 ges_track_text_overlay_get_type

diff --git a/ges/ges-timeline-overlay.c b/ges/ges-timeline-overlay.c
index 541cd4561cc4ab5f9a3a6d557870e8f5070dcc22..e132cd032fae1a8686810c8386377da1f6d20131 100644 (file)
--- 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 ddb225747cd00f17852b2e610076bf263e408170..b5e6c41fbb11ac8683956e978e819703aeb05b99 100644 (file)
--- 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 789273e5014addba1599a177aaff7e60d63858d2..4b54c1e114f6dbab1a932671a759cd1f487932cd 100644 (file)
--- 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 239012d349432adedf497684b5d345c35a8a391c..e6ad942b21321a77fbe03f479b7c879f28875661 100644 (file)
--- 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 89e23bc27b5d29a48abdf9b65476a4388c016bbb..2658a19c17a7da71155293c3e589772fa0433eb0 100644 (file)
--- 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 251a6d21ba78d1c29c4fe7aaf7e5c6276f9f2ec7..ec76dca3c76bfd89d643c6555d771c7305fb93bf 100644 (file)
--- 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 119811b31a851321b4ee5932ee5615e95c1debb0..0988cd45e070e332ec83d9ed0f1dd91af2fe5ec4 100644 (file)
--- 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 7f923439fcc2956c15bbaf152775e76e0eb64630..77723fbfdcb27b7c61309e52fce6fa00def6d145 100644 (file)
--- 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 3cf6653a87e4cde3dcd578c45e47ece299e743d9..4ddb80b7cac87ca6cb1cf72b9e1c895e99660c41 100644 (file)
--- 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 eb556534695380cafc5c3919234ab140eba607e2..6680ce5a219ac0fb21bfe612abf5127a1d31a899 100644 (file)
--- 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 a856bcab3767709874804a45d260e82a5e6557d9..15331ba40342440be16e9408e2d4f7f2ce5472de 100644 (file)
--- 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 001ffbe59899421ac6f71c6c7d5da21c69e443d2..ba3a02a4910680462a5f646fd728fe5946df393c 100644 (file)
--- 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 c400db030c1d334c812b7ae6ba2d1b61b4dce1a0..cd172a49d09b79adad80fbd60dda6a23286f4ea8 100644 (file)
--- 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 80103e29c7a305a7edf35d236c59b3e00080da21..c30ff6273eb08eb18232e414943ef5788d80056c 100644 (file)
--- 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 6eec3c19a4fd660a9665c7f15621218b7d44a954..4ff731b686e920004d8247fd5eab7588f9fa93a9 100644 (file)
--- 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 7141ba5d93419fa3f9fd365d9e99d70935db48ad..a46006997ca91f6a6ef40732f164c7ed1b253c9a 100644 (file)
--- 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 ddb8d427d6dfaa2fcf72ad9bf9db32586a43c789..b4af6bdea1a67aa364484b625dd81c6c62e0997a 100644 (file)
--- 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 81d31864ad90973ff521d0c93f46d7a2990c035b..a72d5e9f8ddaf76ff1cd3247e8598c7c505de44c 100644 (file)
--- 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"