Variable: checkdoc-create-error-function

checkdoc-create-error-function is a variable defined in checkdoc.el.gz.

Value

checkdoc--create-error-for-checkdoc

Documentation

Function called when Checkdoc encounters an error.

Should accept as arguments (TEXT START END &optional UNFIXABLE).

TEXT is the descriptive text of the error. START and END define the region it is sensible to highlight when describing the problem. Optional argument UNFIXABLE means that the error has no auto-fix available.

An object of type checkdoc-error is returned if we are not generating a buffered list of errors.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/checkdoc.el.gz
(defvar checkdoc-create-error-function #'checkdoc--create-error-for-checkdoc
  "Function called when Checkdoc encounters an error.
Should accept as arguments (TEXT START END &optional UNFIXABLE).

TEXT is the descriptive text of the error.  START and END define the region
it is sensible to highlight when describing the problem.
Optional argument UNFIXABLE means that the error has no auto-fix available.

An object of type `checkdoc-error' is returned if we are not
generating a buffered list of errors.")