SF.net SVN: geany: [2336] trunk

[ntrel at users.sourceforge.net]

Revision: 2336
          http://geany.svn.sourceforge.net/geany/?rev=2336&view=rev
Author:   ntrel
Date:     2008-03-13 06:36:18 -0700 (Thu, 13 Mar 2008)

Log Message:
-----------
Update documentation for plugin_key_group[] to mention declaring it
manually.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/doc/plugins.dox
    trunk/src/plugindata.h

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2008-03-13 13:26:52 UTC (rev 2335)
+++ trunk/ChangeLog	2008-03-13 13:36:18 UTC (rev 2336)
@@ -1,3 +1,10 @@
+2008-03-13  Nick Treleaven  <nick(dot)treleaven(at)btinternet(dot)com>
+
+ * src/plugindata.h, doc/plugins.dox:
+   Update documentation for plugin_key_group[] to mention declaring it
+   manually.
+
+
 2008-03-13  Enrico Tröger  <enrico(dot)troeger(at)uvena(dot)de>
 
  * doc/geany.html, doc/geany.txt, src/search.c:

Modified: trunk/doc/plugins.dox
===================================================================
--- trunk/doc/plugins.dox	2008-03-13 13:26:52 UTC (rev 2335)
+++ trunk/doc/plugins.dox	2008-03-13 13:36:18 UTC (rev 2336)
@@ -65,7 +65,12 @@
  * 	  {NULL, NULL, FALSE, NULL}. See @link signals Signal documentation @endlink.
  *
  *  - @code KeyBindingGroup plugin_key_group[1] @endcode
- * 	  Use the PLUGIN_KEY_GROUP() macro to define it.
+ * 	  Most plugins should use the PLUGIN_KEY_GROUP() macro to define it. However,
+ *    its fields are not read until after init() is called for the plugin, so it
+ *    is possible to setup a variable number of keybindings, e.g. based on the
+ *    plugin's configuration file.
+ *    @note This is a single element array for implementation reasons,
+ *    but you can treat it like a pointer.
  *
  *  - @code void configure(GtkWidget *parent) @endcode
  * 	  Called when the plugin should show a configure dialog to let the user set some basic

Modified: trunk/src/plugindata.h
===================================================================
--- trunk/src/plugindata.h	2008-03-13 13:26:52 UTC (rev 2335)
+++ trunk/src/plugindata.h	2008-03-13 13:36:18 UTC (rev 2336)
@@ -98,9 +98,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.
- * @note This is a single element array for implementation reasons,
- * but you can treat it like a pointer. */
+ * @param key_count	The number of keybindings the group will hold. */
 #define PLUGIN_KEY_GROUP(group_name, key_count) \
 	static KeyBinding plugin_keys[key_count]; \
 	\


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