# HG changeset patch
# User Mark Doliner <mark@kingant.net>
# Date 1228353637 0
# Node ID 23170794f9f558452806e6fa94e87ec86b11f641
# Parent  1ede190e518bf8346b3cc763344d2b1d7d1549f5
Add a comment for the meaning of the return value of this function,
because I had no idea.

diff -r 1ede190e518b -r 23170794f9f5 libpurple/prpl.h
--- a/libpurple/prpl.h	Wed Dec 03 21:27:11 2008 +0000
+++ b/libpurple/prpl.h	Thu Dec 04 01:20:37 2008 +0000
@@ -274,7 +274,16 @@
 					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.