/pidgin/main: 0d6a2ff4f776: Minor comment fiddling.

[Mark Doliner]

Changeset: 0d6a2ff4f776225ae7953ec2b6c309fff5ecf1ca
Author:	 Mark Doliner <mark at kingant.net>
Date:	 2013-12-06 00:10 -0800
Branch:	 default
URL: https://hg.pidgin.im/pidgin/main/rev/0d6a2ff4f776

Description:

Minor comment fiddling.

These "TODO" comments are really intended for us, where as the
/** doc style */ comments are intended for 3rd party devs. So
move the TODOs into a separate comment.

diffstat:

 libpurple/connection.c |  6 +++---
 libpurple/roomlist.c   |  6 +++---
 libpurple/whiteboard.c |  6 +++---
 libpurple/xfer.c       |  5 ++---
 4 files changed, 11 insertions(+), 12 deletions(-)

diffs (63 lines):

diff --git a/libpurple/connection.c b/libpurple/connection.c
--- a/libpurple/connection.c
+++ b/libpurple/connection.c
@@ -65,9 +65,9 @@ struct _PurpleConnectionPrivate
 
 	GSList *active_chats;         /**< A list of active chats
 	                                  (#PurpleChatConversation structs). */
-	void *proto_data;             /**< Protocol-specific data.            
-	                                  TODO Remove this, and use
-	                                       protocol-specific subclasses  */
+
+	/* TODO Remove this and use protocol-specific subclasses. */
+	void *proto_data;             /**< Protocol-specific data.           */
 
 	char *display_name;           /**< How you appear to other people.   */
 	guint keepalive;              /**< Keep-alive.                       */
diff --git a/libpurple/roomlist.c b/libpurple/roomlist.c
--- a/libpurple/roomlist.c
+++ b/libpurple/roomlist.c
@@ -46,9 +46,9 @@ struct _PurpleRoomlistPrivate {
 	GList *fields;           /**< The fields.                       */
 	GList *rooms;            /**< The list of rooms.                */
 	gboolean in_progress;    /**< The listing is in progress.       */
-	gpointer proto_data;     /** Protocol private data.
-	                             TODO Remove this, and use
-	                                  protocol-specific subclasses  */
+
+	/* TODO Remove this and use protocol-specific subclasses. */
+	gpointer proto_data;     /** Protocol private data.             */
 };
 
 /**
diff --git a/libpurple/whiteboard.c b/libpurple/whiteboard.c
--- a/libpurple/whiteboard.c
+++ b/libpurple/whiteboard.c
@@ -40,9 +40,9 @@ struct _PurpleWhiteboardPrivate
 	PurpleAccount *account;         /**< Account associated with this session */
 	char *who;                      /**< Name of the remote user              */
 
-	void *proto_data;               /**< Protocol specific data
-	                                     TODO Remove this, and use
-	                                          protocol-specific subclasses    */
+	/* TODO Remove this and use protocol-specific subclasses. */
+	void *proto_data;               /**< Protocol specific data               */
+
 	PurpleWhiteboardPrplOps *prpl_ops; /**< Protocol-plugin operations        */
 
 	GList *draw_list;               /**< List of drawing elements/deltas to
diff --git a/libpurple/xfer.c b/libpurple/xfer.c
--- a/libpurple/xfer.c
+++ b/libpurple/xfer.c
@@ -100,9 +100,8 @@ struct _PurpleXferPrivate {
 
 	PurpleXferUiOps *ui_ops;     /**< UI-specific operations.             */
 
-	void *proto_data;            /**< prpl-specific data.
-	                                  TODO Remove this, and use
-	                                       protocol-specific subclasses   */
+	/* TODO Remove this and use protocol-specific subclasses. */
+	void *proto_data;            /**< prpl-specific data.                 */
 
 	/*
 	 * Used to moderate the file transfer when either the read/write ui_ops are