Doc updates to HildonAppMenu

* hildon/hildon-app-menu.c: Doc updates.

diff --git a/ChangeLog b/ChangeLog
index 6de1c62..f3903bf 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2009-05-25  Alberto Garcia  <agarcia@igalia.com>
+
+       * hildon/hildon-app-menu.c: Doc updates.
+
 2009-05-25  Claudio Saavedra  <csaavedra@igalia.com>
 
        * hildon/hildon-banner.c: Remove leftover macro.

diff --git a/hildon/hildon-app-menu.c b/hildon/hildon-app-menu.c
index 8b6974d..2381f22 100644 (file)
--- a/hildon/hildon-app-menu.c
+++ b/hildon/hildon-app-menu.c
@@ -20,8 +20,8 @@
  * SECTION:hildon-app-menu
  * @short_description: Widget representing the application menu in the Hildon framework.
  *
- * The #HildonAppMenu is a GTK widget which represents an application
- * menu in the Hildon framework.
+ * #HildonAppMenu is a GTK widget which represents an application menu
+ * in the Hildon framework.
  *
  * This menu opens from the top of the screen and contains a number of
  * entries (#GtkButton) organized in one or two columns, depending on
@@ -29,8 +29,12 @@
  * if the screen is resized). Entries are added left to right and top
  * to bottom.
  *
- * Besides that, the #HildonAppMenu can contain a group of filter buttons
- * (#GtkToggleButton or #GtkRadioButton).
+ * Besides that, #HildonAppMenu can contain a group of filter buttons
+ * (#GtkToggleButton or #GtkRadioButton). Filters are meant to change
+ * the way data is presented in the application, rather than change
+ * the layout of the menu itself. For example, a file manager can have
+ * filters to decide the order used to display a list of files (name,
+ * date, size, etc.).
  *
  * To use a #HildonAppMenu, add it to a #HildonWindow using
  * hildon_window_set_app_menu(). The menu will appear when the user