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

This commit is contained in:
Tim-Philipp Müller 2010-05-03 00:26:04 +01:00
parent 6e4fde7195
commit f77f7e987c
2 changed files with 6 additions and 4 deletions

View file

@ -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
*

View file

@ -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
*