Add or fix documentation to appease checkdoc

evil-ag.el

@@ -31,6 +31,7 @@
 (require 'evil)
 
 (defun evil-ag-setup ()
+  "Set up `evil' bindings for `ag'."
   (evil-add-hjkl-bindings ag-mode-map 'normal
     "gg" #'evil-goto-first-line
     "gr" #'recompile

evil-anaconda-mode.el

@@ -30,6 +30,7 @@
 (require 'evil)
 
 (defun evil-anaconda-mode-setup ()
+  "Set up `evil' bindings for `anaconda-mode'."
   ;; Bindings don't seem to be set the first time.
   (add-hook 'anaconda-mode-hook #'evil-normalize-keymaps)
 

evil-arc-mode.el

@@ -31,6 +31,7 @@
 (require 'evil)
 
 (defun evil-arc-mode-setup ()
+  "Set up `evil' bindings for `arc-mode'."
   (evil-set-initial-state 'arc-mode 'motion)
   (evil-set-initial-state 'archive-mode 'motion)
   (evil-define-key 'motion archive-mode-map

evil-bookmark.el

@@ -31,6 +31,7 @@
 (require 'evil-collection-util)
 
 (defun evil-bookmark-setup ()
+  "Set up `evil' bindings for `bookmark'."
   (evil-collection-util-evilify-map
    bookmark-bmenu-mode-map
    :mode bookmark-bmenu-mode))

evil-calendar.el

@@ -31,6 +31,7 @@
 (require 'evil)
 
 (defun evil-calendar-setup ()
+  "Set up `evil' bindings for `calendar'."
   (evil-define-key 'motion calendar-mode-map
     ;; motion
     "h" 'calendar-backward-day

evil-cider.el

@@ -31,6 +31,7 @@
 (require 'evil-collection-util)
 
 (defun evil-cider-setup ()
+  "Set up `evil' bindings for `cider'."
   (evil-define-key '(normal visual) cider-mode-map
     (kbd "gz") 'cider-switch-to-repl-buffer
     (kbd "gf") 'cider-find-resource

evil-comint.el

@@ -31,6 +31,7 @@
 (require 'evil)
 
 (defun evil-comint-setup ()
+  "Set up `evil' bindings for `comint'."
   (when evil-want-C-d-scroll
     (evil-define-key 'normal comint-mode-map
       (kbd "C-d") #'evil-scroll-down))

evil-company.el

@@ -34,6 +34,7 @@
 (defvar company-search-map)
 
 (defun evil-company-setup ()
+  "Set up `evil' bindings for `company'."
   (define-key company-active-map (kbd "C-n") 'company-select-next-or-abort)
   (define-key company-active-map (kbd "C-p") 'company-select-previous-or-abort)
   (define-key company-active-map (kbd "C-j") 'company-select-next-or-abort)

evil-compile.el

@@ -31,6 +31,7 @@
 (require 'compile)
 
 (defun evil-compile-setup ()
+  "Set up `evil' bindings for `compile'."
   (evil-collection-util-evilify-map
    compilation-mode-map
    :mode compilation-mode

evil-cus-theme.el

@@ -31,6 +31,7 @@
 (require 'evil)
 
 (defun evil-cus-theme-setup ()
+  "Set up `evil' bindings for `cus-theme'."
   (evil-set-initial-state 'custom-new-theme-mode 'normal)
   (evil-set-initial-state 'custom-theme-choose-mode 'normal)
 

evil-custom.el

@@ -31,6 +31,7 @@
 (require 'evil)
 
 (defun evil-custom-setup ()
+  "Set up `evil' bindings for `Custom-mode'."
   (evil-set-initial-state 'Custom-mode 'normal)
 
   (evil-define-key 'normal custom-mode-map

evil-debbugs.el

@@ -31,6 +31,7 @@
 (require 'evil)
 
 (defun evil-debbugs-mode-setup ()
+  "Set up `evil' bindings for `debbugs-gnu-mode'."
   (evil-set-initial-state 'debbugs-gnu-mode 'motion)
 
   (evil-define-key 'motion debbugs-gnu-mode-map

evil-debug.el

@@ -32,6 +32,7 @@
 (require 'debug)
 
 (defun evil-debug-setup ()
+  "Set up `evil' bindings for `debug'."
   (evil-set-initial-state 'debugger-mode 'motion)
 
   (evil-define-key 'motion debugger-mode-map

evil-diff-mode.el

@@ -83,6 +83,7 @@ current file instead."
     (diff-restrict-view arg)))
 
 (defun evil-diff-mode-setup ()
+  "Set up `evil' bindings for `diff-mode'."
   (evil-define-key 'normal diff-mode-map
     ;; motion
     (kbd "SPC") 'scroll-up-command

evil-dired.el

@@ -31,6 +31,7 @@
 (require 'evil-collection-util)
 
 (defun evil-dired-setup ()
+  "Set up `evil' bindings for `dired'."
   (evil-define-key 'normal dired-mode-map
     "j" 'evil-next-line
     "k" 'evil-previous-line

evil-doc-view.el

@@ -31,6 +31,7 @@
 (require 'doc-view)
 
 (defun evil-doc-view-setup ()
+  "Set up `evil' bindings for `doc-view'."
   (evil-set-initial-state 'doc-view-mode 'motion)
   (evil-define-key 'motion doc-view-mode-map
     (kbd "C-j") 'doc-view-next-page

evil-edebug.el

@@ -33,7 +33,7 @@
 (evil-collection-util-set-initial-state edebug-mode motion)
 
 (defun evil-edebug-setup ()
-
+  "Set up `evil' bindings for `edebug'."
   (evil-define-key 'motion 'edebug-mode-map
     ;; control
     " " nil

evil-elfeed.el

@@ -31,6 +31,7 @@
 (require 'evil)
 
 (defun evil-elfeed-setup ()
+  "Set up `evil' bindings for `elfeed'."
   (evil-set-initial-state 'elfeed-search-mode 'motion)
 
   (evil-define-key 'motion elfeed-search-mode-map

evil-elisp-mode.el

@@ -50,6 +50,7 @@ alternative printed representations that can be displayed."
                      rear-nonsticky (mouse-face keymap help-echo
                                                 printed-value)))))
 (defun evil-elisp-mode-setup ()
+  "Set up `evil' bindings for `elisp-mode'."
   (advice-add 'last-sexp-setup-props
               :override #'evil-elisp-mode-last-sexp-setup-props))
 

evil-elisp-refs.el

@@ -32,6 +32,7 @@
 (require 'elisp-refs nil t)
 
 (defun evil-elisp-refs-setup ()
+  "Set up `evil' bindings for `elisp-refs'."
   (evil-define-key 'normal elisp-refs-mode-map
     (kbd "<tab>") #'elisp-refs-next-match
     (kbd "<backtab>") #'elisp-refs-prev-match

evil-emms.el

@@ -45,6 +45,7 @@
 ;;; emms-browser does not run any mode hook.  As such the default state is 'normal.
 ;;; TODO: Report upstream.
 (defun evil-emms-browser ()
+  "Default `emms-browser' to motion state."
   (evil-motion-state))
 
 (with-no-warnings
@@ -79,6 +80,7 @@
     (evil-emms-playlist-mode-paste-before)))
 
 (defun evil-emms-setup ()
+  "Set up `evil' bindings for `emms'."
   (advice-add 'emms-browser :after 'evil-emms-browser)
   (evil-set-initial-state 'emms-playlist-mode 'motion)
 

evil-eshell.el

@@ -32,16 +32,19 @@
 (require 'evil)
 
 (defun evil-eshell-next-prompt ()
+  "`evil' wrapper around `eshell-next-prompt'."
   (when (get-text-property (point) 'read-only)
     ;; If at end of prompt, `eshell-next-prompt' will not move, so go backward.
     (beginning-of-line)
     (eshell-next-prompt 1)))
 
 (defun evil-eshell-next-prompt-on-insert ()
+  "Go to next prompt on `evil' replace/insert enter."
   (dolist (hook '(evil-replace-state-entry-hook evil-insert-state-entry-hook))
     (add-hook hook 'evil-eshell-next-prompt nil t)))
 
 (defun evil-eshell-interrupt-process ()
+  "Interupt `eshell' process and enter insert state."
   (interactive)
   (eshell-interrupt-process)
   (evil-insert 1))
@@ -49,6 +52,7 @@
 ;;; `eshell-mode-map' is reset when Eshell is initialized in `eshell-mode'. We
 ;;; need to add bindings to `eshell-first-time-mode-hook'.
 (defun evil-eshell-setup-keys ()
+  "Set up `evil' bindings for `eshell'."
   (evil-define-key 'normal eshell-mode-map
     ;; motion
     "[" 'eshell-previous-prompt
@@ -78,6 +82,7 @@
 
 ;; TODO: Compare this setup procedure with evil-ediff.
 (defun evil-eshell-setup ()
+  "Set up `evil' bindings for `eshell'."
   (add-hook 'eshell-mode-hook 'evil-eshell-next-prompt-on-insert)
   (add-hook 'eshell-first-time-mode-hook 'evil-eshell-setup-keys))
 

evil-evilified-state.el

@@ -133,7 +133,7 @@ Needed to bypass keymaps set as text properties."
     (evil-evilified-state--clear-normal-state-keymap)))
 
 (defun evil-evilified-state--visual-state-on-exit ()
-  "Clean visual state"
+  "Clean visual state."
   (evil-evilified-state--restore-normal-state-keymap))
 
 (add-hook 'evil-evilified-state-entry-hook
@@ -186,7 +186,7 @@ BODY is a list of additional key bindings to apply for the given MAP in
 Avaiblabe PROPS:
 
 `:mode SYMBOL'
-A mode SYMBOL associated with MAP. Used to add SYMBOL to the list of modes
+A mode SYMBOL associated with MAP.  Used to add SYMBOL to the list of modes
 defaulting to `evilified-state'.
 
 `:evilified-map SYMBOL'
@@ -195,7 +195,7 @@ A map SYMBOL of an alternate evilified map, if nil then
 
 `:eval-after-load SYMBOL'
 If specified the evilification of MAP is deferred to the loading of the feature
-bound to SYMBOL. May be required for some lazy-loaded maps.
+bound to SYMBOL.  May be required for some lazy-loaded maps.
 
 `:pre-bindings EXPRESSIONS'
 One or several EXPRESSIONS with the form `KEY FUNCTION':
@@ -207,7 +207,7 @@ These bindings are set in MAP before the evilification happens.
 One or several EXPRESSIONS with the form `KEY FUNCTION':
    KEY1 FUNCTION1
    KEY2 FUNCTION2
-These bindings are set directly in evil-evilified-state-map submap.
+These bindings are set directly in ‘evil-evilified-state-map’ submap.
    ...
 Each pair KEYn FUNCTIONn is defined in MAP after the evilification of it."
   (declare (indent 1))
@@ -251,12 +251,14 @@ Each pair KEYn FUNCTIONn is defined in MAP after the evilification of it."
       (eval `(define-key ,map key ,func)))))
 
 (defun evil-evilified-state--configure-default-state (mode)
-  "Configure default state for the passed mode."
+  "Configure default state for the passed MODE."
   (evil-set-initial-state mode 'evilified))
 
 (defun evil-evilified-state--evilify-event (map map-symbol evil-map event evil-value
                                            &optional processed pending-funcs)
-  "Evilify EVENT in MAP and return a list of PROCESSED events."
+  "Evilify EVENT in MAP and return a list of PROCESSED events.
+Argument MAP-SYMBOL Symbol of MAP.
+Argument EVIL-MAP `evil' map."
   (if (and event (or evil-value pending-funcs))
       (let* ((kbd-event (kbd (single-key-description event)))
              (map-value (lookup-key map kbd-event))
@@ -297,7 +299,7 @@ Each pair KEYn FUNCTIONn is defined in MAP after the evilification of it."
      ((and (numberp event) (<= 1 event) (<= event 26)) (+ (expt 2 25) event)))))
 
 (defun evil-evilified-state--sort-keymap (map)
-  "Sort MAP following the order: `s' > `S' > `C-s' > `C-S-s'"
+  "Sort MAP following the order: `s' > `S' > `C-s' > `C-S-s'."
   (let (list)
     (map-keymap (lambda (a b) (push (cons a b) list)) map)
     (sort list

evil-flycheck.el

@@ -33,6 +33,7 @@
 (defvar flycheck-error-list-mode-map)
 
 (defun evil-flycheck-setup ()
+  "Set up `evil' bindings for `flycheck'."
   (evil-collection-util-evilify-map
    flycheck-error-list-mode-map
    :mode flycheck-error-list-mode

evil-ggtags.el

@@ -36,6 +36,7 @@
 (defvar ggtags-navigation-map)
 
 (defun evil-ggtags-setup ()
+  "Set up `evil' bindings for `ggtags'."
   (evil-collection-util-evilify-map
    ggtags-global-mode-map
    :mode ggtags-global-mode)

evil-helm.el

@@ -43,6 +43,7 @@
 (defvar helm-read-file-map)
 
 (defun evil-helm-setup ()
+  "Set up `evil' bindings for `helm'."
   ;; TODO: We should not modify helm-map in Emacs state but somehow it does not
   ;; work otherwise.
   (define-key helm-map (kbd "M-[") 'helm-previous-source)

evil-help.el

@@ -31,6 +31,7 @@
 (require 'help-mode)
 
 (defun evil-help-setup ()
+  "Set up `evil' bindings for `help'."
   (evil-define-key 'motion help-mode-map
     ;; motion
     (kbd "SPC") 'scroll-up-command

evil-ibuffer.el

@@ -31,6 +31,7 @@
 (require 'ibuffer)
 
 (defun evil-ibuffer-setup ()
+  "Set up `evil' bindings for `ibuffer'."
   (evil-collection-util-evilify-map
    ibuffer-mode-map
    :mode ibuffer-mode

evil-image+.el

@@ -31,6 +31,7 @@
 (require 'image+ nil t)
 
 (defun evil-image+-setup ()
+  "Set up `evil' bindings for `image+'."
   (evil-define-key 'motion image-mode-map
     "+" 'imagex-sticky-zoom-in
     "-" 'imagex-sticky-zoom-out

evil-image.el

@@ -31,6 +31,7 @@
 (require 'image-mode)
 
 (defun evil-image-setup ()
+  "Set up `evil' bindings for `image-mode'."
   (evil-set-initial-state 'image-mode 'motion)
 
   (evil-define-key 'motion image-mode-map

evil-info.el

@@ -32,6 +32,7 @@
 (require 'info)
 
 (defun evil-info-setup ()
+  "Set up `evil' bindings for `info-mode'."
   (evil-define-key 'motion Info-mode-map
     ;; motion: Restore some Evil keys that got overriden.
     "w" 'evil-forward-word-begin

evil-ivy.el

@@ -31,6 +31,7 @@
 (require 'ivy nil t)
 
 (defun evil-ivy-setup ()
+  "Set up `evil' bindings for `ivy-mode'."
   (evil-define-key 'normal ivy-occur-mode-map
     [mouse-1] 'ivy-occur-click
     (kbd "RET") 'ivy-occur-press-and-switch

evil-macrostep.el

@@ -31,6 +31,7 @@
 (require 'macrostep nil t)
 
 (defun evil-macrostep-setup ()
+  "Set up `evil' bindings for `macrostep'."
   ;; Keymaps don't seem to be populated on first try.
   ;; Force `evil' to normalize keymaps.
   (add-hook 'macrostep-mode-hook #'evil-normalize-keymaps)

evil-man.el

@@ -31,6 +31,7 @@
 (require 'man)
 
 (defun evil-man-setup ()
+  "Set up `evil' bindings for `man'."
   (evil-define-key 'motion Man-mode-map
     ;; motion
     (kbd "SPC") 'scroll-up-command

evil-minibuffer.el

@@ -46,6 +46,7 @@ it does not have a mode."
   (evil-insert 1))
 
 (defun evil-minibuffer-init ()
+  "Initialize minibuffer for `evil'."
   ;; https://www.gnu.org/software/emacs/manual/html_node/elisp/Text-from-Minibuffer.html
   ;; WARNING: With lexical binding, lambdas from `mapc' and `dolist' become
   ;; closures in which we must use `evil-define-key*' instead of

evil-occur.el

@@ -33,6 +33,7 @@
   (require 'replace))
 
 (defun evil-occur-setup ()
+  "Set up `evil' bindings for `occur'."
   (evil-set-initial-state 'occur-mode 'normal)
 
   (evil-define-key 'normal occur-mode-map

evil-outline.el

@@ -31,6 +31,7 @@
 (require 'outline)
 
 (defun evil-outline-setup ()
+  "Set up `evil' bindings for `outline'."
   (evil-define-key 'normal outline-mode-map
     ;; folding
     ;; Evil default keys:

evil-p4.el

@@ -33,6 +33,7 @@
 (defvar p4-basic-mode-map)
 
 (defun evil-p4-setup ()
+  "Set up `evil' bindings for `p4'."
   (evil-collection-util-evilify-map
    p4-basic-mode-map
    :mode p4-basic-mode

evil-package-menu.el

@@ -31,6 +31,7 @@
 (require 'package)
 
 (defun evil-package-menu-setup ()
+  "Set up `evil' bindings for `package-menu'."
   (evil-set-initial-state 'package-menu-mode 'motion)
 
   (evil-define-key 'motion package-menu-mode-map

evil-pass.el

@@ -33,6 +33,7 @@
 (defvar pass-mode-map)
 
 (defun evil-pass-setup ()
+  "Set up `evil' bindings for `pass-mode'."
   (evil-collection-util-evilify-map
    pass-mode-map
    :mode pass-mode

evil-pdf.el

@@ -38,18 +38,21 @@
 
 (with-no-warnings
   (defun evil-pdf-view-goto-page (&optional page)
+    "`evil' wrapper around `pdf-view-last-page'."
     (interactive "P")
     (if page
         (pdf-view-goto-page page)
       (pdf-view-last-page)))
 
   (defun evil-pdf-view-goto-first-page (&optional page)
+    "`evil' wrapper around `pdf-view-first-page'."
     (interactive "P")
     (if page
         (pdf-view-goto-page page)
       (pdf-view-first-page))))
 
 (defun evil-pdf-setup ()
+  "Set up `evil' bindings for `pdf-view'."
   (evil-set-initial-state 'pdf-view-mode 'motion)
   (evil-define-key 'motion pdf-view-mode-map
     ;; motion

evil-prodigy.el

@@ -31,6 +31,7 @@
 (require 'prodigy nil t)
 
 (defun evil-prodigy-setup ()
+  "Set up `evil' bindings for `prodigy'."
   (evil-define-key 'normal prodigy-mode-map
     "q" 'quit-window
     "j" 'prodigy-next

evil-profiler.el

@@ -31,6 +31,7 @@
 (require 'profiler)
 
 (defun evil-profiler-setup ()
+  "Set up `evil' bindings for `profiler'."
   (evil-set-initial-state 'profiler-report-mode 'motion)
 
   (evil-define-key 'motion profiler-report-mode-map

evil-slime.el

@@ -34,6 +34,7 @@
 (defvar slime-inspector-mode-map)
 
 (defun evil-slime-setup ()
+  "Set up `evil' bindings for `slime'."
   (evil-collection-util-evilify-map
    sldb-mode-map
    :mode sldb-mode

evil-term.el

@@ -46,11 +46,13 @@ it is not appropriate in some cases like terminals."
   (setq-local evil-move-cursor-back nil))
 
 (defun evil-term-char-mode-insert ()
+  "Switch to `term-char-mode' and enter insert state."
   (interactive)
   (term-char-mode)
   (evil-insert-state))
 
 (defun evil-term-char-mode-entry-function ()
+  "Maybe switch to `term-char-mode' on insert state."
   (when (get-buffer-process (current-buffer))
     (let (last-prompt)
       (save-excursion
@@ -62,6 +64,7 @@ it is not appropriate in some cases like terminals."
         (term-char-mode)))))
 
 (defun evil-term-sync-state-and-mode ()
+  "Sync `term-char-mode' and `term-line-mode' with insert and normal state."
   (add-hook 'evil-insert-state-entry-hook 'evil-term-char-mode-entry-function)
   (add-hook 'evil-insert-state-exit-hook 'term-line-mode))
 
@@ -71,6 +74,7 @@ it is not appropriate in some cases like terminals."
   (term-send-raw-string "\t"))
 
 (defun evil-term-setup ()
+  "Set up `evil' bindings for `term'."
   (evil-set-initial-state 'term-mode 'insert)
   (add-hook 'term-mode-hook 'evil-term-sync-state-and-mode)
   (add-hook 'term-mode-hook 'evil-term-escape-stay)

evil-tide.el

@@ -31,6 +31,7 @@
 (require 'evil)
 
 (defun evil-tide-setup ()
+  "Set up `evil' bindings for `tide'."
   (evil-define-key 'normal tide-mode-map
     (kbd "gd") #'tide-jump-to-definition
     (kbd "C-t") #'tide-jump-back

evil-transmission.el

@@ -23,6 +23,7 @@
 ;; For a full copy of the GNU General Public License
 ;; see <http://www.gnu.org/licenses/>.
 
+
 ;;; Commentary:
 ;; Evil bindings for `transmission'.
 
@@ -31,6 +32,7 @@
 (require 'transmission nil t)
 
 (defun evil-transmission-setup ()
+  "Set up `evil' bindings for `transmission'."
   (evil-set-initial-state 'transmission-mode 'motion)
   (evil-define-key 'motion transmission-mode-map
     ;; motion

evil-vlf.el

@@ -34,6 +34,7 @@
 
 ;;; Code:
 (defun evil-vlf-setup ()
+  "Set up `evil' bindings for `vlf'."
   (evil-collection-util-evilify-map
    vlf-mode-map
    :mode vlf-mode

evil-woman.el

@@ -32,6 +32,7 @@
 (require 'woman)
 
 (defun evil-woman-setup ()
+  "Set up `evil' bindings for `woman'."
   (evil-define-key 'motion woman-mode-map
     (kbd "]") 'WoMan-next-manpage
     (kbd "[") 'WoMan-previous-manpage

evil-xref.el

@@ -31,6 +31,7 @@
 (require 'xref)
 
 (defun evil-xref-setup ()
+  "Set up `evil' bindings for `xref'."
   (evil-define-key 'normal xref--xref-buffer-mode-map
     "j" #'xref-next-line
     "k" #'xref-prev-line

evil-ztree.el

@@ -30,6 +30,7 @@
 (require 'ztree nil t)
 
 (defun evil-ztree-setup ()
+  "Set up `evil' bindings for `ztree'."
   (evil-set-initial-state 'ztree-mode 'motion)
 
   (evil-define-key 'motion ztree-mode-map