Clarify the documentation + regarding overflows (wording by Jan Schmidt)

* glib/gprintf.c (g_sprintf): Clarify the documentation
+       regarding overflows (wording by Jan Schmidt)

svn path=/trunk/; revision=5315

diff --git a/ChangeLog b/ChangeLog
index 1e0d451..87b0b1a 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-01-24  Benjamin Otte <otte@gnome.org>
+
+       * glib/gprintf.c (g_sprintf): Clarify the documentation
+       regarding overflows (wording by Jan Schmidt)
+
 2007-01-23  Roozbeh Pournader  <roozbeh@farsiweb.info>
 
        * README: Remove mention of no-longer-existing PATCH

diff --git a/glib/gprintf.c b/glib/gprintf.c
index e62e34c..7de0953 100644 (file)
--- a/glib/gprintf.c
+++ b/glib/gprintf.c
@@ -89,7 +89,9 @@ g_fprintf (FILE        *file,
 
 /**
  * g_sprintf:
- * @string: the buffer to hold the output.
+ * @string: A pointer to a memory buffer to contain the resulting string. It 
+ *          is up to the caller to ensure that the allocated buffer is large 
+ *          enough to hold the formatted result
  * @format: a standard printf() format string, but notice 
  *          <link linkend="string-precision">string precision pitfalls</link>.
  * @Varargs: the arguments to insert in the output.