im.pidgin.pidgin: 9825a5529451f2000418ac3fb9c586502380a2c6

[resiak at soc.pidgin.im]

-----------------------------------------------------------------
Revision: 9825a5529451f2000418ac3fb9c586502380a2c6
Ancestor: 240095fc3a12eafe8418f57362c4b2a88da143c1
Author: resiak at soc.pidgin.im
Date: 2007-11-07T10:51:21
Branch: im.pidgin.pidgin

Modified files:
        libpurple/prefs.h

ChangeLog: 

Document PurplePrefCallback.

-------------- next part --------------
============================================================
--- libpurple/prefs.h	b38e1269836dfb788efd1bf36df5badd81f734f2
+++ libpurple/prefs.h	b821c4e64168c1fbb4cafc54b7058e8ce21a80db
@@ -45,9 +45,20 @@ typedef enum _PurplePrefType
 } PurplePrefType;
 
 /**
- * Pref change callback type
+ * The type of callbacks for preference changes.
+ *
+ * @param name the name of the preference which has changed.
+ * @param type the type of the preferenced named @a name
+ * @param val  the new value of the preferencs; should be cast to the correct
+ *             type.  For instance, to recover the value of a #PURPLE_PREF_INT
+ *             preference, use <tt>GPOINTER_TO_INT(val)</tt>.  Alternatively,
+ *             just call purple_prefs_get_int(), purple_prefs_get_string_list()
+ *             etc.
+ * @param data Arbitrary data specified when the callback was connected with
+ *             purple_prefs_connect_callback().
+ *
+ * @see purple_prefs_connect_callback()
  */
-
 typedef void (*PurplePrefCallback) (const char *name, PurplePrefType type,
 		gconstpointer val, gpointer data);