Mercurial > pidgin.yaz
comparison src/blist.h @ 6720:41120df7ed94
[gaim-migrate @ 7247]
Fixed documentation errors so Doxygen no longer complains.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Wed, 03 Sep 2003 05:21:04 +0000 |
parents | 0c5637b5462e |
children | b0913ab92893 |
comparison
equal
deleted
inserted
replaced
6719:3cc4d5e55a69 | 6720:41120df7ed94 |
---|---|
246 | 246 |
247 | 247 |
248 /** | 248 /** |
249 * Updates a buddy's warning level. | 249 * Updates a buddy's warning level. |
250 * | 250 * |
251 * @param buddy The buddy whose warning level has changed | 251 * @param buddy The buddy whose warning level has changed. |
252 * @param evil The warning level as an int from 0 to 100 (or higher, I guess... but that'd be weird) | 252 * @param warning The warning level as an int from 0 to 100. |
253 */ | 253 */ |
254 void gaim_blist_update_buddy_evil(GaimBuddy *buddy, int warning); | 254 void gaim_blist_update_buddy_evil(GaimBuddy *buddy, int warning); |
255 | 255 |
256 /** | 256 /** |
257 * Updates a buddy's icon. | 257 * Updates a buddy's icon. |
349 * | 349 * |
350 * The buddy will be inserted right after node or prepended to the | 350 * The buddy will be inserted right after node or prepended to the |
351 * group if node is NULL. If both are NULL, the buddy will be added to | 351 * group if node is NULL. If both are NULL, the buddy will be added to |
352 * the "Buddies" group. | 352 * the "Buddies" group. |
353 * | 353 * |
354 * @param buddy The new buddy who gets added | 354 * @param buddy The new buddy who gets added |
355 * @param group The group to add the new buddy to. | 355 * @param contact The optional contact to place the buddy in. |
356 * @param node The insertion point | 356 * @param group The group to add the new buddy to. |
357 * @param node The insertion point | |
357 */ | 358 */ |
358 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | 359 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); |
359 | 360 |
360 /** | 361 /** |
361 * Creates a new group | 362 * Creates a new group |
492 GaimContact *gaim_find_contact(GaimGroup *group, const char *name); | 493 GaimContact *gaim_find_contact(GaimGroup *group, const char *name); |
493 | 494 |
494 /** | 495 /** |
495 * Finds a chat by name. | 496 * Finds a chat by name. |
496 * | 497 * |
497 * @param name The chat's name. | 498 * @param account The chat's account. |
499 * @param name The chat's name. | |
498 * | 500 * |
499 * @return The chat, or @c NULL if the chat does not exist. | 501 * @return The chat, or @c NULL if the chat does not exist. |
500 */ | 502 */ |
501 GaimBlistChat *gaim_blist_find_chat(GaimAccount *account, const char *name); | 503 GaimBlistChat *gaim_blist_find_chat(GaimAccount *account, const char *name); |
502 | 504 |
519 | 521 |
520 | 522 |
521 /** | 523 /** |
522 * Returns a list of accounts that have buddies in this group | 524 * Returns a list of accounts that have buddies in this group |
523 * | 525 * |
524 * @param group The group | 526 * @param g The group |
525 * @return A list of gaim_accounts | 527 * |
528 * @return A list of gaim_accounts | |
526 */ | 529 */ |
527 GSList *gaim_group_get_accounts(GaimGroup *g); | 530 GSList *gaim_group_get_accounts(GaimGroup *g); |
528 | 531 |
529 /** | 532 /** |
530 * Determines whether an account owns any buddies in a given group | 533 * Determines whether an account owns any buddies in a given group |
531 * | 534 * |
532 * @param g The group to search through. | 535 * @param g The group to search through. |
533 * @param account The account. | 536 * @param account The account. |
537 * | |
538 * @return TRUE if there are any buddies in the group, or FALSE otherwise. | |
534 */ | 539 */ |
535 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); | 540 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); |
536 | 541 |
537 /** | 542 /** |
538 * Called when an account gets signed on. Tells the UI to update all the | 543 * Called when an account gets signed on. Tells the UI to update all the |
614 char *gaim_group_get_setting(GaimGroup *g, const char *key); | 619 char *gaim_group_get_setting(GaimGroup *g, const char *key); |
615 | 620 |
616 /** | 621 /** |
617 * Associates some data with the chat in the xml buddy list | 622 * Associates some data with the chat in the xml buddy list |
618 * | 623 * |
619 * @param b The chat the data is associated with | 624 * @param c The chat the data is associated with |
620 * @param key The key used to retrieve the data | 625 * @param key The key used to retrieve the data |
621 * @param value The data to set | 626 * @param value The data to set |
622 */ | 627 */ |
623 void gaim_blist_chat_set_setting(GaimBlistChat *c, const char *key, const char *value); | 628 void gaim_blist_chat_set_setting(GaimBlistChat *c, const char *key, const char *value); |
624 | 629 |
625 /** | 630 /** |
626 * Retrieves data from the XML buddy list set by gaim_chat_set_setting()) | 631 * Retrieves data from the XML buddy list set by gaim_chat_set_setting()) |
627 * | 632 * |
628 * @param b The chat to retrieve data from | 633 * @param c The chat to retrieve data from |
629 * @param key The key to retrieve the data with | 634 * @param key The key to retrieve the data with |
635 * | |
630 * @return The associated data or NULL if no data is associated | 636 * @return The associated data or NULL if no data is associated |
631 */ | 637 */ |
632 char *gaim_blist_chat_get_setting(GaimBlistChat *c, const char *key); | 638 char *gaim_blist_chat_get_setting(GaimBlistChat *c, const char *key); |
633 | 639 |
634 /** | 640 /** |