ld/avy
1
0
Fork 0
mirror of https://github.com/abo-abo/avy.git synced 2025-10-13 13:33:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

avy.el: Fix checkdoc warnings

Browse Source 
Fixes #212
This commit is contained in:
fabacino 2017-08-04 14:19:04 +02:00 committed by Oleh Krehel
parent 49b070d7da
commit 0ed6408f18
1 changed files with 60 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
avy.el
View File

@ -1064,9 +1064,10 @@ exist."
(defun avy--generic-jump (regex window-flip style &optional beg end) (defun avy--generic-jump (regex window-flip style &optional beg end)
"Jump to REGEX. "Jump to REGEX.
The window scope is determined by `avy-all-windows'.
When WINDOW-FLIP is non-nil, do the opposite of `avy-all-windows'. When WINDOW-FLIP is non-nil, do the opposite of `avy-all-windows'.
STYLE determines the leading char overlay style. STYLE determines the leading char overlay style.
BEG and END delimit the area where candidates are searched." BEG and END narrow the scope where candidates are searched."
(let ((avy-all-windows (let ((avy-all-windows
(if window-flip (if window-flip
(not avy-all-windows) (not avy-all-windows)
@ -1105,7 +1106,9 @@ The window scope is determined by `avy-all-windows' (ARG negates it)."
;;;###autoload ;;;###autoload
(defun avy-goto-char-2 (char1 char2 &optional arg beg end) (defun avy-goto-char-2 (char1 char2 &optional arg beg end)
"Jump to the currently visible CHAR1 followed by CHAR2. "Jump to the currently visible CHAR1 followed by CHAR2.
The window scope is determined by `avy-all-windows' (ARG negates it)." The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'.
BEG and END narrow the scope where candidates are searched."
(interactive (list (read-char "char 1: " t) (interactive (list (read-char "char 1: " t)
(read-char "char 2: " t) (read-char "char 2: " t)
current-prefix-arg current-prefix-arg
@ -1125,7 +1128,9 @@ The window scope is determined by `avy-all-windows' (ARG negates it)."
(defun avy-goto-char-2-above (char1 char2 &optional arg) (defun avy-goto-char-2-above (char1 char2 &optional arg)
"Jump to the currently visible CHAR1 followed by CHAR2. "Jump to the currently visible CHAR1 followed by CHAR2.
This is a scoped version of `avy-goto-char-2', where the scope is This is a scoped version of `avy-goto-char-2', where the scope is
the visible part of the current buffer up to point." the visible part of the current buffer up to point.
The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'."
(interactive (list (read-char "char 1: " t) (interactive (list (read-char "char 1: " t)
(read-char "char 2: " t) (read-char "char 2: " t)
current-prefix-arg)) current-prefix-arg))
@ -1138,7 +1143,9 @@ the visible part of the current buffer up to point."
(defun avy-goto-char-2-below (char1 char2 &optional arg) (defun avy-goto-char-2-below (char1 char2 &optional arg)
"Jump to the currently visible CHAR1 followed by CHAR2. "Jump to the currently visible CHAR1 followed by CHAR2.
This is a scoped version of `avy-goto-char-2', where the scope is This is a scoped version of `avy-goto-char-2', where the scope is
the visible part of the current buffer following point." the visible part of the current buffer following point.
The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'."
(interactive (list (read-char "char 1: " t) (interactive (list (read-char "char 1: " t)
(read-char "char 2: " t) (read-char "char 2: " t)
current-prefix-arg)) current-prefix-arg))
@ -1163,19 +1170,25 @@ the visible part of the current buffer following point."
;;;###autoload ;;;###autoload
(defun avy-goto-word-0 (arg &optional beg end) (defun avy-goto-word-0 (arg &optional beg end)
"Jump to a word start. "Jump to a word start.
The window scope is determined by `avy-all-windows' (ARG negates it)." The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'.
BEG and END narrow the scope where candidates are searched."
(interactive "P") (interactive "P")
(avy-with avy-goto-word-0 (avy-with avy-goto-word-0
(avy--generic-jump avy-goto-word-0-regexp arg avy-style beg end))) (avy--generic-jump avy-goto-word-0-regexp arg avy-style beg end)))
(defun avy-goto-word-0-above (arg) (defun avy-goto-word-0-above (arg)
"Jump to a word start between window start and point." "Jump to a word start between window start and point.
The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'."
(interactive "P") (interactive "P")
(avy-with avy-goto-word-0 (avy-with avy-goto-word-0
(avy-goto-word-0 arg (window-start) (point)))) (avy-goto-word-0 arg (window-start) (point))))
(defun avy-goto-word-0-below (arg) (defun avy-goto-word-0-below (arg)
"Jump to a word start between point and window end." "Jump to a word start between point and window end.
The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'."
(interactive "P") (interactive "P")
(avy-with avy-goto-word-0 (avy-with avy-goto-word-0
(avy-goto-word-0 arg (point) (window-end (selected-window) t)))) (avy-goto-word-0 arg (point) (window-end (selected-window) t))))
@ -1183,7 +1196,10 @@ The window scope is determined by `avy-all-windows' (ARG negates it)."
;;;###autoload ;;;###autoload
(defun avy-goto-word-1 (char &optional arg beg end symbol) (defun avy-goto-word-1 (char &optional arg beg end symbol)
"Jump to the currently visible CHAR at a word start. "Jump to the currently visible CHAR at a word start.
The window scope is determined by `avy-all-windows' (ARG negates it)." The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'.
BEG and END narrow the scope where candidates are searched.
When SYMBOL is non-nil, jump to symbol start instead of word start."
(interactive (list (read-char "char: " t) (interactive (list (read-char "char: " t)
current-prefix-arg)) current-prefix-arg))
(avy-with avy-goto-word-1 (avy-with avy-goto-word-1
@ -1205,7 +1221,9 @@ The window scope is determined by `avy-all-windows' (ARG negates it)."
(defun avy-goto-word-1-above (char &optional arg) (defun avy-goto-word-1-above (char &optional arg)
"Jump to the currently visible CHAR at a word start. "Jump to the currently visible CHAR at a word start.
This is a scoped version of `avy-goto-word-1', where the scope is This is a scoped version of `avy-goto-word-1', where the scope is
the visible part of the current buffer up to point. " the visible part of the current buffer up to point.
The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'."
(interactive (list (read-char "char: " t) (interactive (list (read-char "char: " t)
current-prefix-arg)) current-prefix-arg))
(avy-with avy-goto-word-1 (avy-with avy-goto-word-1
@ -1215,7 +1233,9 @@ the visible part of the current buffer up to point. "
(defun avy-goto-word-1-below (char &optional arg) (defun avy-goto-word-1-below (char &optional arg)
"Jump to the currently visible CHAR at a word start. "Jump to the currently visible CHAR at a word start.
This is a scoped version of `avy-goto-word-1', where the scope is This is a scoped version of `avy-goto-word-1', where the scope is
the visible part of the current buffer following point. " the visible part of the current buffer following point.
The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'."
(interactive (list (read-char "char: " t) (interactive (list (read-char "char: " t)
current-prefix-arg)) current-prefix-arg))
(avy-with avy-goto-word-1 (avy-with avy-goto-word-1
@ -1224,7 +1244,8 @@ the visible part of the current buffer following point. "
;;;###autoload ;;;###autoload
(defun avy-goto-symbol-1 (char &optional arg) (defun avy-goto-symbol-1 (char &optional arg)
"Jump to the currently visible CHAR at a symbol start. "Jump to the currently visible CHAR at a symbol start.
The window scope is determined by `avy-all-windows' (ARG negates it)." The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'."
(interactive (list (read-char "char: " t) (interactive (list (read-char "char: " t)
current-prefix-arg)) current-prefix-arg))
(avy-with avy-goto-symbol-1 (avy-with avy-goto-symbol-1
@ -1234,7 +1255,9 @@ The window scope is determined by `avy-all-windows' (ARG negates it)."
(defun avy-goto-symbol-1-above (char &optional arg) (defun avy-goto-symbol-1-above (char &optional arg)
"Jump to the currently visible CHAR at a symbol start. "Jump to the currently visible CHAR at a symbol start.
This is a scoped version of `avy-goto-symbol-1', where the scope is This is a scoped version of `avy-goto-symbol-1', where the scope is
the visible part of the current buffer up to point. " the visible part of the current buffer up to point.
The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'."
(interactive (list (read-char "char: " t) (interactive (list (read-char "char: " t)
current-prefix-arg)) current-prefix-arg))
(avy-with avy-goto-symbol-1-above (avy-with avy-goto-symbol-1-above
@ -1244,7 +1267,9 @@ the visible part of the current buffer up to point. "
(defun avy-goto-symbol-1-below (char &optional arg) (defun avy-goto-symbol-1-below (char &optional arg)
"Jump to the currently visible CHAR at a symbol start. "Jump to the currently visible CHAR at a symbol start.
This is a scoped version of `avy-goto-symbol-1', where the scope is This is a scoped version of `avy-goto-symbol-1', where the scope is
the visible part of the current buffer following point. " the visible part of the current buffer following point.
The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'."
(interactive (list (read-char "char: " t) (interactive (list (read-char "char: " t)
current-prefix-arg)) current-prefix-arg))
(avy-with avy-goto-symbol-1-below (avy-with avy-goto-symbol-1-below
@ -1323,6 +1348,10 @@ Which one depends on variable `subword-mode'."
(defvar visual-line-mode) (defvar visual-line-mode)
(defun avy--line-cands (&optional arg beg end) (defun avy--line-cands (&optional arg beg end)
"Get candidates for selecting a line.
The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'.
BEG and END narrow the scope where candidates are searched."
(let (candidates) (let (candidates)
(avy-dowindows arg (avy-dowindows arg
(let ((ws (or beg (window-start)))) (let ((ws (or beg (window-start))))
@ -1346,6 +1375,7 @@ Which one depends on variable `subword-mode'."
(nreverse candidates))) (nreverse candidates)))
(defun avy--linum-strings () (defun avy--linum-strings ()
"Get strings for `avy-linum-mode'."
(let* ((lines (mapcar #'car (avy--line-cands))) (let* ((lines (mapcar #'car (avy--line-cands)))
(line-tree (avy-tree lines avy-keys)) (line-tree (avy-tree lines avy-keys))
(line-list nil)) (line-list nil))
@ -1429,8 +1459,9 @@ Which one depends on variable `subword-mode'."
(defun avy--line (&optional arg beg end) (defun avy--line (&optional arg beg end)
"Select a line. "Select a line.
The window scope is determined by `avy-all-windows' (ARG negates it). The window scope is determined by `avy-all-windows'.
Narrow the scope to BEG END." When ARG is non-nil, do the opposite of `avy-all-windows'.
BEG and END narrow the scope where candidates are searched."
(let ((avy-action #'identity)) (let ((avy-action #'identity))
(avy--process (avy--process
(avy--line-cands arg beg end) (avy--line-cands arg beg end)
@ -1618,7 +1649,7 @@ The window scope is determined by `avy-all-windows' or
(end (list (avy--line arg) (selected-window)))) (end (list (avy--line arg) (selected-window))))
(cond (cond
((not (numberp (car beg))) ((not (numberp (car beg)))
(user-error "Fail to select the beginning of region.")) (user-error "Fail to select the beginning of region"))
((not (numberp (car end))) ((not (numberp (car end)))
(user-error "Fail to select the end of region")) (user-error "Fail to select the end of region"))
;; Restrict operation to same window. It's better if it can be ;; Restrict operation to same window. It's better if it can be
@ -1640,7 +1671,9 @@ The window scope is determined by `avy-all-windows' or
;;;###autoload ;;;###autoload
(defun avy-kill-ring-save-region (arg) (defun avy-kill-ring-save-region (arg)
"Select two lines and save the region between them to the kill ring." "Select two lines and save the region between them to the kill ring.
The window scope is determined by `avy-all-windows'.
When ARG is non-nil, do the opposite of `avy-all-windows'."
(interactive "P") (interactive "P")
(let ((initial-window (selected-window))) (let ((initial-window (selected-window)))
(avy-with avy-kill-ring-save-region (avy-with avy-kill-ring-save-region
@ -1649,7 +1682,7 @@ The window scope is determined by `avy-all-windows' or
(end (list (avy--line arg) (selected-window)))) (end (list (avy--line arg) (selected-window))))
(cond (cond
((not (numberp (car beg))) ((not (numberp (car beg)))
(user-error "Fail to select the beginning of region.")) (user-error "Fail to select the beginning of region"))
((not (numberp (car end))) ((not (numberp (car end)))
(user-error "Fail to select the end of region")) (user-error "Fail to select the end of region"))
((not (equal (cdr beg) (cdr end))) ((not (equal (cdr beg) (cdr end)))
@ -1671,7 +1704,7 @@ The window scope is determined by `avy-all-windows' or
"Select line and kill the whole selected line. "Select line and kill the whole selected line.
With a numerical prefix ARG, kill ARG line(s) starting from the With a numerical prefix ARG, kill ARG line(s) starting from the
selected line. If ARG is negative, kill backward. selected line. If ARG is negative, kill backward.
If ARG is zero, kill the selected line but exclude the trailing If ARG is zero, kill the selected line but exclude the trailing
newline. newline.
@ -1693,10 +1726,16 @@ selected line."
;;;###autoload ;;;###autoload
(defun avy-kill-ring-save-whole-line (arg) (defun avy-kill-ring-save-whole-line (arg)
"Select line and Save the whole selected line as if killed, but don’t kill it. "Select line and save the whole selected line as if killed, but don’t kill it.
This command is similar to `avy-kill-whole-line', except that it This command is similar to `avy-kill-whole-line', except that it
saves the line(s) as if killed, but does not kill it(them)." saves the line(s) as if killed, but does not kill it(them).
With a numerical prefix ARG, kill ARG line(s) starting from the
selected line. If ARG is negative, kill backward.
If ARG is zero, kill the selected line but exclude the trailing
newline."
(interactive "P") (interactive "P")
(let ((initial-window (selected-window))) (let ((initial-window (selected-window)))
(avy-with avy-kill-ring-save-whole-line (avy-with avy-kill-ring-save-whole-line