staticpadtemplate: Update docs of gst_static_pad_template_get_caps ()
authorSebastian Dröge <sebastian.droege@collabora.co.uk>
Wed, 15 Apr 2009 11:05:16 +0000 (13:05 +0200)
committerSebastian Dröge <sebastian.droege@collabora.co.uk>
Wed, 15 Apr 2009 11:06:13 +0000 (13:06 +0200)
gst_static_pad_template_get_caps () actually returns a reference to the
caps and it's cleaner to unref them after usage. The core will, however,
always hold a reference to the caps so this didn't result in a memory
leak.

gst/gstpadtemplate.c

index 2d74148..53c51bc 100644 (file)
@@ -378,8 +378,10 @@ gst_pad_template_new (const gchar * name_template,
  *
  * Gets the capabilities of the static pad template.
  *
- * Returns: the #GstCaps of the static pad template. If you need to keep a
- * reference to the caps, take a ref (see gst_caps_ref ()).
+ * Returns: the #GstCaps of the static pad template.
+ * Unref after usage. Since the core holds an additional
+ * ref to the returned caps, use gst_caps_make_writable()
+ * on the returned caps to modify it.
  */
 GstCaps *
 gst_static_pad_template_get_caps (GstStaticPadTemplate * templ)