From f77f7e987cc0aa33d802a0b1dca9ea21fdeafb95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= Date: Mon, 3 May 2010 00:26:04 +0100 Subject: [PATCH] docs: document that gst_byte_writer_put_string*() writes the terminator too --- libs/gst/base/gstbytewriter.c | 6 +++--- libs/gst/base/gstbytewriter.h | 4 +++- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/libs/gst/base/gstbytewriter.c b/libs/gst/base/gstbytewriter.c index 2ccd1d434f..99e0b557c8 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 d81f7de2ad..743e9dbcd2 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 *