pidgin: f7d017b0: Add doxycomment for PurpleBuddyIcon; twe...

[resiak at pidgin.im]

-----------------------------------------------------------------
Revision: f7d017b07571640c01e4ebb88a33ceb638a133bb
Ancestor: e3ab9304de960d8da40ffcc4fe6a16993a1d2537
Author: resiak at pidgin.im
Date: 2008-05-26T20:46:00
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/f7d017b07571640c01e4ebb88a33ceb638a133bb

Modified files:
        libpurple/buddyicon.h libpurple/prpl.h

ChangeLog: 

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.)

-------------- next part --------------
============================================================
--- libpurple/buddyicon.h	f26e74502fc1777f3b7b12902dfa3d3270d1f24a
+++ libpurple/buddyicon.h	9833d0334d2e344c5b0924db76d2c268d3fb2042
@@ -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"
============================================================
--- libpurple/prpl.h	4e5d2a689d62f552a31774e768a0eea24306f9c5
+++ libpurple/prpl.h	582acb3c684815077385c8181e5409110eccd74a
@@ -71,16 +71,22 @@ typedef struct _PurpleBuddyIconSpec Purp
 #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 {