changeset 41938:f8c0a921c536

Improve doc of font-lock-keywords.
author Richard M. Stallman <rms@gnu.org>
date Tue, 11 Dec 2001 06:10:32 +0000
parents 9ad71f03b20b
children e9a4c1f03019
files lispref/modes.texi
diffstat 1 files changed, 9 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/modes.texi	Tue Dec 11 06:07:52 2001 +0000
+++ b/lispref/modes.texi	Tue Dec 11 06:10:32 2001 +0000
@@ -1824,8 +1824,15 @@
 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