diff options
| author | Gary Kramlich <grim@reaperworld.com> | 2021-08-04 04:40:54 -0500 |
|---|---|---|
| committer | Gary Kramlich <grim@reaperworld.com> | 2021-08-04 04:40:54 -0500 |
| commit | e7a275df761f9449359b52d2919f4c38312de510 (patch) | |
| tree | cf4ef502dd4b2e246d20e57d35e5390d40b332f4 /libpurple/buddy.h | |
| parent | 61bc1a87178b18781a5c41259e7b1b83696aef9e (diff) | |
| download | pidgin-e7a275df761f9449359b52d2919f4c38312de510.tar.gz | |
A bunch of random libpurple documentation fixes
Testing Done:
Build the docs and verified the fixes in `build/doc/reference/libpurple/libpurple-undocumented.txt`
Reviewed at https://reviews.imfreedom.org/r/872/
Diffstat (limited to 'libpurple/buddy.h')
| -rw-r--r-- | libpurple/buddy.h | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/libpurple/buddy.h b/libpurple/buddy.h index 40781b0926..fcd9241ae6 100644 --- a/libpurple/buddy.h +++ b/libpurple/buddy.h @@ -53,11 +53,23 @@ typedef struct _PurpleBuddyClass PurpleBuddyClass; #include "purplepresence.h" #include "status.h" +/** + * PURPLE_BUDDY_IS_ONLINE: + * @b: The #PurpleBuddy instance. + * + * Checks whether @b is online or not. + */ #define PURPLE_BUDDY_IS_ONLINE(b) \ (PURPLE_IS_BUDDY(b) \ && purple_account_is_connected(purple_buddy_get_account(PURPLE_BUDDY(b))) \ && purple_presence_is_online(purple_buddy_get_presence(PURPLE_BUDDY(b)))) +/** + * PURPLE_BLIST_NODE_NAME: + * @n: The #PurpleBlistNode instance. + * + * Gets the name of @n. + */ #define PURPLE_BLIST_NODE_NAME(n) \ (PURPLE_IS_CHAT(n) ? purple_chat_get_name(PURPLE_CHAT(n)) : \ PURPLE_IS_BUDDY(n) ? purple_buddy_get_name(PURPLE_BUDDY(n)) : NULL) |