From 74194465d771110242a989e527000cbb896a6af2 Mon Sep 17 00:00:00 2001 From: Chong Yidong Date: Sat, 4 Dec 2010 19:43:18 -0500 Subject: [PATCH] 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). --- lisp/ChangeLog | 5 +++++ lisp/subr.el | 14 ++++++++------ 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 300a5dd31d5..7dce76c1c22 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,8 @@ +2010-12-05 Chong Yidong + + * subr.el (posn-x-y, posn-object-x-y, posn-object-width-height): + Doc fix (Bug#7471). + 2010-12-04 Martin Rudalics * dired.el (dired-pop-to-buffer): Bind pop-up-frames to nil diff --git a/lisp/subr.el b/lisp/subr.el index 7449295421c..8404352636e 100644 --- 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)) -- 2.39.2