Document g_snprintf to return "bytes" rather than "characters".

2007-08-22  Cody Russell  <bratsche@gnome.org>

        * glib/gprintf.c: Document g_snprintf to return "bytes" rather
        than "characters".

svn path=/trunk/; revision=5716

diff --git a/ChangeLog b/ChangeLog
index 25b66d1672e5b3b2c131bdb0f123c6ac0e22044f..f8d3f93539146e2434a71596b8f90664744f8e50 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-08-22  Cody Russell  <bratsche@gnome.org>
+
+       * glib/gprintf.c: Document g_snprintf to return "bytes" rather
+       than "characters".
+
 2007-08-20  Behdad Esfahbod  <behdad@gnome.org>
 
        * glib/guniprop.c: Document that g_unichar_get_script() is

diff --git a/glib/gprintf.c b/glib/gprintf.c
index 7de0953a24da17df3b05614d29d92b095925acfa..4bd47a34fd9200f34f909ff4db431ca20bad24a1 100644 (file)
--- a/glib/gprintf.c
+++ b/glib/gprintf.c
@@ -145,7 +145,7 @@ g_sprintf (gchar       *string,
  * The format string may contain positional parameters, as specified in 
  * the Single Unix Specification.
  *
- * Returns: the number of characters which would be produced if the buffer 
+ * Returns: the number of bytes which would be produced if the buffer 
  *     was large enough.
  **/
 gint