Add some docs

svn path=/trunk/; revision=20381

diff --git a/ChangeLog b/ChangeLog
index 86e2fd58d9ccec939bf5e6c60d57517320c8d1b5..1ea9cb0debc50956425e71ec1b7b08b426408dab 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 2008-06-13  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkaccelgroup.c: Add some docs
+
        * gdk/gdkwindow.c: Fix doc typos
 
 2008-06-13  Matthias Clasen  <mclasen@redhat.com>

diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c
index 30b2aa605115ec4a8c2afc5265e6a390c1b6c9a9..55de4bb2967496100d466b547ba1689eabe494a7 100644 (file)
--- a/gtk/gtkaccelgroup.c
+++ b/gtk/gtkaccelgroup.c
@@ -727,6 +727,22 @@ gtk_accel_group_from_accel_closure (GClosure *closure)
   return NULL;
 }
 
+/**
+ * gtk_accel_group_activate:
+ * @accel_group:   a #GtkAccelGroup
+ * @accel_quark:   the quark for the accelerator name
+ * @acceleratable: the #GObject, usually a #GtkWindow, on which
+ *                 to activate the accelerator.
+ * @accel_key:     accelerator keyval from a key event
+ * @accel_mods:    keyboard state mask from a key event
+ * @returns:       %TRUE if the accelerator was handled, %FALSE otherwise
+ * 
+ * Finds the first accelerator in @accel_group 
+ * that matches @accel_key and @accel_mods, and
+ * activates it.
+ *
+ * Returns: %TRUE if an accelerator was activated and handled this keypress
+ */
 gboolean
 gtk_accel_group_activate (GtkAccelGroup   *accel_group,
                           GQuark          accel_quark,
@@ -757,8 +773,8 @@ gtk_accel_group_activate (GtkAccelGroup   *accel_group,
  * Finds the first accelerator in any #GtkAccelGroup attached
  * to @object that matches @accel_key and @accel_mods, and
  * activates that accelerator.
- * If an accelerator was activated and handled this keypress, %TRUE
- * is returned.
+ *
+ * Returns: %TRUE if an accelerator was activated and handled this keypress
  */
 gboolean
 gtk_accel_groups_activate (GObject       *object,