pidgin: aa4b8ad0: Document this callback function. Prompt...

[markdoliner at pidgin.im]

-----------------------------------------------------------------
Revision: aa4b8ad0fd74e3f29df8b583c30594e034d55cb3
Ancestor: 1ae2b55502a0afd8f28918fc4726683c52e998e9
Author: markdoliner at pidgin.im
Date: 2009-04-20T06:56:25
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/aa4b8ad0fd74e3f29df8b583c30594e034d55cb3

Modified files:
        libpurple/plugin.h

ChangeLog: 

Document this callback function.  Prompted by a question in #pidgin
that I didn't know the answer to

-------------- next part --------------
============================================================
--- libpurple/plugin.h	335697ddffb4f659404d1e8182b0a13f39a23c55
+++ libpurple/plugin.h	2fcd7b248cc9ca4f4eb27d250dbd1ae1e1dafb6d
@@ -105,6 +105,20 @@ struct _PurplePluginInfo
 	void *ui_info; /**< Used only by UI-specific plugins to build a preference screen with a custom UI */
 	void *extra_info;
 	PurplePluginUiInfo *prefs_info; /**< Used by any plugin to display preferences.  If #ui_info has been specified, this will be ignored. */
+
+	/**
+	 * This callback has a different use depending on whether this
+	 * plugin type is PURPLE_PLUGIN_STANDARD or PURPLE_PLUGIN_PROTOCOL.
+	 *
+	 * If PURPLE_PLUGIN_STANDARD then the list of actions will show up
+	 * in the Tools menu, under a submenu with the name of the plugin.
+	 * context will be NULL.
+	 *
+	 * If PURPLE_PLUGIN_PROTOCOL then the list of actions will show up
+	 * in the Accounts menu, under a submenu with the name of the
+	 * account.  context will be set to the PurpleConnection for that
+	 * account.  This callback will only be called for online accounts.
+	 */
 	GList *(*actions)(PurplePlugin *plugin, gpointer context);
 
 	void (*_purple_reserved1)(void);