diff libpurple/conversation.h @ 21023:42ecde230f91

Documentation tweaks for the write_conv uiop and for prpl_info.offline_message.
author Will Thompson <will.thompson@collabora.co.uk>
date Sat, 27 Oct 2007 13:27:31 +0000
parents 59c9c04879af
children 6de09629f091
line wrap: on
line diff
--- a/libpurple/conversation.h	Fri Oct 26 13:22:49 2007 +0000
+++ b/libpurple/conversation.h	Sat Oct 27 13:27:31 2007 +0000
@@ -171,9 +171,12 @@
 	void (*write_im)(PurpleConversation *conv, const char *who,
 	                 const char *message, PurpleMessageFlags flags,
 	                 time_t mtime);
-	/** Write a message to a conversation.  This is used rather than
-	 *  the chat- or im-specific ops for generic messages, such as system
-	 *  messages like "x is now know as y".
+	/** Write a message to a conversation.  This is used rather than the
+	 *  chat- or im-specific ops for errors, system messages (such as "x is
+	 *  now know as y"), and as the fallback if #write_im and #write_chat
+	 *  are not implemented.  It should be implemented, or the UI will miss
+	 *  conversation error messages and your users will hate you.
+	 *
 	 *  @see purple_conversation_write()
 	 */
 	void (*write_conv)(PurpleConversation *conv,