summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Hervey <bilboed@bilboed.com>2010-07-06 10:28:14 +0200
committerEdward Hervey <bilboed@bilboed.com>2010-07-06 11:18:32 +0200
commit27410f3934e2b52de3334eb93b10d729111ba539 (patch)
tree72e69f3bc8a53221e49a6047d3c9c4829b0f1c13
parent7acde37fc10486908e3b685ecd895543beaf8d96 (diff)
gstvalue: Improve gst_value_{set|get}_caps docs
-rw-r--r--gst/gstvalue.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/gst/gstvalue.c b/gst/gstvalue.c
index 5d6739713e..a8d58deb00 100644
--- a/gst/gstvalue.c
+++ b/gst/gstvalue.c
@@ -1341,8 +1341,8 @@ gst_value_deserialize_fraction_range (GValue * dest, const gchar * s)
* @value: a GValue initialized to GST_TYPE_CAPS
* @caps: the caps to set the value to
*
- * Sets the contents of @value to @caps. The actual
- * #GstCaps structure is copied before it is used.
+ * Sets the contents of @value to @caps. A reference to the
+ * provided @caps will be taken by the @value.
*/
void
gst_value_set_caps (GValue * value, const GstCaps * caps)
@@ -1358,7 +1358,9 @@ gst_value_set_caps (GValue * value, const GstCaps * caps)
* gst_value_get_caps:
* @value: a GValue initialized to GST_TYPE_CAPS
*
- * Gets the contents of @value.
+ * Gets the contents of @value. The reference count of the returned
+ * #GstCaps will not be modified, therefore the caller must take one
+ * before getting rid of the @value.
*
* Returns: the contents of @value
*/