Changeset 4161 for trunk/lisp/emacs-lisp/checkdoc.el

Timestamp:

09/09/06 16:30:10 (2 years ago)

Author:

miyoshi

Message:

Sync up with Emacs CVS HEAD.

Files:

• trunk/lisp/emacs-lisp/checkdoc.el (modified) (12 diffs)

trunk/lisp/emacs-lisp/checkdoc.el

@@ -194 +194 @@
-(defvar compilation-mode-font-lock-keywords)
-
+(defgroup checkdoc nil
+  "Support for doc string checking in Emacs Lisp."
+  :prefix "checkdoc"
+  :group 'lisp
+  :version "20.3")
+
-(defcustom checkdoc-autofix-flag 'semiautomatic
-*
+
-If this value is the symbol `query', then the user is queried before
-any change is made.  If the value is `automatic', then all changes are
@@ -209 +215 @@
-
-(defcustom checkdoc-bouncy-flag t
-*
+
-Setting this to nil will silently make fixes that require no user
-interaction.  See `checkdoc-autofix-flag' for auto-fixing details."
@@ -216 +222 @@
-
-(defcustom checkdoc-force-docstrings-flag t
-*
+
-Style guide dictates that interactive functions MUST have documentation,
-and that it's good but not required practice to make non user visible items
@@ -222 +228 @@
-  :group 'checkdoc
-  :type 'boolean)
+(put 'checkdoc-force-docstrings-flag 'safe-local-variable 'booleanp)
-
-(defcustom checkdoc-force-history-flag t
-*
+
-This helps document the evolution of, and recent changes to, the package."
-  :group 'checkdoc
@@ -230 +237 @@
-
-(defcustom checkdoc-permit-comma-termination-flag nil
-*
+
-Ordinarily, a full sentence is required.  This may be misleading when
-there is a substantial caveat to the one-line description -- the comma
@@ -237 +244 @@
-  :group 'checkdoc
-  :type 'boolean)
+(put 'checkdoc-permit-comma-termination-flag 'safe-local-variable 'booleanp)
-
-(defcustom checkdoc-spellcheck-documentation-flag nil
-*
+
-This is automatically set to nil if Ispell does not exist on your
-system.  Possible values are:
@@ -260 +268 @@
-
-(defcustom checkdoc-max-keyref-before-warn 10
-*
+
-Any more than this and a warning is generated suggesting that the construct
-\\ {keymap} be used instead."
@@ -267 +275 @@
-
-(defcustom checkdoc-arguments-in-order-flag t
-*
+
-Setting this to nil will mean only checking that all the arguments
-appear in the proper form in the documentation, not that they are in
@@ -299 +307 @@
-
-(defcustom checkdoc-verb-check-experimental-flag t
-*
+
-This check keys off some words which are commonly misused.  See the
-variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
@@ -2254 +2262 @@
-                    (re-search-forward "^(require" nil t)
-                    (re-search-forward "^(" nil t))
-
+
+
-              (if (checkdoc-y-or-n-p
-                   "You should have a \";;; Commentary:\", add one? ")
@@ -2634 +2643 @@
-        nil)))
-
-(defgroup checkdoc nil
-  "Support for doc string checking in Emacs Lisp."
-  :prefix "checkdoc"
-  :group 'lisp
-  :version "20.3")
-
-(custom-add-option 'emacs-lisp-mode-hook
-                   (lambda () (checkdoc-minor-mode 1)))
@@ -2651 +2654 @@
-(provide 'checkdoc)
-
-;
+
-;;; checkdoc.el ends here