mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-30 08:09:04 +00:00
Code Issues Releases Activity

(font-lock-add-keywords, font-lock-remove-keywords): Clarify docstring.

Browse Source 
(font-lock-keywords-alist, font-lock-removed-keywords-alist):
Don't start docstrings with a `*'.
(font-lock-update-removed-keyword-alist): Give it a docstring.
This commit is contained in:
Lute Kamstra 2005-04-28 11:48:53 +00:00
parent 18acc65523
commit 95965740cf
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
lisp/font-lock.el
View File

@ -466,12 +466,12 @@ user-level keywords, but normally their values have been
optimized.")
(defvar font-lock-keywords-alist nil
"*Alist of `font-lock-keywords' local to a `major-mode'.
"Alist of `font-lock-keywords' local to a `major-mode'.
This is normally set via `font-lock-add-keywords' and
`font-lock-remove-keywords'.")
(defvar font-lock-removed-keywords-alist nil
"*Alist of `font-lock-keywords' removed from `major-mode'.
"Alist of `font-lock-keywords' removed from `major-mode'.
This is normally set via `font-lock-add-keywords' and
`font-lock-remove-keywords'.")
@ -664,9 +664,9 @@ For example:
adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
comments, and to fontify `and', `or' and `not' words as keywords.
When used from an elisp package (such as a minor mode), it is recommended
to use nil for MODE (and place the call in a loop or on a hook) to avoid
subtle problems due to details of the implementation.
When used from a Lisp program (such as a minor mode), it is recommended to
use nil for MODE (and place the call on a hook) to avoid subtle problems
due to details of the implementation.
Note that some modes have specialized support for additional patterns, e.g.,
see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
@ -707,9 +707,7 @@ see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
(font-lock-compile-keywords font-lock-keywords t)))))))
(defun font-lock-update-removed-keyword-alist (mode keywords append)
;; Update `font-lock-removed-keywords-alist' when adding new
;; KEYWORDS to MODE.
;;
"Update `font-lock-removed-keywords-alist' when adding new KEYWORDS to MODE."
;; When font-lock is enabled first all keywords in the list
;; `font-lock-keywords-alist' are added, then all keywords in the
;; list `font-lock-removed-keywords-alist' are removed. If a
@ -757,9 +755,9 @@ see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
MODE should be a symbol, the major mode command name, such as `c-mode'
or nil. If nil, highlighting keywords are removed for the current buffer.
When used from an elisp package (such as a minor mode), it is recommended
to use nil for MODE (and place the call in a loop or on a hook) to avoid
subtle problems due to details of the implementation."
When used from a Lisp program (such as a minor mode), it is recommended to
use nil for MODE (and place the call on a hook) to avoid subtle problems
due to details of the implementation."
(cond (mode
;; Remove one keyword at the time.
(dolist (keyword keywords)