Fix/clarify gtk-doc comment in atk_add_key_event_listener in atkutil.c

diff --git a/ChangeLog b/ChangeLog
index a64617c..3dd92a6 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -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 (executable)
--- 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.
  **/