adapter: fix docs for 1.0
authorWim Taymans <wim.taymans@collabora.co.uk>
Wed, 5 Dec 2012 13:03:27 +0000 (14:03 +0100)
committerWim Taymans <wim.taymans@collabora.co.uk>
Wed, 5 Dec 2012 13:03:27 +0000 (14:03 +0100)
Add parent to chain function signature and use it.

libs/gst/base/gstadapter.c

index c9b0e83..73d009b 100644 (file)
  * in 512-byte chunks could be implemented like this:
  * |[
  * static GstFlowReturn
- * sink_pad_chain (GstPad *pad, GstBuffer *buffer)
+ * sink_pad_chain (GstPad *pad, GstObject *parent, GstBuffer *buffer)
  * {
  *   MyElement *this;
  *   GstAdapter *adapter;
  *   GstFlowReturn ret = GST_FLOW_OK;
  *
- *   // will give the element an extra ref; remember to drop it
- *   this = MY_ELEMENT (gst_pad_get_parent (pad));
+ *   this = MY_ELEMENT (parent);
+ *
  *   adapter = this->adapter;
  *
  *   // put buffer into adapter
  *   gst_adapter_push (adapter, buffer);
+ *
  *   // while we can read out 512 bytes, process them
  *   while (gst_adapter_available (adapter) >= 512 && ret == GST_FLOW_OK) {
  *     const guint8 *data = gst_adapter_map (adapter, 512);
@@ -65,8 +66,6 @@
  *     gst_adapter_unmap (adapter);
  *     gst_adapter_flush (adapter, 512);
  *   }
- *
- *   gst_object_unref (this);
  *   return ret;
  * }
  * ]|