[amtk] docs: document exception to set several accelerators



commit 7c1c9d01d0c56fa7a0d23523dc2028a487127363
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Fri Apr 13 16:20:12 2018 +0200

    docs: document exception to set several accelerators

 amtk/amtk-action-info-store.c |   11 +++++++----
 1 files changed, 7 insertions(+), 4 deletions(-)
---
diff --git a/amtk/amtk-action-info-store.c b/amtk/amtk-action-info-store.c
index 642cc9c..615744e 100644
--- a/amtk/amtk-action-info-store.c
+++ b/amtk/amtk-action-info-store.c
@@ -39,10 +39,13 @@
  * #AmtkActionInfoCentralStore. Examples of namespaced action names:
  * `"win.amtk-save"` or `"app.amtk-quit"`.
  *
- * Once an #AmtkActionInfo has been added to an #AmtkActionInfoStore, it is
- * discouraged to modify it afterwards. An #AmtkActionInfoStore is meant to be
- * something static, created on application startup. See the [paragraph about
- * static objects in AmtkFactory][amtk-factory-static-objects].
+ * An #AmtkActionInfoStore is meant to be something static, created on
+ * application startup. See the [paragraph about static objects in
+ * AmtkFactory][amtk-factory-static-objects]. So once an #AmtkActionInfo has
+ * been added to an #AmtkActionInfoStore, it is discouraged to modify it
+ * afterwards; an exception is to call amtk_action_info_set_accels() with
+ * several accelerators after using amtk_action_info_store_add_entries()
+ * (because an #AmtkActionInfoEntry can contain only one accelerator).
  */
 
 struct _AmtkActionInfoStorePrivate


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]