Give some autoloaded things doc-strings.

* lisp/lpr.el (lpr-windows-system, lpr-lp-system):
* lisp/mail/binhex.el (binhex-begin-line):
* lisp/progmodes/grep.el (grep-history, grep-find-history):
* lisp/textmodes/flyspell.el:
* lisp/vc/pcvs-defs.el (cvs-global-menu):
* lisp/vc/vc-bzr.el (vc-bzr-admin-checkout-format-file):
* lisp/vc/vc-mtn.el (vc-mtn-admin-dir, vc-mtn-admin-format):
* lisp/vc/vc-cvs.el (vc-cvs-registered): Give them basic doc-strings.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index b4c1365..d441008 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,14 @@
 2011-11-24  Glenn Morris  <rgm@gnu.org>
 
+       * lpr.el (lpr-windows-system, lpr-lp-system):
+       * mail/binhex.el (binhex-begin-line):
+       * progmodes/grep.el (grep-history, grep-find-history):
+       * textmodes/flyspell.el:
+       * vc/pcvs-defs.el (cvs-global-menu):
+       * vc/vc-bzr.el (vc-bzr-admin-checkout-format-file):
+       * vc/vc-mtn.el (vc-mtn-admin-dir, vc-mtn-admin-format):
+       * vc/vc-cvs.el (vc-cvs-registered): Give them basic doc-strings.
+
        * net/tls.el: Fix case of "GnuTLS".
 
        * paths.el (rmail-file-name): Format doc-string for make-docfile.

