Added note in g_slist_free about using *free_full to mirror GList docs
authorChris Kühl <chrisk@openismus.com>
Sun, 5 Dec 2010 23:34:43 +0000 (00:34 +0100)
committerChris Kühl <chrisk@openismus.com>
Sun, 5 Dec 2010 23:34:59 +0000 (00:34 +0100)
glib/gslist.c

index f6581a8..f8e7dcd 100644 (file)
@@ -159,6 +159,12 @@ g_slist_alloc (void)
  *
  * Frees all of the memory used by a #GSList.
  * The freed elements are returned to the slice allocator.
+ *
+ * <note><para>
+ * If list elements contain dynamically-allocated memory,
+ * you should either use g_slist_free_full() or free them manually
+ * first.
+ * </para></note>
  */
 void
 g_slist_free (GSList *list)