From faec1e803d6a7c058591ece58c7d2e561eee5e24 Mon Sep 17 00:00:00 2001 From: Edward Hervey Date: Wed, 8 Dec 2010 15:36:55 +0100 Subject: [PATCH] docs: A round of updates --- docs/libs/ges-sections.txt | 44 +++++++++++++++++-------------- ges/ges-custom-timeline-source.h | 3 +-- ges/ges-formatter.c | 2 +- ges/ges-keyfile-formatter.h | 9 ++----- ges/ges-simple-timeline-layer.c | 8 +++--- ges/ges-simple-timeline-layer.h | 13 +++------ ges/ges-timeline-file-source.h | 6 ++--- ges/ges-timeline-layer.h | 2 +- ges/ges-timeline-object.h | 7 ++--- ges/ges-timeline-overlay.h | 4 +-- ges/ges-timeline-pipeline.c | 2 +- ges/ges-timeline-pipeline.h | 4 +-- ges/ges-timeline-source.h | 4 +-- ges/ges-timeline-test-source.h | 5 ++-- ges/ges-timeline-text-overlay.h | 7 +++-- ges/ges-timeline-title-source.h | 12 +++------ ges/ges-timeline-transition.h | 5 ++-- ges/ges-timeline.c | 3 ++- ges/ges-track-audio-test-source.h | 13 +++------ ges/ges-track-audio-transition.h | 9 +------ ges/ges-track-filesource.h | 14 +++------- ges/ges-track-image-source.h | 13 ++------- ges/ges-track-object.h | 3 +-- ges/ges-track-operation.h | 7 +++-- ges/ges-track-source.h | 7 +++-- ges/ges-track-text-overlay.h | 10 ++----- ges/ges-track-transition.h | 11 ++++---- ges/ges-track-video-test-source.h | 10 ++----- ges/ges-track.h | 3 +-- 29 files changed, 87 insertions(+), 153 deletions(-) diff --git a/docs/libs/ges-sections.txt b/docs/libs/ges-sections.txt index f10fc39146..10c5b051c8 100644 --- a/docs/libs/ges-sections.txt +++ b/docs/libs/ges-sections.txt @@ -4,6 +4,8 @@ ges-common Initialization ges_init + +GES_PADDING
@@ -39,7 +41,6 @@ ges_video_transition_type_get_type ges-track GESTrack 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 +GESTrackClass GESTrackPrivate ges_track_set_timeline ges_track_get_type @@ -125,9 +127,9 @@ GES_TYPE_TRACK_OPERATION ges-track-filesource GESTrackFileSource GESTrackFileSource -GESTrackFileSourceClass ges_track_filesource_new +GESTrackFileSourceClass GESTrackFileSourcePrivate GES_TRACK_FILESOURCE GES_TRACK_FILESOURCE_CLASS @@ -142,7 +144,7 @@ ges_track_filesource_get_type ges-track-image-source GESTrackImageSource GESTrackImageSource -GESTrackImageSourceClass +ges_track_image_source_new 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
@@ -175,9 +177,9 @@ ges_track_transition_get_type ges-track-audio-transition GESTrackAudioTransition GESTrackAudioTransition -GESTrackAudioTransitionClass ges_track_audio_transition_new +GESTrackAudioTransitionClass GESTrackAudioTransitionPrivate GES_IS_TRACK_AUDIO_TRANSITION ges_track_audio_transition_get_type @@ -192,10 +194,10 @@ GES_TYPE_TRACK_AUDIO_TRANSITION ges-track-video-transition GESTrackVideoTransition GESTrackVideoTransition -GESTrackVideoTransitionClass ges_track_video_transition_new ges_track_video_transition_set_type +GESTrackVideoTransitionClass GESTrackVideoTransitionPrivate ges_track_video_transition_get_type GES_IS_TRACK_VIDEO_TRANSITION @@ -210,7 +212,6 @@ GES_TYPE_TRACK_VIDEO_TRANSITION ges-timeline GESTimeline 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 + ges_timeline_get_tracks +ges_timeline_get_track_for_pad +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 ges-timeline-pipeline GESTimelinePipeline 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 +GESTimelinePipelineClass +GESTimelinePipelinePrivate ges_play_sink_convert_frame ges_timeline_pipeline_get_type GES_TIMELINE_PIPELINE @@ -339,9 +344,9 @@ GES_TYPE_TIMELINE_SOURCE ges-timeline-filesource GESTimelineFileSource GESTimelineFileSource -GESTimelineFileSourceClass ges_timeline_filesource_new +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 ges-custom-timeline-source GESCustomTimelineSource GESCustomTimelineSource -GESCustomTimelineSourceClass FillTrackObjectUserFunc ges_custom_timeline_source_new +GESCustomTimelineSourceClass ges_cust_timeline_src_get_type GESCustomTimelineSourcePrivate GES_CUSTOM_TIMELINE_SOURCE @@ -408,12 +413,12 @@ GES_TYPE_CUSTOM_TIMELINE_SOURCE ges-simple-timeline-layer GESSimpleTimelineLayer 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 +GESSimpleTimelineLayerClass ges_simple_timeline_layer_get_type GESSimpleTimelineLayerPrivate GES_IS_SIMPLE_TIMELINE_LAYER @@ -446,9 +451,9 @@ GES_TIMELINE_TEST_SOURCE_GET_CLASS ges-timeline-title-source GESTimelineTitleSource GESTimelineTitleSource -GESTimelineTitleSourceClass ges_timeline_title_source_new +GESTimelineTitleSourceClass GESTimelineTitleSourcePrivate ges_tl_title_src_get_type GES_IS_TIMELINE_TITLE_SOURCE @@ -462,9 +467,9 @@ GES_TIMELINE_TITLE_SOURCE_GET_CLASS ges-timeline-text-overlay GESTimelineTextOverlay GESTimelineTextOverlay -GESTimelineTextOverlayClass ges_timeline_text_overlay_new +GESTimelineTextOverlayClass GESTimelineTextOverlayPrivate ges_tl_text_overlay_get_type GES_IS_TIMELINE_TEXT_OVERLAY @@ -479,10 +484,10 @@ GES_TYPE_TIMELINE_TEXT_OVERLAY ges-track-video-test-source GESTrackVideoTestSource GESTrackVideoTestSource -GESTrackVideoTestSourceClass ges_track_video_test_source_new ges_track_video_test_source_set_pattern +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 ges-track-audio-test-source GESTrackAudioTestSource GESTrackAudioTestSource -GESTrackAudioTestSourceClass ges_track_audio_test_source_new ges_track_audio_test_source_set_freq ges_track_audio_test_source_set_volume +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 ges-track-title-source GESTrackTitleSource 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 +GESTrackTitleSourceClass GESTrackTitleSourcePrivate ges_track_title_src_get_type GES_TRACK_TITLE_SOURCE @@ -539,13 +543,13 @@ GES_IS_TRACK_TITLE_SOURCE_CLASS ges-track-text-overlay GESTrackTextOverlay 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 +GESTrackTextOverlayClass GESTrackTextOverlayPrivate ges_track_text_overlay_get_type GES_IS_TRACK_TEXT_OVERLAY @@ -593,9 +597,9 @@ GESFormatterSaveMethod ges-keyfile-formatter GESKeyFileFormatter GESKeyfileFormatter -GESKeyfileFormatterClass ges_keyfile_formatter_new +GESKeyfileFormatterClass GES_IS_KEYFILE_FORMATTER GES_IS_KEYFILE_FORMATTER_CLASS GES_KEYFILE_FORMATTER diff --git a/ges/ges-custom-timeline-source.h b/ges/ges-custom-timeline-source.h index fff1c1b3eb..1a34b91f91 100644 --- a/ges/ges-custom-timeline-source.h +++ b/ges/ges-custom-timeline-source.h @@ -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 { diff --git a/ges/ges-formatter.c b/ges/ges-formatter.c index 955d73a606..d3716b396f 100644 --- a/ges/ges-formatter.c +++ b/ges/ges-formatter.c @@ -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 */ diff --git a/ges/ges-keyfile-formatter.h b/ges/ges-keyfile-formatter.h index 96d4d98d76..0e18d89824 100644 --- a/ges/ges-keyfile-formatter.h +++ b/ges/ges-keyfile-formatter.h @@ -48,22 +48,17 @@ */ 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]; }; diff --git a/ges/ges-simple-timeline-layer.c b/ges/ges-simple-timeline-layer.c index f81029633d..9f5c1f9cb5 100644 --- a/ges/ges-simple-timeline-layer.c +++ b/ges/ges-simple-timeline-layer.c @@ -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) diff --git a/ges/ges-simple-timeline-layer.h b/ges/ges-simple-timeline-layer.h index fc79bb12f4..2725616466 100644 --- a/ges/ges-simple-timeline-layer.h +++ b/ges/ges-simple-timeline-layer.h @@ -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]; diff --git a/ges/ges-timeline-file-source.h b/ges/ges-timeline-file-source.h index a5afd18671..6cd1360279 100644 --- a/ges/ges-timeline-file-source.h +++ b/ges/ges-timeline-file-source.h @@ -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]; diff --git a/ges/ges-timeline-layer.h b/ges/ges-timeline-layer.h index b527ffbf8e..a9bbbc1b95 100644 --- a/ges/ges-timeline-layer.h +++ b/ges/ges-timeline-layer.h @@ -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 >*/ diff --git a/ges/ges-timeline-object.h b/ges/ges-timeline-object.h index d7cae73ab1..5af4ea093a 100644 --- a/ges/ges-timeline-object.h +++ b/ges/ges-timeline-object.h @@ -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 >*/ diff --git a/ges/ges-timeline-overlay.h b/ges/ges-timeline-overlay.h index 11387ced09..1db3d720c4 100644 --- a/ges/ges-timeline-overlay.h +++ b/ges/ges-timeline-overlay.h @@ -51,10 +51,10 @@ typedef struct _GESTimelineOverlayPrivate GESTimelineOverlayPrivate; */ struct _GESTimelineOverlay { - GESTimelineObject parent; - /*< private >*/ + GESTimelineObject parent; + GESTimelineOverlayPrivate *priv; /* Padding for API extension */ diff --git a/ges/ges-timeline-pipeline.c b/ges/ges-timeline-pipeline.c index 0e753e84d4..d2e6032f52 100644 --- a/ges/ges-timeline-pipeline.c +++ b/ges/ges-timeline-pipeline.c @@ -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. diff --git a/ges/ges-timeline-pipeline.h b/ges/ges-timeline-pipeline.h index c9017fb5ba..c710ea7b8a 100644 --- a/ges/ges-timeline-pipeline.h +++ b/ges/ges-timeline-pipeline.h @@ -70,9 +70,9 @@ typedef enum { */ struct _GESTimelinePipeline { + /*< private >*/ GstPipeline parent; - /* */ 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]; }; diff --git a/ges/ges-timeline-source.h b/ges/ges-timeline-source.h index 51102fc31e..37e1fabecb 100644 --- a/ges/ges-timeline-source.h +++ b/ges/ges-timeline-source.h @@ -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]; }; diff --git a/ges/ges-timeline-test-source.h b/ges/ges-timeline-test-source.h index 5b1bf8641b..3404a2846f 100644 --- a/ges/ges-timeline-test-source.h +++ b/ges/ges-timeline-test-source.h @@ -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]; }; diff --git a/ges/ges-timeline-text-overlay.h b/ges/ges-timeline-text-overlay.h index 1fbee557f2..24dacf0939 100644 --- a/ges/ges-timeline-text-overlay.h +++ b/ges/ges-timeline-text-overlay.h @@ -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]; diff --git a/ges/ges-timeline-title-source.h b/ges/ges-timeline-title-source.h index fa086d0862..04c02aa597 100644 --- a/ges/ges-timeline-title-source.h +++ b/ges/ges-timeline-title-source.h @@ -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]; }; diff --git a/ges/ges-timeline-transition.h b/ges/ges-timeline-transition.h index 6006da9746..6e42f4b84b 100644 --- a/ges/ges-timeline-transition.h +++ b/ges/ges-timeline-transition.h @@ -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]; }; diff --git a/ges/ges-timeline.c b/ges/ges-timeline.c index 64c153a465..c0e40c5723 100644 --- a/ges/ges-timeline.c +++ b/ges/ges-timeline.c @@ -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) { diff --git a/ges/ges-track-audio-test-source.h b/ges/ges-track-audio-test-source.h index 5d6065fa8d..da1b49e6f1 100644 --- a/ges/ges-track-audio-test-source.h +++ b/ges/ges-track-audio-test-source.h @@ -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]; }; diff --git a/ges/ges-track-audio-transition.h b/ges/ges-track-audio-transition.h index 5098308042..c9c18bc149 100644 --- a/ges/ges-track-audio-transition.h +++ b/ges/ges-track-audio-transition.h @@ -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]; }; diff --git a/ges/ges-track-filesource.h b/ges/ges-track-filesource.h index 5192c8bc33..0bbcda5b36 100644 --- a/ges/ges-track-filesource.h +++ b/ges/ges-track-filesource.h @@ -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]; }; diff --git a/ges/ges-track-image-source.h b/ges/ges-track-image-source.h index 93ca2f9fb2..65f15fa99e 100644 --- a/ges/ges-track-image-source.h +++ b/ges/ges-track-image-source.h @@ -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; - /* */ - /* Padding for API extension */ gpointer _ges_reserved[GES_PADDING]; }; diff --git a/ges/ges-track-object.h b/ges/ges-track-object.h index c523af5f66..3429e22c63 100644 --- a/ges/ges-track-object.h +++ b/ges/ges-track-object.h @@ -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 >*/ diff --git a/ges/ges-track-operation.h b/ges/ges-track-operation.h index 1ef842fb52..18946f9a1c 100644 --- a/ges/ges-track-operation.h +++ b/ges/ges-track-operation.h @@ -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 >*/ diff --git a/ges/ges-track-source.h b/ges/ges-track-source.h index 81bc781e89..20aa1e2027 100644 --- a/ges/ges-track-source.h +++ b/ges/ges-track-source.h @@ -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 >*/ diff --git a/ges/ges-track-text-overlay.h b/ges/ges-track-text-overlay.h index 9dd8e97f16..cc9c170ecc 100644 --- a/ges/ges-track-text-overlay.h +++ b/ges/ges-track-text-overlay.h @@ -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; diff --git a/ges/ges-track-transition.h b/ges/ges-track-transition.h index b95b6816f4..ea94a24927 100644 --- a/ges/ges-track-transition.h +++ b/ges/ges-track-transition.h @@ -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 >*/ diff --git a/ges/ges-track-video-test-source.h b/ges/ges-track-video-test-source.h index e787dd4b14..b4661361cc 100644 --- a/ges/ges-track-video-test-source.h +++ b/ges/ges-track-video-test-source.h @@ -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]; }; diff --git a/ges/ges-track.h b/ges/ges-track.h index 0953d6bed9..3ad09ba5c3 100644 --- a/ges/ges-track.h +++ b/ges/ges-track.h @@ -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]; };