cpw.darkrain42.buddy-add: efede975: Update the comment for add_buddy in prpl...

[paul at darkrain42.org]

-----------------------------------------------------------------
Revision: efede975ff9a603c14dd195e9c7b72b1d7e15364
Ancestor: cdf242cb346bc741802d3a2bfede51cfd8e41866
Author: paul at darkrain42.org
Date: 2008-12-21T22:12:23
Branch: im.pidgin.cpw.darkrain42.buddy-add
URL: http://d.pidgin.im/viewmtn/revision/info/efede975ff9a603c14dd195e9c7b72b1d7e15364

Modified files:
        libpurple/prpl.h

ChangeLog: 

Update the comment for add_buddy in prpl.h to note it may be called to mean 'request authorization'

-------------- next part --------------
============================================================
--- libpurple/prpl.h	f93c6c9088ab8fd3d2984da02ace7121f7dab5f5
+++ libpurple/prpl.h	42c6c28ab948f8bed99994cbf00c912b8e21f5ac
@@ -294,6 +294,14 @@ struct _PurplePluginProtocolInfo
 	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);