[gst-cvs] gstreamer: staticpadtemplate: Update docs of gst_static_pad_template_get_caps ()

[Sebastian Dröge]

Module: gstreamer
Branch: master
Commit: 484c3272c46d78ad4920ac54b3197b9f1eb3eeb0
URL:    http://cgit.freedesktop.org/gstreamer/gstreamer/commit/?id=484c3272c46d78ad4920ac54b3197b9f1eb3eeb0

Author: Sebastian Dröge <sebastian.droege at collabora.co.uk>
Date:   Wed Apr 15 13:05:16 2009 +0200

staticpadtemplate: Update docs of gst_static_pad_template_get_caps ()

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 |    6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/gst/gstpadtemplate.c b/gst/gstpadtemplate.c
index 2d74148..53c51bc 100644
--- a/gst/gstpadtemplate.c
+++ b/gst/gstpadtemplate.c
@@ -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)