From 4cd054dea02008163cfc3190dd3387c57631c791 Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Wed, 1 May 2019 11:53:07 -0400 Subject: [PATCH] title-clip: Enhance documentation --- ges/ges-title-clip.c | 103 +++++++++++++++++++++++-------------------- 1 file changed, 55 insertions(+), 48 deletions(-) diff --git a/ges/ges-title-clip.c b/ges/ges-title-clip.c index f663a227db..d292b48260 100644 --- a/ges/ges-title-clip.c +++ b/ges/ges-title-clip.c @@ -162,8 +162,9 @@ ges_title_clip_class_init (GESTitleClipClass * klass) * * The text to diplay * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties or + * #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ g_object_class_install_property (object_class, PROP_TEXT, g_param_spec_string ("text", "Text", "The text to display", @@ -175,8 +176,9 @@ ges_title_clip_class_init (GESTitleClipClass * klass) * * Pango font description string * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties or + * #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_FONT_DESC, g_param_spec_string ("font-desc", "font description", @@ -191,8 +193,9 @@ ges_title_clip_class_init (GESTitleClipClass * klass) * * Vertical alignent of the text * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties or + * #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_VALIGNMENT, g_param_spec_enum ("valignment", "vertical alignment", @@ -205,8 +208,9 @@ ges_title_clip_class_init (GESTitleClipClass * klass) * * Horizontal alignment of the text * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties or + * #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_HALIGNMENT, g_param_spec_enum ("halignment", "horizontal alignment", @@ -226,8 +230,9 @@ ges_title_clip_class_init (GESTitleClipClass * klass) * * The color of the text * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties or + * #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ g_object_class_install_property (object_class, PROP_COLOR, @@ -240,8 +245,9 @@ ges_title_clip_class_init (GESTitleClipClass * klass) * * The background of the text * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties or + * #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ g_object_class_install_property (object_class, PROP_BACKGROUND, @@ -254,8 +260,9 @@ ges_title_clip_class_init (GESTitleClipClass * klass) * * The horizontal position of the text * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties or + * #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ g_object_class_install_property (object_class, PROP_XPOS, @@ -268,8 +275,9 @@ ges_title_clip_class_init (GESTitleClipClass * klass) * * The vertical position of the text * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties or + * #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ g_object_class_install_property (object_class, PROP_YPOS, @@ -295,8 +303,8 @@ ges_title_clip_init (GESTitleClip * self) * * Sets the text this clip will render. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ void ges_title_clip_set_text (GESTitleClip * self, const gchar * text) @@ -317,8 +325,8 @@ ges_title_clip_set_text (GESTitleClip * self, const gchar * text) * * Sets the pango font description of the text. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ void ges_title_clip_set_font_desc (GESTitleClip * self, const gchar * font_desc) @@ -340,8 +348,8 @@ ges_title_clip_set_font_desc (GESTitleClip * self, const gchar * font_desc) * * Sets the horizontal aligment of the text. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ void ges_title_clip_set_halignment (GESTitleClip * self, GESTextHAlign halign) @@ -363,8 +371,8 @@ ges_title_clip_set_halignment (GESTitleClip * self, GESTextHAlign halign) * * Sets the vertical aligment of the text. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ void ges_title_clip_set_valignment (GESTitleClip * self, GESTextVAlign valign) @@ -386,8 +394,8 @@ ges_title_clip_set_valignment (GESTitleClip * self, GESTextVAlign valign) * * Sets the color of the text. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ void ges_title_clip_set_color (GESTitleClip * self, guint32 color) @@ -408,8 +416,8 @@ ges_title_clip_set_color (GESTitleClip * self, guint32 color) * * Sets the background of the text. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ void ges_title_clip_set_background (GESTitleClip * self, guint32 background) @@ -432,8 +440,8 @@ ges_title_clip_set_background (GESTitleClip * self, guint32 background) * * Sets the horizontal position of the text. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ void ges_title_clip_set_xpos (GESTitleClip * self, gdouble position) @@ -454,8 +462,8 @@ ges_title_clip_set_xpos (GESTitleClip * self, gdouble position) * * Sets the vertical position of the text. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_set_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ void ges_title_clip_set_ypos (GESTitleClip * self, gdouble position) @@ -477,8 +485,8 @@ ges_title_clip_set_ypos (GESTitleClip * self, gdouble position) * * Returns: The text currently set on @self. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ const gchar * ges_title_clip_get_text (GESTitleClip * self) @@ -499,8 +507,8 @@ ges_title_clip_get_text (GESTitleClip * self) * * Returns: The pango font description used by @self. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ const char * ges_title_clip_get_font_desc (GESTitleClip * self) @@ -521,8 +529,8 @@ ges_title_clip_get_font_desc (GESTitleClip * self) * * Returns: The horizontal aligment used by @self. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ GESTextHAlign ges_title_clip_get_halignment (GESTitleClip * self) @@ -543,8 +551,8 @@ ges_title_clip_get_halignment (GESTitleClip * self) * * Returns: The vertical aligment used by @self. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ GESTextVAlign ges_title_clip_get_valignment (GESTitleClip * self) @@ -565,8 +573,8 @@ ges_title_clip_get_valignment (GESTitleClip * self) * * Returns: The color used by @self. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ const guint32 ges_title_clip_get_text_color (GESTitleClip * self) @@ -587,8 +595,8 @@ ges_title_clip_get_text_color (GESTitleClip * self) * * Returns: The color used by @self. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ const guint32 ges_title_clip_get_background_color (GESTitleClip * self) @@ -609,8 +617,8 @@ ges_title_clip_get_background_color (GESTitleClip * self) * * Returns: The horizontal position used by @self. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_get_children_properties instead. + * See #GESTitleSource for more information about exposed properties */ const gdouble ges_title_clip_get_xpos (GESTitleClip * self) @@ -631,8 +639,7 @@ ges_title_clip_get_xpos (GESTitleClip * self) * * Returns: The vertical position used by @self. * - * Deprecated: use ges_track_element_get/set_children_properties on the - * underlying GESTrackElement instead + * Deprecated:1.6: use #ges_timeline_element_get_children_property instead */ const gdouble ges_title_clip_get_ypos (GESTitleClip * self)