From b8edde55e2d4941b2790f592befab97f40e9201e Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 13 Jun 2008 17:40:17 +0000 Subject: [PATCH] Add some docs svn path=/trunk/; revision=20381 --- ChangeLog | 2 ++ gtk/gtkaccelgroup.c | 20 ++++++++++++++++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/ChangeLog b/ChangeLog index 86e2fd58d9..1ea9cb0deb 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,7 @@ 2008-06-13 Matthias Clasen + * gtk/gtkaccelgroup.c: Add some docs + * gdk/gdkwindow.c: Fix doc typos 2008-06-13 Matthias Clasen diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c index 30b2aa6051..55de4bb296 100644 --- 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,