From: Richard M. Stallman <rms@gnu.org>
Date: Fri, 23 Sep 2005 18:29:20 +0000 (+0000)
Subject: (flyspell-incorrect-hook, flyspell-highlight-incorrect-region)
X-Git-Tag: emacs-pretest-22.0.90~6974
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=91346f5419070003e0cd917b5adafb6d9cc3eef1;p=emacs.git

(flyspell-incorrect-hook, flyspell-highlight-incorrect-region)
(flyspell-highlight-duplicate-region): Doc fixes.
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index a545e3e400a..90212e0f6e1 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,12 @@
+2005-09-23  Richard M. Stallman  <rms@gnu.org>
+
+	* textmodes/flyspell.el (flyspell-highlight-incorrect-region)
+	(flyspell-incorrect-hook, flyspell-highlight-duplicate-region):
+	Doc fixes.
+
+	* progmodes/cc-mode.el (c-font-lock-init): Specify
+	font-lock-lines-before.
+
 2005-09-23  Stefan Monnier  <monnier@iro.umontreal.ca>
 
 	* smerge-mode.el (smerge-remove-props): Cause re-highlighting of the
diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el
index e46b8533fc4..151a32c60a9 100644
--- a/lisp/textmodes/flyspell.el
+++ b/lisp/textmodes/flyspell.el
@@ -169,11 +169,12 @@ command was not the very same command."
 
 (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 @@ Mostly we check word delimiters."
 					      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 @@ for the overlay."
 ;*    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 @@ for the overlay."
 ;*    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)