X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/26e06f4464c58704889bdc536edc25b73e8c0179..ccd3ce49e08b4f0c0e1bcbb34e9055ca4002e21c:/lisp/help-at-pt.el diff --git a/lisp/help-at-pt.el b/lisp/help-at-pt.el index ae32af8ec8..8bac48424f 100644 --- a/lisp/help-at-pt.el +++ b/lisp/help-at-pt.el @@ -1,6 +1,6 @@ ;;; help-at-pt.el --- local help through the keyboard -;; Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. +;; Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. ;; Author: Luc Teirlinck ;; Keywords: help @@ -73,8 +73,8 @@ can also be t, if that is the value of the `kbd-help' property." (defun help-at-pt-kbd-string () "Return the keyboard help string at point. If the `kbd-help' text or overlay property at point produces a -string, return it. Otherwise, use the `help-echo' property. If -this produces no string either, return nil." +string, return it. Otherwise, use the `help-echo' property. +If this produces no string either, return nil." (let ((kbd (help-at-pt-string t)) (echo (help-at-pt-string))) (if (and kbd (not (eq kbd t))) kbd echo))) @@ -104,7 +104,7 @@ internally to enable `help-at-pt-display-when-idle'. Do not set it yourself.") (defcustom help-at-pt-timer-delay 1 - "*Delay before displaying local help. + "Delay before displaying local help. This is used if `help-at-pt-display-when-idle' is enabled. The value may be an integer or floating point number. @@ -146,7 +146,7 @@ This is done by setting a timer, if none is currently active." ;;;###autoload (defcustom help-at-pt-display-when-idle 'never - "*Automatically show local help on point-over. + "Automatically show local help on point-over. If the value is t, the string obtained from any `kbd-help' or `help-echo' property at point is automatically printed in the echo area, if nothing else is already displayed there, or after a @@ -344,7 +344,7 @@ rarely happens in practice." Print the help found there using `display-local-help'. Adjacent areas with different non-nil help-echo properties are considered different regions. With numeric argument ARG, behaves like -`scan-buf-next-region' with argument -ARG.." +`scan-buf-next-region' with argument -ARG." (interactive "p") (scan-buf-move-to-region 'help-echo (- arg) 'scan-buf-move-hook))