changeset 21039:5af17c5a4a12

Document PurplePluginProtocolInfo.get_cb_real_name
author Will Thompson <will.thompson@collabora.co.uk>
date Sun, 28 Oct 2007 16:51:48 +0000
parents ec9c30ce628d
children cb086fef7ca1 b3ae0eb23df3
files libpurple/prpl.h
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/prpl.h	Sun Oct 28 16:30:10 2007 +0000
+++ b/libpurple/prpl.h	Sun Oct 28 16:51:48 2007 +0000
@@ -339,6 +339,15 @@
 
 	void (*remove_group)(PurpleConnection *gc, PurpleGroup *group);
 
+	/** Gets the real name of a participant in a chat.  For example, on
+	 *  XMPP this turns a chat room nick <tt>foo</tt> into
+	 *  <tt>room@server/foo</tt>
+	 *  @param gc  the connection on which the room is.
+	 *  @param id  the ID of the chat room.
+	 *  @param who the nickname of the chat participant.
+	 *  @return    the real name of the participant.  This string must be
+	 *             freed by the caller.
+	 */
 	char *(*get_cb_real_name)(PurpleConnection *gc, int id, const char *who);
 
 	void (*set_chat_topic)(PurpleConnection *gc, int id, const char *topic);