docs: fix some more docs
authorWim Taymans <wim.taymans@collabora.co.uk>
Wed, 28 Sep 2011 09:16:33 +0000 (11:16 +0200)
committerWim Taymans <wim.taymans@collabora.co.uk>
Wed, 28 Sep 2011 09:16:33 +0000 (11:16 +0200)
docs/libs/gstreamer-libs-sections.txt
libs/gst/base/gstbasesrc.c
libs/gst/base/gstbasesrc.h
libs/gst/base/gstbasetransform.h

index 29f4fcd..1e9e968 100644 (file)
@@ -280,7 +280,7 @@ gst_base_src_get_do_timestamp
 gst_base_src_set_do_timestamp
 gst_base_src_set_dynamic_size
 gst_base_src_new_seamless_segment
-gst_base_src_set_dynamic_size
+gst_base_src_set_caps
 
 GST_BASE_SRC_PAD
 <SUBSECTION Standard>
index d59de0f..84fe263 100644 (file)
@@ -787,7 +787,7 @@ gst_base_src_new_seamless_segment (GstBaseSrc * src, gint64 start, gint64 stop,
 
 /**
  * gst_base_src_set_caps:
- * @bsrc: a #GstBaseSrc
+ * @src: a #GstBaseSrc
  * @caps: a #GstCaps
  *
  * Set new caps on the basesrc source pad.
@@ -795,17 +795,17 @@ gst_base_src_new_seamless_segment (GstBaseSrc * src, gint64 start, gint64 stop,
  * Returns: %TRUE if the caps could be set
  */
 gboolean
-gst_base_src_set_caps (GstBaseSrc * bsrc, GstCaps * caps)
+gst_base_src_set_caps (GstBaseSrc * src, GstCaps * caps)
 {
   GstBaseSrcClass *bclass;
   gboolean res = TRUE;
 
-  bclass = GST_BASE_SRC_GET_CLASS (bsrc);
+  bclass = GST_BASE_SRC_GET_CLASS (src);
 
-  gst_pad_push_event (bsrc->srcpad, gst_event_new_caps (caps));
+  gst_pad_push_event (src->srcpad, gst_event_new_caps (caps));
 
   if (bclass->set_caps)
-    res = bclass->set_caps (bsrc, caps);
+    res = bclass->set_caps (src, caps);
 
   return res;
 }
index 9466d7d..0624096 100644 (file)
@@ -143,8 +143,10 @@ struct _GstBaseSrc {
  *   requested size unless fewer bytes are available because an EOS condition
  *   is near. No buffer should be returned when the return value is different
  *   from GST_FLOW_OK. A return value of GST_FLOW_UNEXPECTED signifies that the
- *   end of stream is reached. The default implementation will create a new
- *   buffer from the negotiated allocator and will call @fill.
+ *   end of stream is reached. The default implementation will call @alloc and
+ *   then call @fill.
+ * @alloc: Ask the subclass to allocate a buffer with for offset and size. The
+ *   default implementation will create a new buffer from the negotiated allocator.
  * @fill: Ask the subclass to fill the buffer with data for offset and size. The
  *   passed buffer is guaranteed to hold the requested amount of bytes.
  *
index af72eb0..16eed7a 100644 (file)
@@ -158,11 +158,10 @@ struct _GstBaseTransform {
  *                  Handle a requested query. Subclasses that implement this
  *                  should must chain up to the parent if they didn't handle the
  *                  query
- * @decide_allocation: Decide what parameters you want upstream elements to use
- *                     for the allocation of buffers. This function is only
- *                     called when not operating in passthrough mode. The
- *                     default implementation is NULL.
- * @setup_allocation: Setup the allocation parameters for allocating output
+ * @propose_allocation: Propose buffer allocation parameters for upstream elements.
+ *                      This function is only called when not operating in
+ *                      passthrough mode. The default implementation is NULL.
+ * @decide_allocation: Setup the allocation parameters for allocating output
  *                    buffers. The passed in query contains the result of the
  *                    downstream allocation query. This function is only called
  *                    when not operating in passthrough mode. The default