luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-28 10:06:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'gstring-docs' into 'master'

Browse Source 
gstring: fully document semantics of @len for g_string_insert_len

See merge request GNOME/glib!650
This commit is contained in:
Philip Withnall 2019-02-12 12:01:46 +00:00
commit b841c9a7a7
1 changed files with 26 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
glib/gstring.c
View File

@ -407,16 +407,18 @@ g_string_set_size (GString *string,
* @pos: position in @string where insertion should * @pos: position in @string where insertion should
* happen, or -1 for at the end * happen, or -1 for at the end
* @val: bytes to insert * @val: bytes to insert
* @len: number of bytes of @val to insert * @len: number of bytes of @val to insert, or -1 for all of @val
* *
* Inserts @len bytes of @val into @string at @pos. * Inserts @len bytes of @val into @string at @pos.
* Because @len is provided, @val may contain embedded
* nuls and need not be nul-terminated. If @pos is -1,
* bytes are inserted at the end of the string.
* *
* Since this function does not stop at nul bytes, it is * If @len is positive, @val may contain embedded nuls and need
* the caller's responsibility to ensure that @val has at * not be nul-terminated. It is the caller's responsibility to
* least @len addressable bytes. * ensure that @val has at least @len addressable bytes.
*
* If @len is negative, @val must be nul-terminated and @len
* is considered to request the entire string length.
*
* If @pos is -1, bytes are inserted at the end of the string.
* *
* Returns: (transfer none): @string * Returns: (transfer none): @string
*/ */
@ -600,15 +602,17 @@ g_string_append (GString *string,
* g_string_append_len: * g_string_append_len:
* @string: a #GString * @string: a #GString
* @val: bytes to append * @val: bytes to append
* @len: number of bytes of @val to use * @len: number of bytes of @val to use, or -1 for all of @val
* *
* Appends @len bytes of @val to @string. Because @len is * Appends @len bytes of @val to @string.
* provided, @val may contain embedded nuls and need not
* be nul-terminated.
* *
* Since this function does not stop at nul bytes, it is * If @len is positive, @val may contain embedded nuls and need
* the caller's responsibility to ensure that @val has at * not be nul-terminated. It is the caller's responsibility to
* least @len addressable bytes. * ensure that @val has at least @len addressable bytes.
*
* If @len is negative, @val must be nul-terminated and @len
* is considered to request the entire string length. This
* makes g_string_append_len() equivalent to g_string_append().
* *
* Returns: (transfer none): @string * Returns: (transfer none): @string
*/ */
@ -680,15 +684,17 @@ g_string_prepend (GString *string,
* g_string_prepend_len: * g_string_prepend_len:
* @string: a #GString * @string: a #GString
* @val: bytes to prepend * @val: bytes to prepend
* @len: number of bytes in @val to prepend * @len: number of bytes in @val to prepend, or -1 for all of @val
* *
* Prepends @len bytes of @val to @string. * Prepends @len bytes of @val to @string.
* Because @len is provided, @val may contain
* embedded nuls and need not be nul-terminated.
* *
* Since this function does not stop at nul bytes, * If @len is positive, @val may contain embedded nuls and need
* it is the caller's responsibility to ensure that * not be nul-terminated. It is the caller's responsibility to
* @val has at least @len addressable bytes. * ensure that @val has at least @len addressable bytes.
*
* If @len is negative, @val must be nul-terminated and @len
* is considered to request the entire string length. This
* makes g_string_prepend_len() equivalent to g_string_prepend().
* *
* Returns: (transfer none): @string * Returns: (transfer none): @string
*/ */