1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-02-03 20:24:29 +00:00

Fix doc string of 'posn-at-point'

* src/keyboard.c (Fposn_at_point): Clarify the doc string.
(Bug#25796)
This commit is contained in:
Eli Zaretskii 2017-02-25 10:40:13 +02:00
parent 0d5957ec6f
commit eed96776b1

View File

@ -10705,13 +10705,13 @@ The `posn-' functions access elements of such lists. */)
}
DEFUN ("posn-at-point", Fposn_at_point, Sposn_at_point, 0, 2, 0,
doc: /* Return position information for buffer POS in WINDOW.
doc: /* Return position information for buffer position POS in WINDOW.
POS defaults to point in WINDOW; WINDOW defaults to the selected window.
Return nil if position is not visible in window. Otherwise,
Return nil if POS is not visible in WINDOW. Otherwise,
the return value is similar to that returned by `event-start' for
a mouse click at the upper left corner of the glyph corresponding
to the given buffer position:
to the POS:
(WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
IMAGE (DX . DY) (WIDTH . HEIGHT))
The `posn-' functions access elements of such lists. */)