Mercurial > emacs
changeset 65662:f621d74f5b9a
(flyspell-incorrect-hook, flyspell-highlight-incorrect-region)
(flyspell-highlight-duplicate-region): Doc fixes.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Fri, 23 Sep 2005 18:28:10 +0000 |
| parents | 1da971deed7b |
| children | a36daa69a131 |
| files | lisp/textmodes/flyspell.el |
| diffstat | 1 files changed, 14 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/textmodes/flyspell.el Fri Sep 23 18:26:09 2005 +0000 +++ b/lisp/textmodes/flyspell.el Fri Sep 23 18:28:10 2005 +0000 @@ -169,11 +169,12 @@ (defcustom flyspell-incorrect-hook nil "*List of functions to be called when incorrect words are encountered. -Each function is given three arguments: the beginning and the end -of the incorrect region. The third is either the symbol 'doublon' or the list +Each function is given three arguments. The first two +arguments are the beginning and the end of the incorrect region. +The third is either the symbol `doublon' or the list of possible corrections as returned by `ispell-parse-output'. -If any of the functions return non-Nil, the word is not highlighted as +If any of the functions return non-nil, the word is not highlighted as incorrect." :group 'flyspell :version "21.1" @@ -1086,6 +1087,8 @@ word (+ end flyspell-duplicate-distance)))))) + ;; This is a misspelled word which occurs + ;; twice within flyspell-duplicate-distance. (setq flyspell-word-cache-result nil) (if flyspell-highlight-flag (flyspell-highlight-duplicate-region @@ -1559,7 +1562,11 @@ ;* flyspell-highlight-incorrect-region ... */ ;*---------------------------------------------------------------------*/ (defun flyspell-highlight-incorrect-region (beg end poss) - "Set up an overlay on a misspelled word, in the buffer from BEG to END." + "Set up an overlay on a misspelled word, in the buffer from BEG to END. +POSS is usually a list of possible spelling/correction lists, +as returned by `ispell-parse-output'. +It can also be the symbol `doublon', in the case where the word +is itself incorrect, but suspiciously repeated." (let ((inhibit-read-only t)) (unless (run-hook-with-args-until-success 'flyspell-incorrect-hook beg end poss) @@ -1592,8 +1599,9 @@ ;* flyspell-highlight-duplicate-region ... */ ;*---------------------------------------------------------------------*/ (defun flyspell-highlight-duplicate-region (beg end poss) - "Set up an overlay on a duplicated word, in the buffer from BEG to END. -??? What does POSS mean?" + "Set up an overlay on a duplicate misspelled word, in the buffer from BEG to END. +POSS is a list of possible spelling/correction lists, +as returned by `ispell-parse-output'." (let ((inhibit-read-only t)) (unless (run-hook-with-args-until-success 'flyspell-incorrect-hook beg end poss)