# HG changeset patch
# User Will Thompson <will.thompson@collabora.co.uk>
# Date 1193491651 0
# Node ID 42ecde230f91ab77de9e471a0d7f15a60a5d4299
# Parent  3f8b32a4786cd81e82e816838d964ea51a65adf4
Documentation tweaks for the write_conv uiop and for prpl_info.offline_message.

diff -r 3f8b32a4786c -r 42ecde230f91 libpurple/conversation.h
--- 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,
diff -r 3f8b32a4786c -r 42ecde230f91 libpurple/prpl.h
--- a/libpurple/prpl.h	Fri Oct 26 13:22:49 2007 +0000
+++ b/libpurple/prpl.h	Sat Oct 27 13:27:31 2007 +0000
@@ -354,6 +354,11 @@
 	gboolean (*can_receive_file)(PurpleConnection *, const char *who);
 	void (*send_file)(PurpleConnection *, const char *who, const char *filename);
 	PurpleXfer *(*new_xfer)(PurpleConnection *, const char *who);
+
+	/** Checks whether offline messages to @a buddy are supported.
+	 *  @return @c TRUE if @a buddy can be sent messages while they are
+	 *          offline, or @c FALSE if not.
+	 */
 	gboolean (*offline_message)(const PurpleBuddy *buddy);
 
 	PurpleWhiteboardPrplOps *whiteboard_prpl_ops;