Remove dependency on libxkbcommon

[platform/upstream/at-spi2-core.git] / atspi / atspi-image.c

diff --git a/atspi/atspi-image.c b/atspi/atspi-image.c
index 75c3553..4f17326 100644 (file)
--- a/atspi/atspi-image.c
+++ b/atspi/atspi-image.c
@@ -4,6 +4,7 @@
  *
  * Copyright 2001, 2002 Sun Microsystems Inc.,
  * Copyright 2001, 2002 Ximian, Inc.
+ * Copyright 2010, 2011 Novell, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ -27,14 +28,14 @@
  * atspi_image_get_image_description:
  * @obj: a pointer to the #AtspiImage implementor on which to operate.
  *
- * Get the description of the image displayed in an #AtspiImage object.
+ * Gets the description of the image displayed in an #AtspiImage object.
  *
  * Returns: a UTF-8 string describing the image.
  **/
 gchar *
 atspi_image_get_image_description (AtspiImage *obj, GError **error)
 {
-  char *retval;
+  char *retval = NULL;
 
   g_return_val_if_fail (obj != NULL, NULL);
 
@@ -47,7 +48,11 @@ atspi_image_get_image_description (AtspiImage *obj, GError **error)
  * atspi_image_get_image_size:
  * @obj: a pointer to the #AtspiImage to query.
  *
- * Get the size of the image displayed in a specified #AtspiImage object.
+ * Gets the size of the image displayed in a specified #AtspiImage object.
+ *
+ * Returns: a pointer to an #AtspiPoint where x corresponds to
+ * the image's width and y corresponds to the image's height.
+ *
  **/
 AtspiPoint *
 atspi_image_get_image_size (AtspiImage *obj, GError **error)
@@ -71,8 +76,12 @@ atspi_image_get_image_size (AtspiImage *obj, GError **error)
  * @ctype: the desired coordinate system into which to return the results,
  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
  *
- * Get the minimum x and y coordinates of the image displayed in a
+ * Gets the minimum x and y coordinates of the image displayed in a
  *         specified #AtspiImage implementor.
+ *
+ * Returns: a pointer to an #AtspiPoint where x and y correspond to the
+ * minimum coordinates of the displayed image. 
+ * 
  **/
 AtspiPoint *
 atspi_image_get_image_position (AtspiImage *obj,
@@ -80,7 +89,7 @@ atspi_image_get_image_position (AtspiImage *obj,
                                 GError **error)
 {
   dbus_int32_t d_x, d_y;
-  dbus_uint16_t d_ctype = ctype;
+  dbus_uint32_t d_ctype = ctype;
   AtspiPoint ret;
 
   ret.x = ret.y = 0;
@@ -101,8 +110,11 @@ atspi_image_get_image_position (AtspiImage *obj,
  * @ctype: the desired coordinate system into which to return the results,
  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
  *
- * Get the bounding box of the image displayed in a
+ * Gets the bounding box of the image displayed in a
  *         specified #AtspiImage implementor.
+ *
+ * Returns: a pointer to an #AtspiRect corresponding to the image's bounding box. The minimum x and y coordinates, 
+ * width, and height are specified.
  **/
 AtspiRect *
 atspi_image_get_image_extents (AtspiImage *obj,
@@ -122,11 +134,11 @@ atspi_image_get_image_extents (AtspiImage *obj,
 
 /**
  * atspi_image_get_image_locale:
- * @obj: The #AtspiImage being queried.
+ * @obj: a pointer to the #AtspiImage to query.
  *
- * Get the locale associated with an image and its textual representation.
+ * Gets the locale associated with an image and its textual representation.
  *
- * Returns: A POSIX LC_MESSAGES-style Locale value for image description and text.
+ * Returns: A POSIX LC_MESSAGES-style locale value for image description and text.
  **/
 gchar *
 atspi_image_get_image_locale  (AtspiImage *obj, GError **error)