Kaydet (Commit) 745c858f authored tarafından Nick Treleaven's avatar Nick Treleaven

Update documentation for plugin_key_group[] to mention declaring it

manually.


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2336 ea778897-0a13-0410-b9d1-a72fbfd435f5
üst b1a888a0
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:
......
......@@ -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
......
......@@ -98,9 +98,7 @@ PluginInfo;
* 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]; \
\
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment