massive update to doc comments

docs/libs/ges-sections.txt

@@ -331,8 +331,9 @@ GES_TIMELINE_TITLE_SOURCE_GET_CLASS
 <SECTION>
 <FILE>ges-track-video-background-source</FILE>
 <TITLE>GESTrackVideoBackgroundSource</TITLE>
-GESTrackAudioBackgroundSource
+GESTrackVideoBackgroundSource
-GESTrackAudioBackgroundSourceClass
+GESTrackVideoBackgroundSourceClass
+GESTrackVideoBgSrcPattern
 ges_track_video_background_source_new
 ges_track_vbg_src_get_type
 <SUBSECTION Standard>
@@ -376,18 +377,11 @@ GES_TRACK_TITLE_SOURCE_GET_CLASS
 GES_TYPE_TRACK_TITLE_SOURCE
 </SECTION>
 
-<SECTION>
-<FILE>ges-track-video-background-source</FILE>
-<TITLE>GESTrackVideoBackgroundSource</TITLE>
-GESTrackVideoBackgroundSource
-GESTrackVideoBackgroundSourceClass
-GESTrackVideoBgSrcPattern
-<SUBSECTION Standard>
-</SECTION>
-
 <SECTION>
 <FILE>ges-track-audio-background-source</FILE>
 <TITLE>GESTrackAudioBackgroundSource</TITLE>
+GESTrackAudioBackgroundSource
+GESTrackAudioBackgroundSourceClass
 ges_track_audio_background_source_new
 ges_track_abg_src_get_type
 ges_track_video_title_source_new

ges/ges-timeline-background-source.c

@@ -19,7 +19,7 @@
  */
 
 /**
- * SECTION:ges-timeline-backgroundsource
+ * SECTION:ges-timeline-background-source
  * @short_description: An object for manipulating media files in a GESTimeline
  * 
  * Represents all the output treams from a particular uri. It is assumed that

ges/ges-timeline-background-source.h

@@ -46,15 +46,16 @@ G_BEGIN_DECLS
   (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_BACKGROUND_SOURCE, GESTimelineBackgroundSourceClass))
 
 /**
- * GESTimelineSource:
+ * GESTimelineBackgroundSource:
+ * @parent: parent
  * 
  */
 
 struct _GESTimelineBackgroundSource {
   GESTimelineSource parent;
-  gboolean mute;
 
   /*< private >*/
+  gboolean mute;
   gint vpattern;
 };
 

ges/ges-timeline-title-source.c

@@ -19,7 +19,7 @@
  */
 
 /**
- * SECTION:ges-timeline-titlesource
+ * SECTION:ges-timeline-title-source
  * @short_description: An object for manipulating media files in a GESTimeline
  * 
  * Represents all the output treams from a particular uri. It is assumed that

ges/ges-timeline-title-source.h

@@ -46,7 +46,8 @@ G_BEGIN_DECLS
   (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_TITLE_SOURCE, GESTimelineTitleSourceClass))
 
 /**
- * GESTimelineSource:
+ * GESTimelineTitleSource:
+ * @parent: parent
  * 
  */
 

ges/ges-track-audio-background-source.c

@@ -19,7 +19,7 @@
  */
 
 /**
- * SECTION:ges-track-source
+ * SECTION:ges-track-audio-background-source
  * @short_description: Base Class for single-media sources
  */
 

ges/ges-track-audio-background-source.h

@@ -43,11 +43,13 @@ G_BEGIN_DECLS
 
 #define GES_TRACK_AUDIO_BACKGROUND_SOURCE_GET_CLASS(obj) \
   (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_AUDIO_BACKGROUND_SOURCE, GESTrackAudioBackgroundSourceClass))
+
 /** 
  * GESTrackAudioBackgroundSource:
- * @uri: #gchar *, the URI of the media audio_background to play
+ * @parent: parent
  *
  */
