[geany/geany] 304f3a: Adding a small note pointing out that setting a default keybinding might not the best idea for plugin maintainers

[Frank Lanitz]

Branch:      refs/heads/document-messages
Author:      Frank Lanitz <frank at frank.uvena.de>
Committer:   Lex Trotman <elextr at gmail.com>
Date:        Mon, 04 Jun 2012 06:19:11
Commit:      304f3a8b476351230bc0324597f0689e9cddebeb
             https://github.com/geany/geany/commit/304f3a8b476351230bc0324597f0689e9cddebeb

Log Message:
-----------
Adding a small note pointing out that setting a default keybinding might not the best idea for plugin maintainers


Modified Paths:
--------------
    src/keybindings.c

Modified: src/keybindings.c
3 files changed, 3 insertions(+), 0 deletions(-)
===================================================================
@@ -131,6 +131,9 @@ GeanyKeyBinding *keybindings_get_item(GeanyKeyGroup *group, gsize key_id)
 /* This is used to set default keybindings on startup.
  * Menu accels are set in apply_kb_accel(). */
 /** Fills a GeanyKeyBinding struct item.
+ * @note Always set @a key and @a mod to 0, otherwise you will likely
+ * cause conflicts with the user's custom, other plugin's keybindings or 
+ * future default keybindings.
  * @param group Group.
  * @param key_id Keybinding index for the group.
  * @param callback Function to call when activated, or @c NULL to use the group callback.


@@ Diff output truncated at 100000 characters. @@


--------------
This E-Mail was brought to you by github_commit_mail.py (Source: TBD).