From: Mike Gorse <mgorse@novell.com>
Date: Sun, 7 Nov 2010 14:00:39 +0000 (-0500)
Subject: Fix some annotations and documentation issues
X-Git-Tag: AT_SPI2_CORE_1_91_3~16
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=05d45d055808d9195c23f108cf9e635f1d63270c;p=platform%2Fupstream%2Fat-spi2-core.git

Fix some annotations and documentation issues
---

diff --git a/atspi/atspi-accessible.c b/atspi/atspi-accessible.c
index ccb4ec8..c66ad00 100644
--- a/atspi/atspi-accessible.c
+++ b/atspi/atspi-accessible.c
@@ -217,8 +217,9 @@ atspi_accessible_get_description (AtspiAccessible *obj, GError **error)
  *
  * Get an #AtspiAccessible object's parent container.
  *
- * Returns: a pointer tothe #AtspiAccessible object which contains the given
- *          #AtspiAccessible instance, or NULL if the @obj has no parent container.
+ * Returns: (transfer full): a pointer to the #AtspiAccessible object which
+ *          contains the given #AtspiAccessible instance, or NULL if the @obj
+ *          has no parent container.
  *
  **/
 AtspiAccessible *
@@ -412,7 +413,8 @@ atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error)
  *
  * Gets the current state of an object.
  *
- * Returns: a pointer to an #AtspiStateSet representing the object's current state.
+ * Returns: (transfer full): a pointer to an #AtspiStateSet representing the
+ *          object's current state.
  **/
 AtspiStateSet *
 atspi_accessible_get_state_set (AtspiAccessible *obj)
diff --git a/atspi/atspi-event-listener.c b/atspi/atspi-event-listener.c
index 8bcdd4f..36dce89 100644
--- a/atspi/atspi-event-listener.c
+++ b/atspi/atspi-event-listener.c
@@ -276,7 +276,7 @@ listener_entry_free (EventListenerEntry *e)
  * @callback: (scope notified): the #AtspiEventListenerCB to be registered against
  *            an event type.
  * @user_data: (closure): User data to be passed to the callback.
- * @callback_freed: A #GDestroyNotify called when the callback is destroyed.
+ * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
  * @event_type: a character string indicating the type of events for which
  *            notification is requested.  Format is
  *            EventClass:major_type:minor_type:detail
@@ -428,7 +428,7 @@ remove_datum (const AtspiEvent *event, void *user_data)
  * atspi_event_listener_register_no_data:
  * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
  *            registered against an event type.
- * @callback_freed: A #GDestroyNotify called when the callback is destroyed.
+ * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
  * @event_type: a character string indicating the type of events for which
  *            notification is requested.  Format is
  *            EventClass:major_type:minor_type:detail
diff --git a/atspi/atspi-registry.c b/atspi/atspi-registry.c
index 15263e1..cf49d3d 100644
--- a/atspi/atspi-registry.c
+++ b/atspi/atspi-registry.c
@@ -95,7 +95,7 @@ atspi_get_desktop_list ()
  * atspi_register_accessible_keystroke_listener:
  * @listener:  a pointer to the #AccessibleKeystrokeListener for which
  *             keystroke events are requested.
- * @keys: (type: AtspiKeyDefinition): a pointer to the
+ * @key_set: (type: AtspiKeyDefinition): a pointer to the
  *        #AccessibleKeyDefinition array indicating which keystroke events are requested, or #ATSPI_KEYSET_ALL_KEYS
  *             to indicate that all keycodes and keyvals for the specified
  *             modifier set are to be included.