summaryrefslogtreecommitdiff
path: root/libpurple/buddyicon.h
diff options
context:
space:
mode:
authorWill Thompson <will.thompson@collabora.co.uk>2008-05-26 20:46:00 (GMT)
committerWill Thompson <will.thompson@collabora.co.uk>2008-05-26 20:46:00 (GMT)
commitd0a6b38705b9827d14edf532f17d9d537a78b142 (patch)
treef581aca41d579ecc82de7560351ce1c4776c52e7 /libpurple/buddyicon.h
parent4df68ca8f900f082879d61e0177fbc52824464b5 (diff)
downloadpidgin-d0a6b38705b9827d14edf532f17d9d537a78b142.tar.gz
pidgin-d0a6b38705b9827d14edf532f17d9d537a78b142.tar.xz
Add doxycomment for PurpleBuddyIcon; tweak that of PurpleBuddyIconSpec.
(Documentation for struct members does not appear in the HTML documentation unless the struct (not just the typedef) has a doxycomment.)
Diffstat (limited to 'libpurple/buddyicon.h')
-rw-r--r--libpurple/buddyicon.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/libpurple/buddyicon.h b/libpurple/buddyicon.h
index cf1343a..581f31e 100644
--- a/libpurple/buddyicon.h
+++ b/libpurple/buddyicon.h
@@ -26,6 +26,11 @@
#ifndef _PURPLE_BUDDYICON_H_
#define _PURPLE_BUDDYICON_H_
+/** An opaque structure representing a buddy icon for a particular user on a
+ * particular #PurpleAccount. Instances are reference-counted; use
+ * purple_buddy_icon_ref() and purple_buddy_icon_unref() to take and release
+ * references.
+ */
typedef struct _PurpleBuddyIcon PurpleBuddyIcon;
#include "account.h"