comparison lisp/emacs-lisp/checkdoc.el @ 21181:2b9774c50f91

Updated to 0.4.3: Removed string check in basic doc search code. Made the check for embeded key codes more robust from erronious checks.

21180:921bd225796e

;;; checkdoc --- Check documentation strings for style requirements

;;;  Copyright (C) 1997, 1998  Free Software Foundation
;;
;; Author: Eric M. Ludlam <[e-mail]>
;; Version: 0.4.2
;; Keywords: docs, maint, lisp
;;
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;;
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;       `checkdoc-spellcheck-documentation-flag' off by default.
;;       Re-sorted check order so white space is removed before adding a .
;; 0.4.2 Added some more comments in the commentary.
;;       You can now `quote' symbols that look like keystrokes
;;       When spell checking, meta variables can end in `th' or `s'.

;;; TO DO:
;;   Hook into the byte compiler on a defun/defver level to generate
;;     warnings in the byte-compiler's warning/error buffer.
;;   Better ways to override more typical `eval' functions.  Advice

;;   Code sweep checks for "forbidden functions", proper use of hooks,
;;     proper keybindings, and other items from the manual that are
;;     not specifically docstring related.  Would this even be useful?

;;; Code:
(defvar checkdoc-version "0.4.2"
  "Release version of checkdoc you are currently running.")

;; From custom web page for compatibility between versions of custom:
(eval-and-compile
  (condition-case ()

    (save-excursion
      ;; If we are taking notes, encompass the whole buffer, otherwise
      ;; the user is navigating down through the buffer.
      (if take-notes (checkdoc-start-section "checkdoc"))
      (while (and (not wrong) (checkdoc-next-docstring))
	(if (not (checkdoc-char= (following-char) ?\"))
	    ;; No doc-string...
	    nil
	  ;; OK, lets look at the doc-string.
	  (setq msg (checkdoc-this-string-valid))
	  (if msg
	      ;; Oops
	      (if take-notes
		  (progn
		    (checkdoc-error (point) msg)
		    (setq errors t))
		(setq wrong (point)))))))
    (if wrong
	(progn
	  (goto-char wrong)
	  (error msg)))
    (if (and take-notes errors)

		   replace original)))))
     ;;   * Don't write key sequences directly in documentation strings.
     ;;     Instead, use the `\\[...]' construct to stand for them.
     (save-excursion
       (let ((f nil) (m nil) (start (point))
	     (re "[^`]\\([CMA]-[a-zA-Z]\\|\\(\\([CMA]-\\)?\
mouse-[0-3]\\)\\)\\>"))
	 ;; Find the first key sequence not in a sample
	 (while (and (not f) (setq m (re-search-forward re e t)))
	   (setq f (not (checkdoc-in-sample-code-p start e))))
	 (if m

21181:2b9774c50f91

;;; checkdoc --- Check documentation strings for style requirements

;;;  Copyright (C) 1997, 1998  Free Software Foundation

;; Author: Eric M. Ludlam <[e-mail]>
;; Version: 0.4.3
;; Keywords: docs, maint, lisp

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;       `checkdoc-spellcheck-documentation-flag' off by default.
;;       Re-sorted check order so white space is removed before adding a .
;; 0.4.2 Added some more comments in the commentary.
;;       You can now `quote' symbols that look like keystrokes
;;       When spell checking, meta variables can end in `th' or `s'.
;; 0.4.3 Fixed bug where multi-function checking skips defuns that
;;         have comments before the doc-string.
;;       Fixed bug where keystrokes were identified from a variable name
;;         like ASSOC-P.

;;; TO DO:
;;   Hook into the byte compiler on a defun/defver level to generate
;;     warnings in the byte-compiler's warning/error buffer.
;;   Better ways to override more typical `eval' functions.  Advice

;;   Code sweep checks for "forbidden functions", proper use of hooks,
;;     proper keybindings, and other items from the manual that are
;;     not specifically docstring related.  Would this even be useful?

;;; Code:
(defvar checkdoc-version "0.4.3"
  "Release version of checkdoc you are currently running.")

;; From custom web page for compatibility between versions of custom:
(eval-and-compile
  (condition-case ()

    (save-excursion
      ;; If we are taking notes, encompass the whole buffer, otherwise
      ;; the user is navigating down through the buffer.
      (if take-notes (checkdoc-start-section "checkdoc"))
      (while (and (not wrong) (checkdoc-next-docstring))
	;; OK, lets look at the doc-string.
	(setq msg (checkdoc-this-string-valid))
	(if msg
	    ;; Oops
	    (if take-notes
		(progn
		  (checkdoc-error (point) msg)
		  (setq errors t))
	      (setq wrong (point))))))
    (if wrong
	(progn
	  (goto-char wrong)
	  (error msg)))
    (if (and take-notes errors)

		   replace original)))))
     ;;   * Don't write key sequences directly in documentation strings.
     ;;     Instead, use the `\\[...]' construct to stand for them.
     (save-excursion
       (let ((f nil) (m nil) (start (point))
	     (re "[^`A-Za-z0-9_]\\([CMA]-[a-zA-Z]\\|\\(\\([CMA]-\\)?\
mouse-[0-3]\\)\\)\\>"))
	 ;; Find the first key sequence not in a sample
	 (while (and (not f) (setq m (re-search-forward re e t)))
	   (setq f (not (checkdoc-in-sample-code-p start e))))
	 (if m