]> git.eshelyaron.com Git - emacs.git/commitdiff
Give some autoloaded things doc-strings.
authorGlenn Morris <rgm@gnu.org>
Thu, 24 Nov 2011 08:21:03 +0000 (00:21 -0800)
committerGlenn Morris <rgm@gnu.org>
Thu, 24 Nov 2011 08:21:03 +0000 (00:21 -0800)
* 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.

lisp/ChangeLog
lisp/lpr.el
lisp/mail/binhex.el
lisp/progmodes/grep.el
lisp/textmodes/flyspell.el
lisp/vc/pcvs-defs.el
lisp/vc/vc-bzr.el
lisp/vc/vc-cvs.el
lisp/vc/vc-mtn.el

index b4c1365c1d3c3380aa4c1479db03b651e850bfa5..d4410089716f9e81ddcc3698ec1340e550d8da52 100644 (file)
@@ -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.
index 76c69f3308c2796769ebe3bee971521c1d90e836..296063549fc9a95f42aeee2f968502f227c1b410 100644 (file)
 
 ;;;###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
index 5332c0f14ba015650b761881f7ee0ec36615367b..32593462062a519f8afa70c35b0b5c82920f828f 100644 (file)
@@ -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))
index dbffbc266e704a900d8d23242387567cf2bccbef..75d71d2d8a920718630ab49e382ebe78a42cccbb 100644 (file)
@@ -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)
index d54debcec4cff1cd2942a47e9ebfdee6fbd9d56d..6b4c1a2940d8c5d25c34ba09709372ea5cebae5e 100644 (file)
@@ -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).
index f6340392dc2110cb0bcf3ce825b45b49c6e4fc2f..477cd472289198a44bc3ae83d3ab8362bba686b5 100644 (file)
@@ -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
index f6b6a56f31c88925075316f2c625fcd05215574a..c5c0ce73b3a6d7d3857d9ef7d9da54bc908b448d 100644 (file)
@@ -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
index 6a76359b5f7cf979b21d613ce080c648fd6cbb95..7d6c3caf7ff94ef2a70442a5dbafb1e4e204b291 100644 (file)
@@ -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")
index 0fc7ba96fb70de524823ed748372a29052156810..f49ad09b5d787d333e6e562f64c90bfb9b16e2e7 100644 (file)
@@ -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)