From: Lute Kamstra <lute@gnu.org>
Date: Thu, 28 Apr 2005 11:48:53 +0000 (+0000)
Subject: (font-lock-add-keywords, font-lock-remove-keywords): Clarify docstring.
X-Git-Tag: ttn-vms-21-2-B4~680
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=95965740cf51d558b20b5ddb144d9b0040460cb2;p=emacs.git

(font-lock-add-keywords, font-lock-remove-keywords): Clarify docstring.
(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.
---

diff --git a/lisp/font-lock.el b/lisp/font-lock.el
index 9c5851abd2f..19a5f6a2f4b 100644
--- a/lisp/font-lock.el
+++ b/lisp/font-lock.el
@@ -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)