/soc/2013/ankitkv/gobjectification: 91119588bc3a: Merge gtkdoc-c...
Ankit Vani
a at nevitus.org
Fri Jan 31 09:38:46 EST 2014
Changeset: 91119588bc3a1a4d9d3e2b36a3d52c5130f4368e
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-31 20:07 +0530
Branch: soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/91119588bc3a
Description:
Merge gtkdoc-conversion
diffstat:
libpurple/buddyicon.h | 220 +++++++++++++--------
libpurple/buddylist.h | 184 ++++++++++++------
libpurple/certificate.h | 269 +++++++++++++++++++--------
libpurple/cipher.h | 115 +++++++----
libpurple/circularbuffer.h | 53 +++--
libpurple/cmds.h | 138 +++++++++-----
libpurple/connection.h | 298 +++++++++++++++++++-----------
libpurple/conversation.h | 407 +++++++++++++++++++++++++----------------
libpurple/conversations.h | 49 +++-
libpurple/conversationtypes.h | 364 +++++++++++++++++++++++--------------
libpurple/core.h | 37 ++-
libpurple/dbus-server.h | 136 +++++++------
libpurple/debug.h | 101 ++++++---
libpurple/desktopitem.h | 25 +-
libpurple/dnsquery.h | 49 +++-
libpurple/dnssrv.h | 52 +++-
libpurple/e2ee.h | 83 +++++---
libpurple/eventloop.h | 117 +++++++----
libpurple/http.h | 368 +++++++++++++++++++++++++------------
libpurple/idle.h | 17 +-
libpurple/imgstore.h | 103 ++++++----
libpurple/internal.h | 66 ++++--
libpurple/keyring.h | 215 ++++++++++++++-------
libpurple/log.h | 279 +++++++++++++++++-----------
libpurple/media-gst.h | 101 ++++++---
libpurple/media.h | 176 ++++++++++-------
libpurple/mediamanager.h | 88 +++++---
libpurple/mime.h | 101 ++++++---
libpurple/nat-pmp.h | 15 +-
libpurple/network.h | 135 ++++++++-----
libpurple/notify.h | 344 +++++++++++++++++++++++------------
libpurple/ntlm.h | 19 +-
libpurple/pluginpref.h | 132 +++++++++----
libpurple/pounce.h | 192 ++++++++++++-------
libpurple/prefs.h | 169 +++++++++++-----
libpurple/presence.h | 149 +++++++++-----
libpurple/proxy.h | 142 +++++++++-----
libpurple/version.h.in | 36 ++-
38 files changed, 3540 insertions(+), 2004 deletions(-)
diffs (truncated from 13301 to 300 lines):
diff --git a/libpurple/buddyicon.h b/libpurple/buddyicon.h
--- a/libpurple/buddyicon.h
+++ b/libpurple/buddyicon.h
@@ -28,21 +28,18 @@
#define PURPLE_TYPE_BUDDY_ICON (purple_buddy_icon_get_type())
-/** 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.
+/**
+ * PurpleBuddyIcon:
+ *
+ * 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;
#define PURPLE_TYPE_BUDDY_ICON_SPEC (purple_buddy_icon_spec_get_type())
-/**
- * A description of a Buddy Icon specification. This tells Purple what kind of
- * image file it should give a protocol, and what kind of image file it should
- * expect back. Dimensions less than 1 should be ignored and the image not
- * scaled.
- */
typedef struct _PurpleBuddyIconSpec PurpleBuddyIconSpec;
#include "account.h"
@@ -51,21 +48,32 @@ typedef struct _PurpleBuddyIconSpec Purp
#include "protocols.h"
#include "util.h"
-/** @copydoc PurpleBuddyIconSpec */
+/**
+ * PurpleBuddyIconSpec:
+ * @format: This is a comma-delimited list of image formats or %NULL if icons
+ * are not supported. Neither the core nor the protocol 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
+ * @min_width: Minimum width of this icon
+ * @min_height: Minimum height of this icon
+ * @max_width: Maximum width of this icon
+ * @max_height: Maximum height of this icon
+ * @max_filesize: Maximum size in bytes
+ * @scale_rules: How to stretch this icon
+ *
+ * A description of a Buddy Icon specification. This tells Purple what kind of
+ * image file it should give a protocol, and what kind of image file it should
+ * expect back. Dimensions less than 1 should be ignored and the image not
+ * scaled.
+ */
struct _PurpleBuddyIconSpec {
- /** This is a comma-delimited list of image formats or %NULL if icons
- * are not supported. Neither the core nor the protocol 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 */
+ int min_width;
+ int min_height;
+ int max_width;
+ int max_height;
+ size_t max_filesize;
+ PurpleIconScaleRules scale_rules;
};
G_BEGIN_DECLS
@@ -76,22 +84,25 @@ G_BEGIN_DECLS
/*@{*/
/**
+ * purple_buddy_icon_get_type:
+ *
* Returns the GType for the PurpleBuddyIcon boxed structure.
*/
GType purple_buddy_icon_get_type(void);
/**
- * Creates a new buddy icon structure and populates it.
- *
- * If an icon for this account+username already exists, you'll get a reference
- * to that structure, which will have been updated with the data supplied.
- *
+ * purple_buddy_icon_new:
* @account: The account the user is on.
* @username: The username the icon belongs to.
* @icon_data: The buddy icon data.
* @icon_len: The buddy icon length.
* @checksum: A protocol checksum from the protocol or %NULL.
*
+ * Creates a new buddy icon structure and populates it.
+ *
+ * If an icon for this account+username already exists, you'll get a reference
+ * to that structure, which will have been updated with the data supplied.
+ *
* Returns: The buddy icon structure, with a reference for the caller.
*/
PurpleBuddyIcon *purple_buddy_icon_new(PurpleAccount *account, const char *username,
@@ -99,94 +110,106 @@ PurpleBuddyIcon *purple_buddy_icon_new(P
const char *checksum);
/**
+ * purple_buddy_icon_ref:
+ * @icon: The buddy icon.
+ *
* Increments the reference count on a buddy icon.
*
- * @icon: The buddy icon.
- *
- * Returns: @a icon.
+ * Returns: @icon.
*/
PurpleBuddyIcon *purple_buddy_icon_ref(PurpleBuddyIcon *icon);
/**
+ * purple_buddy_icon_unref:
+ * @icon: The buddy icon.
+ *
* Decrements the reference count on a buddy icon.
*
* If the reference count reaches 0, the icon will be destroyed.
- *
- * @icon: The buddy icon.
*/
void purple_buddy_icon_unref(PurpleBuddyIcon *icon);
/**
+ * purple_buddy_icon_update:
+ * @icon: The buddy icon.
+ *
* Updates every instance of this icon.
- *
- * @icon: The buddy icon.
*/
void purple_buddy_icon_update(PurpleBuddyIcon *icon);
/**
- * Sets the buddy icon's data.
- *
+ * purple_buddy_icon_set_data:
* @icon: The buddy icon.
* @data: The buddy icon data, which the buddy icon code
* takes ownership of and will free.
* @len: The length of the data in @a data.
* @checksum: A protocol checksum from the protocol or %NULL.
+ *
+ * Sets the buddy icon's data.
*/
void
purple_buddy_icon_set_data(PurpleBuddyIcon *icon, guchar *data,
size_t len, const char *checksum);
/**
+ * purple_buddy_icon_get_account:
+ * @icon: The buddy icon.
+ *
* Returns the buddy icon's account.
*
- * @icon: The buddy icon.
- *
* Returns: The account.
*/
PurpleAccount *purple_buddy_icon_get_account(const PurpleBuddyIcon *icon);
/**
+ * purple_buddy_icon_get_username:
+ * @icon: The buddy icon.
+ *
* Returns the buddy icon's username.
*
- * @icon: The buddy icon.
- *
* Returns: The username.
*/
const char *purple_buddy_icon_get_username(const PurpleBuddyIcon *icon);
/**
+ * purple_buddy_icon_get_checksum:
+ * @icon: The buddy icon.
+ *
* Returns the buddy icon's checksum.
*
* This function is really only for protocol use.
*
- * @icon: The buddy icon.
- *
* Returns: The checksum.
*/
const char *purple_buddy_icon_get_checksum(const PurpleBuddyIcon *icon);
/**
- * Returns the buddy icon's data.
- *
+ * purple_buddy_icon_get_data:
* @icon: The buddy icon.
* @len: If not %NULL, the length of the icon data returned will be
* set in the location pointed to by this.
*
+ * Returns the buddy icon's data.
+ *
* Returns: A pointer to the icon data.
*/
gconstpointer purple_buddy_icon_get_data(const PurpleBuddyIcon *icon, size_t *len);
/**
+ * purple_buddy_icon_get_extension:
+ * @icon: The buddy icon.
+ *
* Returns an extension corresponding to the buddy icon's file type.
*
- * @icon: The buddy icon.
- *
* Returns: The icon's extension, "icon" if unknown, or %NULL if
* the image data has disappeared.
*/
const char *purple_buddy_icon_get_extension(const PurpleBuddyIcon *icon);
/**
+ * purple_buddy_icon_get_full_path:
+ * @icon: The buddy icon
+ *
* Returns a full path to an icon.
*
* If the icon has data and the file exists in the cache, this will return
@@ -196,8 +219,6 @@ const char *purple_buddy_icon_get_extens
* directly. If you find yourself wanting to use this function, think
* very long and hard about it, and then don't.
*
- * @icon: The buddy icon
- *
* Returns: A full path to the file, or %NULL under various conditions.
*/
char *purple_buddy_icon_get_full_path(PurpleBuddyIcon *icon);
@@ -210,14 +231,15 @@ char *purple_buddy_icon_get_full_path(Pu
/*@{*/
/**
- * Sets a buddy icon for a user.
- *
+ * purple_buddy_icons_set_for_user:
* @account: The account the user is on.
* @username: The username of the user.
* @icon_data: The buddy icon data, which the buddy icon code
* takes ownership of and will free.
* @icon_len: The length of the icon data.
* @checksum: A protocol checksum from the protocol or %NULL.
+ *
+ * Sets a buddy icon for a user.
*/
void
purple_buddy_icons_set_for_user(PurpleAccount *account, const char *username,
@@ -225,24 +247,26 @@ purple_buddy_icons_set_for_user(PurpleAc
const char *checksum);
/**
+ * purple_buddy_icons_get_checksum_for_user:
+ * @buddy: The buddy
+ *
* Returns the checksum for the buddy icon of a specified buddy.
*
* This avoids loading the icon image data from the cache if it's
* not already loaded for some other reason.
*
- * @buddy: The buddy
- *
* Returns: The checksum.
*/
const char *
purple_buddy_icons_get_checksum_for_user(PurpleBuddy *buddy);
/**
- * Returns the buddy icon information for a user.
- *
+ * purple_buddy_icons_find:
* @account: The account the user is on.
* @username: The username of the user.
*
+ * Returns the buddy icon information for a user.
+ *
* Returns: The icon (with a reference for the caller) if found, or %NULL if
* not found.
*/
@@ -250,6 +274,9 @@ PurpleBuddyIcon *
purple_buddy_icons_find(PurpleAccount *account, const char *username);
/**
+ * purple_buddy_icons_find_account_icon:
+ * @account: The account
+ *
More information about the Commits
mailing list