docs: A round of updates
authorEdward Hervey <edward.hervey@collabora.co.uk>
Wed, 8 Dec 2010 14:36:55 +0000 (15:36 +0100)
committerEdward Hervey <edward.hervey@collabora.co.uk>
Wed, 8 Dec 2010 14:36:55 +0000 (15:36 +0100)
29 files changed:
docs/libs/ges-sections.txt
ges/ges-custom-timeline-source.h
ges/ges-formatter.c
ges/ges-keyfile-formatter.h
ges/ges-simple-timeline-layer.c
ges/ges-simple-timeline-layer.h
ges/ges-timeline-file-source.h
ges/ges-timeline-layer.h
ges/ges-timeline-object.h
ges/ges-timeline-overlay.h
ges/ges-timeline-pipeline.c
ges/ges-timeline-pipeline.h
ges/ges-timeline-source.h
ges/ges-timeline-test-source.h
ges/ges-timeline-text-overlay.h
ges/ges-timeline-title-source.h
ges/ges-timeline-transition.h
ges/ges-timeline.c
ges/ges-track-audio-test-source.h
ges/ges-track-audio-transition.h
ges/ges-track-filesource.h
ges/ges-track-image-source.h
ges/ges-track-object.h
ges/ges-track-operation.h
ges/ges-track-source.h
ges/ges-track-text-overlay.h
ges/ges-track-transition.h
ges/ges-track-video-test-source.h
ges/ges-track.h

index f10fc391465381a55f03ada16caa57f88232abe2..10c5b051c8c1b24bab9d2cc67a31a3536bae8472 100644 (file)
@@ -4,6 +4,8 @@
 <FILE>ges-common</FILE>
 <TITLE>Initialization</TITLE>
 ges_init
+<SUBSECTION Standard>
+GES_PADDING
 </SECTION>
 
 <SECTION>
@@ -39,7 +41,6 @@ ges_video_transition_type_get_type
 <FILE>ges-track</FILE>
 <TITLE>GESTrack</TITLE>
 GESTrack
-GESTrackClass
 ges_track_audio_raw_new
 ges_track_video_raw_new
 ges_track_new
@@ -47,6 +48,7 @@ ges_track_add_object
 ges_track_remove_object
 ges_track_set_caps
 <SUBSECTION Standard>
+GESTrackClass
 GESTrackPrivate
 ges_track_set_timeline
 ges_track_get_type
@@ -125,9 +127,9 @@ GES_TYPE_TRACK_OPERATION
 <FILE>ges-track-filesource</FILE>
 <TITLE>GESTrackFileSource</TITLE>
 GESTrackFileSource
-GESTrackFileSourceClass
 ges_track_filesource_new
 <SUBSECTION Standard>
+GESTrackFileSourceClass
 GESTrackFileSourcePrivate
 GES_TRACK_FILESOURCE
 GES_TRACK_FILESOURCE_CLASS
@@ -142,7 +144,7 @@ ges_track_filesource_get_type
 <FILE>ges-track-image-source</FILE>
 <TITLE>GESTrackImageSource</TITLE>
 GESTrackImageSource
-GESTrackImageSourceClass
+ges_track_image_source_new
 <SUBSECTION Standard>
 GESTrackImageSourcePrivate
 GES_IS_TRACK_IMAGE_SOURCE
@@ -151,8 +153,8 @@ GES_TRACK_IMAGE_SOURCE
 GES_TRACK_IMAGE_SOURCE_CLASS
 GES_TRACK_IMAGE_SOURCE_GET_CLASS
 GES_TYPE_TRACK_IMAGE_SOURCE
+GESTrackImageSourceClass
 ges_track_image_source_get_type
-ges_track_image_source_new
 </SECTION>
 
 <SECTION>
@@ -175,9 +177,9 @@ ges_track_transition_get_type
 <FILE>ges-track-audio-transition</FILE>
 <TITLE>GESTrackAudioTransition</TITLE>
 GESTrackAudioTransition
-GESTrackAudioTransitionClass
 ges_track_audio_transition_new
 <SUBSECTION Standard>
+GESTrackAudioTransitionClass
 GESTrackAudioTransitionPrivate
 GES_IS_TRACK_AUDIO_TRANSITION
 ges_track_audio_transition_get_type
@@ -192,10 +194,10 @@ GES_TYPE_TRACK_AUDIO_TRANSITION
 <FILE>ges-track-video-transition</FILE>
 <TITLE>GESTrackVideoTransition</TITLE>
 GESTrackVideoTransition
