Fix docs to use "nul-terminated" consistently.

2008-08-10  Behdad Esfahbod  <behdad@gnome.org>

        * glib/gutf8.c: Fix docs to use "nul-terminated" consistently.


svn path=/trunk/; revision=7334
This commit is contained in:
Behdad Esfahbod 2008-08-10 20:24:32 +00:00 committed by Behdad Esfahbod
parent aa7397b36c
commit ae6300bd09
2 changed files with 9 additions and 5 deletions

View File

@ -1,3 +1,7 @@
2008-08-10 Behdad Esfahbod <behdad@gnome.org>
* glib/gutf8.c: Fix docs to use "nul-terminated" consistently.
2008-08-08 Ryan Lortie <desrt@desrt.ca> 2008-08-08 Ryan Lortie <desrt@desrt.ca>
Fix 'fail' markup test cases to -not- be valid XML 1.1. Fix 'fail' markup test cases to -not- be valid XML 1.1.

View File

@ -987,7 +987,7 @@ g_utf8_to_ucs4 (const gchar *str,
* g_ucs4_to_utf8: * g_ucs4_to_utf8:
* @str: a UCS-4 encoded string * @str: a UCS-4 encoded string
* @len: the maximum length (number of characters) of @str to use. * @len: the maximum length (number of characters) of @str to use.
* If @len < 0, then the string is terminated with a 0 character. * If @len < 0, then the string is nul-terminated.
* @items_read: location to store number of characters read, or %NULL. * @items_read: location to store number of characters read, or %NULL.
* @items_written: location to store number of bytes written or %NULL. * @items_written: location to store number of bytes written or %NULL.
* The value here stored does not include the trailing 0 * The value here stored does not include the trailing 0
@ -1059,7 +1059,7 @@ g_ucs4_to_utf8 (const gunichar *str,
* g_utf16_to_utf8: * g_utf16_to_utf8:
* @str: a UTF-16 encoded string * @str: a UTF-16 encoded string
* @len: the maximum length (number of <type>gunichar2</type>) of @str to use. * @len: the maximum length (number of <type>gunichar2</type>) of @str to use.
* If @len < 0, then the string is terminated with a 0 character. * If @len < 0, then the string is nul-terminated.
* @items_read: location to store number of words read, or %NULL. * @items_read: location to store number of words read, or %NULL.
* If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be * If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
* returned in case @str contains a trailing partial * returned in case @str contains a trailing partial
@ -1208,7 +1208,7 @@ g_utf16_to_utf8 (const gunichar2 *str,
* g_utf16_to_ucs4: * g_utf16_to_ucs4:
* @str: a UTF-16 encoded string * @str: a UTF-16 encoded string
* @len: the maximum length (number of <type>gunichar2</type>) of @str to use. * @len: the maximum length (number of <type>gunichar2</type>) of @str to use.
* If @len < 0, then the string is terminated with a 0 character. * If @len < 0, then the string is nul-terminated.
* @items_read: location to store number of words read, or %NULL. * @items_read: location to store number of words read, or %NULL.
* If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be * If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
* returned in case @str contains a trailing partial * returned in case @str contains a trailing partial
@ -1222,7 +1222,7 @@ g_utf16_to_utf8 (const gunichar2 *str,
* %G_CONVERT_ERROR_NO_CONVERSION may occur. * %G_CONVERT_ERROR_NO_CONVERSION may occur.
* *
* Convert a string from UTF-16 to UCS-4. The result will be * Convert a string from UTF-16 to UCS-4. The result will be
* terminated with a 0 character. * nul-terminated.
* *
* Return value: a pointer to a newly allocated UCS-4 string. * Return value: a pointer to a newly allocated UCS-4 string.
* This value must be freed with g_free(). If an * This value must be freed with g_free(). If an
@ -1467,7 +1467,7 @@ g_utf8_to_utf16 (const gchar *str,
* g_ucs4_to_utf16: * g_ucs4_to_utf16:
* @str: a UCS-4 encoded string * @str: a UCS-4 encoded string
* @len: the maximum length (number of characters) of @str to use. * @len: the maximum length (number of characters) of @str to use.
* If @len < 0, then the string is terminated with a 0 character. * If @len < 0, then the string is nul-terminated.
* @items_read: location to store number of bytes read, or %NULL. * @items_read: location to store number of bytes read, or %NULL.
* If an error occurs then the index of the invalid input * If an error occurs then the index of the invalid input
* is stored here. * is stored here.