summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/checkdoc.el
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2009-08-22 23:02:14 +0000
committerGlenn Morris <rgm@gnu.org>2009-08-22 23:02:14 +0000
commit9b89e3ee328a08937e796c0b2a4f9075ca8eeb90 (patch)
tree42b291961b3453c21c867aab3eafbf8207036f0d /lisp/emacs-lisp/checkdoc.el
parent7763401bac994e1c6bf94cba3b2a445927df40cd (diff)
downloademacs-9b89e3ee328a08937e796c0b2a4f9075ca8eeb90.tar.gz
emacs-9b89e3ee328a08937e796c0b2a4f9075ca8eeb90.tar.bz2
emacs-9b89e3ee328a08937e796c0b2a4f9075ca8eeb90.zip
Kevin Ryde <user42 at zip.com.au>
(checkdoc-force-history-flag, checkdoc-arguments-in-order-flag): Add safe-local-variable booleanp. (checkdoc-symbol-words): Add safe-local-variable for list of strings. Clarify docstring that the value is strings not symbols. (checkdoc-list-of-strings-p): New function.
Diffstat (limited to 'lisp/emacs-lisp/checkdoc.el')
-rw-r--r--lisp/emacs-lisp/checkdoc.el14
1 files changed, 12 insertions, 2 deletions
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index fad8d25ab6b..54d1a356259 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -223,6 +223,7 @@ have doc strings."
This helps document the evolution of, and recent changes to, the package."
:group 'checkdoc
:type 'boolean)
+;;;###autoload(put 'checkdoc-force-history-flag 'safe-local-variable 'booleanp)
(defcustom checkdoc-permit-comma-termination-flag nil
"Non-nil means the first line of a docstring may end with a comma.
@@ -270,6 +271,7 @@ the same order as they appear in the argument list. No mention is
made in the style guide relating to order."
:group 'checkdoc
:type 'boolean)
+;;;###autoload(put 'checkdoc-arguments-in-order-flag 'safe-local-variable 'booleanp)
(defvar checkdoc-style-hooks nil
"Hooks called after the standard style check is completed.
@@ -307,11 +309,19 @@ Do not set this by hand, use a function like `checkdoc-current-buffer'
with a universal argument.")
(defcustom checkdoc-symbol-words nil
- "A list of symbols which also happen to make good words.
-These symbol-words are ignored when unquoted symbols are searched for.
+ "A list of symbol names (strings) which also happen to make good words.
+These words are ignored when unquoted symbols are searched for.
This should be set in an Emacs Lisp file's local variables."
:group 'checkdoc
:type '(repeat (symbol :tag "Word")))
+;;;###autoload(put 'checkdoc-symbol-words 'safe-local-variable 'checkdoc-list-of-strings-p)
+
+;;;###autoload
+(defun checkdoc-list-of-strings-p (obj)
+ ;; this is a function so it might be shared by checkdoc-proper-noun-list
+ ;; and/or checkdoc-ispell-lisp-words in the future
+ (and (listp obj)
+ (not (memq nil (mapcar 'stringp obj)))))
(defvar checkdoc-proper-noun-list
'("ispell" "xemacs" "emacs" "lisp")