diff options
author | Richard M. Stallman <rms@gnu.org> | 2002-06-12 12:16:08 +0000 |
---|---|---|
committer | Richard M. Stallman <rms@gnu.org> | 2002-06-12 12:16:08 +0000 |
commit | fc896a928cac48ab605eb17dc32267450a85c0d4 (patch) | |
tree | e75d7ab047b5179f430fe968af6545e7d22ae1c1 /lisp/font-lock.el | |
parent | 8b22c65ad8d81768abd43e379f13312f932ffe88 (diff) | |
download | emacs-fc896a928cac48ab605eb17dc32267450a85c0d4.tar.gz |
(font-lock-beginning-of-syntax-function): Doc fix.
Diffstat (limited to 'lisp/font-lock.el')
-rw-r--r-- | lisp/font-lock.el | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/lisp/font-lock.el b/lisp/font-lock.el index 04d422b7942..fc9fe45954b 100644 --- a/lisp/font-lock.el +++ b/lisp/font-lock.el @@ -519,12 +519,17 @@ If this is nil, the major mode's syntax table is used. This is normally set via `font-lock-defaults'.") (defvar font-lock-beginning-of-syntax-function nil - "*Non-nil means use this function to move back outside of a syntactic block. -When called with no args it should leave point at the beginning of any -enclosing syntactic block. -If this is nil, the beginning of the buffer is used (in the worst case). + "*Non-nil means use this function to move back outside all constructs. +When called with no args it should move point backward to a place which +is not in a string or comment and not within any bracket-pairs (or else, +a place such that any bracket-pairs outside it can be ignored for Emacs +syntax analysis and fontification). + +If this is nil, the beginning of the buffer is used, which is +always correct but tends to be slow. This is normally set via `font-lock-defaults'. -It is preferable to set `syntax-begin-function' instead.") +This variable is semi-obsolete; we recommend setting +`syntax-begin-function' instead.") (defvar font-lock-mark-block-function nil "*Non-nil means use this function to mark a block of text. |