Function: checkdoc-minor-mode

checkdoc-minor-mode is an autoloaded, interactive and byte-compiled function defined in checkdoc.el.gz.

Signature

(checkdoc-minor-mode &optional ARG)

Documentation

Toggle automatic docstring checking (Checkdoc minor mode).

In Checkdoc minor mode, the usual bindings for eval-defun which is bound to C-M-x (checkdoc-eval-defun) and checkdoc-eval-current-buffer are overridden to include checking of documentation strings.

C-M-x checkdoc-eval-defun
C-c ? B checkdoc-ispell-current-buffer
C-c ? C checkdoc-ispell-comments
C-c ? D checkdoc-ispell
C-c ? M checkdoc-ispell-message-text
C-c ? S checkdoc-ispell-start
C-c ? SPC checkdoc-rogue-spaces
C-c ? X checkdoc-ispell-defun
C-c ? ` checkdoc-continue
C-c ? b checkdoc-current-buffer
C-c ? c checkdoc-comments
C-c ? d checkdoc
C-c ? e checkdoc-eval-current-buffer
C-c ? m checkdoc-message-text
C-c ? s checkdoc-start
C-c ? x checkdoc-defun
C-c ? ~ checkdoc-ispell-continue
C-x ` checkdoc-continue

This is a minor mode. If called interactively, toggle the Checkdoc minor mode mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

To check whether the minor mode is enabled in the current buffer, evaluate the variable checkdoc-minor-mode(var)/checkdoc-minor-mode(fun).

The mode's hook is called both when the mode is enabled and when it is disabled.

View in manual

Probably introduced at or before Emacs version 20.3.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/checkdoc.el.gz
;;;###autoload
(define-minor-mode checkdoc-minor-mode
  "Toggle automatic docstring checking (Checkdoc minor mode).

In Checkdoc minor mode, the usual bindings for `eval-defun' which is
bound to \\<checkdoc-minor-mode-map>\\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include
checking of documentation strings.

\\{checkdoc-minor-mode-map}"
  :lighter checkdoc-minor-mode-string
  :group 'checkdoc)