Mercurial > emacs
changeset 61419:662ca833c8e0
Comment change.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Sun, 10 Apr 2005 00:41:34 +0000 |
| parents | 02c939955b7a |
| children | 132c9732a8f0 |
| files | src/keyboard.c |
| diffstat | 1 files changed, 10 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/src/keyboard.c Sun Apr 10 00:28:37 2005 +0000 +++ b/src/keyboard.c Sun Apr 10 00:41:34 2005 +0000 @@ -2258,12 +2258,16 @@ return c; } -/* Display help echo in the echo area. - - HELP a string means display that string, HELP nil means clear the - help echo. If HELP is a function, call it with OBJECT and POS as - arguments; the function should return a help string or nil for - none. For all other types of HELP evaluate it to obtain a string. +/* Display the help-echo property of the character after the mouse pointer. + Either show it in the echo area, or call show-help-function to display + it by other means (maybe in a tooltip). + + If HELP is nil, that means clear the previous help echo. + + If HELP is a string, display that string. If HELP is a function, + call it with OBJECT and POS as arguments; the function should + return a help string or nil for none. For all other types of HELP, + evaluate it to obtain a string. WINDOW is the window in which the help was generated, if any. It is nil if not in a window.