Mercurial > pidgin
diff libpurple/buddyicon.h @ 23208:d3fb9d9b57e2
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.)
| author | Will Thompson <will.thompson@collabora.co.uk> |
|---|---|
| date | Mon, 26 May 2008 20:46:00 +0000 |
| parents | 4044655e5615 |
| children | 2ecdd0403dc1 |
line wrap: on
line diff
--- a/libpurple/buddyicon.h Mon May 26 02:16:05 2008 +0000 +++ b/libpurple/buddyicon.h Mon May 26 20:46:00 2008 +0000 @@ -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"