/soc/2013/ankitkv/gobjectification: 8ee08a41f2f3: Convert some o...

Ankit Vani a at nevitus.org
Thu Feb 6 09:47:09 EST 2014


Changeset: 8ee08a41f2f351c34f4a396e9fcb6f6235090f93
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-06 17:25 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/8ee08a41f2f3

Description:

Convert some other doxygen-type comments

diffstat:

 finch/gntblist.h           |  19 +++++++++-----
 finch/libgnt/gntentry.h    |   4 +-
 libpurple/account.c        |  52 +++++++++++++++++++-------------------
 libpurple/accountopt.c     |  30 +++++++++++-----------
 libpurple/blistnode.c      |  20 ++++++--------
 libpurple/blistnodetypes.c |  60 +++++++++++++++++++++------------------------
 libpurple/imgstore.c       |   6 ++--
 libpurple/log.h            |  57 +++++++++++++++++++++++-------------------
 libpurple/prpl.c           |  10 +++---
 libpurple/roomlist.h       |  18 +++++++++----
 libpurple/smiley.c         |  12 ++++----
 libpurple/whiteboard.c     |  17 ++++++------
 pidgin/gtkroomlist.c       |   2 +-
 pidgin/gtkthemes.h         |   2 +-
 14 files changed, 159 insertions(+), 150 deletions(-)

diffs (truncated from 599 to 300 lines):

diff --git a/finch/gntblist.h b/finch/gntblist.h
--- a/finch/gntblist.h
+++ b/finch/gntblist.h
@@ -40,8 +40,13 @@ typedef struct _FinchBlistManager  Finch
 
 /**
  * FinchBlistManager:
- * @id:   An identifier for the manager.
- * @name: Displayable name for the manager.
+ * @id:             An identifier for the manager.
+ * @name:           Displayable name for the manager.
+ * @init:           Called right before it's being used.
+ * @uninit:         Called right after it's not being used any more.
+ * @can_add_node:   Whether a node should be added to the view.
+ * @find_parent:    Find the parent row for a node.
+ * @create_tooltip: Create tooltip for a selected row.
  *
  * Buddylist manager for finch. This decides the visility, ordering and hierarchy
  * of the buddylist nodes. This also manages the creation of tooltips.
@@ -50,11 +55,11 @@ struct _FinchBlistManager
 {
 	const char *id;
 	const char *name;
-	gboolean (*init)(void);                            /**< Called right before it's being used. */
-	gboolean (*uninit)(void);                          /**< Called right after it's not being used any more. */
-	gboolean (*can_add_node)(PurpleBlistNode *node);   /**< Whether a node should be added to the view. */
-	gpointer (*find_parent)(PurpleBlistNode *node);    /**< Find the parent row for a node. */
-	gboolean (*create_tooltip)(gpointer selected_row, GString **body, char **title);  /**< Create tooltip for a selected row. */
+	gboolean (*init)(void);
+	gboolean (*uninit)(void);
+	gboolean (*can_add_node)(PurpleBlistNode *node);
+	gpointer (*find_parent)(PurpleBlistNode *node);
+	gboolean (*create_tooltip)(gpointer selected_row, GString **body, char **title);
 
 	/*< private >*/
 	gpointer reserved[4];
diff --git a/finch/libgnt/gntentry.h b/finch/libgnt/gntentry.h
--- a/finch/libgnt/gntentry.h
+++ b/finch/libgnt/gntentry.h
@@ -88,8 +88,8 @@ struct _GntEntry
 	gboolean word;      /* Are the suggestions for only a word, or for the whole thing? */
 	gboolean always;    /* Should the list of suggestions show at all times, or only on tab-press? */
 	GntWidget *ddown;   /* The dropdown with the suggested list */
-	GntEntryKillRing *killring; /**< Since: 2.3.0 */
-	GntEntrySearch *search;		/**< Since: 2.7.0 */
+	GntEntryKillRing *killring; /* Since: 2.3.0 */
+	GntEntrySearch *search;		/* Since: 2.7.0 */
 };
 
 struct _GntEntryClass
