# HG changeset patch
# User Will Thompson <will.thompson@collabora.co.uk>
# Date 1193590308 0
# Node ID 5af17c5a4a12afcd611ae3e05cc7d4460ae5844c
# Parent  ec9c30ce628d59ead3194f330da283173bd1ebcd
Document PurplePluginProtocolInfo.get_cb_real_name

diff -r ec9c30ce628d -r 5af17c5a4a12 libpurple/prpl.h
--- 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);