-GESTrackVideoTransitionClass
 ges_track_video_transition_new
 ges_track_video_transition_set_type
 <SUBSECTION Standard>
+GESTrackVideoTransitionClass
 GESTrackVideoTransitionPrivate
 ges_track_video_transition_get_type
 GES_IS_TRACK_VIDEO_TRANSITION
@@ -210,7 +212,6 @@ GES_TYPE_TRACK_VIDEO_TRANSITION
 <FILE>ges-timeline</FILE>
 <TITLE>GESTimeline</TITLE>
 GESTimeline
-GESTimelineClass
 ges_timeline_new
 ges_timeline_new_audio_video
 ges_timeline_new_from_uri
@@ -218,11 +219,13 @@ ges_timeline_add_layer
 ges_timeline_remove_layer
 ges_timeline_add_track
 ges_timeline_remove_track
-ges_timeline_get_track_for_pad
 ges_timeline_load_from_uri
 ges_timeline_save_to_uri
+<SUBSECTION usage>
 ges_timeline_get_tracks
+ges_timeline_get_track_for_pad
 <SUBSECTION Standard>
+GESTimelineClass
 ges_timeline_get_type
 GES_IS_TIMELINE
 GES_IS_TIMELINE_CLASS
@@ -283,6 +286,7 @@ ges_timeline_object_release_track_object
 ges_timeline_object_get_track_objects
 ges_timeline_object_set_layer
 ges_timeline_object_set_priority
+GESTimelineObjectPrivate
 GES_IS_TIMELINE_OBJECT
 GES_IS_TIMELINE_OBJECT_CLASS
 GES_TIMELINE_OBJECT
@@ -297,7 +301,6 @@ ges_timeline_object_get_type
 <FILE>ges-timeline-pipeline</FILE>
 <TITLE>GESTimelinePipeline</TITLE>
 GESTimelinePipeline
-GESTimelinePipelineClass
 GESPipelineFlags
 ges_timeline_pipeline_new
 ges_timeline_pipeline_add_timeline
@@ -307,6 +310,8 @@ ges_timeline_pipeline_get_thumbnail_buffer
 ges_timeline_pipeline_get_thumbnail_rgb24
 ges_timeline_pipeline_save_thumbnail
 <SUBSECTION Standard>
+GESTimelinePipelineClass
+GESTimelinePipelinePrivate
 ges_play_sink_convert_frame
 ges_timeline_pipeline_get_type
 GES_TIMELINE_PIPELINE
@@ -339,9 +344,9 @@ GES_TYPE_TIMELINE_SOURCE
 <FILE>ges-timeline-filesource</FILE>
 <TITLE>GESTimelineFileSource</TITLE>
 GESTimelineFileSource
-GESTimelineFileSourceClass
 ges_timeline_filesource_new
 <SUBSECTION Standard>
+GESTimelineFileSourceClass
 ges_tl_filesource_get_type
 GES_IS_TIMELINE_FILE_SOURCE
 GES_IS_TIMELINE_FILE_SOURCE_CLASS
@@ -390,10 +395,10 @@ ges_timeline_transition_get_type
 <FILE>ges-custom-timeline-source</FILE>
 <TITLE>GESCustomTimelineSource</TITLE>
 GESCustomTimelineSource
-GESCustomTimelineSourceClass
 FillTrackObjectUserFunc
 ges_custom_timeline_source_new
 <SUBSECTION Standard>
+GESCustomTimelineSourceClass
 ges_cust_timeline_src_get_type
 GESCustomTimelineSourcePrivate
 GES_CUSTOM_TIMELINE_SOURCE
@@ -408,12 +413,12 @@ GES_TYPE_CUSTOM_TIMELINE_SOURCE
 <FILE>ges-simple-timeline-layer</FILE>
 <TITLE>GESSimpleTimelineLayer</TITLE>
 GESSimpleTimelineLayer
-GESSimpleTimelineLayerClass
 ges_simple_timeline_layer_new
 ges_simple_timeline_layer_add_object
 ges_simple_timeline_layer_move_object
 ges_simple_timeline_layer_is_valid
 <SUBSECTION Standard>
+GESSimpleTimelineLayerClass
 ges_simple_timeline_layer_get_type
 GESSimpleTimelineLayerPrivate
 GES_IS_SIMPLE_TIMELINE_LAYER
@@ -446,9 +451,9 @@ GES_TIMELINE_TEST_SOURCE_GET_CLASS
 <FILE>ges-timeline-title-source</FILE>
 <TITLE>GESTimelineTitleSource</TITLE>
 GESTimelineTitleSource
-GESTimelineTitleSourceClass
 ges_timeline_title_source_new
 <SUBSECTION Standard>
