/soc/2013/ankitkv/gobjectification: 92122af1f083: Some documenta...

Ankit Vani a at nevitus.org
Fri Sep 6 14:52:26 EDT 2013


Changeset: 92122af1f0835dbefce9ec9d32df154d8ffe2940
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-09-06 23:02 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/92122af1f083

Description:

Some documentation updates with regard to 'protocol plugins' and 'protocols'

diffstat:

 finch/gntconv.c                |  4 ++--
 libpurple/account.c            |  2 +-
 libpurple/accountopt.c         |  2 +-
 libpurple/connection.c         |  4 ++--
 libpurple/connection.h         |  4 ++--
 libpurple/example/nullclient.c |  2 +-
 libpurple/roomlist.h           |  2 +-
 libpurple/server.h             |  2 +-
 libpurple/util.h               |  2 +-
 libpurple/whiteboard.c         |  2 +-
 libpurple/xfer.h               |  2 +-
 pidgin/gtkconv.c               |  4 ++--
 12 files changed, 16 insertions(+), 16 deletions(-)

diffs (164 lines):

diff --git a/finch/gntconv.c b/finch/gntconv.c
--- a/finch/gntconv.c
+++ b/finch/gntconv.c
@@ -1243,9 +1243,9 @@ debug_command_cb(PurpleConversation *con
 		tmp = g_strdup_printf("Using Finch v%s with libpurple v%s.",
 				DISPLAY_VERSION, purple_core_get_version());
 	} else if (!g_ascii_strcasecmp(args[0], "plugins")) {
-		/* Show all the loaded plugins, including the protocol plugins and plugin loaders.
+		/* Show all the loaded plugins, including plugins marked internal.
 		 * This is intentional, since third party protocols are often sources of bugs, and some
-		 * plugin loaders (e.g. mono) can also be buggy.
+		 * loaders can also be buggy.
 		 */
 		GString *str = g_string_new("Loaded Plugins: ");
 		const GList *plugins = purple_plugins_get_loaded();
diff --git a/libpurple/account.c b/libpurple/account.c
--- a/libpurple/account.c
+++ b/libpurple/account.c
@@ -327,7 +327,7 @@ purple_account_connect(PurpleAccount *ac
 	if (protocol == NULL) {
 		gchar *message;
 
-		message = g_strdup_printf(_("Missing protocol plugin for %s"), username);
+		message = g_strdup_printf(_("Missing protocol for %s"), username);
 		purple_notify_error(account, _("Connection Error"), message, NULL);
 		g_free(message);
 		return;
diff --git a/libpurple/accountopt.c b/libpurple/accountopt.c
--- a/libpurple/accountopt.c
+++ b/libpurple/accountopt.c
@@ -32,7 +32,7 @@
 /**
  * An option for an account.
  *
- * This is set by protocol plugins, and appears in the account settings
+ * This is set by protocols, and appears in the account settings
  * dialogs.
  */
 struct _PurpleAccountOption
diff --git a/libpurple/connection.c b/libpurple/connection.c
--- a/libpurple/connection.c
+++ b/libpurple/connection.c
@@ -878,7 +878,7 @@ void
 	if (protocol == NULL) {
 		gchar *message;
 
-		message = g_strdup_printf(_("Missing protocol plugin for %s"),
+		message = g_strdup_printf(_("Missing protocol for %s"),
 			purple_account_get_username(account));
 		purple_notify_error(NULL, regist ? _("Registration Error") :
 						  _("Connection Error"), message, NULL);
@@ -942,7 +942,7 @@ void
 	if (protocol == NULL) {
 		gchar *message;
 
-		message = g_strdup_printf(_("Missing protocol plugin for %s"),
+		message = g_strdup_printf(_("Missing protocol for %s"),
 								  purple_account_get_username(account));
 		purple_notify_error(NULL, _("Unregistration Error"), message, NULL);
 		g_free(message);
diff --git a/libpurple/connection.h b/libpurple/connection.h
--- a/libpurple/connection.h
+++ b/libpurple/connection.h
@@ -352,11 +352,11 @@ PurpleConnectionFlags purple_connection_
 PurpleAccount *purple_connection_get_account(const PurpleConnection *gc);
 
 /**
- * Returns the protocol plugin managing a connection.
+ * Returns the protocol managing a connection.
  *
  * @param gc The connection.
  *
- * @return The protocol plugin.
+ * @return The protocol.
  */
 PurpleProtocol *purple_connection_get_protocol(const PurpleConnection *gc);
 
diff --git a/libpurple/example/nullclient.c b/libpurple/example/nullclient.c
--- a/libpurple/example/nullclient.c
+++ b/libpurple/example/nullclient.c
@@ -210,7 +210,7 @@ init_libpurple(void)
 	}
 
 	/* Set path to search for plugins. The core (libpurple) takes care of loading the
-	 * core-plugins, which includes the protocol-plugins. So it is not essential to add
+	 * core-plugins, which includes the in-tree protocols. So it is not essential to add
 	 * any path here, but it might be desired, especially for ui-specific plugins. */
 	purple_plugins_add_search_path(CUSTOM_PLUGIN_PATH);
 	purple_plugins_refresh();
diff --git a/libpurple/roomlist.h b/libpurple/roomlist.h
--- a/libpurple/roomlist.h
+++ b/libpurple/roomlist.h
@@ -250,7 +250,7 @@ GList *purple_roomlist_get_fields(Purple
  * @param list The roomlist, which must not be @c NULL.
  *
  * @return The protocol data associated with this room list.  This is a
- *         convenience field provided to the protocol plugin--it is not
+ *         convenience field provided to the protocol -- it is not
  *         used the libpurple core.
  */
 gpointer purple_roomlist_get_proto_data(PurpleRoomlist *list);
diff --git a/libpurple/server.h b/libpurple/server.h
--- a/libpurple/server.h
+++ b/libpurple/server.h
@@ -75,7 +75,7 @@ void serv_alias_buddy(PurpleBuddy *);
 void serv_got_alias(PurpleConnection *gc, const char *who, const char *alias);
 
 /**
- * A protocol plugin should call this when it retrieves a private alias from
+ * A protocol should call this when it retrieves a private alias from
  * the server.  Private aliases are the aliases the user sets, while public
  * aliases are the aliases or display names that buddies set for themselves.
  *
diff --git a/libpurple/util.h b/libpurple/util.h
--- a/libpurple/util.h
+++ b/libpurple/util.h
@@ -956,7 +956,7 @@ const char *purple_normalize_nocase(cons
 /**
  * Checks, if a string is valid.
  *
- * @param protocol The protocol plugin the string belongs to.
+ * @param protocol The protocol the string belongs to.
  * @param str      The string to validate.
  *
  * @return TRUE, if string is valid, otherwise FALSE.
diff --git a/libpurple/whiteboard.c b/libpurple/whiteboard.c
--- a/libpurple/whiteboard.c
+++ b/libpurple/whiteboard.c
@@ -37,7 +37,7 @@ struct _PurpleWhiteboard
 
 	void *ui_data;                   /**< Graphical user-interface data */
 	void *proto_data;                /**< Protocol specific data */
-	PurpleWhiteboardOps *protocol_ops; /**< Protocol-plugin operations */
+	PurpleWhiteboardOps *protocol_ops; /**< Protocol operations */
 
 	GList *draw_list;                /**< List of drawing elements/deltas to send */
 };
diff --git a/libpurple/xfer.h b/libpurple/xfer.h
--- a/libpurple/xfer.h
+++ b/libpurple/xfer.h
@@ -630,7 +630,7 @@ purple_xfer_read_file(PurpleXfer *xfer, 
  * @a ip and @a port are ignored.
  *
  * Passing @a fd as '-1' is a special-case and indicates to the
- * protocol plugin to facilitate the file transfer itself.
+ * protocol to facilitate the file transfer itself.
  *
  * @param xfer The file transfer.
  * @param fd   The file descriptor for the socket.
diff --git a/pidgin/gtkconv.c b/pidgin/gtkconv.c
--- a/pidgin/gtkconv.c
+++ b/pidgin/gtkconv.c
@@ -377,9 +377,9 @@ debug_command_cb(PurpleConversation *con
 		tmp = g_strdup_printf("Using Pidgin v%s with libpurple v%s.",
 				DISPLAY_VERSION, purple_core_get_version());
 	} else if (!g_ascii_strcasecmp(args[0], "plugins")) {
-		/* Show all the loaded plugins, including the protocol plugins and plugin loaders.
+		/* Show all the loaded plugins, including plugins marked internal.
 		 * This is intentional, since third party protocols are often sources of bugs, and some
-		 * plugin loaders (e.g. mono) can also be buggy.
+		 * plugin loaders can also be buggy.
 		 */
 		GString *str = g_string_new("Loaded Plugins: ");
 		const GList *plugins = purple_plugins_get_loaded();



More information about the Commits mailing list