pidgin: 9017d251: Improve PurpleConvChatBuddy documentatio...

[resiak at pidgin.im]

-----------------------------------------------------------------
Revision: 9017d2519c3dbbb02402b0785a4750aab2e18a56
Ancestor: 2b1bb94ccf5a258ba779d38122c39b153abfc288
Author: resiak at pidgin.im
Date: 2008-06-18T13:17:52
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/9017d2519c3dbbb02402b0785a4750aab2e18a56

Modified files:
        libpurple/conversation.h

ChangeLog: 

Improve PurpleConvChatBuddy documentation

-------------- next part --------------
============================================================
--- libpurple/conversation.h	b2665285aa7139a4a774e120b7c9055875127de6
+++ libpurple/conversation.h	832dab7eda729de07ccb1e0dce6321e5ba709737
@@ -285,11 +285,21 @@ struct _PurpleConvChatBuddy
  */
 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.
+	                                  */
 };
 
 /**