summaryrefslogtreecommitdiff
path: root/lispref
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>2001-12-11 06:10:32 +0000
committerRichard M. Stallman <rms@gnu.org>2001-12-11 06:10:32 +0000
commit07f7b41c2fdb4ac23903f415469d2bbe5e20ec04 (patch)
tree4a843c634e796fd3743e2dfea8c45ffb69af4753 /lispref
parent4b12215e3e0119b8ecfababd84b712515809874a (diff)
downloademacs-07f7b41c2fdb4ac23903f415469d2bbe5e20ec04.tar.gz
Improve doc of font-lock-keywords.
Diffstat (limited to 'lispref')
-rw-r--r--lispref/modes.texi11
1 files changed, 9 insertions, 2 deletions
diff --git a/lispref/modes.texi b/lispref/modes.texi
index bbeb08409ed..4ea2e6d25aa 100644
--- a/lispref/modes.texi
+++ b/lispref/modes.texi
@@ -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