SF.net SVN: geany:[4401] trunk

[ntrel at users.sourceforge.net]

Revision: 4401
          http://geany.svn.sourceforge.net/geany/?rev=4401&view=rev
Author:   ntrel
Date:     2009-11-05 16:17:11 +0000 (Thu, 05 Nov 2009)

Log Message:
-----------
Deprecate PLUGIN_KEY_GROUP() macro - use plugin_set_key_group()
instead.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/HACKING
    trunk/src/plugindata.h

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2009-11-04 18:32:52 UTC (rev 4400)
+++ trunk/ChangeLog	2009-11-05 16:17:11 UTC (rev 4401)
@@ -1,3 +1,10 @@
+2009-11-05  Nick Treleaven  <nick(dot)treleaven(at)btinternet(dot)com>
+
+ * src/plugindata.h, HACKING:
+   Deprecate PLUGIN_KEY_GROUP() macro - use plugin_set_key_group()
+   instead.
+
+
 2009-11-04  Enrico Tröger  <enrico(dot)troeger(at)uvena(dot)de>
 
  * tagmanager/makefile.win32:

Modified: trunk/HACKING
===================================================================
--- trunk/HACKING	2009-11-04 18:32:52 UTC (rev 4400)
+++ trunk/HACKING	2009-11-05 16:17:11 UTC (rev 4401)
@@ -75,10 +75,10 @@
 
 .. warning::
 
-    Some structs like GeanyKeyGroupInfo and GeanyCallback cannot be
-    appended to without breaking the ABI because they are used to declare
-    structs by plugins, not just for accessing struct members through
-    a pointer.
+    Some structs like GeanyCallback cannot be appended to without
+    breaking the ABI because they are used to declare structs by
+    plugins, not just for accessing struct members through a pointer.
+    Normally structs should never be allocated by plugins.
 
 Keeping the plugin ABI stable
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Modified: trunk/src/plugindata.h
===================================================================
--- trunk/src/plugindata.h	2009-11-04 18:32:52 UTC (rev 4400)
+++ trunk/src/plugindata.h	2009-11-05 16:17:11 UTC (rev 4401)
@@ -119,7 +119,8 @@
 	}
 
 
-/** @see PLUGIN_KEY_GROUP() macro. */
+/** @deprecated - use plugin_set_key_group() instead.
+ * @see PLUGIN_KEY_GROUP() macro. */
 typedef struct GeanyKeyGroupInfo
 {
 	const gchar *name;		/**< Group name used in the configuration file, such as @c "html_chars" */
@@ -127,7 +128,8 @@
 }
 GeanyKeyGroupInfo;
 
-/** Declare and initialise a keybinding group.
+/** @deprecated - use plugin_set_key_group() instead.
+ * Declare and initialise a keybinding group.
  * @code GeanyKeyGroup *plugin_key_group; @endcode
  * You must then set the @c plugin_key_group::keys[] entries for the group in plugin_init(),
  * normally using keybindings_set_item().
@@ -135,8 +137,7 @@
  * is called, to the name of the plugin.
  * @param group_name A unique group name (without quotes) to be used in the
  * configuration file, such as @c html_chars.
- * @param key_count	The number of keybindings the group will hold.
- * @see plugin_set_key_group() to set the group size dynamically. */
+ * @param key_count	The number of keybindings the group will hold. */
 #define PLUGIN_KEY_GROUP(group_name, key_count) \
 	/* We have to declare this as a single element array.
 	 * Declaring as a pointer to a struct doesn't work with g_module_symbol(). */ \


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.