diff --git a/ChangeLog b/ChangeLog index 9f4c93c624..b8a34acd9f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,13 @@ +2005-08-11 Stefan Kost + + * docs/gst/gstreamer-docs.sgml: + * docs/libs/gstreamer-libs-docs.sgml: + added deprecation and since indexes + * libs/gst/controller/gst-controller.c: + * libs/gst/controller/gst-helper.c: + added since tags + + 2005-08-11 Wim Taymans * gst/gstghostpad.c: (gst_proxy_pad_set_target_unlocked), diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index c41abac281..140bfbe74c 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -222,7 +222,16 @@ - API Index + Index + + + Index of deprecated symbols + + + Index of new symbols in 0.8 + + + Index of new symbols in 0.9 diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml index 53f5cd5f86..5089335749 100644 --- a/docs/libs/gstreamer-libs-docs.sgml +++ b/docs/libs/gstreamer-libs-docs.sgml @@ -52,7 +52,16 @@ - API Index + Index + + + Index of deprecated symbols + + + Index of new symbols in 0.8 + + + Index of new symbols in 0.9 diff --git a/libs/gst/controller/gst-controller.c b/libs/gst/controller/gst-controller.c index e6be06327c..2c5374ea2c 100644 --- a/libs/gst/controller/gst-controller.c +++ b/libs/gst/controller/gst-controller.c @@ -371,6 +371,7 @@ gst_controller_find_controlled_property (GstController * self, * Creates a new GstController for the given object's properties * * Returns: the new controller. + * Since: 0.9 */ GstController * gst_controller_new_valist (GObject * object, va_list var_args) @@ -431,6 +432,7 @@ gst_controller_new_valist (GObject * object, va_list var_args) * Creates a new GstController for the given object's properties * * Returns: the new controller. + * Since: 0.9 */ GstController * gst_controller_new (GObject * object, ...) @@ -455,6 +457,7 @@ gst_controller_new (GObject * object, ...) * Removes the given object properties from the controller * * Returns: %FALSE if one of the given property isn't handled by the controller, %TRUE otherwise + * Since: 0.9 */ gboolean gst_controller_remove_properties_valist (GstController * self, va_list var_args) @@ -489,6 +492,7 @@ gst_controller_remove_properties_valist (GstController * self, va_list var_args) * Removes the given object properties from the controller * * Returns: %FALSE if one of the given property isn't handled by the controller, %TRUE otherwise + * Since: 0.9 */ gboolean gst_controller_remove_properties (GstController * self, ...) @@ -515,6 +519,7 @@ gst_controller_remove_properties (GstController * self, ...) * Set the value of given controller-handled property at a certain time. * * Returns: FALSE if the values couldn't be set (ex : properties not handled by controller), TRUE otherwise + * Since: 0.9 */ gboolean gst_controller_set (GstController * self, gchar * property_name, @@ -567,6 +572,7 @@ gst_controller_set (GstController * self, gchar * property_name, * Sets multiple timed values at once. * * Returns: %FALSE if the values couldn't be set (ex : properties not handled by controller), %TRUE otherwise + * Since: 0.9 */ gboolean @@ -611,6 +617,7 @@ gst_controller_set_from_list (GstController * self, gchar * property_name, * time. * * Returns: %FALSE if the values couldn't be unset (ex : properties not handled by controller), %TRUE otherwise + * Since: 0.9 */ gboolean gst_controller_unset (GstController * self, gchar * property_name, @@ -643,8 +650,8 @@ gst_controller_unset (GstController * self, gchar * property_name, * time. * * Returns: the GValue of the property at the given time, or %NULL if the property isn't handled by the controller + * Since: 0.9 */ - GValue * gst_controller_get (GstController * self, gchar * property_name, GstClockTime timestamp) @@ -675,6 +682,7 @@ gst_controller_get (GstController * self, gchar * property_name, * Free the list after done with it. * * Returns: a copy of the list, or %NULL if the property isn't handled by the controller + * Since: 0.9 */ const GList * gst_controller_get_all (GstController * self, gchar * property_name) @@ -704,6 +712,7 @@ gst_controller_get_all (GstController * self, gchar * property_name) * * Returns: %TRUE if the controller values could be applied to the object * properties, %FALSE otherwise + * Since: 0.9 */ gboolean gst_controller_sink_values (GstController * self, GstClockTime timestamp) @@ -775,6 +784,7 @@ gst_controller_sink_values (GstController * self, GstClockTime timestamp) * The type of the values in the array are the same as the property's type. * * Returns: %TRUE if the given array(s) could be filled, %FALSE otherwise + * Since: 0.9 */ gboolean gst_controller_get_value_arrays (GstController * self, @@ -806,6 +816,7 @@ gst_controller_get_value_arrays (GstController * self, * The type of the values in the array are the same as the property's type. * * Returns: %TRUE if the given array(s) could be filled, %FALSE otherwise + * Since: 0.9 */ gboolean gst_controller_get_value_array (GstController * self, GstClockTime timestamp, @@ -848,6 +859,7 @@ gst_controller_get_value_array (GstController * self, GstClockTime timestamp, * Sets the given interpolation mode on the given property. * * Returns: %TRUE if the property is handled by the controller, %FALSE otherwise + * Since: 0.9 */ gboolean gst_controller_set_interpolation_mode (GstController * self, diff --git a/libs/gst/controller/gst-helper.c b/libs/gst/controller/gst-helper.c index bca4f5d0f6..3c7ee19cdb 100644 --- a/libs/gst/controller/gst-helper.c +++ b/libs/gst/controller/gst-helper.c @@ -23,6 +23,7 @@ /** * SECTION:gstcontrollergobject * @short_description: #GObject convinience methods for using dynamic properties + * @see_also: #GstController * * These methods allow to use some #GstController functionallity directly from * the #GObject class. @@ -49,6 +50,7 @@ extern GQuark controller_key; * * Returns: 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, ...) @@ -76,6 +78,7 @@ 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, ...) @@ -100,6 +103,7 @@ gst_object_uncontrol_properties (GObject * object, ...) * @object: the object that has controlled properties * * Returns: the controller handling some of the given element's properties, %NULL if no controller + * Since: 0.9 */ GstController * gst_object_get_controller (GObject * object) @@ -117,6 +121,7 @@ gst_object_get_controller (GObject * object) * Sets the controller on the given GObject * * Returns: %FALSE if the GObject already has an controller, %TRUE otherwise + * Since: 0.9 */ gboolean gst_object_set_controller (GObject * object, GstController * controller) @@ -140,6 +145,7 @@ gst_object_set_controller (GObject * object, GstController * controller) * Convenience function for GObject * * Returns: same thing as gst_controller_sink_values() + * Since: 0.9 */ gboolean gst_object_sink_values (GObject * object, GstClockTime timestamp) @@ -170,6 +176,7 @@ gst_object_sink_values (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_arrays (GObject * object, GstClockTime timestamp, @@ -199,6 +206,7 @@ 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, diff --git a/libs/gst/controller/gstcontroller.c b/libs/gst/controller/gstcontroller.c index e6be06327c..2c5374ea2c 100644 --- a/libs/gst/controller/gstcontroller.c +++ b/libs/gst/controller/gstcontroller.c @@ -371,6 +371,7 @@ gst_controller_find_controlled_property (GstController * self, * Creates a new GstController for the given object's properties * * Returns: the new controller. + * Since: 0.9 */ GstController * gst_controller_new_valist (GObject * object, va_list var_args) @@ -431,6 +432,7 @@ gst_controller_new_valist (GObject * object, va_list var_args) * Creates a new GstController for the given object's properties * * Returns: the new controller. + * Since: 0.9 */ GstController * gst_controller_new (GObject * object, ...) @@ -455,6 +457,7 @@ gst_controller_new (GObject * object, ...) * Removes the given object properties from the controller * * Returns: %FALSE if one of the given property isn't handled by the controller, %TRUE otherwise + * Since: 0.9 */ gboolean gst_controller_remove_properties_valist (GstController * self, va_list var_args) @@ -489,6 +492,7 @@ gst_controller_remove_properties_valist (GstController * self, va_list var_args) * Removes the given object properties from the controller * * Returns: %FALSE if one of the given property isn't handled by the controller, %TRUE otherwise + * Since: 0.9 */ gboolean gst_controller_remove_properties (GstController * self, ...) @@ -515,6 +519,7 @@ gst_controller_remove_properties (GstController * self, ...) * Set the value of given controller-handled property at a certain time. * * Returns: FALSE if the values couldn't be set (ex : properties not handled by controller), TRUE otherwise + * Since: 0.9 */ gboolean gst_controller_set (GstController * self, gchar * property_name, @@ -567,6 +572,7 @@ gst_controller_set (GstController * self, gchar * property_name, * Sets multiple timed values at once. * * Returns: %FALSE if the values couldn't be set (ex : properties not handled by controller), %TRUE otherwise + * Since: 0.9 */ gboolean @@ -611,6 +617,7 @@ gst_controller_set_from_list (GstController * self, gchar * property_name, * time. * * Returns: %FALSE if the values couldn't be unset (ex : properties not handled by controller), %TRUE otherwise + * Since: 0.9 */ gboolean gst_controller_unset (GstController * self, gchar * property_name, @@ -643,8 +650,8 @@ gst_controller_unset (GstController * self, gchar * property_name, * time. * * Returns: the GValue of the property at the given time, or %NULL if the property isn't handled by the controller + * Since: 0.9 */ - GValue * gst_controller_get (GstController * self, gchar * property_name, GstClockTime timestamp) @@ -675,6 +682,7 @@ gst_controller_get (GstController * self, gchar * property_name, * Free the list after done with it. * * Returns: a copy of the list, or %NULL if the property isn't handled by the controller + * Since: 0.9 */ const GList * gst_controller_get_all (GstController * self, gchar * property_name) @@ -704,6 +712,7 @@ gst_controller_get_all (GstController * self, gchar * property_name) * * Returns: %TRUE if the controller values could be applied to the object * properties, %FALSE otherwise + * Since: 0.9 */ gboolean gst_controller_sink_values (GstController * self, GstClockTime timestamp) @@ -775,6 +784,7 @@ gst_controller_sink_values (GstController * self, GstClockTime timestamp) * The type of the values in the array are the same as the property's type. * * Returns: %TRUE if the given array(s) could be filled, %FALSE otherwise + * Since: 0.9 */ gboolean gst_controller_get_value_arrays (GstController * self, @@ -806,6 +816,7 @@ gst_controller_get_value_arrays (GstController * self, * The type of the values in the array are the same as the property's type. * * Returns: %TRUE if the given array(s) could be filled, %FALSE otherwise + * Since: 0.9 */ gboolean gst_controller_get_value_array (GstController * self, GstClockTime timestamp, @@ -848,6 +859,7 @@ gst_controller_get_value_array (GstController * self, GstClockTime timestamp, * Sets the given interpolation mode on the given property. * * Returns: %TRUE if the property is handled by the controller, %FALSE otherwise + * Since: 0.9 */ gboolean gst_controller_set_interpolation_mode (GstController * self, diff --git a/libs/gst/controller/gsthelper.c b/libs/gst/controller/gsthelper.c index bca4f5d0f6..3c7ee19cdb 100644 --- a/libs/gst/controller/gsthelper.c +++ b/libs/gst/controller/gsthelper.c @@ -23,6 +23,7 @@ /** * SECTION:gstcontrollergobject * @short_description: #GObject convinience methods for using dynamic properties + * @see_also: #GstController * * These methods allow to use some #GstController functionallity directly from * the #GObject class. @@ -49,6 +50,7 @@ extern GQuark controller_key; * * Returns: 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, ...) @@ -76,6 +78,7 @@ 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, ...) @@ -100,6 +103,7 @@ gst_object_uncontrol_properties (GObject * object, ...) * @object: the object that has controlled properties * * Returns: the controller handling some of the given element's properties, %NULL if no controller + * Since: 0.9 */ GstController * gst_object_get_controller (GObject * object) @@ -117,6 +121,7 @@ gst_object_get_controller (GObject * object) * Sets the controller on the given GObject * * Returns: %FALSE if the GObject already has an controller, %TRUE otherwise + * Since: 0.9 */ gboolean gst_object_set_controller (GObject * object, GstController * controller) @@ -140,6 +145,7 @@ gst_object_set_controller (GObject * object, GstController * controller) * Convenience function for GObject * * Returns: same thing as gst_controller_sink_values() + * Since: 0.9 */ gboolean gst_object_sink_values (GObject * object, GstClockTime timestamp) @@ -170,6 +176,7 @@ gst_object_sink_values (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_arrays (GObject * object, GstClockTime timestamp, @@ -199,6 +206,7 @@ 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,