diff options
author | Bill Haneman <billh@src.gnome.org> | 2001-11-22 13:21:04 +0000 |
---|---|---|
committer | Bill Haneman <billh@src.gnome.org> | 2001-11-22 13:21:04 +0000 |
commit | 77626512f3d262bf2eb3986f5d42cb567184554d (patch) | |
tree | 18e5c871fb011d3f64923c597e48acd5a74322ee | |
parent | 98803cc8e887b6ef291d8e16bbdf0fd3e78441a6 (diff) | |
download | atk-77626512f3d262bf2eb3986f5d42cb567184554d.tar.gz |
Fix/clarify gtk-doc comment in atk_add_key_event_listener in atkutil.c
-rw-r--r-- | ChangeLog | 5 | ||||
-rwxr-xr-x | atk/atkutil.c | 6 |
2 files changed, 9 insertions, 2 deletions
@@ -1,3 +1,8 @@ +2001-11-22 Bill Haneman <bill.haneman@sun.com> + + * atk/atkutil.c (atk_add_key_event_listener): + Fix gtk-doc comment and clarify use of 'data' gpointer. + 2001-11-22 Michael Meeks <michael@ximian.com> * atk/atkutil.c (atk_add_key_event_listener): switch diff --git a/atk/atkutil.c b/atk/atkutil.c index 65bb03e..41bc774 100755 --- a/atk/atkutil.c +++ b/atk/atkutil.c @@ -235,10 +235,12 @@ atk_remove_global_event_listener (guint listener_id) /** * atk_add_key_event_listener: * @listener: the listener to notify - * @event_type: the type of event for which notification is requested + * @data: a #gpointer that points to a block of data that should be sent to the registered listeners, + * along with the event notification, when it occurs. * * Adds the specified function to the list of functions to be called - * when an event of type event_type occurs. + * when a key event occurs. The @data element will be passed to the + * #AtkKeySnoopFunc (@listener) as the @func_data param, on notification. * * Returns: added event listener id, or 0 on failure. **/ |