Doc fix for posn-* functions (Bug#7471).

* lisp/subr.el (posn-x-y, posn-object-x-y, posn-object-width-height):
Doc fix (Bug#7471).

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 300a5dd31d5c4d182d8fc5b14dd29565d1c15505..7dce76c1c22261118da7dc74c382f4051aabaa75 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2010-12-05  Chong Yidong  <cyd@stupidchicken.com>
+
+       * subr.el (posn-x-y, posn-object-x-y, posn-object-width-height):
+       Doc fix (Bug#7471).
+
 2010-12-04  Martin Rudalics  <rudalics@gmx.at>
 
        * dired.el (dired-pop-to-buffer): Bind pop-up-frames to nil

diff --git a/lisp/subr.el b/lisp/subr.el
index 7449295421c36e3ddb85f1da3b1a3964fb7a0b76..8404352636eaf3e0db13ab800c700c524f5546fd 100644 (file)
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -916,8 +916,9 @@ Select the corresponding window as well."
 
 (defsubst posn-x-y (position)
   "Return the x and y coordinates in POSITION.
-POSITION should be a list of the form returned by the `event-start'
-and `event-end' functions."
+The return value has the form (X . Y), where X and Y are given in
+pixels.  POSITION should be a list of the form returned by
+`event-start' and `event-end'."
   (nth 2 position))
 
 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
@@ -997,14 +998,15 @@ and `event-end' functions."
 
 (defsubst posn-object-x-y (position)
   "Return the x and y coordinates relative to the object of POSITION.
-POSITION should be a list of the form returned by the `event-start'
-and `event-end' functions."
+The return value has the form (DX . DY), where DX and DY are
+given in pixels.  POSITION should be a list of the form returned
+by `event-start' and `event-end'."
   (nth 8 position))
 
 (defsubst posn-object-width-height (position)
   "Return the pixel width and height of the object of POSITION.
-POSITION should be a list of the form returned by the `event-start'
-and `event-end' functions."
+The return value has the form (WIDTH . HEIGHT).  POSITION should
+be a list of the form returned by `event-start' and `event-end'."
   (nth 9 position))
 
 \f