# HG changeset patch
# User Will Thompson <will.thompson@collabora.co.uk>
# Date 1213795072 0
# Node ID d73ad65a7d5d304cf9af2bf8e2b6c3c7a2243fd2
# Parent  0b6475f97648580be1fbf4a9fef11c5a4458f98c
Improve PurpleConvChatBuddy documentation

diff -r 0b6475f97648 -r d73ad65a7d5d libpurple/conversation.h
--- a/libpurple/conversation.h	Tue Jun 17 22:14:19 2008 +0000
+++ b/libpurple/conversation.h	Wed Jun 18 13:17:52 2008 +0000
@@ -285,11 +285,21 @@
  */
 struct _PurpleConvChatBuddy
 {
-	char *name;                      /**< The name                      */
-	char *alias;					 /**< The alias 					*/
-	char *alias_key;				 /**< The alias key					*/
-	gboolean buddy;					 /**< ChatBuddy is on the blist		*/
-	PurpleConvChatBuddyFlags flags;    /**< Flags (ops, voice etc.)       */
+	char *name;                      /**< The chat participant's name in the chat. */
+	char *alias;                     /**< The chat participant's alias, if known;
+	                                  *   @a NULL otherwise.
+	                                  */
+	char *alias_key;                 /**< A string by which this buddy will be sorted,
+	                                  *   or @c NULL if the buddy should be sorted by
+	                                  *   its @c name.  (This is currently always @c
+	                                  *   NULL.)
+	                                  */
+	gboolean buddy;                  /**< @a TRUE if this chat participant is on the
+	                                  *   buddy list; @a FALSE otherwise.
+	                                  */
+	PurpleConvChatBuddyFlags flags;  /**< A bitwise OR of flags for this participant,
+	                                  *   such as whether they are a channel operator.
+	                                  */
 };
 
 /**