+GESTimelineTitleSourceClass
 GESTimelineTitleSourcePrivate
 ges_tl_title_src_get_type
 GES_IS_TIMELINE_TITLE_SOURCE
@@ -462,9 +467,9 @@ GES_TIMELINE_TITLE_SOURCE_GET_CLASS
 <FILE>ges-timeline-text-overlay</FILE>
 <TITLE>GESTimelineTextOverlay</TITLE>
 GESTimelineTextOverlay
-GESTimelineTextOverlayClass
 ges_timeline_text_overlay_new
 <SUBSECTION Standard>
+GESTimelineTextOverlayClass
 GESTimelineTextOverlayPrivate
 ges_tl_text_overlay_get_type
 GES_IS_TIMELINE_TEXT_OVERLAY
@@ -479,10 +484,10 @@ GES_TYPE_TIMELINE_TEXT_OVERLAY
 <FILE>ges-track-video-test-source</FILE>
 <TITLE>GESTrackVideoTestSource</TITLE>
 GESTrackVideoTestSource
-GESTrackVideoTestSourceClass
 ges_track_video_test_source_new
 ges_track_video_test_source_set_pattern
 <SUBSECTION Standard>
+GESTrackVideoTestSourceClass
 GESTrackVideoTestSourcePrivate
 ges_track_video_test_source_get_type
 GES_IS_TRACK_VIDEO_TEST_SOURCE
@@ -497,11 +502,11 @@ GES_TYPE_TRACK_VIDEO_TEST_SOURCE
 <FILE>ges-track-audio-test-source</FILE>
 <TITLE>GESTrackAudioTestSource</TITLE>
 GESTrackAudioTestSource
-GESTrackAudioTestSourceClass
 ges_track_audio_test_source_new
 ges_track_audio_test_source_set_freq
 ges_track_audio_test_source_set_volume
 <SUBSECTION Standard>
+GESTrackAudioTestSourceClass
 GESTrackAudioTestSourcePrivate
 ges_track_audio_test_source_get_type
 GES_TRACK_AUDIO_TEST_SOURCE
@@ -516,14 +521,13 @@ GES_IS_TRACK_AUDIO_TEST_SOURCE_CLASS
 <FILE>ges-track-title-source</FILE>
 <TITLE>GESTrackTitleSource</TITLE>
 GESTrackTitleSource
-GESTrackTitleSourceClass
-ges_tl_title_src_get_type
 ges_track_title_source_set_text
 ges_track_title_source_set_font_desc
 ges_track_title_source_set_halignment
 ges_track_title_source_set_valignment
 ges_track_title_source_new
 <SUBSECTION Standard>
+GESTrackTitleSourceClass
 GESTrackTitleSourcePrivate
 ges_track_title_src_get_type
 GES_TRACK_TITLE_SOURCE
@@ -539,13 +543,13 @@ GES_IS_TRACK_TITLE_SOURCE_CLASS
 <FILE>ges-track-text-overlay</FILE>
 <TITLE>GESTrackTextOverlay</TITLE>
 GESTrackTextOverlay
-GESTrackTextOverlayClass
 ges_track_text_overlay_new
 ges_track_text_overlay_set_font_desc
 ges_track_text_overlay_set_halignment
 ges_track_text_overlay_set_text
 ges_track_text_overlay_set_valignment
 <SUBSECTION Standard>
+GESTrackTextOverlayClass
 GESTrackTextOverlayPrivate
 ges_track_text_overlay_get_type
 GES_IS_TRACK_TEXT_OVERLAY
@@ -593,9 +597,9 @@ GESFormatterSaveMethod
 <FILE>ges-keyfile-formatter</FILE>
 <TITLE>GESKeyFileFormatter</TITLE>
 GESKeyfileFormatter
-GESKeyfileFormatterClass
 ges_keyfile_formatter_new
 <SUBSECTION Standard>
+GESKeyfileFormatterClass
 GES_IS_KEYFILE_FORMATTER
 GES_IS_KEYFILE_FORMATTER_CLASS
 GES_KEYFILE_FORMATTER
