Mercurial > pidgin.yaz
comparison libpurple/blist.h @ 25412:d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
try to make the formatting of our comments a little more uniform
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Mon, 26 Jan 2009 06:18:18 +0000 |
parents | 65cfc59858cf |
children | 584063555949 |
comparison
equal
deleted
inserted
replaced
25411:c0e3b62f8098 | 25412:d25cbbea7fe5 |
---|---|
73 { | 73 { |
74 PURPLE_BLIST_NODE_FLAG_NO_SAVE = 1 << 0 /**< node should not be saved with the buddy list */ | 74 PURPLE_BLIST_NODE_FLAG_NO_SAVE = 1 << 0 /**< node should not be saved with the buddy list */ |
75 | 75 |
76 } PurpleBlistNodeFlags; | 76 } PurpleBlistNodeFlags; |
77 | 77 |
78 /** | |
79 * @since 2.6.0 | |
80 */ | |
78 #define PURPLE_BLIST_NODE(obj) ((PurpleBlistNode *)(obj)) | 81 #define PURPLE_BLIST_NODE(obj) ((PurpleBlistNode *)(obj)) |
79 | 82 |
80 #define PURPLE_BLIST_NODE_HAS_FLAG(b, f) (purple_blist_node_get_flags((PurpleBlistNode*)(b)) & (f)) | 83 #define PURPLE_BLIST_NODE_HAS_FLAG(b, f) (purple_blist_node_get_flags((PurpleBlistNode*)(b)) & (f)) |
81 #define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE)) | 84 #define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE)) |
82 | 85 |
83 #define PURPLE_BLIST_NODE_NAME(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE ? purple_chat_get_name((PurpleChat*)n) : \ | 86 #define PURPLE_BLIST_NODE_NAME(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE ? purple_chat_get_name((PurpleChat*)n) : \ |
84 purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL) | 87 purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL) |
85 | 88 |
89 /** | |
90 * @since 2.6.0 | |
91 */ | |
86 #define PURPLE_GROUP(obj) ((PurpleGroup *)(obj)) | 92 #define PURPLE_GROUP(obj) ((PurpleGroup *)(obj)) |
93 | |
94 /** | |
95 * @since 2.6.0 | |
96 */ | |
87 #define PURPLE_CONTACT(obj) ((PurpleContact *)(obj)) | 97 #define PURPLE_CONTACT(obj) ((PurpleContact *)(obj)) |
98 | |
99 /** | |
100 * @since 2.6.0 | |
101 */ | |
88 #define PURPLE_BUDDY(obj) ((PurpleBuddy *)(obj)) | 102 #define PURPLE_BUDDY(obj) ((PurpleBuddy *)(obj)) |
103 | |
104 /** | |
105 * @since 2.6.0 | |
106 */ | |
89 #define PURPLE_CHAT(obj) ((PurpleChat *)(obj)) | 107 #define PURPLE_CHAT(obj) ((PurpleChat *)(obj)) |
90 | 108 |
91 #include "account.h" | 109 #include "account.h" |
92 #include "buddyicon.h" | 110 #include "buddyicon.h" |
93 #include "status.h" | 111 #include "status.h" |
243 | 261 |
244 /** | 262 /** |
245 * Returns the hash table of every buddy in the list. | 263 * Returns the hash table of every buddy in the list. |
246 * | 264 * |
247 * @return The hash table of every buddy in the list. | 265 * @return The hash table of every buddy in the list. |
266 * | |
248 * @since 2.6.0 | 267 * @since 2.6.0 |
249 */ | 268 */ |
250 GHashTable *purple_blist_get_buddies(void); | 269 GHashTable *purple_blist_get_buddies(void); |
251 | 270 |
252 /** | 271 /** |
253 * Returns the UI data for the list. | 272 * Returns the UI data for the list. |
254 * | 273 * |
255 * @return The UI data for the list. | 274 * @return The UI data for the list. |
275 * | |
256 * @since 2.6.0 | 276 * @since 2.6.0 |
257 */ | 277 */ |
258 void *purple_blist_get_ui_data(void); | 278 void *purple_blist_get_ui_data(void); |
259 | 279 |
260 /** | 280 /** |
261 * Sets the UI data for the list. | 281 * Sets the UI data for the list. |
262 * | 282 * |
263 * @param ui_data The UI data for the list. | 283 * @param ui_data The UI data for the list. |
284 * | |
264 * @since 2.6.0 | 285 * @since 2.6.0 |
265 */ | 286 */ |
266 void purple_blist_set_ui_data(void *ui_data); | 287 void purple_blist_set_ui_data(void *ui_data); |
267 | 288 |
268 /** | 289 /** |
343 /** | 364 /** |
344 * Sets the UI data of a given node. | 365 * Sets the UI data of a given node. |
345 * | 366 * |
346 * @param node The node. | 367 * @param node The node. |
347 * @param ui_data The UI data. | 368 * @param ui_data The UI data. |
369 * | |
348 * @since 2.6.0 | 370 * @since 2.6.0 |
349 */ | 371 */ |
350 void purple_blist_node_set_ui_data(PurpleBlistNode *node, void *ui_data); | 372 void purple_blist_node_set_ui_data(PurpleBlistNode *node, void *ui_data); |
351 | 373 |
352 /** | 374 /** |
377 | 399 |
378 /** | 400 /** |
379 * Updates a node's custom icon. | 401 * Updates a node's custom icon. |
380 * | 402 * |
381 * @param node The PurpleBlistNode whose custom icon has changed. | 403 * @param node The PurpleBlistNode whose custom icon has changed. |
404 * | |
382 * @since 2.5.0 | 405 * @since 2.5.0 |
383 */ | 406 */ |
384 void purple_blist_update_node_icon(PurpleBlistNode *node); | 407 void purple_blist_update_node_icon(PurpleBlistNode *node); |
385 | 408 |
386 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_) | 409 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_) |
759 /** | 782 /** |
760 * Returns the local alias for the buddy, or @c NULL if none exists. | 783 * Returns the local alias for the buddy, or @c NULL if none exists. |
761 * | 784 * |
762 * @param buddy The buddy | 785 * @param buddy The buddy |
763 * @return The local alias for the buddy | 786 * @return The local alias for the buddy |
787 * | |
764 * @since 2.6.0 | 788 * @since 2.6.0 |
765 */ | 789 */ |
766 const char *purple_buddy_get_local_buddy_alias(PurpleBuddy *buddy); | 790 const char *purple_buddy_get_local_buddy_alias(PurpleBuddy *buddy); |
767 | 791 |
768 /** | 792 /** |
835 * Returns the account the chat belongs to. | 859 * Returns the account the chat belongs to. |
836 * | 860 * |
837 * @param chat The chat. | 861 * @param chat The chat. |
838 * | 862 * |
839 * @return The account the chat belongs to. | 863 * @return The account the chat belongs to. |
864 * | |
840 * @since 2.4.0 | 865 * @since 2.4.0 |
841 */ | 866 */ |
842 PurpleAccount *purple_chat_get_account(PurpleChat *chat); | 867 PurpleAccount *purple_chat_get_account(PurpleChat *chat); |
843 | 868 |
844 /** | 869 /** |
845 * Get a hashtable containing information about a chat. | 870 * Get a hashtable containing information about a chat. |
846 * | 871 * |
847 * @param chat The chat. | 872 * @param chat The chat. |
848 * | 873 * |
849 * @constreturn The hashtable. | 874 * @constreturn The hashtable. |
875 * | |
850 * @since 2.4.0 | 876 * @since 2.4.0 |
851 */ | 877 */ |
852 GHashTable *purple_chat_get_components(PurpleChat *chat); | 878 GHashTable *purple_chat_get_components(PurpleChat *chat); |
853 | 879 |
854 /** | 880 /** |
1063 * Get the type of a given node. | 1089 * Get the type of a given node. |
1064 * | 1090 * |
1065 * @param node The node. | 1091 * @param node The node. |
1066 * | 1092 * |
1067 * @return The type of the node. | 1093 * @return The type of the node. |
1094 * | |
1068 * @since 2.1.0 | 1095 * @since 2.1.0 |
1069 */ | 1096 */ |
1070 PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node); | 1097 PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node); |
1071 | 1098 |
1072 /*@}*/ | 1099 /*@}*/ |