Mercurial > pidgin.yaz
changeset 23210: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 | f8a02ba588d1 |
| children | bda7c7c4d4b2 |
| files | libpurple/buddyicon.h libpurple/prpl.h |
| diffstat | 2 files changed, 20 insertions(+), 9 deletions(-) [+] |
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"
--- a/libpurple/prpl.h Mon May 26 02:16:05 2008 +0000 +++ b/libpurple/prpl.h Mon May 26 20:46:00 2008 +0000 @@ -71,16 +71,22 @@ #include "status.h" #include "whiteboard.h" + +/** @copydoc PurpleBuddyIconSpec */ struct _PurpleBuddyIconSpec { - char *format; /**< This is a comma-delimited list of image formats or NULL if icons are not supported. - * Neither the core nor the prpl will actually check to see if the data it's given matches this; it's - * entirely up to the UI to do what it wants */ - int min_width; /**< The minimum width of this icon */ - int min_height; /**< The minimum height of this icon */ - int max_width; /**< The maximum width of this icon */ - int max_height; /**< The maximum height of this icon */ - size_t max_filesize; /**< The maximum number of bytes */ - PurpleIconScaleRules scale_rules; /**< How to stretch this icon */ + /** This is a comma-delimited list of image formats or @c NULL if icons + * are not supported. Neither the core nor the prpl will actually + * check to see if the data it's given matches this; it's entirely up + * to the UI to do what it wants + */ + char *format; + + int min_width; /**< Minimum width of this icon */ + int min_height; /**< Minimum height of this icon */ + int max_width; /**< Maximum width of this icon */ + int max_height; /**< Maximum height of this icon */ + size_t max_filesize; /**< Maximum size in bytes */ + PurpleIconScaleRules scale_rules; /**< How to stretch this icon */ }; struct proto_chat_entry {