diff --git a/libpurple/account.c b/libpurple/account.c
--- a/libpurple/account.c
+++ b/libpurple/account.c
@@ -39,28 +39,28 @@
 
 typedef struct
 {
-	char *username;             /**< The username.                          */
-	char *alias;                /**< How you appear to yourself.            */
-	char *password;             /**< The account password.                  */
-	char *user_info;            /**< User information.                      */
-
-	char *buddy_icon_path;      /**< The buddy icon's non-cached path.      */
-
-	gboolean remember_pass;     /**< Remember the password.                 */
+	char *username;             /* The username.                          */
+	char *alias;                /* How you appear to yourself.            */
+	char *password;             /* The account password.                  */
+	char *user_info;            /* User information.                      */
+
+	char *buddy_icon_path;      /* The buddy icon's non-cached path.      */
+
+	gboolean remember_pass;     /* Remember the password.                 */
 
 	/*
 	 * TODO: After a GObject representing a protocol is ready, use it
 	 * here instead of the protocol ID.
 	 */
-	char *protocol_id;          /**< The ID of the protocol.                */
-
-	PurpleConnection *gc;         /**< The connection handle.               */
-	gboolean disconnecting;     /**< The account is currently disconnecting */
-
-	GHashTable *settings;       /**< Protocol-specific settings.            */
-	GHashTable *ui_settings;    /**< UI-specific settings.                  */
-
-	PurpleProxyInfo *proxy_info;  /**< Proxy information.  This will be set */
+	char *protocol_id;          /* The ID of the protocol.                */
+
+	PurpleConnection *gc;       /* The connection handle.               */
+	gboolean disconnecting;     /* The account is currently disconnecting */
+
+	GHashTable *settings;       /* Protocol-specific settings.            */
+	GHashTable *ui_settings;    /* UI-specific settings.                  */
+
+	PurpleProxyInfo *proxy_info;  /* Proxy information.  This will be set */
 								/*   to NULL when the account inherits      */
 								/*   proxy settings from global prefs.      */
 
@@ -72,19 +72,19 @@ typedef struct
 	 * list therefore the permit list is large. Possibly GTree or
 	 * GHashTable.
 	 */
-	GSList *permit;             /**< Permit list.                           */
-	GSList *deny;               /**< Deny list.                             */
-	PurpleAccountPrivacyType privacy_type;  /**< The permit/deny setting.   */
-
-	GList *status_types;        /**< Status types.                          */
-
-	PurplePresence *presence;     /**< Presence.                            */
-	PurpleLog *system_log;        /**< The system log                       */
+	GSList *permit;             /* Permit list.                           */
+	GSList *deny;               /* Deny list.                             */
+	PurpleAccountPrivacyType privacy_type;  /* The permit/deny setting.   */
+
+	GList *status_types;        /* Status types.                          */
+
+	PurplePresence *presence;     /* Presence.                            */
+	PurpleLog *system_log;        /* The system log                       */
 
 	PurpleAccountRegistrationCb registration_cb;
 	void *registration_cb_user_data;
 
-	PurpleConnectionErrorInfo *current_error;	/**< Errors */
+	PurpleConnectionErrorInfo *current_error;	/* Errors */
 } PurpleAccountPrivate;
 
 typedef struct
diff --git a/libpurple/accountopt.c b/libpurple/accountopt.c
--- a/libpurple/accountopt.c
+++ b/libpurple/accountopt.c
@@ -32,17 +32,17 @@
  */
 struct _PurpleAccountOption
 {
-	PurplePrefType type;      /**< The type of value.                     */
+	PurplePrefType type;      /* The type of value.                     */
 
-	char *text;             /**< The text that will appear to the user. */
-	char *pref_name;        /**< The name of the associated preference. */
+	char *text;             /* The text that will appear to the user. */
+	char *pref_name;        /* The name of the associated preference. */
 
 	union
 	{
-		gboolean boolean;   /**< The default boolean value.             */
-		int integer;        /**< The default integer value.             */
-		char *string;       /**< The default string value.              */
-		GList *list;        /**< The default list value.                */
+		gboolean boolean;   /* The default boolean value.             */
+		int integer;        /* The default integer value.             */
+		char *string;       /* The default string value.              */
+		GList *list;        /* The default list value.                */
 
 	} default_value;
 
@@ -50,11 +50,11 @@ struct _PurpleAccountOption
 	{
 		struct
 		{
-			gboolean masked; /**< Whether the value entered should
+			gboolean masked; /* Whether the value entered should
 			                  *   be obscured from view (for
 			                  *   passwords and similar options)
 			                  */
-			GSList *hints;    /**< List of hinted values */
+			GSList *hints;    /* List of hinted values */
 		} string;
 	} params;
 };
@@ -67,12 +67,12 @@ struct _PurpleAccountOption
  */
 struct _PurpleAccountUserSplit
 {
-	char *text;             /**< The text that will appear to the user. */
-	char *default_value;    /**< The default value.                     */
-	char  field_sep;        /**< The field separator.                   */
-	gboolean reverse;       /**< TRUE if the separator should be found
-							  starting a the end of the string, FALSE
-							  otherwise                                 */
+	char *text;             /* The text that will appear to the user. */
+	char *default_value;    /* The default value.                     */
+	char  field_sep;        /* The field separator.                   */
+	gboolean reverse;       /* TRUE if the separator should be found
+							   starting a the end of the string, FALSE
+							   otherwise                                 */
 };
 
 
diff --git a/libpurple/blistnode.c b/libpurple/blistnode.c
--- a/libpurple/blistnode.c
+++ b/libpurple/blistnode.c
@@ -27,19 +27,17 @@
 #define PURPLE_BLIST_NODE_GET_PRIVATE(obj) \
 	(G_TYPE_INSTANCE_GET_PRIVATE((obj), PURPLE_TYPE_BLIST_NODE, PurpleBlistNodePrivate))
 
-/** @copydoc _PurpleBlistNodePrivate */
 typedef struct _PurpleBlistNodePrivate  PurpleBlistNodePrivate;
 
 #define PURPLE_COUNTING_NODE_GET_PRIVATE(obj) \
 	(G_TYPE_INSTANCE_GET_PRIVATE((obj), PURPLE_TYPE_COUNTING_NODE, PurpleCountingNodePrivate))
 
