/soc/2013/ankitkv/gobjectification: 22bf5ea00006: Merge gtkdoc-c...

Ankit Vani a at nevitus.org
Tue Feb 4 12:52:52 EST 2014


Changeset: 22bf5ea00006a4aaa0a4cd9bff460b729abcce3e
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-04 23:21 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/22bf5ea00006

Description:

Merge gtkdoc-conversion

diffstat:

 libpurple/account.c        |    2 +-
 libpurple/account.h        |    4 +-
 libpurple/accountopt.c     |    4 +-
 libpurple/accounts.h       |   29 ++--
 libpurple/blistnode.h      |   11 +-
 libpurple/blistnodetypes.h |   20 +-
 libpurple/buddyicon.c      |   22 ++--
 libpurple/buddyicon.h      |    2 +-
 libpurple/buddylist.c      |   10 +-
 libpurple/buddylist.h      |  111 ++++++++++---------
 libpurple/certificate.c    |   32 +++--
 libpurple/certificate.h    |  240 +++++++++++++++++++-------------------------
 libpurple/cipher.h         |    4 +-
 libpurple/cmds.c           |    2 +-
 libpurple/connection.c     |   35 +++---
 pidgin/gtkdocklet.h        |    2 +-
 pidgin/gtkwebview.h        |    2 +-
 17 files changed, 255 insertions(+), 277 deletions(-)

diffs (truncated from 1154 to 300 lines):

diff --git a/libpurple/account.c b/libpurple/account.c
--- a/libpurple/account.c
+++ b/libpurple/account.c
@@ -1772,7 +1772,7 @@ purple_account_privacy_deny_remove(Purpl
 	return TRUE;
 }
 
-/**
+/*
  * This makes sure your permit list contains all buddies from your
  * buddy list and ONLY buddies from your buddy list.
  */
diff --git a/libpurple/account.h b/libpurple/account.h
--- a/libpurple/account.h
+++ b/libpurple/account.h
@@ -107,6 +107,7 @@ struct _PurpleAccount
 {
 	GObject gparent;
 
+	/*< public >*/
 	gpointer ui_data;
 };
 
@@ -135,7 +136,7 @@ G_BEGIN_DECLS
 /**
  * purple_account_get_type:
  *
- * Returns the GType for the Account object.
+ * Returns: The #GType for the Account object.
  */
 GType purple_account_get_type(void);
 
