1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-03 11:33:37 +00:00

Clarify documentation of 'mouse-on-link-p'

* lisp/mouse.el (mouse-on-link-p): Clarify the form of the POS
argument.  (Bug#23899)
This commit is contained in:
Eli Zaretskii 2016-07-07 19:15:03 +03:00
parent 8f9c1eda93
commit c53135b6b6

View File

@ -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.