]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve doc of font-lock-keywords.
authorRichard M. Stallman <rms@gnu.org>
Tue, 11 Dec 2001 06:10:32 +0000 (06:10 +0000)
committerRichard M. Stallman <rms@gnu.org>
Tue, 11 Dec 2001 06:10:32 +0000 (06:10 +0000)
lispref/modes.texi

index bbeb08409edb2549202a57f0afffb301eb13d4cf..4ea2e6d25aa7c4ac84eb5fc035efcaa724057cb2 100644 (file)
@@ -1824,8 +1824,15 @@ Find text by calling @var{function}, and highlight the matches
 it finds using @code{font-lock-keyword-face}.
 
 When @var{function} is called, it receives one argument, the limit of
-the search.  It should return non-@code{nil} if it succeeds, and set the
-match data to describe the match that was found.
+the search; it should searching at point, and not search beyond the
+limit.  It should return non-@code{nil} if it succeeds, and set the
+match data to describe the match that was found.  Returning @code{nil}
+indicates failure of the search.
+
+Fontification will call @var{function} repeatedly with the same limit,
+and with point where the previous invocation left it, until
+@var{function} fails.  On failure, @var{function} need not reset point
+in any particular way.
 
 @item (@var{matcher} . @var{match})
 In this kind of element, @var{matcher} is either a regular