aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/avoid.el
diff options
context:
space:
mode:
authorJuanma Barranquero2011-03-12 20:44:42 +0100
committerJuanma Barranquero2011-03-12 20:44:42 +0100
commitad22b7f7c16aa6c26df6ec1e1c192dde2e1b0cce (patch)
tree2e218b14919f189d195e376e70d726182c12d56e /lisp/avoid.el
parent6efb972c00a9ea8ffa84118199aa59c2d3a3b50e (diff)
downloademacs-ad22b7f7c16aa6c26df6ec1e1c192dde2e1b0cce.tar.gz
emacs-ad22b7f7c16aa6c26df6ec1e1c192dde2e1b0cce.zip
lisp/avoid.el: Fix typos in docstrings.
Diffstat (limited to 'lisp/avoid.el')
-rw-r--r--lisp/avoid.el15
1 files changed, 7 insertions, 8 deletions
diff --git a/lisp/avoid.el b/lisp/avoid.el
index 31833994323..c9c989b2ab9 100644
--- a/lisp/avoid.el
+++ b/lisp/avoid.el
@@ -77,7 +77,7 @@
77 77
78;;;###autoload 78;;;###autoload
79(defcustom mouse-avoidance-mode nil 79(defcustom mouse-avoidance-mode nil
80 "Activate mouse avoidance mode. 80 "Activate Mouse Avoidance mode.
81See function `mouse-avoidance-mode' for possible values. 81See function `mouse-avoidance-mode' for possible values.
82Setting this variable directly does not take effect; 82Setting this variable directly does not take effect;
83use either \\[customize] or the function `mouse-avoidance-mode'." 83use either \\[customize] or the function `mouse-avoidance-mode'."
@@ -86,8 +86,7 @@ use either \\[customize] or the function `mouse-avoidance-mode'."
86 (mouse-avoidance-mode (or value 'none))) 86 (mouse-avoidance-mode (or value 'none)))
87 :initialize 'custom-initialize-default 87 :initialize 'custom-initialize-default
88 :type '(choice (const :tag "none" nil) (const banish) (const jump) 88 :type '(choice (const :tag "none" nil) (const banish) (const jump)
89 (const animate) (const exile) (const proteus) 89 (const animate) (const exile) (const proteus))
90 )
91 :group 'avoid 90 :group 'avoid
92 :require 'avoid 91 :require 'avoid
93 :version "20.3") 92 :version "20.3")
@@ -95,7 +94,7 @@ use either \\[customize] or the function `mouse-avoidance-mode'."
95 94
96(defcustom mouse-avoidance-nudge-dist 15 95(defcustom mouse-avoidance-nudge-dist 15
97 "Average distance that mouse will be moved when approached by cursor. 96 "Average distance that mouse will be moved when approached by cursor.
98Only applies in Mouse-Avoidance mode `jump' and its derivatives. 97Only applies in Mouse Avoidance mode `jump' and its derivatives.
99For best results make this larger than `mouse-avoidance-threshold'." 98For best results make this larger than `mouse-avoidance-threshold'."
100 :type 'integer 99 :type 'integer
101 :group 'avoid) 100 :group 'avoid)
@@ -113,7 +112,7 @@ For best results make this larger than `mouse-avoidance-threshold'."
113(defcustom mouse-avoidance-threshold 5 112(defcustom mouse-avoidance-threshold 5
114 "Mouse-pointer's flight distance. 113 "Mouse-pointer's flight distance.
115If the cursor gets closer than this, the mouse pointer will move away. 114If the cursor gets closer than this, the mouse pointer will move away.
116Only applies in mouse-avoidance-modes `animate' and `jump'." 115Only applies in Mouse Avoidance modes `animate' and `jump'."
117 :type 'integer 116 :type 'integer
118 :group 'avoid) 117 :group 'avoid)
119 118
@@ -184,7 +183,7 @@ Acceptable distance is defined by `mouse-avoidance-threshold'."
184 mouse-avoidance-threshold)))))) 183 mouse-avoidance-threshold))))))
185 184
186(defun mouse-avoidance-banish-destination () 185(defun mouse-avoidance-banish-destination ()
187 "The position to which Mouse-Avoidance mode `banish' moves the mouse. 186 "The position to which Mouse Avoidance mode `banish' moves the mouse.
188You can redefine this if you want the mouse banished to a different corner." 187You can redefine this if you want the mouse banished to a different corner."
189 (let* ((pos (window-edges))) 188 (let* ((pos (window-edges)))
190 (cons (- (nth 2 pos) 2) 189 (cons (- (nth 2 pos) 2)
@@ -332,7 +331,7 @@ redefine this function to suit your own tastes."
332 331
333;;;###autoload 332;;;###autoload
334(defun mouse-avoidance-mode (&optional mode) 333(defun mouse-avoidance-mode (&optional mode)
335 "Set cursor avoidance mode to MODE. 334 "Set Mouse Avoidance mode to MODE.
336MODE should be one of the symbols `banish', `exile', `jump', `animate', 335MODE should be one of the symbols `banish', `exile', `jump', `animate',
337`cat-and-mouse', `proteus', or `none'. 336`cat-and-mouse', `proteus', or `none'.
338 337
@@ -352,7 +351,7 @@ Effects of the different modes:
352 351
353Whenever the mouse is moved, the frame is also raised. 352Whenever the mouse is moved, the frame is also raised.
354 353
355\(see `mouse-avoidance-threshold' for definition of \"too close\", 354\(See `mouse-avoidance-threshold' for definition of \"too close\",
356and `mouse-avoidance-nudge-dist' and `mouse-avoidance-nudge-var' for 355and `mouse-avoidance-nudge-dist' and `mouse-avoidance-nudge-var' for
357definition of \"random distance\".)" 356definition of \"random distance\".)"
358 (interactive 357 (interactive