summaryrefslogtreecommitdiff
path: root/atk/atkimage.c
diff options
context:
space:
mode:
authorBill Haneman <billh@src.gnome.org>2005-11-16 15:37:08 +0000
committerBill Haneman <billh@src.gnome.org>2005-11-16 15:37:08 +0000
commit43ccc848ace2a984274b6de0ae0ea2fa5dffc3fa (patch)
tree3d81f4b8685c5a190465d15df066b8374ea84261 /atk/atkimage.c
parent3bb2b3e41185159bbd29b418bdaaa501b6977768 (diff)
downloadatk-43ccc848ace2a984274b6de0ae0ea2fa5dffc3fa.tar.gz
Added small docs patch from Bill Abt.;
supplements AtkUtil sgml page, and moves return code exception/range info to "Returns" block.
Diffstat (limited to 'atk/atkimage.c')
-rwxr-xr-xatk/atkimage.c7
1 files changed, 3 insertions, 4 deletions
diff --git a/atk/atkimage.c b/atk/atkimage.c
index 95b2686..f0ab0bd 100755
--- a/atk/atkimage.c
+++ b/atk/atkimage.c
@@ -141,14 +141,13 @@ atk_image_set_image_description (AtkImage *image,
/**
* atk_image_get_image_position:
* @image: a #GObject instance that implements AtkImageIface
- * @x: address of #gint to put x coordinate position
- * @y: address of #gint to put y coordinate position
+ * @x: address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.
+ * @y: address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained.
* @coord_type: specifies whether the coordinates are relative to the screen
* or to the components top level window
*
* Gets the position of the image in the form of a point specifying the
- * images top-left corner. The values of @x and @y are returned as -1
- * if the values cannot be obtained.
+ * images top-left corner.
**/
void
atk_image_get_image_position (AtkImage *image,