From: Tim-Philipp Müller <tim.muller@collabora.co.uk>
Date: Sun, 2 May 2010 23:26:04 +0000 (+0100)
Subject: docs: document that gst_byte_writer_put_string*() writes the terminator too
X-Git-Tag: RELEASE-0.10.30~186
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f77f7e987cc0aa33d802a0b1dca9ea21fdeafb95;p=platform%2Fupstream%2Fgstreamer.git

docs: document that gst_byte_writer_put_string*() writes the terminator too
---

diff --git a/libs/gst/base/gstbytewriter.c b/libs/gst/base/gstbytewriter.c
index 2ccd1d4..99e0b55 100644
--- a/libs/gst/base/gstbytewriter.c
+++ b/libs/gst/base/gstbytewriter.c
@@ -781,7 +781,7 @@ CREATE_WRITE_STRING_FUNC (32, guint32);
  * @writer: #GstByteWriter instance
  * @data: UTF8 string to write
  *
- * Writes a null-terminated UTF8 string to @writer.
+ * Writes a NUL-terminated UTF8 string to @writer (including the terminator).
  *
  * Returns: %TRUE if the value could be written
  *
@@ -792,7 +792,7 @@ CREATE_WRITE_STRING_FUNC (32, guint32);
  * @writer: #GstByteWriter instance
  * @data: UTF16 string to write
  *
- * Writes a null-terminated UTF16 string to @writer.
+ * Writes a NUL-terminated UTF16 string to @writer (including the terminator).
  *
  * Returns: %TRUE if the value could be written
  *
@@ -803,7 +803,7 @@ CREATE_WRITE_STRING_FUNC (32, guint32);
  * @writer: #GstByteWriter instance
  * @data: UTF32 string to write
  *
- * Writes a null-terminated UTF32 string to @writer.
+ * Writes a NUL-terminated UTF32 string to @writer (including the terminator).
  *
  * Returns: %TRUE if the value could be written
  *
diff --git a/libs/gst/base/gstbytewriter.h b/libs/gst/base/gstbytewriter.h
index d81f7de..743e9db 100644
--- a/libs/gst/base/gstbytewriter.h
+++ b/libs/gst/base/gstbytewriter.h
@@ -154,7 +154,9 @@ gboolean gst_byte_writer_put_string_utf32 (GstByteWriter *writer, const guint32
  * @writer: #GstByteWriter instance
  * @data: Null terminated string
  *
- * Write a null-terminated string to @writer.
+ * Write a NUL-terminated string to @writer (including the terminator). The
+ * string is assumed to be in an 8-bit encoding (e.g. ASCII,UTF-8 or
+ * ISO-8859-1).
  *
  * Returns: %TRUE if the string could be written
  *