From a28a3fdd0403a9f92c97131a54db63662c07cb9d Mon Sep 17 00:00:00 2001
From: Michael Smith <msmith@xiph.org>
Date: Wed, 9 Nov 2005 18:41:53 +0000
Subject: [PATCH] Slightly polish docs for GstAdapter.

Original commit message from CVS:
Slightly polish docs for GstAdapter.
---
 gst/base/gstadapter.c      | 9 +++++----
 libs/gst/base/gstadapter.c | 9 +++++----
 2 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/gst/base/gstadapter.c b/gst/base/gstadapter.c
index 37598e5c60..b6d7c1043c 100644
--- a/gst/base/gstadapter.c
+++ b/gst/base/gstadapter.c
@@ -176,7 +176,7 @@ gst_adapter_clear (GstAdapter * adapter)
 /**
  * gst_adapter_push:
  * @adapter: a #GstAdapter
- * @buf: the #GstBuffer to queue into the adapter
+ * @buf: a #GstBuffer to add to queue in the adapter
  *
  * Adds the data from @buf to the data stored inside @adapter and takes
  * ownership of the buffer.
@@ -263,7 +263,8 @@ gst_adapter_peek (GstAdapter * adapter, guint size)
  * @adapter: a #GstAdapter
  * @flush: the number of bytes to flush
  *
- * Flushes the first @flush bytes out of @adapter.
+ * Flushes the first @flush bytes in the @adapter. The caller must ensure that
+ * at least this many bytes are available.
  *
  * See also: gst_adapter_peek().
  */
@@ -352,10 +353,10 @@ gst_adapter_available (GstAdapter * adapter)
  * gst_adapter_available_fast:
  * @adapter: a #GstAdapter
  *
- * Gets the maximum amount of bytes available without the need to do expensive
+ * Gets the maximum number of bytes available without the need to do expensive
  * operations (like copying the data into a temporary buffer).
  *
- * Returns: amount of bytes available in @adapter without expensive operations
+ * Returns: number of bytes available in @adapter without expensive operations
  */
 guint
 gst_adapter_available_fast (GstAdapter * adapter)
diff --git a/libs/gst/base/gstadapter.c b/libs/gst/base/gstadapter.c
index 37598e5c60..b6d7c1043c 100644
--- a/libs/gst/base/gstadapter.c
+++ b/libs/gst/base/gstadapter.c
@@ -176,7 +176,7 @@ gst_adapter_clear (GstAdapter * adapter)
 /**
  * gst_adapter_push:
  * @adapter: a #GstAdapter
- * @buf: the #GstBuffer to queue into the adapter
+ * @buf: a #GstBuffer to add to queue in the adapter
  *
  * Adds the data from @buf to the data stored inside @adapter and takes
  * ownership of the buffer.
@@ -263,7 +263,8 @@ gst_adapter_peek (GstAdapter * adapter, guint size)
  * @adapter: a #GstAdapter
  * @flush: the number of bytes to flush
  *
- * Flushes the first @flush bytes out of @adapter.
+ * Flushes the first @flush bytes in the @adapter. The caller must ensure that
+ * at least this many bytes are available.
  *
  * See also: gst_adapter_peek().
  */
@@ -352,10 +353,10 @@ gst_adapter_available (GstAdapter * adapter)
  * gst_adapter_available_fast:
  * @adapter: a #GstAdapter
  *
- * Gets the maximum amount of bytes available without the need to do expensive
+ * Gets the maximum number of bytes available without the need to do expensive
  * operations (like copying the data into a temporary buffer).
  *
- * Returns: amount of bytes available in @adapter without expensive operations
+ * Returns: number of bytes available in @adapter without expensive operations
  */
 guint
 gst_adapter_available_fast (GstAdapter * adapter)