[tepl] docs: update/improve Amtk docs



commit bcb9cf0b277cf51f8c6d23edc9e3202031bd0424
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Mon Jul 31 11:36:24 2017 +0200

    docs: update/improve Amtk docs

 amtk/amtk-action-info-store.c  |    6 +++---
 amtk/amtk-application-window.c |    7 ++++---
 2 files changed, 7 insertions(+), 6 deletions(-)
---
diff --git a/amtk/amtk-action-info-store.c b/amtk/amtk-action-info-store.c
index 4dcb8ba..a215aee 100644
--- a/amtk/amtk-action-info-store.c
+++ b/amtk/amtk-action-info-store.c
@@ -213,9 +213,9 @@ check_used_cb (gpointer key,
  * 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
- * are not used by the application.
+ * You probably want to call this function on the application store after
+ * creating the menu and toolbar. But it can also be useful for a store provided
+ * by a library, to easily see which actions are not used by the application.
  *
  * Since: 2.0
  */
diff --git a/amtk/amtk-application-window.c b/amtk/amtk-application-window.c
index b0d625e..940a6d6 100644
--- a/amtk/amtk-application-window.c
+++ b/amtk/amtk-application-window.c
@@ -31,7 +31,9 @@
  * @Short_description: An extension of GtkApplicationWindow
  * @Title: AmtkApplicationWindow
  *
- * #AmtkApplicationWindow extends the #GtkApplicationWindow class.
+ * #AmtkApplicationWindow extends the #GtkApplicationWindow class with a
+ * #AmtkApplicationWindow:statusbar property and functions to show longer
+ * descriptions of #GtkMenuItem's to the #GtkStatusbar.
  *
  * Note that #AmtkApplicationWindow extends the #GtkApplicationWindow class but
  * without subclassing it, because several libraries might want to extend
@@ -453,8 +455,7 @@ statusbar_notify_cb (AmtkApplicationWindow *amtk_window,
  *
  * The long description is retrieved with amtk_menu_item_get_long_description().
  * So amtk_menu_item_set_long_description() must have been called, which is the
- * case if the #GtkMenuItem has been created with the functions available in
- * #AmtkActionInfoStore.
+ * case if the #GtkMenuItem has been created by an #AmtkFactoryMenu.
  *
  * Since: 2.0
  */


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