-/** @copydoc _PurpleCountingNodePrivate */
 typedef struct _PurpleCountingNodePrivate  PurpleCountingNodePrivate;
 
-/** Private data of a buddy list node */
+/* Private data of a buddy list node */
 struct _PurpleBlistNodePrivate {
-	GHashTable *settings;  /**< per-node settings                            */
-	gboolean transient;    /**< node should not be saved with the buddy list */
+	GHashTable *settings;  /* per-node settings                            */
+	gboolean transient;    /* node should not be saved with the buddy list */
 };
 
 /* Blist node property enums */
@@ -50,13 +48,13 @@ enum
 	BLNODE_PROP_LAST
 };
 
-/** Private data of a counting node */
+/* Private data of a counting node */
 struct _PurpleCountingNodePrivate {
-	int totalsize;    /**< The number of children under this node            */
-	int currentsize;  /**< The number of children under this node
-	                       corresponding to online accounts                  */
-	int onlinecount;  /**< The number of children under this contact who are
-	                       currently online                                  */
+	int totalsize;    /* The number of children under this node            */
+	int currentsize;  /* The number of children under this node
+	                     corresponding to online accounts                  */
+	int onlinecount;  /* The number of children under this contact who are
+	                     currently online                                  */
 };
 
 /* Counting node property enums */
diff --git a/libpurple/blistnodetypes.c b/libpurple/blistnodetypes.c
--- a/libpurple/blistnodetypes.c
+++ b/libpurple/blistnodetypes.c
@@ -28,45 +28,41 @@
 #define PURPLE_BUDDY_GET_PRIVATE(obj) \
 	(G_TYPE_INSTANCE_GET_PRIVATE((obj), PURPLE_TYPE_BUDDY, PurpleBuddyPrivate))
 
-/** @copydoc _PurpleBuddyPrivate */
 typedef struct _PurpleBuddyPrivate      PurpleBuddyPrivate;
 
 #define PURPLE_CONTACT_GET_PRIVATE(obj) \
 	(G_TYPE_INSTANCE_GET_PRIVATE((obj), PURPLE_TYPE_CONTACT, PurpleContactPrivate))
 
-/** @copydoc _PurpleContactPrivate */
 typedef struct _PurpleContactPrivate    PurpleContactPrivate;
 
 #define PURPLE_GROUP_GET_PRIVATE(obj) \
 	(G_TYPE_INSTANCE_GET_PRIVATE((obj), PURPLE_TYPE_GROUP, PurpleGroupPrivate))
 
-/** @copydoc _PurpleGroupPrivate */
 typedef struct _PurpleGroupPrivate      PurpleGroupPrivate;
 
 #define PURPLE_CHAT_GET_PRIVATE(obj) \
 	(G_TYPE_INSTANCE_GET_PRIVATE((obj), PURPLE_TYPE_CHAT, PurpleChatPrivate))
 
-/** @copydoc _PurpleChatPrivate */
 typedef struct _PurpleChatPrivate       PurpleChatPrivate;
 
 /**************************************************************************/
 /* Private data                                                           */
 /**************************************************************************/
-/** Private data for a buddy. */
+/* Private data for a buddy. */
 struct _PurpleBuddyPrivate {
-	char *name;                  /**< The name of the buddy.                  */
-	char *local_alias;           /**< The user-set alias of the buddy         */
-	char *server_alias;          /**< The server-specified alias of the buddy.
-	                                  (i.e. MSN "Friendly Names")             */
-	void *proto_data;            /**< This allows the prpl to associate
-	                                  whatever data it wants with a buddy.    */
-	PurpleBuddyIcon *icon;       /**< The buddy icon.                         */
-	PurpleAccount *account;      /**< the account this buddy belongs to       */
-	PurplePresence *presence;    /**< Presense information of the buddy       */
-	PurpleMediaCaps media_caps;  /**< The media capabilities of the buddy.    */
+	char *name;                  /* The name of the buddy.                  */
+	char *local_alias;           /* The user-set alias of the buddy         */
+	char *server_alias;          /* The server-specified alias of the buddy.
+	                                (i.e. MSN "Friendly Names")             */
+	void *proto_data;            /* This allows the prpl to associate
+	                                whatever data it wants with a buddy.    */
+	PurpleBuddyIcon *icon;       /* The buddy icon.                         */
+	PurpleAccount *account;      /* the account this buddy belongs to       */
+	PurplePresence *presence;    /* Presense information of the buddy       */
+	PurpleMediaCaps media_caps;  /* The media capabilities of the buddy.    */
 
-	gboolean is_constructed;     /**< Indicates if the buddy has finished
-	                                  being constructed.                      */
+	gboolean is_constructed;     /* Indicates if the buddy has finished
+	                                being constructed.                      */
 };
 
 /* Buddy property enums */
@@ -83,11 +79,11 @@ enum
 	BUDDY_PROP_LAST
 };



More information about the Commits mailing list