summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2016-07-07 19:15:03 +0300
committerEli Zaretskii <eliz@gnu.org>2016-07-07 19:15:03 +0300
commitc53135b6b64a32ccde324140437377e24dd32bf8 (patch)
treee2056dcd55eff7480d7257130a153a545f22b73a
parent8f9c1eda934fd842f53be2d4e72c41728f9b5bd1 (diff)
downloademacs-c53135b6b64a32ccde324140437377e24dd32bf8.tar.gz
Clarify documentation of 'mouse-on-link-p'
* lisp/mouse.el (mouse-on-link-p): Clarify the form of the POS argument. (Bug#23899)
-rw-r--r--lisp/mouse.el5
1 files changed, 3 insertions, 2 deletions
diff --git a/lisp/mouse.el b/lisp/mouse.el
index 64ee796a681..27f2acbc76a 100644
--- a/lisp/mouse.el
+++ b/lisp/mouse.el
@@ -718,8 +718,9 @@ its value is returned."
(defun mouse-on-link-p (pos)
"Return non-nil if POS is on a link in the current buffer.
-POS must be a buffer position in the current buffer or a mouse
-event location in the selected window (see `event-start').
+POS must specify a buffer position in the current buffer, as a list
+of the form returned by the `event-start' and `event-end' functions,
+or a mouse event location in the selected window (see `event-start').
However, if `mouse-1-click-in-non-selected-windows' is non-nil,
POS may be a mouse event location in any window.