[geany/geany] debe14: Improve API docs related to keybindings configuration file

[Colomban Wendling]

Branch:      refs/heads/master
Author:      Colomban Wendling <ban at herbesfolles.org>
Committer:   Colomban Wendling <ban at herbesfolles.org>
Date:        Thu, 03 Mar 2016 14:00:15 UTC
Commit:      debe14549d6c9ae488ae4fb2be20315a27d39e5d
             https://github.com/geany/geany/commit/debe14549d6c9ae488ae4fb2be20315a27d39e5d

Log Message:
-----------
Improve API docs related to keybindings configuration file


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

Modified: src/keybindings.c
4 lines changed, 2 insertions(+), 2 deletions(-)
===================================================================
@@ -161,7 +161,7 @@ GeanyKeyBinding *keybindings_get_item(GeanyKeyGroup *group, gsize key_id)
  * Usually it's better to use the group callback instead - see plugin_set_key_group().
  * @param key Default key, e.g. @c GDK_j (must be lower case), but usually 0 for unset.
  * @param mod Default modifier, e.g. @c GDK_CONTROL_MASK, but usually 0 for unset.
- * @param kf_name Key name for the configuration file, such as @c "menu_new".
+ * @param kf_name Key name used for this item in the keybindings configuration file, i.e. @c "menu_new".
  * @param label Label used in the preferences dialog keybindings tab. May contain
  * underscores - these won't be displayed.
  * @param menu_item @nullable Optional widget to set an accelerator for, or @c NULL.
@@ -214,7 +214,7 @@ GeanyKeyBinding *keybindings_set_item(GeanyKeyGroup *group, gsize key_id,
  * @param key_id Keybinding index for the group.
  * @param key Default key, e.g. @c GDK_j (must be lower case), but usually 0 for unset.
  * @param mod Default modifier, e.g. @c GDK_CONTROL_MASK, but usually 0 for unset.
- * @param kf_name Key name for the configuration file, such as @c "menu_new".
+ * @param kf_name Key name used for this item in the keybindings configuration file, i.e. @c "menu_new".
  * @param label Label used in the preferences dialog keybindings tab. May contain
  * underscores - these won't be displayed.
  * @param menu_item @nullable Optional widget to set an accelerator for, or @c NULL.


Modified: src/pluginutils.c
4 lines changed, 2 insertions(+), 2 deletions(-)
===================================================================
@@ -298,7 +298,7 @@ guint plugin_idle_add(GeanyPlugin *plugin, GSourceFunc function, gpointer data)
  * Sets up or resizes a keybinding group for the plugin.
  * You should then call keybindings_set_item() for each keybinding in the group.
  * @param plugin Must be @ref geany_plugin.
- * @param section_name Name used in the configuration file, such as @c "html_chars".
+ * @param section_name Name of the section used for this group in the keybindings configuration file, i.e. @c "html_chars".
  * @param count Number of keybindings for the group.
  * @param callback @nullable Group callback, or @c NULL if you only want individual keybinding callbacks.
  * @return The plugin's keybinding group.
@@ -320,7 +320,7 @@ GeanyKeyGroup *plugin_set_key_group(GeanyPlugin *plugin,
  * You should then call keybindings_set_item() or keybindings_set_item_full() for each
  * keybinding in the group.
  * @param plugin Must be @ref geany_plugin.
- * @param section_name Name used in the configuration file, such as @c "html_chars".
+ * @param section_name Name of the section used for this group in the keybindings configuration file, i.e. @c "html_chars".
  * @param count Number of keybindings for the group.
  * @param cb @nullable New-style group callback, or @c NULL if you only want individual keybinding callbacks.
  * @param pdata Plugin specific data, passed to the group callback @a cb.



--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).