Variable: checkdoc-spellcheck-documentation-flag

checkdoc-spellcheck-documentation-flag is a customizable variable defined in checkdoc.el.gz.

Value

nil

Documentation

Non-nil means run Ispell on text based on value.

This is automatically set to nil if Ispell does not exist on your system. Possible values are:

  nil - Don't spell-check during basic style checks.
  defun - Spell-check when style checking a single defun.
  buffer - Spell-check when style checking the whole buffer.
  interactive - Spell-check during any interactive check.
  t - Always spell-check.

There is a list of Lisp-specific words which checkdoc will install into Ispell on the fly, but only if Ispell is not already running. Use ispell-kill-ispell to make checkdoc restart it with these words enabled.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/checkdoc.el.gz
;;;###autoload(put 'checkdoc-permit-comma-termination-flag 'safe-local-variable #'booleanp)

(defcustom checkdoc-spellcheck-documentation-flag nil
  "Non-nil means run Ispell on text based on value.
This is automatically set to nil if Ispell does not exist on your
system.  Possible values are:

  nil         - Don't spell-check during basic style checks.
  defun       - Spell-check when style checking a single defun.
  buffer      - Spell-check when style checking the whole buffer.
  interactive - Spell-check during any interactive check.
  t           - Always spell-check.

There is a list of Lisp-specific words which checkdoc will
install into Ispell on the fly, but only if Ispell is not already
running.  Use `ispell-kill-ispell' to make checkdoc restart it
with these words enabled."
  :type '(choice (const nil)
          (const defun)
          (const buffer)
          (const interactive)
          (const t)))