+
 struct _GESTrackAudioBackgroundSource {
   GESTrackBackgroundSource parent;
 
@@ -57,6 +59,7 @@ struct _GESTrackAudioBackgroundSource {
 /**
  * GESTrackAudioBackgroundSourceClass:
  * @parent_class: parent class
+ *
  */
 
 struct _GESTrackAudioBackgroundSourceClass {

ges/ges-track-background-source.c

@@ -19,8 +19,8 @@
  */
 
 /**
- * SECTION:ges-track-source
+ * SECTION:ges-track-background-source
- * @short_description: Base Class for single-media sources
+ * @short_description: Base Class for background source track objects
  */
 
 #include "ges-internal.h"

ges/ges-track-background-source.h

@@ -46,13 +46,13 @@ G_BEGIN_DECLS
   (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_BACKGROUND_SOURCE, GESTrackBackgroundSourceClass))
 /** 
  * GESTrackBackgroundSource:
- * @uri: #gchar *, the URI of the media file to play
+ * @parent: parent
  *
  */
 struct _GESTrackBackgroundSource {
   GESTrackSource parent;
 
-  /*< public >*/
+  /*< private >*/
   GstElement *element;
 };
 

ges/ges-track-title-source.c

@@ -19,7 +19,7 @@
  */
 
 /**
- * SECTION:ges-track-source
+ * SECTION:ges-track-title-source
  * @short_description: Base Class for single-media sources
  */
 

ges/ges-track-title-source.h

@@ -46,7 +46,7 @@ G_BEGIN_DECLS
   (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_TITLE_SOURCE, GESTrackTitleSourceClass))
 /** 
  * GESTrackTitleSource:
- * @uri: #gchar *, the URI of the media file to play
+ * @parent: parent
  *
  */
 struct _GESTrackTitleSource {

ges/ges-track-video-background-source.c

@@ -19,8 +19,8 @@
  */
 
 /**
- * SECTION:ges-track-source
+ * SECTION:ges-track-video-background-source
- * @short_description: Base Class for single-media sources
+ * @short_description: implements solid colors and patterns with videotestsrc
  */
 
 #include "ges-internal.h"

ges/ges-track-video-background-source.h

@@ -44,6 +44,26 @@ G_BEGIN_DECLS
 #define GES_TRACK_VIDEO_BACKGROUND_SOURCE_GET_CLASS(obj) \
   (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_VIDEO_BACKGROUND_SOURCE, GESTrackVideoBackgroundSourceClass))
 
+/**$
+ * GESTrackVideoBgSrcPattern:$
+ * @GES_TRACK_VIDEO_BG_SRC_SMPTE: A standard SMPTE test pattern$
+ * @GES_TRACK_VIDEO_BG_SRC_SNOW: Random noise$
+ * @GES_TRACK_VIDEO_BG_SRC_BLACK: A black image$
+ * @GES_TRACK_VIDEO_BG_SRC_WHITE: A white image$
+ * @GES_TRACK_VIDEO_BG_SRC_RED: A red image$
+ * @GES_TRACK_VIDEO_BG_SRC_GREEN: A green image$
+ * @GES_TRACK_VIDEO_BG_SRC_BLUE: A blue image$
+ * @GES_TRACK_VIDEO_BG_SRC_CHECKERS1: Checkers pattern (1px)$
+ * @GES_TRACK_VIDEO_BG_SRC_CHECKERS2: Checkers pattern (2px)$
+ * @GES_TRACK_VIDEO_BG_SRC_CHECKERS4: Checkers pattern (4px)$
+ * @GES_TRACK_VIDEO_BG_SRC_CHECKERS8: Checkers pattern (8px)$
+ * @GES_TRACK_VIDEO_BG_SRC_CIRCULAR: Circular pattern$
+ * @GES_TRACK_VIDEO_BG_SRC_BLINK: Alternate between black and white$
+ * @GES_TRACK_VIDEO_BG_SRC_SMPTE75: SMPTE test pattern (75% color bars)$
+ *
+ */
+
+
 typedef enum {
   GES_TRACK_VIDEO_BG_SRC_SMPTE,
   GES_TRACK_VIDEO_BG_SRC_SNOW,
@@ -63,8 +83,7 @@ typedef enum {
 
 /** 
  * GESTrackVideoBackgroundSource:
- * @uri: #gchar *, the URI of the media video_background to play
+ * @parent: parent
- *
  */
 struct _GESTrackVideoBackgroundSource {
   GESTrackBackgroundSource parent;