changeset 20978:d947d75635fb

Add notes about how the value argument to the purple_prefs_add_{string,path}_list functions needs to be handled by the caller.
author Etan Reisner <pidgin@unreliablesource.net>
date Wed, 17 Oct 2007 03:46:27 +0000
parents 72edbc003dd5
children cb5cbe04a340 1aaa6e9881b9
files libpurple/prefs.h
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/prefs.h	Wed Oct 17 03:40:16 2007 +0000
+++ b/libpurple/prefs.h	Wed Oct 17 03:46:27 2007 +0000
@@ -115,6 +115,9 @@
  *
  * @param name  The name of the pref
  * @param value The initial value to set
+ * @note This function takes a copy of the strings in the value list. The list
+ *       itself and original copies of the strings are up to the caller to
+ *       free.
  */
 void purple_prefs_add_string_list(const char *name, GList *value);
 
@@ -131,6 +134,9 @@
  *
  * @param name  The name of the pref
  * @param value The initial value to set
+ * @note This function takes a copy of the strings in the value list. The list
+ *       itself and original copies of the strings are up to the caller to
+ *       free.
  */
 void purple_prefs_add_path_list(const char *name, GList *value);