diff --git a/lisp/lpr.el b/lisp/lpr.el
index 76c69f3..2960635 100644 (file)
--- a/lisp/lpr.el
+++ b/lisp/lpr.el
@@ -33,11 +33,13 @@
 
 ;;;###autoload
 (defvar lpr-windows-system
-  (memq system-type '(ms-dos windows-nt)))
+  (memq system-type '(ms-dos windows-nt))
+  "Non-nil if running on MS-DOS or MS Windows.")
 
 ;;;###autoload
 (defvar lpr-lp-system
-  (memq system-type '(usg-unix-v hpux irix)))
+  (memq system-type '(usg-unix-v hpux irix))
+  "Non-nil if running on a system type that uses the \"lp\" command.")
 
 
 (defgroup lpr nil

diff --git a/lisp/mail/binhex.el b/lisp/mail/binhex.el
index 5332c0f..3259346 100644 (file)
--- a/lisp/mail/binhex.el
+++ b/lisp/mail/binhex.el
@@ -79,10 +79,11 @@ input and write the converted data to its standard output."
 
 ;;;###autoload
 (defconst binhex-begin-line
-  "^:...............................................................$")
+  "^:...............................................................$"
+  "Regular expression matching the start of a BinHex encoded region.")
 (defconst binhex-body-line
   "^[^:]...............................................................$")
-(defconst binhex-end-line ":$")
+(defconst binhex-end-line ":$")                ; unused
 
 (defvar binhex-temporary-file-directory
   (cond ((fboundp 'temp-directory) (temp-directory))

diff --git a/lisp/progmodes/grep.el b/lisp/progmodes/grep.el
index dbffbc2..75d71d2 100644 (file)
--- a/lisp/progmodes/grep.el
+++ b/lisp/progmodes/grep.el
@@ -438,9 +438,9 @@ This variable's value takes effect when `grep-compute-defaults' is called.")
 
 ;; History of grep commands.
 ;;;###autoload
-(defvar grep-history nil)
+(defvar grep-history nil "History list for grep.")
 ;;;###autoload
-(defvar grep-find-history nil)
+(defvar grep-find-history nil "History list for grep-find.")
 
 ;; History of lgrep and rgrep regexp and files args.
 (defvar grep-regexp-history nil)

diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el
index d54debc..6b4c1a2 100644 (file)
--- a/lisp/textmodes/flyspell.el
+++ b/lisp/textmodes/flyspell.el
@@ -466,7 +466,7 @@ See also `flyspell-duplicate-distance'."
 ;;*---------------------------------------------------------------------*/
 ;;*    flyspell-mode ...                                                */
 ;;*---------------------------------------------------------------------*/
-;;;###autoload(defvar flyspell-mode nil)
+;;;###autoload(defvar flyspell-mode nil "Non-nil if Flyspell mode is enabled.")
 ;;;###autoload
 (define-minor-mode flyspell-mode
   "Toggle on-the-fly spell checking (Flyspell mode).

diff --git a/lisp/vc/pcvs-defs.el b/lisp/vc/pcvs-defs.el
index f634039..477cd47 100644 (file)
--- a/lisp/vc/pcvs-defs.el
+++ b/lisp/vc/pcvs-defs.el
@@ -493,7 +493,8 @@ It is expected to call the function.")
     (define-key m [examine]
       `(menu-item ,(purecopy "Examine Directory") cvs-examine
                  :help ,(purecopy "Examine the current state of a workarea")))
-    (fset 'cvs-global-menu m)))
+    (fset 'cvs-global-menu m))
+  "Global menu used by PCL-CVS.")
 
 
 ;; cvs-1.10 and above can take file arguments in other directories

diff --git a/lisp/vc/vc-bzr.el b/lisp/vc/vc-bzr.el
index f6b6a56..c5c0ce7 100644 (file)
--- a/lisp/vc/vc-bzr.el
+++ b/lisp/vc/vc-bzr.el
@@ -124,7 +124,8 @@ Use the current Bzr root directory as the ROOT argument to
 ;; Used in the autoloaded vc-bzr-registered; see below.
 ;;;###autoload
 (defconst vc-bzr-admin-checkout-format-file
-  (concat vc-bzr-admin-dirname "/checkout/format"))
+  (concat vc-bzr-admin-dirname "/checkout/format")
+  "Name of the format file in a .bzr directory.")
 (defconst vc-bzr-admin-dirstate
   (concat vc-bzr-admin-dirname "/checkout/dirstate"))
 (defconst vc-bzr-admin-branch-format-file

diff --git a/lisp/vc/vc-cvs.el b/lisp/vc/vc-cvs.el
index 6a76359..7d6c3ca 100644 (file)
--- a/lisp/vc/vc-cvs.el
+++ b/lisp/vc/vc-cvs.el
@@ -189,7 +189,8 @@ See also variable `vc-cvs-sticky-date-format-string'."
 ;;; State-querying functions
 ;;;
 
-;;;###autoload (defun vc-cvs-registered (f)
+;;;###autoload(defun vc-cvs-registered (f)
+;;;###autoload   "Return non-nil if file F is registered with CVS."
 ;;;###autoload   (when (file-readable-p (expand-file-name
 ;;;###autoload                           "CVS/Entries" (file-name-directory f)))
 ;;;###autoload       (load "vc-cvs")

diff --git a/lisp/vc/vc-mtn.el b/lisp/vc/vc-mtn.el
index 0fc7ba9..f49ad09 100644 (file)
--- a/lisp/vc/vc-mtn.el
+++ b/lisp/vc/vc-mtn.el
@@ -59,9 +59,10 @@ If nil, use the value of `vc-diff-switches'.  If t, use no switches."
   (setq vc-handled-backends (delq 'Mtn vc-handled-backends)))
 
 ;;;###autoload
-(defconst vc-mtn-admin-dir "_MTN")
+(defconst vc-mtn-admin-dir "_MTN" "Name of the monotone directory.")
 ;;;###autoload
-(defconst vc-mtn-admin-format (concat vc-mtn-admin-dir "/format"))
+(defconst vc-mtn-admin-format (concat vc-mtn-admin-dir "/format")
+  "Name of the monotone directory's format file.")
 
 ;;;###autoload (defun vc-mtn-registered (file)
 ;;;###autoload   (if (vc-find-root file vc-mtn-admin-format)