index fff1c1b3eb081059a621a6b009e45c1ef57205c4..1a34b91f9114f38308b5e067d1355f3d178b3e35 100644 (file)
@@ -69,6 +69,7 @@ typedef gboolean (*FillTrackObjectUserFunc) (GESTimelineObject * object,
 /**
  * GESCustomTimelineSource:
  *
+ * Debugging custom timeline source
  */
 
 struct _GESCustomTimelineSource {
@@ -83,8 +84,6 @@ struct _GESCustomTimelineSource {
 
 /**
  * GESCustomTimelineSourceClass:
- * @parent_class: parent class
- *
  */
 
 struct _GESCustomTimelineSourceClass {
index 955d73a6064a0ba29e343298b5c5d4c211d05556..d3716b396fce9dd4a922f381a3c3997250a42541 100644 (file)
@@ -107,7 +107,7 @@ ges_formatter_new_for_uri (gchar * uri)
  * ges_default_formatter_new:
  *
  * Creates a new instance of the default GESFormatter type on this system
- * (currently #GESKeyFileFormatter).
+ * (currently #GESKeyfileFormatter).
  *
  * Returns: a #GESFormatter instance or NULL 
  */
index 96d4d98d76da6c55b0f01a4ac9ced654d55c556f..0e18d898245db0f277c656b5f8db5e615093b2e8 100644 (file)
  */
 
 struct _GESKeyfileFormatter {
+  /*< private >*/
   GESFormatter parent;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
 
-/**
- * GESKeyfileFormatterClass:
- * @parent_class: parent class
- */
-
 struct _GESKeyfileFormatterClass {
+  /*< private >*/
   GESFormatterClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index f81029633db9316622c226fa4870d8e6f2987f1c..9f5c1f9cb572fdbae4a13e29f5e38c4448dc610f 100644 (file)
@@ -441,13 +441,13 @@ ges_simple_timeline_layer_new (void)
 
 /**
  * ges_simple_timeline_layer_is_valid:
+ * @layer: a #GESSimpleTimelineLayer
  *
- * FALSE when the arrangement of objects in the layer would cause errors or
- * unexpected output during playback. Do not set the containing pipeline
+ * Checks whether the arrangement of objects in the layer would cause errors
+ * or unexpected output during playback. Do not set the containing pipeline
  * state to PLAYING when this property is FALSE.
  *
- * Returns: #True if current arrangement of the layer is valid, #False
- * otherwise
+ * Returns: #TRUE if current arrangement of the layer is valid else #FALSE.
  */
 gboolean
 ges_simple_timeline_layer_is_valid (GESSimpleTimelineLayer * layer)
index fc79bb12f4a3ce23bd5f053f728ca6d26b406bf0..2725616466c64305df4c55710834ef520ad4b04a 100644 (file)
@@ -48,32 +48,25 @@ typedef struct _GESSimpleTimelineLayerPrivate GESSimpleTimelineLayerPrivate;
 
 /**
  * GESSimpleTimelineLayer:
- * 
  */
 
 struct _GESSimpleTimelineLayer {
+  /*< private >*/
   GESTimelineLayer parent;
 
-  /*< private >*/
   GESSimpleTimelineLayerPrivate *priv;
 
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
 
-/**
- * GESSimpleTimelineLayerClass:
- * @parent_class: parent class
- *
- */
-
 struct _GESSimpleTimelineLayerClass {
+  /*< private >*/
   GESTimelineLayerClass parent_class;
-  /*< signals >*/
 
+  /*< signals >*/
   void (*object_moved) (GESTimelineLayer * layer, GESTimelineObject * object,
       gint old_position, gint new_position);
-  /*< private >*/
 
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
index a5afd18671d08d0426c4fa3101ae5ae67eca9c60..6cd13602791779f8c1b2a4216c03f50eed75fe28 100644 (file)
@@ -51,9 +51,9 @@ G_BEGIN_DECLS
  */
 
 struct _GESTimelineFileSource {
+  /*< private >*/
   GESTimelineSource parent;
 
-  /*< private >*/
   gchar *uri;
 
   gboolean mute;
@@ -71,13 +71,11 @@ struct _GESTimelineFileSource {
 
 /**
  * GESTimelineFileSourceClass:
- * @parent_class: parent class
  */
 
 struct _GESTimelineFileSourceClass {
-  GESTimelineSourceClass parent_class;
-
   /*< private >*/
+  GESTimelineSourceClass parent_class;
 
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
index b527ffbf8ef1e4d9728f1235fee07396275c5e27..a9bbbc1b950b455d208f4106410107403dfa8d29 100644 (file)
@@ -73,13 +73,13 @@ struct _GESTimelineLayer {
 
 /**
  * GESTimelineLayerClass:
- * @parent_class: layer parent class
  * @get_objects: method to get the objects contained in the layer
  *
  * Subclasses can override the @get_objects if they can provide a more
  * efficient way of providing the list of contained #GESTimelineObject(s).
  */
 struct _GESTimelineLayerClass {
+  /*< private >*/
   GObjectClass parent_class;
 
   /*< public >*/
index d7cae73ab147eb4aaf911f645cad90f1e7f46da4..5af4ea093ac0f6041e75c3d16cf6cdff5c3cedd1 100644 (file)
@@ -139,15 +139,12 @@ typedef gboolean (*CreateTrackObjectsFunc) (GESTimelineObject * object,
 
 /**
  * GESTimelineObject:
- * @layer: the #GESTimelineLayer where this object is being used.
  *
  * The GESTimelineObject subclass. Subclasses can access these fields.
  */
 struct _GESTimelineObject {
-  GObject parent;
-
-
   /*< private >*/
+  GObject parent;
 
   GESTimelineObjectPrivate *priv;
   
@@ -167,7 +164,6 @@ struct _GESTimelineObject {
 
 /**
  * GESTimelineObjectClass:
- * @parent_class: object parent class
  * @create_track_object: method to create a single #GESTrackObject for a given #GESTrack.
  * @create_track_objects: method to crate multiple #GESTrackObjects for a
  * #GESTrack.
@@ -177,6 +173,7 @@ struct _GESTimelineObject {
  * Subclasses can override the @create_track_object and @fill_track_object methods.
  */
 struct _GESTimelineObjectClass {
+  /*< private >*/
   GObjectClass parent_class;
 
   /*< public >*/
index 11387ced09a984b291751d0e4a562ab17d874ecf..1db3d720c42cac50dd828c5e6169178a3ae7334a 100644 (file)
@@ -51,10 +51,10 @@ typedef struct _GESTimelineOverlayPrivate GESTimelineOverlayPrivate;
  */
 
 struct _GESTimelineOverlay {
-  GESTimelineObject parent;
-
   /*< private >*/
 
+  GESTimelineObject parent;
+
   GESTimelineOverlayPrivate *priv;
 
   /* Padding for API extension */
index 0e753e84d47970e982d518a8e3feffa3e6b66da9..d2e6032f52a089e13f708f49ced4dbf913caf8d9 100644 (file)
@@ -596,7 +596,7 @@ ges_timeline_pipeline_add_timeline (GESTimelinePipeline * pipeline,
 /**
  * ges_timeline_pipeline_set_render_settings:
  * @pipeline: a #GESTimelinePipeline
- * @output_uri: the %URI to which the timeline will be rendered
+ * @output_uri: the URI to which the timeline will be rendered
  * @profile: the #GstEncodingProfile to use to render the timeline.
  *
  * Specify where the pipeline shall be rendered and with what settings.
index c9017fb5babea456d3242d7529499367bfadbcce..c710ea7b8a68e78e0bde803027d02397da9f8c74 100644 (file)
@@ -70,9 +70,9 @@ typedef enum {
  */
 
 struct _GESTimelinePipeline {
+  /*< private >*/
   GstPipeline parent;
 
-  /* <private> */
   GESTimelinePipelinePrivate *priv;
 
   /* Padding for API extension */
@@ -86,9 +86,9 @@ struct _GESTimelinePipeline {
  */
 
 struct _GESTimelinePipelineClass {
+  /*< private >*/
   GstPipelineClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index 51102fc31e9e68ae25cbcbadeb786c75c2f0cf0d..37e1fabecb5968db90b2b9ef6bc2db8bdb787446 100644 (file)
@@ -50,6 +50,7 @@ typedef struct _GESTimelineSourcePrivate GESTimelineSourcePrivate;
 /**
  * GESTimelineSource:
  *
+ * Base class for sources of a #GESTimelineLayer
  */
 
 struct _GESTimelineSource {
@@ -69,13 +70,12 @@ struct _GESTimelineSource {
 
 /**
  * GESTimelineSourceClass:
- * @parent_class: parent class
  */
 
 struct _GESTimelineSourceClass {
+  /*< private >*/
   GESTimelineObjectClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index 5b1bf8641be0f6bb4390367548da33b65fbf71d1..3404a2846fcefb88f2aa974737736be4cfdd43da 100644 (file)
@@ -54,9 +54,9 @@ typedef struct _GESTimelineTestSourcePrivate GESTimelineTestSourcePrivate;
  */
 
 struct _GESTimelineTestSource {
+  /*< private >*/
   GESTimelineSource parent;
 
-  /*< private >*/
   gboolean mute;
   GESVideoTestPattern vpattern;
   gdouble freq;
@@ -70,13 +70,12 @@ struct _GESTimelineTestSource {
 
 /**
  * GESTimelineTestSourceClass:
- * @parent_class: parent class
  */
 
 struct _GESTimelineTestSourceClass {
+  /*< private >*/
   GESTimelineSourceClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index 1fbee557f2ffd812f32e88f8b251a381b73a9344..24dacf0939132233ef2e88c32063581abbc4938e 100644 (file)
@@ -53,9 +53,9 @@ typedef struct _GESTimelineTextOverlayPrivate GESTimelineTextOverlayPrivate;
  */
 
 struct _GESTimelineTextOverlay {
+  /*< private >*/
   GESTimelineOverlay parent;
 
-  /*< private >*/
   gboolean mute;
   gchar *text;
   gchar *font_desc;
@@ -70,13 +70,12 @@ struct _GESTimelineTextOverlay {
 
 /**
  * GESTimelineTextOverlayClass:
- * @parent_class: parent class
  */
 
 struct _GESTimelineTextOverlayClass {
-  GESTimelineOverlayClass parent_class;
+  /*< private >*/
 
-  /*< public >*/
+  GESTimelineOverlayClass parent_class;
 
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
index fa086d08626de7a927ff5f9bd2b451328d5a6160..04c02aa597b97f21155f3cedadf8092901c77990 100644 (file)
@@ -49,13 +49,14 @@ typedef struct _GESTimelineTitleSourcePrivate GESTimelineTitleSourcePrivate;
 
 /**
  * GESTimelineTitleSource:
- * 
+ *
+ * Render stand-alone titles in GESTimelineLayer.
  */
 
 struct _GESTimelineTitleSource {
+  /*< private >*/
   GESTimelineSource parent;
 
-  /*< private >*/
   gboolean mute;
   gchar *text;
   gchar *font_desc;
@@ -68,15 +69,10 @@ struct _GESTimelineTitleSource {
   gpointer _ges_reserved[GES_PADDING];
 };
 
-/**
- * GESTimelineTitleSourceClass:
- * @parent_class: parent class
- */
-
 struct _GESTimelineTitleSourceClass {
+  /*< private >*/
   GESTimelineSourceClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index 6006da97467192c1891b80e973f38e3309ca3856..6e42f4b84baecfc8b1dd960f1f73127de519856d 100644 (file)
@@ -49,9 +49,9 @@ typedef struct _GESTimelineTransitionPrivate GESTimelineTransitionPrivate;
  * GESTimelineTransition:
  * @vtype: a #GESVideoTransitionType indicating the type of video transition
  * to apply.
- *
  */
 struct _GESTimelineTransition {
+  /*< private >*/
   GESTimelineObject parent;
 
   /*< public >*/
@@ -66,14 +66,13 @@ struct _GESTimelineTransition {
 
 /**
  * GESTimelineTransitionClass:
- * @parent_class: parent class
  *
  */
 
 struct _GESTimelineTransitionClass {
+  /*< private >*/
   GESTimelineObjectClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index 64c153a46537ce445b4ce15f52b0d6bc08f3674e..c0e40c57230ff46f083dd5ca711a2a41608ed20a 100644 (file)
@@ -920,7 +920,8 @@ ges_timeline_get_track_for_pad (GESTimeline * timeline, GstPad * pad)
  * Returns the list of #GESTrack used by the Timeline.
  *
  * Returns: A list of #GESTrack. The caller should unref each track
- * once he is done with them. */
+ * once he is done with them.
+ */
 GList *
 ges_timeline_get_tracks (GESTimeline * timeline)
 {
index 5d6065fa8d02e072e415f170ed004c33a2b56382..da1b49e6f126dfbc5771ea9cc02d57904cd7dbd3 100644 (file)
@@ -46,15 +46,16 @@ G_BEGIN_DECLS
 
 typedef struct _GESTrackAudioTestSourcePrivate GESTrackAudioTestSourcePrivate;
 
-/** 
+
+/**
  * GESTrackAudioTestSource:
  *
  */
 
 struct _GESTrackAudioTestSource {
+  /*< private >*/
   GESTrackSource parent;
 
-  /*< private >*/
   gdouble freq;
   gdouble volume;
 
@@ -64,16 +65,10 @@ struct _GESTrackAudioTestSource {
   gpointer _ges_reserved[GES_PADDING];
 };
 
-/**
- * GESTrackAudioTestSourceClass:
- * @parent_class: parent class
- *
- */
-
 struct _GESTrackAudioTestSourceClass {
+  /*< private >*/
   GESTrackSourceClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index 5098308042804297423eeb663d5ea1b4e649c397..c9c18bc14951d5ad2c50f2c3029423bd494974e4 100644 (file)
@@ -46,7 +46,7 @@ G_BEGIN_DECLS
 
 typedef struct _GESTrackAudioTransitionPrivate GESTrackAudioTransitionPrivate;
 
-/** 
+/**
  * GESTrackAudioTransition:
  *
  */
@@ -69,16 +69,9 @@ struct _GESTrackAudioTransition {
   gpointer _ges_reserved[GES_PADDING];
 };
 
-/**
- * GESTrackAudioTransitionClass:
- * @parent_class: parent class
- *
- */
-
 struct _GESTrackAudioTransitionClass {
   GESTrackTransitionClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index 5192c8bc333288273b3585167fb24f9291b78b17..0bbcda5b361d090ffbaf40c8f5c918128f9d4607 100644 (file)
@@ -46,33 +46,25 @@ G_BEGIN_DECLS
 
 typedef struct _GESTrackFileSourcePrivate GESTrackFileSourcePrivate;
 
-/** 
+/**
  * GESTrackFileSource:
- * @uri: #gchar *, the URI of the media file to play
- *
  */
 struct _GESTrackFileSource {
+  /*< private >*/
   GESTrackSource parent;
 
-  /*< public >*/
   gchar *uri;
 
-  /*< private >*/
   GESTrackFileSourcePrivate *priv;
 
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
 
-/**
- * GESTrackFileSourceClass:
- * @parent_class: parent class
- */
-
 struct _GESTrackFileSourceClass {
+  /*< private >*/
   GESTrackSourceClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index 93ca2f9fb25dc74c226faeb78a788b3bc6d7a47b..65f15fa99e91d53d5b33b5135acb83f696154869 100644 (file)
@@ -46,15 +46,13 @@ G_BEGIN_DECLS
 
 typedef struct _GESTrackImageSourcePrivate GESTrackImageSourcePrivate;
 
-/** 
+/**
  * GESTrackImageSource:
- * @uri: #gchar *, the URI of the media file to play
- *
  */
 struct _GESTrackImageSource {
+  /*< private >*/
   GESTrackSource parent;
 
-  /*< public >*/
   gchar *uri;
 
   GESTrackImageSourcePrivate *priv;
@@ -63,16 +61,9 @@ struct _GESTrackImageSource {
   gpointer _ges_reserved[GES_PADDING];
 };
 
-/**
- * GESTrackImageSourceClass:
- * @parent_class: parent class
- */
-
 struct _GESTrackImageSourceClass {
   GESTrackSourceClass parent_class;
 
-  /* <public> */
-
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index c523af5f66b9fddec692d7406945d94ef2c8ff5a..3429e22c63480dacdc0e636a38eba8e87a081cd2 100644 (file)
@@ -132,7 +132,6 @@ struct _GESTrackObject {
   guint32 pending_gnl_priority;
   gboolean pending_active;
 
-
   GstElement *gnlobject;
 
   GESTrackObjectPrivate *priv;
@@ -143,7 +142,6 @@ struct _GESTrackObject {
 
 /**
  * GESTrackObjectClass:
- * @parent_class: parent class
  * @create_gnl_object: method to create the GNonLin container object.
  * @start_changed: start property of gnlobject has changed
  * @media_start_changed: media-start property of gnlobject has changed
@@ -155,6 +153,7 @@ struct _GESTrackObject {
  * of GNonLin object will be created.
  */ 
 struct _GESTrackObjectClass {
+  /*< private >*/
   GObjectClass parent_class;
 
   /*< public >*/
index 1ef842fb525dffe55fb6956b819ca2438db6dbff..18946f9a1c199ea42dd88f616ec896418d46b0fb 100644 (file)
@@ -49,16 +49,14 @@ typedef struct _GESTrackOperationPrivate GESTrackOperationPrivate;
 
 /**
  * GESTrackOperation:
- * @parent: parent
  *
  * Base class for overlays, transitions, and effects
- *
  */
 
 struct _GESTrackOperation {
+  /*< private >*/
   GESTrackObject parent;
 
-  /*< private >*/
   GstElement *element;
 
   GESTrackOperationPrivate *priv;
@@ -69,14 +67,15 @@ struct _GESTrackOperation {
 
 /**
  * GESTrackOperationClass:
- * @parent_class: the parent class
  * @create_element: virtual method which creates the GStreamer element for
  * this object
  */
 
 struct _GESTrackOperationClass {
+  /*< private >*/
   GESTrackObjectClass parent_class;
 
+  /*< public >*/
   GstElement *(*create_element) (GESTrackOperation *);
 
   /*< private >*/
index 81bc781e89b4b00d5eaa70b8eda7582a29015928..20aa1e20271f4f3e2f88888bfa904b069860ac40 100644 (file)
@@ -49,16 +49,14 @@ typedef struct _GESTrackSourcePrivate GESTrackSourcePrivate;
 
 /**
  * GESTrackSource:
- * @parent: parent
  *
  * Base class for single-media sources
- *
  */
 
 struct _GESTrackSource {
+  /*< private >*/
   GESTrackObject parent;
 
-  /*< private >*/
   GstElement *element;
 
   GESTrackSourcePrivate *priv;
@@ -69,15 +67,16 @@ struct _GESTrackSource {
 
 /**
  * GESTrackSourceClass:
- * @parent_class: the parent class
  * @create_element: virtual method which creates the GStreamer element for
  * this object
  *
  */
 
 struct _GESTrackSourceClass {
+  /*< private >*/
   GESTrackObjectClass parent_class;
 
+  /*< public >*/
   GstElement *(*create_element) (GESTrackSource *);
 
   /*< private >*/
index 9dd8e97f16177c08f3c96a5c41acd9c10d1d8921..cc9c170ecc5c9a5398499ebfa49b16d2c7c651c7 100644 (file)
@@ -47,14 +47,13 @@ G_BEGIN_DECLS
 
 typedef struct _GESTrackTextOverlayPrivate GESTrackTextOverlayPrivate;
 
-/** 
+/**
  * GESTrackTextOverlay:
- *
  */
 struct _GESTrackTextOverlay {
+  /*< private >*/
   GESTrackOperation parent;
 
-  /*< private >*/
   gchar         *text;
   gchar         *font_desc;
   GESTextHAlign halign;
@@ -67,11 +66,6 @@ struct _GESTrackTextOverlay {
   gpointer _ges_reserved[GES_PADDING];
 };
 
-/**
- * GESTrackTextOverlayClass:
- * @parent_class: parent class
- */
-
 struct _GESTrackTextOverlayClass {
   GESTrackOperationClass parent_class;
 
index b95b6816f4e23b675b8feff18972a3cedb586ab9..ea94a24927de427e0bc2049fb00809e00beab571 100644 (file)
@@ -55,16 +55,14 @@ typedef struct _GESTrackTransitionPrivate GESTrackTransitionPrivate;
 /**
  * GESTrackTransition:
  *
- * Track level representation of a transition. Has a concrete implementation
- * for both audio and video streams.
- *
+ * Base class for media transitions.
  */
 
 struct _GESTrackTransition
 {
+  /*< private >*/
   GESTrackObject parent;
 
-  /*< private >*/
   GESTrackTransitionPrivate *priv;
 
   /* Padding for API extension */
@@ -72,11 +70,12 @@ struct _GESTrackTransition
 };
 
 /**
- * GESTrackTransitionClass
- * @parent_class: parent class
+ * GESTrackTransitionClass:
+ * @create_element: return the element that should be controlled by the transition
  */
 
 struct _GESTrackTransitionClass {
+  /*< private >*/
   GESTrackObjectClass parent_class;
   
   /*< public >*/
index e787dd4b145f89c512e2d8ab78589cbb1864115b..b4661361cc6f3779bd3b6de8af0a719f0a467622 100644 (file)
@@ -47,13 +47,13 @@ G_BEGIN_DECLS
 
 typedef struct _GESTrackVideoTestSourcePrivate GESTrackVideoTestSourcePrivate;
 
-/** 
+/**
  * GESTrackVideoTestSource:
  */
 struct _GESTrackVideoTestSource {
+  /*< private >*/
   GESTrackSource parent;
 
-  /*< private >*/
   GESVideoTestPattern pattern;
 
   GESTrackVideoTestSourcePrivate *priv;
@@ -62,15 +62,9 @@ struct _GESTrackVideoTestSource {
   gpointer _ges_reserved[GES_PADDING];
 };
 
-/**
- * GESTrackVideoTestSourceClass:
- * @parent_class: parent class
- */
-
 struct _GESTrackVideoTestSourceClass {
   GESTrackSourceClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };
index 0953d6bed990f335d6c1b64d5a112fe06b0917ae..3ad09ba5c3d7dd36680d0eadea7afba9d853e86f 100644 (file)
@@ -77,13 +77,12 @@ struct _GESTrack {
 
 /**
  * GESTrackClass:
- * @parent_class: parent class
  */
 
 struct _GESTrackClass {
+  /*< private >*/
   GstBinClass parent_class;
 
-  /*< private >*/
   /* Padding for API extension */
   gpointer _ges_reserved[GES_PADDING];
 };