X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=docs%2Freference%2Fglib%2Ftmpl%2Fstrings.sgml;h=8a35eeb2ec5b2918754c72cd5047d8125a3f88cf;hb=9090c67afc1aea46e2bc2ccd18574a52f9d52bec;hp=0e34ac9cd5bce119184f6159e8ff6bf77cc6fc24;hpb=963926c7954bd74cd8605be60537e2745b9f43a6;p=platform%2Fupstream%2Fglib.git diff --git a/docs/reference/glib/tmpl/strings.sgml b/docs/reference/glib/tmpl/strings.sgml index 0e34ac9..8a35eeb 100644 --- a/docs/reference/glib/tmpl/strings.sgml +++ b/docs/reference/glib/tmpl/strings.sgml @@ -16,13 +16,16 @@ can be used for binary data with embedded nul bytes. + + + The #GString struct contains the public fields of a #GString. The str field points to the character data. It may move as text is added. The len field contains the length of the string, -not including the terminating nul character. +not including the terminating nul byte. The str field is nul-terminated and so can be used as an ordinary C @@ -56,7 +59,7 @@ provided, @init need not be nul-terminated, and can contain embedded nul bytes. -Creates a new #GString, with enough space for @dfl_size characters. +Creates a new #GString, with enough space for @dfl_size bytes. This is useful if you are going to add a lot of text to the string and don't want it to be reallocated too often. @@ -67,29 +70,30 @@ don't want it to be reallocated too often. -Copies the characters from one #GString into another, destroying any previous -contents. It is rather like the standard strcpy() function, except that +Copies the bytes from a string into a #GString, destroying any previous +contents. It is rather like the standard strcpy() function, except that you do not have to worry about having enough space to copy the string. @string: the destination #GString. Its current contents are destroyed. -@rval: the source #GString. +@rval: the string to copy into @string @Returns: the destination #GString. + +@val: the string to copy into @string. Writes a formatted string into a #GString. -This is similar to the standard sprintf() function, +This is similar to the standard sprintf() function, except that the #GString buffer automatically expands to contain the results. -The previous contents of the #GString are destroyed. This -function has been renamaed to g_string_printf(). +The previous contents of the #GString are destroyed. +@Deprecated: This function has been renamed to g_string_printf(). @string: a #GString. -@format: the string format. See the sprintf() -documentation. +@format: the string format. See the sprintf() documentation. @Varargs: the parameters to insert into the format string. @@ -97,28 +101,26 @@ documentation. Appends a formatted string onto the end of a #GString. This function is is similar to g_string_sprintf() except that -the text is appended to the #GString. The function has been -renamed to g_string_append_printf(). +the text is appended to the #GString. +@Deprecated: This function has been renamed to g_string_append_printf(). @string: a #GString. -@format: the string format. See the sprintf() -documentation. +@format: the string format. See the sprintf() documentation. @Varargs: the parameters to insert into the format string. Writes a formatted string into a #GString. -This is similar to the standard sprintf() function, +This is similar to the standard sprintf() function, except that the #GString buffer automatically expands to contain the results. The previous contents of the #GString are destroyed. @string: a #GString. -@format: the string format. See the printf() -documentation. +@format: the string format. See the printf() documentation. @Varargs: the parameters to insert into the format string. @@ -130,8 +132,7 @@ the text is appended to the #GString. @string: a #GString. -@format: the string format. See the printf() -documentation. +@format: the string format. See the printf() documentation. @Varargs: the parameters to insert into the format string. @@ -147,11 +148,11 @@ Adds a string onto the end of a #GString, expanding it if necessary. -Adds a character onto the end of a #GString, expanding it if necessary. +Adds a byte onto the end of a #GString, expanding it if necessary. @string: a #GString. -@c: the character to append onto the end of the #GString. +@c: the byte to append onto the end of the #GString. @Returns: the #GString. @@ -189,11 +190,11 @@ Adds a string on to the start of a #GString, expanding it if necessary. -Adds a character onto the start of a #GString, expanding it if necessary. +Adds a byte onto the start of a #GString, expanding it if necessary. @string: a #GString. -@c: the character to prepend on the start of the #GString. +@c: the byte to prepend on the start of the #GString. @Returns: the #GString. @@ -232,12 +233,12 @@ Inserts a copy of a string into a #GString, expanding it if necessary. -Inserts a character into a #GString, expanding it if necessary. +Inserts a byte into a #GString, expanding it if necessary. @string: a #GString. -@pos: the position to insert the character. -@c: the character to insert. +@pos: the position to insert the byte. +@c: the byte to insert. @Returns: the #GString. @@ -267,20 +268,20 @@ Inserts @len bytes of @val into @string at @pos. Because @len is provided, @val -Removes @len characters from a #GString, starting at position @pos. +Removes @len bytes from a #GString, starting at position @pos. The rest of the #GString is shifted down to fill the gap. @string: a #GString. -@pos: the position of the characters to remove. -@len: the number of characters to remove, or -1 to remove all - following characters. +@pos: the position of the content to remove. +@len: the number of bytes to remove, or -1 to remove all + following bytes. @Returns: the #GString. -Cuts off the end of the GString, leaving the first @len characters. +Cuts off the end of the GString, leaving the first @len bytes. @string: a #GString. @@ -306,25 +307,23 @@ If @free_segment is %TRUE it also frees the character data. @string: a #GString. @free_segment: if %TRUE the actual character data is freed as well. -@Returns: +@Returns: the character data of @string (i.e. %NULL if @free_segment is %TRUE) -Converts a #GString to upper case. -@string: a #GString. -@Returns: the #GString. +@string: +@Returns: -Converts a #GString to lower case. -@string: a #GString. -@Returns: the #GString. +@string: +@Returns: