aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2005-06-16 09:59:47 +0000
committerJuanma Barranquero2005-06-16 09:59:47 +0000
commit04cedb114c12744d971900c528758d650526ed0a (patch)
tree6e46d7db9aec20a5a06974da5220da292baa5ad5
parent66c20a8203fa0246961ac0f50dd1b5bfecf587d0 (diff)
downloademacs-04cedb114c12744d971900c528758d650526ed0a.tar.gz
emacs-04cedb114c12744d971900c528758d650526ed0a.zip
(tooltip-start-delayed-tip, tooltip-timeout, tooltip-use-echo-area,
tooltip-process-prompt-regexp, tooltip-help-tips): Fix typos in docstrings.
-rw-r--r--lisp/ChangeLog6
-rw-r--r--lisp/tooltip.el16
2 files changed, 14 insertions, 8 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 651f246322c..82ee1698d33 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,9 @@
12005-06-16 Juanma Barranquero <lekktu@gmail.com>
2
3 * tooltip.el (tooltip-start-delayed-tip, tooltip-timeout)
4 (tooltip-use-echo-area, tooltip-process-prompt-regexp)
5 (tooltip-help-tips): Fix typos in docstrings.
6
12005-06-16 David Ponce <david@dponce.com> 72005-06-16 David Ponce <david@dponce.com>
2 8
3 * tree-widget.el (tree-widget-value-create): Simplify last change. 9 * tree-widget.el (tree-widget-value-create): Simplify last change.
diff --git a/lisp/tooltip.el b/lisp/tooltip.el
index 904f2bf8770..3a2d1910f96 100644
--- a/lisp/tooltip.el
+++ b/lisp/tooltip.el
@@ -120,9 +120,9 @@ position to pop up the tooltip."
120 :group 'tooltip) 120 :group 'tooltip)
121 121
122(make-obsolete-variable 'tooltip-use-echo-area 122(make-obsolete-variable 'tooltip-use-echo-area
123"To display help tooltips in the echo area turn tooltip-mode off. 123"To display help tooltips in the echo area turn `tooltip-mode' off.
124To display GUD tooltips in the echo area turn gud-tooltip-mode on and set 124To display GUD tooltips in the echo area turn `gud-tooltip-mode' on and set
125gud-tooltip-echo-area to t." "22.1") 125`gud-tooltip-echo-area' to t." "22.1")
126 126
127 127
128;;; Variables that are not customizable. 128;;; Variables that are not customizable.
@@ -201,12 +201,12 @@ With ARG, turn tooltip mode on if and only if ARG is positive."
201 (setq tooltip-timeout-id nil))) 201 (setq tooltip-timeout-id nil)))
202 202
203(defun tooltip-start-delayed-tip () 203(defun tooltip-start-delayed-tip ()
204 "Add a one-shot timeout to call function tooltip-timeout." 204 "Add a one-shot timeout to call function `tooltip-timeout'."
205 (setq tooltip-timeout-id 205 (setq tooltip-timeout-id
206 (add-timeout (tooltip-delay) 'tooltip-timeout nil))) 206 (add-timeout (tooltip-delay) 'tooltip-timeout nil)))
207 207
208(defun tooltip-timeout (object) 208(defun tooltip-timeout (object)
209 "Function called when timer with id tooltip-timeout-id fires." 209 "Function called when timer with id `tooltip-timeout-id' fires."
210 (run-hook-with-args-until-success 'tooltip-hook 210 (run-hook-with-args-until-success 'tooltip-hook
211 tooltip-last-mouse-motion-event)) 211 tooltip-last-mouse-motion-event))
212 212
@@ -301,8 +301,8 @@ where the mouse is."
301 301
302(defun tooltip-process-prompt-regexp (process) 302(defun tooltip-process-prompt-regexp (process)
303 "Return regexp matching the prompt of PROCESS at the end of a string. 303 "Return regexp matching the prompt of PROCESS at the end of a string.
304The prompt is taken from the value of COMINT-PROMPT-REGEXP in the buffer 304The prompt is taken from the value of `comint-prompt-regexp' in
305of PROCESS." 305the buffer of PROCESS."
306 (let ((prompt-regexp (save-excursion 306 (let ((prompt-regexp (save-excursion
307 (set-buffer (process-buffer process)) 307 (set-buffer (process-buffer process))
308 comint-prompt-regexp))) 308 comint-prompt-regexp)))
@@ -349,7 +349,7 @@ MSG is either a help string to display, or nil to cancel the display."
349(defun tooltip-help-tips (event) 349(defun tooltip-help-tips (event)
350 "Hook function to display a help tooltip. 350 "Hook function to display a help tooltip.
351This is installed on the hook `tooltip-hook', which is run when 351This is installed on the hook `tooltip-hook', which is run when
352the timer with ID `tooltip-timeout-id' fires. 352the timer with id `tooltip-timeout-id' fires.
353Value is non-nil if this function handled the tip." 353Value is non-nil if this function handled the tip."
354 (when (stringp tooltip-help-message) 354 (when (stringp tooltip-help-message)
355 (tooltip-show tooltip-help-message tooltip-use-echo-area) 355 (tooltip-show tooltip-help-message tooltip-use-echo-area)