/soc/2013/ankitkv/gobjectification: 31fa3a1aeff5: Move changes f...
Ankit Vani
a at nevitus.org
Fri Jan 31 09:38:46 EST 2014
Changeset: 31fa3a1aeff581d37b7245eeda52599d0e6f3c3f
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-31 20:02 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/31fa3a1aeff5
Description:
Move changes from soc.2013.gobjectification.gtkdoc to this branch
diffstat:
libpurple/buddyicon.h | 174 +++++++++++------
libpurple/buddylist.h | 184 ++++++++++++------
libpurple/certificate.h | 269 +++++++++++++++++++--------
libpurple/cipher.h | 115 +++++++----
libpurple/circularbuffer.h | 53 +++--
libpurple/cmds.h | 138 +++++++++-----
libpurple/connection.h | 304 +++++++++++++++++++-----------
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 | 281 +++++++++++++++++-----------
libpurple/media-gst.h | 101 ++++++---
libpurple/media.h | 180 +++++++++++-------
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 | 146 +++++++++-----
libpurple/version.h.in | 36 ++-
38 files changed, 3521 insertions(+), 1993 deletions(-)
diffs (truncated from 13213 to 300 lines):
diff --git a/libpurple/buddyicon.h b/libpurple/buddyicon.h
--- a/libpurple/buddyicon.h
+++ b/libpurple/buddyicon.h
@@ -28,10 +28,13 @@
#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;
@@ -49,22 +52,25 @@ G_BEGIN_DECLS
/*@{*/
/**
+ * purple_buddy_icon_get_type:
+ *
* Returns the GType for the PurpleBuddyIcon boxed structure.
*/
GType purple_buddy_icon_get_type(void);
/**
+ * 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.
*
- * @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 prpl or %NULL.
- *
* Returns: The buddy icon structure, with a reference for the caller.
*/
PurpleBuddyIcon *purple_buddy_icon_new(PurpleAccount *account, const char *username,
@@ -72,94 +78,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 prpl or %NULL.
+ * @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 prpl use.
- *
- * @icon: The buddy icon.
+ * This function is really only for protocol use.
*
* 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
@@ -169,8 +187,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);
@@ -183,14 +199,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 prpl or %NULL.
+ * @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,
@@ -198,24 +215,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.
*/
@@ -223,6 +242,9 @@ PurpleBuddyIcon *
purple_buddy_icons_find(PurpleAccount *account, const char *username);
/**
+ * purple_buddy_icons_find_account_icon:
+ * @account: The account
+ *
* Returns the buddy icon image for an account.
*
* The caller owns a reference to the image in the store, and must dereference
@@ -232,24 +254,23 @@ purple_buddy_icons_find(PurpleAccount *a
* needed, so it should be called in any case where you want the
* appropriate icon.
*
- * @account: The account
- *
* Returns: The account's buddy icon image.
*/
PurpleStoredImage *
purple_buddy_icons_find_account_icon(PurpleAccount *account);
/**
+ * purple_buddy_icons_set_account_icon:
+ * @account: The account for which to set a custom icon.
+ * @icon_data: The image data of the icon, which the
+ * buddy icon code will free.
+ * @icon_len: The length of the data in @icon_data.
+ *
* Sets a buddy icon for an account.
*
* This function will deal with saving a record of the icon,
* caching the data, etc.
*
- * @account: The account for which to set a custom icon.
- * @icon_data: The image data of the icon, which the
- * buddy icon code will free.
- * @icon_len: The length of the data in @a icon_data.
- *
* Returns: The icon that was set. The caller does NOT own
* a reference to this, and must call purple_imgstore_ref()
* if it wants one.
@@ -259,29 +280,34 @@ purple_buddy_icons_set_account_icon(Purp
guchar *icon_data, size_t icon_len);
/**
+ * purple_buddy_icons_get_account_icon_timestamp:
+ * @account: The account
+ *
* Returns the timestamp of when the icon was set.
*
* This is intended for use in protocols that require a timestamp for
* buddy icon update reasons.
*
- * @account: The account
- *
* Returns: The time the icon was set, or 0 if an error occurred.
*/
time_t
purple_buddy_icons_get_account_icon_timestamp(PurpleAccount *account);
More information about the Commits
mailing list