[at-spi2-core] Improving atspi-devicelistener documentation.

[Mike Gorse <mgorse src gnome org>]

commit a858dd6dd572e97e822f0fbd16f3011c12597727
Author: Aline Bessa <alibezz gmail com>
Date:   Tue Aug 2 21:44:54 2011 -0300

    Improving atspi-devicelistener documentation.

 atspi/atspi-device-listener.c |   27 ++++++++++++++-------------
 atspi/atspi-device-listener.h |   10 +++++-----
 2 files changed, 19 insertions(+), 18 deletions(-)
---
diff --git a/atspi/atspi-device-listener.c b/atspi/atspi-device-listener.c
index 3843227..1e68eb1 100644
--- a/atspi/atspi-device-listener.c
+++ b/atspi/atspi-device-listener.c
@@ -211,9 +211,9 @@ G_DEFINE_TYPE (AtspiDeviceListener, atspi_device_listener,
  * @user_data: (closure): a pointer to data which will be passed to the
  * callback when invoked.
  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
- * and data associated with the callback should be freed.  Can be NULL.
+ * and data associated with the callback should be freed. It can be NULL.
  *
- * Create a new #AtspiDeviceListener with a specified callback function.
+ * Creates a new #AtspiDeviceListener with a specified callback function.
  *
  * Returns: (transfer full): a pointer to a newly-created #AtspiDeviceListener.
  *
@@ -232,14 +232,15 @@ atspi_device_listener_new (AtspiDeviceListenerCB callback,
 }
 
 /**
- * atspi_device_listener_new_simple: (skip):
+ * atspi_device_listener_new_simple:
  * @callback: (scope notified): an #AtspiDeviceListenerCB callback function,
  *            or NULL.
  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
- * and data associated with the callback should be freed.  Can be NULL.
+ * and data associated with the callback should be freed.  It an be NULL.
  *
- * Create a new #AtspiDeviceListener with a specified callback function.
- * Like atspi_device_listener_new, but callback takes no user data.
+ * Creates a new #AtspiDeviceListener with a specified callback function.
+ * This method is similar to #atspi_device_listener_new, but callback
+ * takes no user data.
  *
  * Returns: a pointer to a newly-created #AtspiDeviceListener.
  *
@@ -255,12 +256,12 @@ atspi_device_listener_new_simple (AtspiDeviceListenerSimpleCB callback,
  * atspi_device_listener_add_callback:
  * @listener: the #AtspiDeviceListener instance to modify.
  * @callback: (scope notified): an #AtspiDeviceListenerCB function pointer.
- * @user_data: (closure): a pointer to data which will be passed to the
- *             callback when invoked.
  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
- * and data associated with the callback should be freed.  Can be NULL.
+ * and data associated with the callback should be freed. It can be NULL.
+ * @user_data: (closure): a pointer to data which will be passed to the
+ *             callback when invoked. 
  *
- * Add an in-process callback function to an existing #AtspiDeviceListener.
+ * Adds an in-process callback function to an existing #AtspiDeviceListener.
  *
  * Returns: #TRUE if successful, otherwise #FALSE.
  *
@@ -291,7 +292,8 @@ atspi_device_listener_add_callback (AtspiDeviceListener  *listener,
  * @listener: the #AtspiDeviceListener instance to modify.
  * @callback: (scope call): an #AtspiDeviceListenerCB function pointer.
  *
- * Remove an in-process callback function from an existing #AtspiDeviceListener.
+ * Removes an in-process callback function from an existing 
+ * #AtspiDeviceListener.
  *
  * Returns: #TRUE if successful, otherwise #FALSE.
  *
@@ -401,8 +403,7 @@ done:
 
 gchar *
 _atspi_device_listener_get_path (AtspiDeviceListener *listener)
-{
-  return g_strdup_printf ("/org/a11y/atspi/listeners/%d", listener->id);
+{  return g_strdup_printf ("/org/a11y/atspi/listeners/%d", listener->id);
 }
 
 G_DEFINE_BOXED_TYPE (AtspiDeviceEvent,
diff --git a/atspi/atspi-device-listener.h b/atspi/atspi-device-listener.h
index 169738c..2e785d1 100644
--- a/atspi/atspi-device-listener.h
+++ b/atspi/atspi-device-listener.h
@@ -38,8 +38,8 @@
  *
  * A callback function prototype via which clients receive device event notifications.
  *
- * Returns: %TRUE if the client wishes to consume/preempt the event, preventing it from being
- * relayed to the currently focussed application, %FALSE if the event delivery should proceed as normal.
+ * Returns: #TRUE if the client wishes to consume/preempt the event, preventing it from being
+ * relayed to the currently focussed application, #FALSE if the event delivery should proceed as normal.
  **/
 typedef gboolean (*AtspiDeviceListenerCB)    (const AtspiDeviceEvent *stroke,
 						     void                      *user_data);
@@ -49,10 +49,10 @@ typedef gboolean (*AtspiDeviceListenerCB)    (const AtspiDeviceEvent *stroke,
  * @stroke: (transfer full): The #AtspiDeviceEvent for which notification is
  *          being received.
  *
- * Like #AtspiDeviceListenerCB but with no user data.
+ * Similar to #AtspiDeviceListenerCB, but with no user data.
  *
- * Returns: %TRUE if the client wishes to consume/preempt the event, preventing it from being
- * relayed to the currently focussed application, %FALSE if the event delivery should proceed as normal.
+ * Returns: #TRUE if the client wishes to consume/preempt the event, preventing it from being
+ * relayed to the currently focussed application, #FALSE if the event delivery should proceed as normal.
  **/
 typedef gboolean (*AtspiDeviceListenerSimpleCB)    (const AtspiDeviceEvent *stroke);