Mercurial > pidgin
comparison src/blist.h @ 10071:af06746954de
[gaim-migrate @ 11047]
sf patch 1038040: Doxygen Fixes #3
This is from Jonathan Champ (royanee)
Thanks!
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Fri, 01 Oct 2004 22:08:39 +0000 |
parents | eaec201b2688 |
children | 64bc206c7473 |
comparison
equal
deleted
inserted
replaced
10070:2b6bf836c6b9 | 10071:af06746954de |
---|---|
210 /**************************************************************************/ | 210 /**************************************************************************/ |
211 /*@{*/ | 211 /*@{*/ |
212 | 212 |
213 /** | 213 /** |
214 * Creates a new buddy list | 214 * Creates a new buddy list |
215 * | |
216 * @return The new buddy list. | |
215 */ | 217 */ |
216 GaimBuddyList *gaim_blist_new(); | 218 GaimBuddyList *gaim_blist_new(); |
217 | 219 |
218 /** | 220 /** |
219 * Sets the main buddy list. | 221 * Sets the main buddy list. |
220 * | 222 * |
223 * @param blist The buddy list you want to use. | |
224 */ | |
225 void gaim_set_blist(GaimBuddyList *blist); | |
226 | |
227 /** | |
228 * Returns the main buddy list. | |
229 * | |
221 * @return The main buddy list. | 230 * @return The main buddy list. |
222 */ | 231 */ |
223 void gaim_set_blist(GaimBuddyList *blist); | |
224 | |
225 /** | |
226 * Returns the main buddy list. | |
227 * | |
228 * @return The main buddy list. | |
229 */ | |
230 GaimBuddyList *gaim_get_blist(void); | 232 GaimBuddyList *gaim_get_blist(void); |
231 | 233 |
232 /** | 234 /** |
233 * Shows the buddy list, creating a new one if necessary. | 235 * Shows the buddy list, creating a new one if necessary. |
234 * | |
235 */ | 236 */ |
236 void gaim_blist_show(); | 237 void gaim_blist_show(); |
237 | 238 |
238 | 239 |
239 /** | 240 /** |
589 const char *gaim_chat_get_name(GaimChat *chat); | 590 const char *gaim_chat_get_name(GaimChat *chat); |
590 | 591 |
591 /** | 592 /** |
592 * Finds the buddy struct given a screenname and an account | 593 * Finds the buddy struct given a screenname and an account |
593 * | 594 * |
595 * @param account The account this buddy belongs to | |
594 * @param name The buddy's screenname | 596 * @param name The buddy's screenname |
597 * @return The buddy or NULL if the buddy does not exist | |
598 */ | |
599 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); | |
600 | |
601 /** | |
602 * Finds the buddy struct given a screenname, an account, and a group | |
603 * | |
595 * @param account The account this buddy belongs to | 604 * @param account The account this buddy belongs to |
596 * @return The buddy or NULL if the buddy does not exist | |
597 */ | |
598 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); | |
599 | |
600 /** | |
601 * Finds the buddy struct given a screenname, an account, and a group | |
602 * | |
603 * @param name The buddy's screenname | 605 * @param name The buddy's screenname |
604 * @param account The account this buddy belongs to | |
605 * @param group The group to look in | 606 * @param group The group to look in |
606 * @return The buddy or NULL if the buddy does not exist in the group | 607 * @return The buddy or NULL if the buddy does not exist in the group |
607 */ | 608 */ |
608 GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name, | 609 GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name, |
609 GaimGroup *group); | 610 GaimGroup *group); |
610 | 611 |
611 /** | 612 /** |
612 * Finds all GaimBuddy structs given a screenname and an account | 613 * Finds all GaimBuddy structs given a screenname and an account |
613 * | 614 * |
615 * @param account The account this buddy belongs to | |
614 * @param name The buddy's screenname | 616 * @param name The buddy's screenname |
615 * @param account The account this buddy belongs to | |
616 * | 617 * |
617 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist | 618 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist |
618 */ | 619 */ |
619 GSList *gaim_find_buddies(GaimAccount *account, const char *name); | 620 GSList *gaim_find_buddies(GaimAccount *account, const char *name); |
620 | 621 |