From: ueno <ueno>
Date: Wed, 26 Apr 2006 01:55:39 +0000 (+0000)
Subject: Add docstring.
X-Git-Tag: epg-0_0_1~17
X-Git-Url: http://git.chise.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6f8c77fee621bd42474ea216df1b0b242375bc39;p=elisp%2Fepg.git

Add docstring.
---

diff --git a/epa.el b/epa.el
index 01a290d..3a2c3ae 100644
--- a/epa.el
+++ b/epa.el
@@ -313,6 +313,7 @@
 	  (if key
 	      (list key))))))
 
+;;;###autoload
 (defun epa-select-keys (context prompt &optional names secret)
   "Display a user's keyring and ask him to select keys.
 CONTEXT is an epg-context.
@@ -434,7 +435,8 @@ If SECRET is non-nil, list secret keys instead of public keys."
   (epa-show-key (widget-get widget :value)))
 
 (defun epa-mark (&optional arg)
-  "Mark the current line."
+  "Mark the current line.
+If ARG is non-nil, unmark the current line."
   (interactive "P")
   (let ((inhibit-read-only t)
 	buffer-read-only
@@ -447,15 +449,20 @@ If SECRET is non-nil, list secret keys instead of public keys."
     (forward-line)))
 
 (defun epa-unmark (&optional arg)
-  "Unmark the current line."
+  "Unmark the current line.
+If ARG is non-nil, mark the current line."
   (interactive "P")
   (epa-mark (not arg)))
 
 (defun epa-exit-buffer ()
+  "Exit the current buffer.
+`epa-exit-buffer-function' is called if it is set."
   (interactive)
   (funcall epa-exit-buffer-function))
 
+;;;###autoload
 (defun epa-decrypt-file (file)
+  "Decrypt FILE."
   (interactive "fFile: ")
   (let* ((default-name (file-name-sans-extension file))
 	 (plain (expand-file-name
@@ -470,7 +477,9 @@ If SECRET is non-nil, list secret keys instead of public keys."
     (epg-decrypt-file context file plain)
     (message "Decrypting %s...done" (file-name-nondirectory file))))
 
+;;;###autoload
 (defun epa-verify-file (file)
+  "Verify FILE."
   (interactive "fFile: ")
   (let* ((context (epg-make-context))
 	 (plain (if (equal (file-name-extension file) "sig")
@@ -482,7 +491,10 @@ If SECRET is non-nil, list secret keys instead of public keys."
 	     (epg-verify-result-to-string
 	      (epg-context-result-for context 'verify)))))
 
+;;;###autoload
 (defun epa-sign-file (file signers detached)
+  "Sign FILE by selected SIGNERS keys.
+If DETACHED is non-nil, it creates a detached signature."
   (interactive
    (list (expand-file-name (read-file-name "File: "))
 	 (epa-select-keys (epg-make-context) "Select keys for signing.
@@ -496,7 +508,9 @@ If no one is selected, default secret key is used.  "
     (epg-sign-file context file signature (not (null detached)))
     (message "Signing %s...done" (file-name-nondirectory file))))
 
+;;;###autoload
 (defun epa-encrypt-file (file recipients)
+  "Encrypt FILE for RECIPIENTS."
   (interactive
    (list (expand-file-name (read-file-name "File: "))
 	 (epa-select-keys (epg-make-context) "Select recipents for encryption.
@@ -507,7 +521,9 @@ If no one is selected, symmetric encryption will be performed.  ")))
     (epg-encrypt-file context file recipients cipher)
     (message "Encrypting %s...done" (file-name-nondirectory file))))
 
+;;;###autoload
 (defun epa-delete-keys (keys)
+  "Delete selected KEYS."
   (interactive
    (let ((keys (epa-marked-keys)))
      (unless keys
@@ -519,7 +535,9 @@ If no one is selected, symmetric encryption will be performed.  ")))
     (apply #'epa-list-keys epa-list-keys-arguments)
     (message "Deleting...done")))
 
+;;;###autoload
 (defun epa-import-keys (file)
+  "Import keys from FILE."
   (interactive "fFile: ")
   (let ((context (epg-make-context)))
     (message "Importing %s..." (file-name-nondirectory file))
@@ -527,7 +545,9 @@ If no one is selected, symmetric encryption will be performed.  ")))
     (apply #'epa-list-keys epa-list-keys-arguments)
     (message "Importing %s...done" (file-name-nondirectory file))))
 
+;;;###autoload
 (defun epa-export-keys (keys file)
+  "Export selected KEYS to FILE."
   (interactive
    (let ((keys (epa-marked-keys))
 	 default-name)
@@ -551,7 +571,10 @@ If no one is selected, symmetric encryption will be performed.  ")))
     (epg-export-keys-to-file context keys file)
     (message "Exporting to %s...done" (file-name-nondirectory file))))
 
+;;;###autoload
 (defun epa-sign-keys (keys &optional local)
+  "Sign selected KEYS.
+If LOCAL is non-nil, the signature is marked as non exportable."
   (interactive
    (let ((keys (epa-marked-keys)))
      (unless keys