changeset 27552:9908d5f5fde0

documents purple_prefs_connect_callback
author Ka-Hing Cheung <khc@hxbc.us>
date Wed, 15 Jul 2009 07:22:50 +0000
parents 60fe5b2ded6f
children 828d21a1ec43
files libpurple/prefs.h
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/prefs.h	Wed Jul 15 06:38:10 2009 +0000
+++ b/libpurple/prefs.h	Wed Jul 15 07:22:50 2009 +0000
@@ -315,6 +315,15 @@
 
 /**
  * Add a callback to a pref (and its children)
+ *
+ * @param handle   The handle of the receiver.
+ * @param name     The name of the preference
+ * @param cb       The callback function
+ * @param data     The data to pass to the callback function.
+ *
+ * @return An id to disconnect the callback
+ *
+ * @see purple_prefs_disconnect_callback
  */
 guint purple_prefs_connect_callback(void *handle, const char *name, PurplePrefCallback cb,
 		gpointer data);