From 828a1b082d797729a216a0ee40372f7d0ef9b563 Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Sun, 25 Jan 2015 16:22:43 +0000 Subject: [PATCH] gstrfuncs: Document that g_ascii_dtostr() writes a nul terminator And g_ascii_formatd(). Reviewed-by: Ryan Lortie --- glib/gstrfuncs.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/glib/gstrfuncs.c b/glib/gstrfuncs.c index f33f84b68..1bae6f912 100644 --- a/glib/gstrfuncs.c +++ b/glib/gstrfuncs.c @@ -858,7 +858,8 @@ g_ascii_strtod (const gchar *nptr, * the string back using g_ascii_strtod() gives the same machine-number * (on machines with IEEE compatible 64bit doubles). It is * guaranteed that the size of the resulting string will never - * be larger than @G_ASCII_DTOSTR_BUF_SIZE bytes. + * be larger than @G_ASCII_DTOSTR_BUF_SIZE bytes, including the terminating + * nul character, which is always added. * * Returns: The pointer to the buffer with the converted string. **/ @@ -886,6 +887,8 @@ g_ascii_dtostr (gchar *buffer, * a printf()-style format string. Allowed conversion * specifiers are 'e', 'E', 'f', 'F', 'g' and 'G'. * + * The returned buffer is guaranteed to be nul-terminated. + * * If you just want to want to serialize the value into a * string, use g_ascii_dtostr(). *