From c593d2b1808f9e7b19acb92c956eb50dc424fa26 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 26 Aug 2005 16:46:09 +0000 Subject: [PATCH] Improvements pointed out by Behdad Esfahbod (#314460): 2005-08-26 Matthias Clasen Improvements pointed out by Behdad Esfahbod (#314460): * glib/tmpl/strings.sgml: Fix up some character/byte sloppyness. * glib/tmpl/iochannels.sgml: Don't mention deprecated functions in the introduction. --- docs/reference/ChangeLog | 10 ++++++++++ docs/reference/glib/tmpl/iochannels.sgml | 2 +- docs/reference/glib/tmpl/strings.sgml | 30 +++++++++++++++--------------- 3 files changed, 26 insertions(+), 16 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index e7beb9c..2f35bc5 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,13 @@ +2005-08-26 Matthias Clasen + + Improvements pointed out by Behdad Esfahbod (#314460): + + * glib/tmpl/strings.sgml: Fix up some character/byte + sloppyness. + + * glib/tmpl/iochannels.sgml: Don't mention deprecated + functions in the introduction. + 2005-08-23 Matthias Clasen * === Released 2.8.1 === diff --git a/docs/reference/glib/tmpl/iochannels.sgml b/docs/reference/glib/tmpl/iochannels.sgml index b3d79e5..f1344da 100644 --- a/docs/reference/glib/tmpl/iochannels.sgml +++ b/docs/reference/glib/tmpl/iochannels.sgml @@ -21,7 +21,7 @@ manner using g_io_channel_new_file(). Once a #GIOChannel has been created, it can be used in a generic manner with the functions g_io_channel_read_chars(), g_io_channel_write_chars(), -g_io_channel_seek_position(), and g_io_channel_close(). +g_io_channel_seek_position(), and g_io_channel_shutdown(). To add a #GIOChannel to the diff --git a/docs/reference/glib/tmpl/strings.sgml b/docs/reference/glib/tmpl/strings.sgml index fb68ae1..8a35eeb 100644 --- a/docs/reference/glib/tmpl/strings.sgml +++ b/docs/reference/glib/tmpl/strings.sgml @@ -25,7 +25,7 @@ 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 @@ -59,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. @@ -70,7 +70,7 @@ don't want it to be reallocated too often. -Copies the characters from a string into a #GString, destroying any previous +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. @@ -148,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. @@ -190,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. @@ -233,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. @@ -268,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. -- 2.7.4