/pidgin/main: afa337c971e0: Fill comment for purple_conversation...

[Tomasz Wasilczyk]

Changeset: afa337c971e0d664396b802ba1e2e164f3b73e55
Author:	 Tomasz Wasilczyk <twasilczyk at pidgin.im>
Date:	 2014-05-22 19:36 +0200
Branch:	 default
URL: https://hg.pidgin.im/pidgin/main/rev/afa337c971e0

Description:

Fill comment for purple_conversation_write_system_message

diffstat:

 libpurple/conversation.h |  8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diffs (18 lines):

diff --git a/libpurple/conversation.h b/libpurple/conversation.h
--- a/libpurple/conversation.h
+++ b/libpurple/conversation.h
@@ -515,6 +515,14 @@ void purple_conversation_write_message(P
 		const char *who, const char *message,
 		PurpleMessageFlags flags, time_t mtime);
 
+/**
+ * purple_conversation_write_system_message:
+ * @conv:    The conversation.
+ * @message: The message to write.
+ * @flags:   The message flags (you don't need to set %PURPLE_MESSAGE_SYSTEM.
+ *
+ * Wites a system message to a chat or an IM.
+ */
 void purple_conversation_write_system_message(PurpleConversation *conv,
 	const gchar *message, PurpleMessageFlags flags);