controller: Add g-i annotations and remove "Since:" markers

2024-07-03 05:05:52 +00:00 · 2011-10-18 13:54:52 +02:00 · 2011-10-18 13:54:52 +02:00 · ef4b00c777
parent 1db50526e7
commit ef4b00c777
3 changed files with 22 additions and 36 deletions
--- a/libs/gst/controller/gstcontroller.c
+++ b/libs/gst/controller/gstcontroller.c
@ -275,10 +275,13 @@ gst_controller_new_valist (GObject * object, va_list var_args)
 /**
 * gst_controller_new_list:
 * @object: the object of which some properties should be controlled
- * @list: list of property names that should be controlled
+ * @list: (transfer none) (element-type utf8): list of property names
+ *   that should be controlled
 *
 * Creates a new GstController for the given object's properties
 *
+ * Rename to: gst_controller_new
+ *
 * Returns: the new controller.
 */
 GstController *
@ -366,10 +369,13 @@ gst_controller_remove_properties_valist (GstController * self, va_list var_args)
 /**
 * gst_controller_remove_properties_list:
 * @self: the controller object from which some properties should be removed
- * @list: #GList of property names that should be removed
+ * @list: (transfer none) (element-type utf8): #GList of property names that
+ *   should be removed
 *
 * Removes the given object properties from the controller
 *
+ * Rename to: gst_controller_remove_properties
+ *
 * Returns: %FALSE if one of the given property isn't handled by the controller, %TRUE otherwise
 */
 gboolean
@ -434,8 +440,6 @@ gst_controller_remove_properties (GstController * self, ...)
 * This function is used to disable the #GstController on a property for
 * some time, i.e. gst_controller_sync_values() will do nothing for the
 * property.
- *
- * Since: 0.10.14
 */

 void
