pidgin: 0b0fb5cb: Add a comment for the meaning of the ret...

[markdoliner at pidgin.im]

-----------------------------------------------------------------
Revision: 0b0fb5cbe8c91543503e2ca8f95012eba592fc76
Ancestor: 81035eb92fa42232b813c2882547c9817e3a5e32
Author: markdoliner at pidgin.im
Date: 2008-12-04T01:20:37
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/0b0fb5cbe8c91543503e2ca8f95012eba592fc76

Modified files:
        libpurple/prpl.h

ChangeLog: 

Add a comment for the meaning of the return value of this function,
because I had no idea.

-------------- next part --------------
============================================================
--- libpurple/prpl.h	81ee17b22edfda143962a23bf3d045afdfb699c5
+++ libpurple/prpl.h	a2812bcdeb76208fc6206752990d00193ccaee04
@@ -274,7 +274,16 @@ struct _PurplePluginProtocolInfo
 					PurpleMessageFlags flags);
 
 	void (*set_info)(PurpleConnection *, const char *info);
+
+	/**
+	 * @return If this protocol requires the PURPLE_TYPING message to
+	 *         be sent repeatedly to signfiy that the user is still
+	 *         typing, then the PRPL should return the number of
+	 *         seconds to wait before sending a subsequent notification.
+	 *         Otherwise the PRPL should return 0.
+	 */
 	unsigned int (*send_typing)(PurpleConnection *, const char *name, PurpleTypingState state);
+
 	/**
 	 * Should arrange for purple_notify_userinfo() to be called with
 	 * @a who's user info.