luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-26 05:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs about string functions taking a length. (#378727)

Browse Source 
2006-12-17  Behdad Esfahbod  <behdad@gnome.org>

        * glib/gstring.c: Improve docs about string functions taking a
        length.  (#378727)
This commit is contained in:
Behdad Esfahbod 2006-12-18 03:04:48 +00:00 committed by Behdad Esfahbod
parent 1787a7e164
commit fdef315ba2
2 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2006-12-17 Behdad Esfahbod <behdad@gnome.org>
* glib/gstring.c: Improve docs about string functions taking a
length. (#378727)
2006-12-17 Matthias Clasen <mclasen@redhat.com> 2006-12-17 Matthias Clasen <mclasen@redhat.com>
* configure.in: Use AC_LANG_SOURCE for the clock test. * configure.in: Use AC_LANG_SOURCE for the clock test.

19
glib/gstring.c
View File

@ -297,8 +297,11 @@ g_string_chunk_insert_const (GStringChunk *chunk,
* Adds a copy of the first @len bytes of @string to the #GStringChunk. The * Adds a copy of the first @len bytes of @string to the #GStringChunk. The
* copy is nul-terminated. * copy is nul-terminated.
* *
* The characters in the string can be changed, if necessary, though you * Since this function does not stop at nul bytes, it is the caller's
* should not change anything after the end of the string. * responsibility to ensure that @string has at least @len addressable bytes.
*
* The characters in the returned string can be changed, if necessary, though
* you should not change anything after the end of the string.
* *
* Return value: a pointer to the copy of @string within the #GStringChunk * Return value: a pointer to the copy of @string within the #GStringChunk
* *
@ -421,6 +424,9 @@ g_string_new (const gchar *init)
* need not be nul-terminated, and can contain embedded * need not be nul-terminated, and can contain embedded
* nul bytes. * nul bytes.
* *
* Since this function does not stop at nul bytes, it is the caller's
* responsibility to ensure that @init has at least @len addressable bytes.
*
* Returns: a new #GString. * Returns: a new #GString.
*/ */
GString* GString*
@ -629,6 +635,9 @@ g_string_set_size (GString *string,
* nuls and need not be nul-terminated. If @pos is -1, * nuls and need not be nul-terminated. If @pos is -1,
* bytes are inserted at the end of the string. * bytes are inserted at the end of the string.
* *
* Since this function does not stop at nul bytes, it is the caller's
* responsibility to ensure that @val has at least @len addressable bytes.
*
* Returns: the #GString * Returns: the #GString
*/ */
GString* GString*
@ -731,6 +740,9 @@ g_string_append (GString *string,
* Because @len is provided, @val may contain * Because @len is provided, @val may contain
* embedded nuls and need not be nul-terminated. * embedded nuls and need not be nul-terminated.
* *
* Since this function does not stop at nul bytes, it is the caller's
* responsibility to ensure that @val has at least @len addressable bytes.
*
* Returns: the #GString * Returns: the #GString
*/ */
GString* GString*
@ -812,6 +824,9 @@ g_string_prepend (GString *string,
* Because @len is provided, @val may contain * Because @len is provided, @val may contain
* embedded nuls and need not be nul-terminated. * embedded nuls and need not be nul-terminated.
* *
* Since this function does not stop at nul bytes, it is the caller's
* responsibility to ensure that @val has at least @len addressable bytes.
*
* Returns: the #GString passed in * Returns: the #GString passed in
*/ */
GString* GString*