changeset 25008:a4d6e2c1e73b

Update the comment for add_buddy in prpl.h to note it may be called to mean 'request authorization'
author Paul Aurich <paul@darkrain42.org>
date Sun, 21 Dec 2008 22:12:23 +0000
parents 071414f413a4
children 9b1310f1cc7c
files libpurple/prpl.h
diffstat 1 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/prpl.h	Sun Dec 21 22:11:46 2008 +0000
+++ b/libpurple/prpl.h	Sun Dec 21 22:12:23 2008 +0000
@@ -294,6 +294,14 @@
 	void (*set_idle)(PurpleConnection *, int idletime);
 	void (*change_passwd)(PurpleConnection *, const char *old_pass,
 						  const char *new_pass);
+	/**
+	 * Add a buddy to a group on the server.
+	 *
+	 * This PRPL function may be called in situations in which the buddy is
+	 * already in the specified group. If the protocol supports
+	 * authorization and the user is not already authorized to see the
+	 * status of \a buddy, \a add_buddy should request authorization.
+	 */
 	void (*add_buddy)(PurpleConnection *, PurpleBuddy *buddy, PurpleGroup *group);
 	void (*add_buddies)(PurpleConnection *, GList *buddies, GList *groups);
 	void (*remove_buddy)(PurpleConnection *, PurpleBuddy *buddy, PurpleGroup *group);