massive update to doc comments

diff --git a/docs/libs/ges-sections.txt b/docs/libs/ges-sections.txt
index f53994934487b23e8f4462f3bf2e105082c2f179..32a0e3635604493fa3d4c064c9d4957cbe3f4970 100644 (file)
--- a/docs/libs/ges-sections.txt
+++ b/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
-GESTrackAudioBackgroundSourceClass
+GESTrackVideoBackgroundSource
+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

diff --git a/ges/ges-timeline-background-source.c b/ges/ges-timeline-background-source.c
index 1125ee8574e0a4a85a7030f7ddac15f61f94fb78..42cd7f8bcaf64f8d923e4459a2b2a8bcee5218f7 100644 (file)
--- a/ges/ges-timeline-background-source.c
+++ b/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

diff --git a/ges/ges-timeline-background-source.h b/ges/ges-timeline-background-source.h
index d616f59fa32db10c6f06fff460650fcb1f229256..68a04e4c3a59d5b8c927689001ec2c5c764a4b32 100644 (file)
--- a/ges/ges-timeline-background-source.h
+++ b/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;
 };
 

diff --git a/ges/ges-timeline-title-source.c b/ges/ges-timeline-title-source.c
index cc97a5702e97f4126da2c27a201eeb218503d0a9..a0597a9a679e7c3e9cae2e2af6bf1b4d09b2bb52 100644 (file)
--- a/ges/ges-timeline-title-source.c
+++ b/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

diff --git a/ges/ges-timeline-title-source.h b/ges/ges-timeline-title-source.h
index 60121467c3dd9266941da7b7f8e2e6fa50f0d283..e585d29909eb5d3e483238a231003f3a25dc2bb9 100644 (file)
--- a/ges/ges-timeline-title-source.h
+++ b/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
  * 
  */
 

diff --git a/ges/ges-timeline-transition.c b/ges/ges-timeline-transition.c
index 11049a896ffa722204c9f3dd4f1a3edd5651f9ba..e486c173fffd152b3ffafd21e1e2fd4f42414d83 100644 (file)
--- a/ges/ges-timeline-transition.c
+++ b/ges/ges-timeline-transition.c
@@ -120,7 +120,7 @@ ges_timeline_transition_class_init (GESTimelineTransitionClass * klass)
   object_class->finalize = ges_timeline_transition_finalize;
 
   /**
-   * GESTimelineTransition: vtype
+   * GESTimelineTransition:vtype
    *
    * The SMPTE wipe to use, or 0 for crossfade.
    */

diff --git a/ges/ges-track-audio-background-source.c b/ges/ges-track-audio-background-source.c
index 4a2509fb3c853f806b9346e8def77a3a9ebacdbc..f5b921bb02ea44db50cbb2ceeaa1ffd7cd59b085 100644 (file)
--- a/ges/ges-track-audio-background-source.c
+++ b/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
  */
 

diff --git a/ges/ges-track-audio-background-source.h b/ges/ges-track-audio-background-source.h
index 5fd87f1ed4c31eb8f6efda6ed101927f24269c42..bea80089385f04475360b361734e9784c015a56f 100644 (file)
--- a/ges/ges-track-audio-background-source.h
+++ b/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,12 +59,13 @@ struct _GESTrackAudioBackgroundSource {
 /**
  * GESTrackAudioBackgroundSourceClass:
  * @parent_class: parent class
+ *
  */
 
 struct _GESTrackAudioBackgroundSourceClass {
   GESTrackBackgroundSourceClass parent_class;
 
-  /* <public> */
+  /*< public >*/
 };
 
 GType ges_track_abg_src_get_type (void);

diff --git a/ges/ges-track-background-source.c b/ges/ges-track-background-source.c
index d785e0af96046416884f903e149f88557004cc6c..111c5e5677f42754ae61cc9f18ae144fb2ab9b52 100644 (file)
--- a/ges/ges-track-background-source.c
+++ b/ges/ges-track-background-source.c
@@ -19,8 +19,8 @@
  */
 
 /**
- * SECTION:ges-track-source
- * @short_description: Base Class for single-media sources
+ * SECTION:ges-track-background-source
+ * @short_description: Base Class for background source track objects
  */
 
 #include "ges-internal.h"

diff --git a/ges/ges-track-background-source.h b/ges/ges-track-background-source.h
index c66f349a34325b85752dcf0f3744b23771b1dc26..3ad4663b567c6b9f186cb3bc8f29f9631c7a0908 100644 (file)
--- a/ges/ges-track-background-source.h
+++ b/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;
 };
 
@@ -64,7 +64,7 @@ struct _GESTrackBackgroundSource {
 struct _GESTrackBackgroundSourceClass {
   GESTrackSourceClass parent_class;
 
-  /* <public> */
+  /*< public >*/
   GstElement* (*create_element) (GESTrackBackgroundSource *obj);
 };
 

diff --git a/ges/ges-track-title-source.c b/ges/ges-track-title-source.c
index 7db095c15b8ee6cd11c17117aa3222abec763d07..2bbe8a05c2a997df70bab63faed6c01d0252970c 100644 (file)
--- a/ges/ges-track-title-source.c
+++ b/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
  */
 

diff --git a/ges/ges-track-title-source.h b/ges/ges-track-title-source.h
index a7218996e3fe58efc8396614ea1eb74cc0d45c47..f3e99105f433e70b38856621afed9c8b228ffc4b 100644 (file)
--- a/ges/ges-track-title-source.h
+++ b/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 {

diff --git a/ges/ges-track-video-background-source.c b/ges/ges-track-video-background-source.c
index 5e20e2100e6f0b08d84b7bd2adf76b4dbf9a205b..7b1389155f371d20260ed6441d01b5f8dc5a3835 100644 (file)
--- a/ges/ges-track-video-background-source.c
+++ b/ges/ges-track-video-background-source.c
@@ -19,8 +19,8 @@
  */
 
 /**
- * SECTION:ges-track-source
- * @short_description: Base Class for single-media sources
+ * SECTION:ges-track-video-background-source
+ * @short_description: implements solid colors and patterns with videotestsrc
  */
 
 #include "ges-internal.h"

diff --git a/ges/ges-track-video-background-source.h b/ges/ges-track-video-background-source.h
index 2aa1970c1fce6ce238d382db6f9d0746954053f2..3c76fdf018961373f5f6671b81df151884ae1267 100644 (file)
--- a/ges/ges-track-video-background-source.h
+++ b/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;