add docs

Original commit message from CVS:
add docs

diff --git a/ChangeLog b/ChangeLog
index 5185348..96508e9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2005-08-25  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+       * gst/base/gstbasetransform.h:
+         comment
+       * gst/gstpad.c:
+         add to docs
+
 2005-08-25  Wim Taymans  <wim@fluendo.com>
 
        * gst/gstbin.c: (bin_bus_handler):

diff --git a/gst/base/gstbasetransform.h b/gst/base/gstbasetransform.h
index 5c8f853..6034bb5 100644 (file)
--- a/gst/base/gstbasetransform.h
+++ b/gst/base/gstbasetransform.h
@@ -109,7 +109,9 @@ struct _GstBaseTransformClass {
   gboolean      (*event)        (GstBaseTransform *trans, GstEvent *event);
 
   /* transform one incoming buffer to one outgoing buffer.
-   * Always needs to be implemented. */
+   * Always needs to be implemented.
+   * transform function is allowed to change size/timestamp/duration of
+   * the outgoing buffer. */
   GstFlowReturn (*transform)    (GstBaseTransform *trans, GstBuffer *inbuf,
                                  GstBuffer *outbuf);
 

diff --git a/gst/gstpad.c b/gst/gstpad.c
index 21ce573..5b7f847 100644 (file)
--- a/gst/gstpad.c
+++ b/gst/gstpad.c
@@ -1730,10 +1730,14 @@ done:
  * gst_pad_get_caps:
  * @pad: a  #GstPad to get the capabilities of.
  *
- * Gets the capabilities of this pad.
- *
- * Returns: the #GstCaps of this pad. This function returns a new caps, so use
- * gst_caps_unref to get rid of it.
+ * Gets the capabilities this pad can produce or consume.
+ * Note that this method doesn't necessarily returns the caps set by
+ * #gst_pad_set_caps - use #GST_PAD_CAPS for that instead.
+ * gst_pad_get_caps returns all possible caps a pad can operate with, using
+ * the pad's get_caps function;
+ * this returns the pad template caps if not explicitly set.
+ *
+ * Returns: a newly allocated copy of the #GstCaps of this pad.
  *
  * MT safe.
  */

diff --git a/libs/gst/base/gstbasetransform.h b/libs/gst/base/gstbasetransform.h
index 5c8f853..6034bb5 100644 (file)
--- a/libs/gst/base/gstbasetransform.h
+++ b/libs/gst/base/gstbasetransform.h
@@ -109,7 +109,9 @@ struct _GstBaseTransformClass {
   gboolean      (*event)        (GstBaseTransform *trans, GstEvent *event);
 
   /* transform one incoming buffer to one outgoing buffer.
-   * Always needs to be implemented. */
+   * Always needs to be implemented.
+   * transform function is allowed to change size/timestamp/duration of
+   * the outgoing buffer. */
   GstFlowReturn (*transform)    (GstBaseTransform *trans, GstBuffer *inbuf,
                                  GstBuffer *outbuf);