[tepl] docs: improve Amtk docs about checking that ActionInfos are used



commit cac7498293305454bb8c864974305cb3dd9d19e3
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sun Jul 30 18:12:29 2017 +0200

    docs: improve Amtk docs about checking that ActionInfos are used

 amtk/amtk-action-info-store.c |    9 ++++-----
 amtk/amtk-action-info.c       |    5 ++++-
 2 files changed, 8 insertions(+), 6 deletions(-)
---
diff --git a/amtk/amtk-action-info-store.c b/amtk/amtk-action-info-store.c
index 0164b72..4dcb8ba 100644
--- a/amtk/amtk-action-info-store.c
+++ b/amtk/amtk-action-info-store.c
@@ -209,14 +209,13 @@ check_used_cb (gpointer key,
  * amtk_action_info_store_check_all_used:
  * @store: an #AmtkActionInfoStore.
  *
- * Checks for each #AmtkActionInfo of @store that it has been used by a factory
- * to create a #GtkWidget (typically a menu or toolbar item). If an
- * #AmtkActionInfo has not been used, a warning is printed and might indicate
- * dead code.
+ * Checks for each #AmtkActionInfo of @store that it has been used (see
+ * amtk_action_info_has_been_used()). If an #AmtkActionInfo has not been used, a
+ * warning is printed and might indicate dead code.
  *
  * You probably want to call this function on the application store. But it can
  * also be useful for a store provided by a library, to easily see which actions
- * you don't use.
+ * are not used by the application.
  *
  * Since: 2.0
  */
diff --git a/amtk/amtk-action-info.c b/amtk/amtk-action-info.c
index 533f0a9..2143e3c 100644
--- a/amtk/amtk-action-info.c
+++ b/amtk/amtk-action-info.c
@@ -409,7 +409,10 @@ amtk_action_info_mark_as_used (AmtkActionInfo *info)
  * amtk_action_info_has_been_used:
  * @info: an #AmtkActionInfo.
  *
- * Returns: whether @info has been used by an #AmtkFactory function.
+ * Returns whether @info has been used (for example by an #AmtkFactory
+ * function). See also amtk_action_info_store_check_all_used().
+ *
+ * Returns: whether @info has been used.
  * Since: 3.0
  */
 gboolean


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