@ -463,8 +467,6 @@ gst_controller_set_property_disabled (GstController * self,
 *
 * This function is used to disable all properties of the #GstController
 * for some time, i.e. gst_controller_sync_values() will do nothing.
- *
- * Since: 0.10.14
 */

 void
@ -494,8 +496,6 @@ gst_controller_set_disabled (GstController * self, gboolean disabled)
 *
 * Returns: %FALSE if the given property isn't handled by the controller or the new #GstControlSource
 * couldn't be bound to the property, %TRUE if everything worked as expected.
- *
- * Since: 0.10.14
 */
 gboolean
 gst_controller_set_control_source (GstController * self,
@ -532,10 +532,9 @@ gst_controller_set_control_source (GstController * self,
 * Gets the corresponding #GstControlSource for the property. This should be unreferenced
 * again after use.
 *
- * Returns: the #GstControlSource for @property_name or NULL if the property is not
- * controlled by this controller or no #GstControlSource was assigned yet.
- *
- * Since: 0.10.14
+ * Returns: (transfer full): the #GstControlSource for @property_name or NULL if
+ * the property is not controlled by this controller or no #GstControlSource was
+ * assigned yet.
 */
 GstControlSource *
 gst_controller_get_control_source (GstController * self,
@ -613,8 +612,6 @@ gst_controller_get (GstController * self, const gchar * property_name,
 *
 * Returns: Returns the suggested timestamp or %GST_CLOCK_TIME_NONE
 * if no control-rate was set.
- *
- * Since: 0.10.13
 */
 GstClockTime
 gst_controller_suggest_next_sync (GstController * self)
--- a/libs/gst/controller/gsthelper.c
+++ b/libs/gst/controller/gsthelper.c
@ -52,9 +52,8 @@ GST_DEBUG_CATEGORY_EXTERN (GST_CAT_DEFAULT);
 * If the given GObject already has a GstController, it adds the given properties to the existing
 * controller and returns that controller.
 *
- * Returns: The GstController with which the user can control the given properties dynamically or NULL if
+ * Returns: (transfer full): The GstController with which the user can control the given properties dynamically or NULL if
 * one or more of the given properties aren't available, or cannot be controlled, for the given element.
- * Since: 0.9
 */
 GstController *
 gst_object_control_properties (GObject * object, ...)
@ -81,7 +80,6 @@ gst_object_control_properties (GObject * object, ...)
 *
 * Returns: %FALSE if one of the given property names isn't handled by the
 * controller, %TRUE otherwise
- * Since: 0.9
 */
 gboolean
 gst_object_uncontrol_properties (GObject * object, ...)
@ -107,8 +105,8 @@ gst_object_uncontrol_properties (GObject * object, ...)
 *
 * Gets the controller for the given GObject
 * 
- * Returns: the controller handling some of the given element's properties, %NULL if no controller
- * Since: 0.9
+ * Returns: (transfer full): the controller handling some of the given element's
+ * properties, %NULL if no controller
 */
 /* FIXME 0.11: This should return a new reference */
 GstController *
@ -122,12 +120,11 @@ gst_object_get_controller (GObject * object)
 /**
 * gst_object_set_controller:
 * @object: the object that should get the controller
- * @controller: the controller object to plug in
+ * @controller: (transfer none): the controller object to plug in
 *
 * Sets the controller on the given GObject
 *
 * Returns: %FALSE if the GObject already has an controller, %TRUE otherwise
- * Since: 0.9
 */
 /* FIXME 0.11: This should increase the refcount before storing */
 gboolean
@ -150,7 +147,6 @@ gst_object_set_controller (GObject * object, GstController * controller)
 * Convenience function for GObject
 *
 * Returns: same thing as gst_controller_suggest_next_sync()
- * Since: 0.10.13
 */
 GstClockTime
 gst_object_suggest_next_sync (GObject * object)
@ -173,7 +169,6 @@ gst_object_suggest_next_sync (GObject * object)
 * Convenience function for GObject
 *
 * Returns: same thing as gst_controller_sync_values()
- * Since: 0.9
 */
 gboolean
 gst_object_sync_values (GObject * object, GstClockTime timestamp)
@ -202,8 +197,6 @@ gst_object_sync_values (GObject * object, GstClockTime timestamp)
 *
 * Returns: %FALSE if the given property isn't handled by the controller or the new #GstControlSource
 * couldn't be bound to the property, %TRUE if everything worked as expected.
- *
- * Since: 0.10.14
 */
 gboolean
 gst_object_set_control_source (GObject * object, const gchar * property_name,
@ -228,10 +221,9 @@ gst_object_set_control_source (GObject * object, const gchar * property_name,
 * Gets the corresponding #GstControlSource for the property. This should be unreferenced
 * again after use.
 *
- * Returns: the #GstControlSource for @property_name or NULL if the property is not
- * controlled by this controller or no #GstControlSource was assigned yet.
- *
- * Since: 0.10.14
+ * Returns: (transfer full): the #GstControlSource for @property_name or NULL if
+ * the property is not controlled by this controller or no #GstControlSource was
+ * assigned yet.
 */
 GstControlSource *
 gst_object_get_control_source (GObject * object, const gchar * property_name)
@ -262,7 +254,6 @@ gst_object_get_control_source (GObject * object, const gchar * property_name)
 * The g_object_* functions are just convenience functions for GObject
 *
 * Returns: %TRUE if the given array(s) could be filled, %FALSE otherwise
- * Since: 0.9
 */
 gboolean
 gst_object_get_value_arrays (GObject * object, GstClockTime timestamp,
@ -293,7 +284,6 @@ gst_object_get_value_arrays (GObject * object, GstClockTime timestamp,
 * The g_object_* functions are just convenience functions for GObject
 *
 * Returns: %TRUE if the given array(s) could be filled, %FALSE otherwise
- * Since: 0.9
 */
 gboolean
 gst_object_get_value_array (GObject * object, GstClockTime timestamp,
@ -326,7 +316,6 @@ gst_object_get_value_array (GObject * object, GstClockTime timestamp,
 * %GST_STATE_PAUSED or %GST_STATE_PLAYING.
 *
 * Returns: the control rate in nanoseconds
- * Since: 0.10.10
 */
 GstClockTime
 gst_object_get_control_rate (GObject * object)
@ -354,8 +343,6 @@ gst_object_get_control_rate (GObject * object)
 *
 * The control-rate should not change if the element is in %GST_STATE_PAUSED or
 * %GST_STATE_PLAYING.
- *
- * Since: 0.10.10
 */
 void
 gst_object_set_control_rate (GObject * object, GstClockTime control_rate)
--- a/libs/gst/controller/gstinterpolationcontrolsource.c
+++ b/libs/gst/controller/gstinterpolationcontrolsource.c
@ -497,7 +497,8 @@ gst_interpolation_control_source_set (GstInterpolationControlSource * self,
 /**
 * gst_interpolation_control_source_set_from_list:
 * @self: the #GstInterpolationControlSource object
- * @timedvalues: a list with #GstTimedValue items
+ * @timedvalues: (transfer none) (element-type GstController.TimedValue): a list
+ * with #GstTimedValue items
 *
 * Sets multiple timed values at once.
 *
@ -616,7 +617,8 @@ _append_control_point (GstControlPoint * cp, GList ** l)
 * Returns a read-only copy of the list of #GstTimedValue for the given property.
 * Free the list after done with it.
 *
- * Returns: a copy of the list, or %NULL if the property isn't handled by the controller
+ * Returns: (transfer container) (element-type GstController.TimedValue): a copy
+ * of the list, or %NULL if the property isn't handled by the controller
 */
 GList *
 gst_interpolation_control_source_get_all (GstInterpolationControlSource * self)