*** empty log message ***

[bpt/emacs.git] / lisp / superyank.el

diff --git a/lisp/superyank.el b/lisp/superyank.el
index 6319f90..f76e6c7 100644 (file)
--- a/lisp/superyank.el
+++ b/lisp/superyank.el
@@ -1,5 +1,30 @@
-;; superyank.el -- Version 1.1
-;;
+;;; superyank.el --- smart message-yanking code for GNUS
+
+;; Copyright (C) 1992 Free Software Foundation, Inc.
+
+;; Author: Barry A. Warsaw <warsaw@cme.nist.gov>
+;; Version: 1.1
+;; Adapted-By: ESR
+;; Keywords: news
+
+;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+
+;;; Commentary:
+
 ;; Inserts the message being replied to with various user controlled
 ;; citation styles.
 ;;
@@ -41,7 +66,7 @@
 ;; modified: 12-Apr-1989 baw (incorp other mail yank features seen on net)
 ;; created : 16-Feb-1989 baw (mod vanilla fn indent-rigidly mail-yank-original)
 
-;; Though I wrote this package basically from scratch, as an elisp
+;; Though I wrote this package basically from scratch, as an Emacs Lisp
 ;; learning exercise, it was inspired by postings of similar packages to
 ;; the gnu.emacs newsgroup over the past month or so.
 ;;
@@ -83,6 +108,9 @@
 ;; 2) reparse nested citations to try to recast as non-nested citations
 ;;    perhaps by checking the References: line
 ;;
+
+;;; Code:
+
 ;; ======================================================================
 ;;
 ;; require and provide features
@@ -1108,11 +1136,12 @@ sy-use-only-preference-p   (default: nil)
 ;; attribution if none could be found from the paragraph.
 ;;
 (defun sy-fill-paragraph-manually (arg)
-  "Fill paragraph containing or following point, automatically finding
-the sy-cite-regexp and using it as the prefix.  If the sy-cite-regexp
-is not in the first line of the paragraph, it makes a guess at what
-the fill-prefix for the paragraph should be by looking at the first
-line and taking anything up to the first alphanumeric character.
+  "Fill paragraph containing or following point.
+This automatically finds the sy-cite-regexp and uses it as the prefix.
+If the sy-cite-regexp is not in the first line of the paragraph, it
+makes a guess at what the fill-prefix for the paragraph should be by
+looking at the first line and taking anything up to the first
+alphanumeric character.
 
 Prefix arg means justify both sides of paragraph as well.
 
@@ -1179,7 +1208,8 @@ attribution string used to cite lines."
 ;; insert the persistant attribution at point
 ;;
 (defun sy-insert-persist-attribution ()
-  "Insert the persistant attribution at the beginning of the line that
+  "Insert the persistant attribution.
+This inserts the peristant attribution at the beginning of the line that
 point is on.  This string is the last attribution confirmed and used
 in the yanked reply buffer."
   (interactive)
@@ -1194,9 +1224,9 @@ in the yanked reply buffer."
 ;; open a line putting the attribution at the beginning
 
 (defun sy-open-line (arg)
-  "Insert a newline and leave point before it.  Also inserts the
-persistant attribution at the beginning of the line.  With arg,
-inserts that many newlines."
+  "Insert a newline and leave point before it.
+Also inserts the persistant attribution at the beginning of the line.
+With argument, inserts ARG newlines."
   (interactive "p")
   (save-excursion
     (let ((start (point)))
@@ -1210,3 +1240,4 @@ inserts that many newlines."
 
 (provide 'superyank)
 
+;;; superyank.el ends here