From: Stefan Sauer <ensonic@users.sf.net>
Date: Mon, 7 Nov 2011 15:57:37 +0000 (+0100)
Subject: buffer: improve parameter docs
X-Git-Tag: RELEASE-0.11.2~507
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=93941a25174243e78bdbc7ff50278d81b5fa4604;p=platform%2Fupstream%2Fgstreamer.git

buffer: improve parameter docs
---

diff --git a/gst/gstbuffer.c b/gst/gstbuffer.c
index bb33e1c..961ec85 100644
--- a/gst/gstbuffer.c
+++ b/gst/gstbuffer.c
@@ -907,7 +907,7 @@ gst_buffer_resize (GstBuffer * buffer, gssize offset, gsize size)
  *
  * @size and @maxsize will contain the current valid number of bytes in the
  * returned memory area and the total maximum mount of bytes available in the
- * returned memory area respectively.
+ * returned memory area respectively. Both parameters can be %NULL.
  *
  * When @buffer is writable but the memory isn't, a writable copy will
  * automatically be created and returned. The readonly copy of the buffer memory
@@ -1000,7 +1000,8 @@ not_writable:
  * @data: the previously mapped data
  * @size: the size of @data
  *
- * Release the memory previously mapped with gst_buffer_map().
+ * Release the memory previously mapped with gst_buffer_map(). Pass -1 to size
+ * if no update is needed.
  *
  * Returns: #TRUE on success. #FALSE can be returned when the new size is larger
  * than the maxsize of the memory.