libs/gst/controller/gstcontroller.c: Clarify docs: The get_all, get_value_array(s...
authorSebastian Dröge <slomo@circular-chaos.org>
Wed, 6 Jun 2007 14:20:01 +0000 (14:20 +0000)
committerSebastian Dröge <slomo@circular-chaos.org>
Wed, 6 Jun 2007 14:20:01 +0000 (14:20 +0000)
Original commit message from CVS:
* libs/gst/controller/gstcontroller.c:
Clarify docs: The get_all, get_value_array(s) functions
don't modify the GObject properties.

ChangeLog
libs/gst/controller/gstcontroller.c

index a45286d..f810346 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,12 @@
 2007-06-06  Sebastian Dröge  <slomo@circular-chaos.org>
 
        * libs/gst/controller/gstcontroller.c:
+       Clarify docs: The get_all, get_value_array(s) functions
+       don't modify the GObject properties.
+
+2007-06-06  Sebastian Dröge  <slomo@circular-chaos.org>
+
+       * libs/gst/controller/gstcontroller.c:
        (gst_controlled_property_set_interpolation_mode),
        (gst_controlled_property_prepend_default),
        (gst_controlled_property_new), (gst_controller_set_unlocked),
index d2b5008..8024696 100644 (file)
@@ -982,6 +982,8 @@ gst_controller_get (GstController * self, gchar * property_name,
  * Returns a read-only copy of the list of GstTimedValue for the given property.
  * Free the list after done with it.
  *
+ * <note><para>This doesn't modify the controlled GObject property!</para></note>
+ *
  * Returns: a copy of the list, or %NULL if the property isn't handled by the controller
  */
 const GList *
@@ -1118,6 +1120,8 @@ gst_controller_sync_values (GstController * self, GstClockTime timestamp)
  *
  * The types of the values in the array are the same as the property's type.
  *
+ * <note><para>This doesn't modify the controlled GObject properties!</para></note>
+ *
  * Returns: %TRUE if the given array(s) could be filled, %FALSE otherwise
  */
 gboolean
@@ -1151,6 +1155,8 @@ gst_controller_get_value_arrays (GstController * self,
  * of values.
  *
  * The type of the values in the array is the same as the property's type.
+ *  
+ * <note><para>This doesn't modify the controlled GObject property!</para></note>
  *
  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
  */