Mercurial > pidgin
changeset 23417:d73ad65a7d5d
Improve PurpleConvChatBuddy documentation
| author | Will Thompson <will.thompson@collabora.co.uk> |
|---|---|
| date | Wed, 18 Jun 2008 13:17:52 +0000 |
| parents | 0b6475f97648 |
| children | ded0a9cf1785 |
| files | libpurple/conversation.h |
| diffstat | 1 files changed, 15 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- 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. + */ }; /**