@@ -452,6 +453,7 @@ void purple_account_set_privacy_type(Pur
 void purple_account_set_status_types(PurpleAccount *account, GList *status_types);
 
 /**
+ * purple_account_set_status:
  * @account:   The account.
  * @status_id: The ID of the status.
  * @active:    Whether @a status_id is to be activated (%TRUE) or
diff --git a/libpurple/accountopt.c b/libpurple/accountopt.c
--- a/libpurple/accountopt.c
+++ b/libpurple/accountopt.c
@@ -24,7 +24,7 @@
 #include "util.h"
 #include "glibcompat.h"
 
-/**
+/*
  * An option for an account.
  *
  * This is set by protocols, and appears in the account settings
@@ -59,7 +59,7 @@ struct _PurpleAccountOption
 	} params;
 };
 
-/**
+/*
  * A username split.
  *
  * This is used by some protocols to separate the fields of the username
diff --git a/libpurple/accounts.h b/libpurple/accounts.h
--- a/libpurple/accounts.h
+++ b/libpurple/accounts.h
@@ -36,38 +36,42 @@ typedef struct _PurpleAccountUiOps  Purp
 
 /**
  * PurpleAccountUiOps:
+ * @notify_added:          A buddy who is already on this account's buddy list
+ *                         added this account to their buddy list.
+ * @status_changed:        This account's status changed.
+ * @request_add:           Someone we don't have on our list added us; prompt
+ *                         to add them.
+ * @request_authorize:     Prompt for authorization when someone adds this
+ *                         account to their buddy list.  To authorize them to
+ *                         see this account's presence, call
+ *                         @authorize_cb (@message, @user_data) otherwise call
+ *                         @deny_cb (@message, @user_data).
+ *                         <sbr/>Returns: A UI-specific handle, as passed to
+ *                         @close_account_request.
+ * @close_account_request: Close a pending request for authorization.
+ *                         @ui_handle is a handle as returned by
+ *                         @request_authorize.
  *
  * Account UI operations, used to notify the user of status changes and when
  * buddies add this account to their buddy lists.
  */
 struct _PurpleAccountUiOps
 {
-	/** A buddy who is already on this account's buddy list added this account
-	 *  to their buddy list.
-	 */
 	void (*notify_added)(PurpleAccount *account,
 	                     const char *remote_user,
 	                     const char *id,
 	                     const char *alias,
 	                     const char *message);
 
-	/** This account's status changed. */
 	void (*status_changed)(PurpleAccount *account,
 	                       PurpleStatus *status);
 
-	/** Someone we don't have on our list added us; prompt to add them. */
 	void (*request_add)(PurpleAccount *account,
 	                    const char *remote_user,
 	                    const char *id,
 	                    const char *alias,
 	                    const char *message);
 
-	/** Prompt for authorization when someone adds this account to their buddy
-	 * list.  To authorize them to see this account's presence, call \a
-	 * authorize_cb (\a message, \a user_data); otherwise call
-	 * \a deny_cb (\a message, \a user_data);
-	 * Returns: a UI-specific handle, as passed to #close_account_request.
-	 */
 	void *(*request_authorize)(PurpleAccount *account,
 	                           const char *remote_user,
 	                           const char *id,
@@ -78,9 +82,6 @@ struct _PurpleAccountUiOps
 	                           PurpleAccountRequestAuthorizationCb deny_cb,
 	                           void *user_data);
 
-	/** Close a pending request for authorization.  \a ui_handle is a handle
-	 *  as returned by #request_authorize.
-	 */
 	void (*close_account_request)(void *ui_handle);
 
 	void (*permit_added)(PurpleAccount *account, const char *name);
diff --git a/libpurple/blistnode.h b/libpurple/blistnode.h
--- a/libpurple/blistnode.h
+++ b/libpurple/blistnode.h
@@ -71,6 +71,7 @@ typedef struct _PurpleCountingNodeClass 
 struct _PurpleBlistNode {
 	GObject gparent;
 
+	/*< public >*/
 	PurpleBlistNode *prev;
 	PurpleBlistNode *next;
 	PurpleBlistNode *parent;
@@ -96,7 +97,6 @@ struct _PurpleBlistNodeClass {
 
 /**
  * PurpleCountingNode:
- * @node: The blist node that this counting node inherits from
  *
  * A node that keeps count of the number of children that it has. It tracks the
  * total number of children, the number of children corresponding to online
@@ -106,8 +106,7 @@ struct _PurpleBlistNodeClass {
  * 1. Contact: Keeps track of the number of buddies under it.
  * 2. Group:   Keeps track of the number of chats and contacts under it.
  *
- * @see PurpleContact
- * @see PurpleGroup
+ * See #PurpleContact, #PurpleGroup
  */
 struct _PurpleCountingNode {
 	PurpleBlistNode node;
@@ -138,7 +137,7 @@ G_BEGIN_DECLS
 /**
  * purple_blist_node_get_type:
  *
- * Returns the GType for the PurpleBlistNode object.
+ * Returns: The #GType for the #PurpleBlistNode object.
  */
 GType purple_blist_node_get_type(void);
 
@@ -356,7 +355,7 @@ gboolean purple_blist_node_is_transient(
 
 /**
  * purple_blist_node_get_extended_menu:
- * @n The blist node for which to obtain the extended menu items.
+ * @n: The blist node for which to obtain the extended menu items.
  *
  * Retrieves the extended menu items for a buddy list node.
  *
@@ -375,7 +374,7 @@ GList *purple_blist_node_get_extended_me
 /**
  * purple_counting_node_get_type:
  *
- * Returns the GType for the PurpleCountingNode object.
+ * Returns: The #GType for the #PurpleCountingNode object.
  */
 GType purple_counting_node_get_type(void);
 
diff --git a/libpurple/blistnodetypes.h b/libpurple/blistnodetypes.h
--- a/libpurple/blistnodetypes.h
+++ b/libpurple/blistnodetypes.h
@@ -90,7 +90,6 @@ typedef struct _PurpleChatClass PurpleCh
 /**************************************************************************/
 /**
  * PurpleBuddy:
- * @node: The node that this buddy inherits from
  *
  * A buddy on the buddy list.
  */
@@ -115,10 +114,11 @@ struct _PurpleBuddyClass {
 
 /**
  * PurpleContact:
- * @counting: The counting node that this contact inherits from. This keeps
- *            track of the counts of the buddies under this contact.
  *
  * A contact on the buddy list.
+ *
+ * A contact is a counting node, which means it keeps track of the counts of
+ * the buddies under this contact.
  */
 struct _PurpleContact {
 	PurpleCountingNode counting;
@@ -141,10 +141,11 @@ struct _PurpleContactClass {
 
 /**
  * PurpleGroup:
- * @counting: The counting node that this group inherits from. This keeps track
- *            of the counts of the chats and contacts under this group.
  *
  * A group on the buddy list.
+ *
+ * A group is a counting node, which means it keeps track of the counts of the
+ * chats and contacts under this group.
  */
 struct _PurpleGroup {
 	PurpleCountingNode counting;
@@ -167,7 +168,6 @@ struct _PurpleGroupClass {
 
 /**
  * PurpleChat:
- * @node: The node that this chat inherits from
  *
  * A chat on the buddy list.
  */
@@ -200,7 +200,7 @@ G_BEGIN_DECLS
 /**
  * purple_buddy_get_type:
  *
- * Returns the GType for the PurpleBuddy object.
+ * Returns: The #GType for the #PurpleBuddy object.
  */
 GType purple_buddy_get_type(void);
 
@@ -447,7 +447,7 @@ PurpleGroup *purple_buddy_get_group(Purp
 /**
  * purple_contact_get_type:
  *
- * Returns the GType for the PurpleContact object.
+ * Returns: The #GType for the #PurpleContact object.
  */
 GType purple_contact_get_type(void);
 
@@ -540,7 +540,7 @@ void purple_contact_merge(PurpleContact 
 /**
  * purple_chat_get_type:
  *
- * Returns the GType for the PurpleChat object.
+ * Returns: The #GType for the #PurpleChat object.
  */
 GType purple_chat_get_type(void);
 
@@ -627,7 +627,7 @@ GHashTable *purple_chat_get_components(P
 /**
  * purple_group_get_type:
  *
- * Returns the GType for the PurpleGroup object.
+ * Returns: The #GType for the #PurpleGroup object.
  */
 GType purple_group_get_type(void);
 
diff --git a/libpurple/buddyicon.c b/libpurple/buddyicon.c
--- a/libpurple/buddyicon.c
+++ b/libpurple/buddyicon.c
@@ -32,15 +32,15 @@
  * NOTE: be sure to update purple_buddy_icon_new() if you add members. */
 struct _PurpleBuddyIcon
 {
-	PurpleAccount *account;    /**< The account the user is on.          */
-	PurpleStoredImage *img;    /**< The stored image containing
-	                                the icon data.                       */
-	char *username;            /**< The username the icon belongs to.    */
-	char *checksum;            /**< The protocol checksum.               */
-	unsigned int ref_count;    /**< The buddy icon reference count.      */
+	PurpleAccount *account;    /* The account the user is on.          */
+	PurpleStoredImage *img;    /* The stored image containing
+	                              the icon data.                       */
+	char *username;            /* The username the icon belongs to.    */
+	char *checksum;            /* The protocol checksum.               */
+	unsigned int ref_count;    /* The buddy icon reference count.      */
 };
 
-/**
+/*
  * This is the big grand daddy hash table that contains references to
  * everybody's buddy icons.
  *
@@ -52,7 +52,7 @@ struct _PurpleBuddyIcon
  */
 static GHashTable *account_cache = NULL;
 
-/**
+/*
  * This hash table contains a bunch of PurpleStoredImages that are



More information about the Commits mailing list