glib: Improve documentation for g_strfreev()
authorAlberto Ruiz <aruiz@gnome.org>
Tue, 18 Nov 2014 14:43:41 +0000 (14:43 +0000)
committerAlberto Ruiz <aruiz@gnome.org>
Tue, 18 Nov 2014 14:43:41 +0000 (14:43 +0000)
Fixes #740309.

glib/gstrfuncs.c

index f33f84b..0a9b109 100644 (file)
@@ -2413,9 +2413,11 @@ g_strsplit_set (const gchar *string,
 /**
  * g_strfreev:
  * @str_array: a %NULL-terminated array of strings to free
-
- * Frees a %NULL-terminated array of strings, and the array itself.
- * If called on a %NULL value, g_strfreev() simply returns.
+ *
+ * Frees a %NULL-terminated array of strings, as well as each
+ * string it contains.
+ *
+ * If @str_array is %NULL, this function simply returns.
  */
 void
 g_strfreev (gchar **str_array)