From: Richard M. Stallman <rms@gnu.org>
Date: Sun, 10 Apr 2005 00:41:34 +0000 (+0000)
Subject: Comment change.
X-Git-Tag: ttn-vms-21-2-B4~1113
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=bb8c48650e8ef154dd299d7220e66d7dae6e992d;p=emacs.git

Comment change.
---

diff --git a/src/keyboard.c b/src/keyboard.c
index f1a131a6f4e..07b2f991c38 100644
--- a/src/keyboard.c
+++ b/src/keyboard.c
@@ -2258,12 +2258,16 @@ make_ctrl_char (c)
   return c;
 }
 
-/* Display help echo in the echo area.
+/* 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).
 
-   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.
+   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.