From 4e2d045ed2a1862daeec406f1641357867cccdd1 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Fri, 5 Aug 2005 17:28:30 +0000 Subject: [PATCH] adding more entries to the docs and fix small doc-bugs Original commit message from CVS: adding more entries to the docs and fix small doc-bugs --- ChangeLog | 8 ++++++++ common | 2 +- docs/libs/gstreamer-libs-sections.txt | 2 ++ libs/gst/controller/gst-controller.c | 6 +++--- libs/gst/controller/gst-controller.h | 13 +++++++++---- libs/gst/controller/gst-helper.c | 9 ++++----- libs/gst/controller/gstcontroller.c | 6 +++--- libs/gst/controller/gstcontroller.h | 13 +++++++++---- libs/gst/controller/gsthelper.c | 9 ++++----- 9 files changed, 43 insertions(+), 25 deletions(-) diff --git a/ChangeLog b/ChangeLog index a06a8fc287..e978fdf9ef 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2005-08-05 Stefan Kost + + * docs/libs/gstreamer-libs-sections.txt: + * libs/gst/controller/gst-controller.c: + * libs/gst/controller/gst-controller.h: + * libs/gst/controller/gst-helper.c: + adding more entries to the docs and fix small doc-bugs + 2005-08-05 Stefan Kost * docs/gst/gstreamer-docs.sgml: diff --git a/common b/common index 694de4dbf4..c99f9050f2 160000 --- a/common +++ b/common @@ -1 +1 @@ -Subproject commit 694de4dbf4827f372321f0634643a254d7edd986 +Subproject commit c99f9050f296219783c6717efe319dc741d2e2d3 diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt index 411100791b..ce2deeda57 100644 --- a/docs/libs/gstreamer-libs-sections.txt +++ b/docs/libs/gstreamer-libs-sections.txt @@ -116,6 +116,8 @@ gst_dp_validate_packet GstController libs/controller/gstcontroller.h GstController +GstValueArray +GstInterpolateMode gst_controller_init gst_controller_new gst_controller_new_valist diff --git a/libs/gst/controller/gst-controller.c b/libs/gst/controller/gst-controller.c index 46d9459a80..e6be06327c 100644 --- a/libs/gst/controller/gst-controller.c +++ b/libs/gst/controller/gst-controller.c @@ -637,7 +637,7 @@ gst_controller_unset (GstController * self, gchar * property_name, * gst_controller_get: * @self: the controller object which handles the properties * @property_name: the name of the property to get - * timestamp: the time the control-change should be read from + * @timestamp: the time the control-change should be read from * * Gets the value for the given controller-handled property at the requested * time. @@ -841,8 +841,8 @@ gst_controller_get_value_array (GstController * self, GstClockTime timestamp, /** * gst_controller_set_interpolation_mode: - * @controller: - * @property_name: + * @self: the controller object + * @property_name: the name of the property for which to change the interpolation * @mode: interpolation mode * * Sets the given interpolation mode on the given property. diff --git a/libs/gst/controller/gst-controller.h b/libs/gst/controller/gst-controller.h index d672f2d882..89297f50b5 100644 --- a/libs/gst/controller/gst-controller.h +++ b/libs/gst/controller/gst-controller.h @@ -61,15 +61,20 @@ typedef struct _GstTimedValue /** * GstValueArray: + * @property_name: the name of the property this array belongs to + * @nbsamples: number of samples requested + * @sample_interval: interval between each sample + * @values: pointer to the array * - * Structure to receive multiple values at once + * Structure to receive multiple values at once. + * If the pointer to the values array is NULL, it will be allocated (CHECKME). */ typedef struct _GstValueArray { gchar *property_name; - gint nbsamples; // Number of samples requested - GstClockTime sample_interval; // Interval between each sample - gpointer *values; // pointer to the array (so it can be filled if NULL) + gint nbsamples; + GstClockTime sample_interval; + gpointer *values; } GstValueArray; diff --git a/libs/gst/controller/gst-helper.c b/libs/gst/controller/gst-helper.c index 3a1a79d707..bca4f5d0f6 100644 --- a/libs/gst/controller/gst-helper.c +++ b/libs/gst/controller/gst-helper.c @@ -39,7 +39,7 @@ extern GQuark controller_key; /** * gst_object_control_properties: * @object: the object of which some properties should be controlled - * @var_args: %NULL terminated list of property names that should be controlled + * @...: %NULL terminated list of property names that should be controlled * * Convenience function for GObject * @@ -68,7 +68,7 @@ gst_object_control_properties (GObject * object, ...) /** * gst_object_uncontrol_properties: * @object: the object of which some properties should not be controlled anymore - * @var_args: %NULL terminated list of property names that should be controlled + * @...: %NULL terminated list of property names that should be controlled * * Convenience function for GObject * @@ -99,8 +99,7 @@ gst_object_uncontrol_properties (GObject * object, ...) * gst_object_get_controller: * @object: the object that has controlled properties * - * Returns: the controller handling some of the given element's properties, - * %NULL if no controller + * Returns: the controller handling some of the given element's properties, %NULL if no controller */ GstController * gst_object_get_controller (GObject * object) @@ -188,7 +187,7 @@ gst_object_get_value_arrays (GObject * object, GstClockTime timestamp, /** * gst_object_get_value_array: - * @self: the object that has controlled properties + * @object: the object that has controlled properties * @timestamp: the time that should be processed * @value_array: array to put control-values in * diff --git a/libs/gst/controller/gstcontroller.c b/libs/gst/controller/gstcontroller.c index 46d9459a80..e6be06327c 100644 --- a/libs/gst/controller/gstcontroller.c +++ b/libs/gst/controller/gstcontroller.c @@ -637,7 +637,7 @@ gst_controller_unset (GstController * self, gchar * property_name, * gst_controller_get: * @self: the controller object which handles the properties * @property_name: the name of the property to get - * timestamp: the time the control-change should be read from + * @timestamp: the time the control-change should be read from * * Gets the value for the given controller-handled property at the requested * time. @@ -841,8 +841,8 @@ gst_controller_get_value_array (GstController * self, GstClockTime timestamp, /** * gst_controller_set_interpolation_mode: - * @controller: - * @property_name: + * @self: the controller object + * @property_name: the name of the property for which to change the interpolation * @mode: interpolation mode * * Sets the given interpolation mode on the given property. diff --git a/libs/gst/controller/gstcontroller.h b/libs/gst/controller/gstcontroller.h index d672f2d882..89297f50b5 100644 --- a/libs/gst/controller/gstcontroller.h +++ b/libs/gst/controller/gstcontroller.h @@ -61,15 +61,20 @@ typedef struct _GstTimedValue /** * GstValueArray: + * @property_name: the name of the property this array belongs to + * @nbsamples: number of samples requested + * @sample_interval: interval between each sample + * @values: pointer to the array * - * Structure to receive multiple values at once + * Structure to receive multiple values at once. + * If the pointer to the values array is NULL, it will be allocated (CHECKME). */ typedef struct _GstValueArray { gchar *property_name; - gint nbsamples; // Number of samples requested - GstClockTime sample_interval; // Interval between each sample - gpointer *values; // pointer to the array (so it can be filled if NULL) + gint nbsamples; + GstClockTime sample_interval; + gpointer *values; } GstValueArray; diff --git a/libs/gst/controller/gsthelper.c b/libs/gst/controller/gsthelper.c index 3a1a79d707..bca4f5d0f6 100644 --- a/libs/gst/controller/gsthelper.c +++ b/libs/gst/controller/gsthelper.c @@ -39,7 +39,7 @@ extern GQuark controller_key; /** * gst_object_control_properties: * @object: the object of which some properties should be controlled - * @var_args: %NULL terminated list of property names that should be controlled + * @...: %NULL terminated list of property names that should be controlled * * Convenience function for GObject * @@ -68,7 +68,7 @@ gst_object_control_properties (GObject * object, ...) /** * gst_object_uncontrol_properties: * @object: the object of which some properties should not be controlled anymore - * @var_args: %NULL terminated list of property names that should be controlled + * @...: %NULL terminated list of property names that should be controlled * * Convenience function for GObject * @@ -99,8 +99,7 @@ gst_object_uncontrol_properties (GObject * object, ...) * gst_object_get_controller: * @object: the object that has controlled properties * - * Returns: the controller handling some of the given element's properties, - * %NULL if no controller + * Returns: the controller handling some of the given element's properties, %NULL if no controller */ GstController * gst_object_get_controller (GObject * object) @@ -188,7 +187,7 @@ gst_object_get_value_arrays (GObject * object, GstClockTime timestamp, /** * gst_object_get_value_array: - * @self: the object that has controlled properties + * @object: the object that has controlled properties * @timestamp: the time that should be processed * @value_array: array to put control-values in *