aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric S. Raymond1993-03-22 16:53:22 +0000
committerEric S. Raymond1993-03-22 16:53:22 +0000
commitd9ecc911ffc5f2d961a8c96129bafbb8d16a17f7 (patch)
tree4a2047cd2e40b4519db2e107ac9a80fd67e1bee8
parent709f7988d203ebbd052805a183d943cd8dd6867d (diff)
downloademacs-d9ecc911ffc5f2d961a8c96129bafbb8d16a17f7.tar.gz
emacs-d9ecc911ffc5f2d961a8c96129bafbb8d16a17f7.zip
Added or corrected Commentary headers
-rw-r--r--lisp/env.el9
-rw-r--r--lisp/help.el5
-rw-r--r--lisp/mail/rfc822.el5
-rw-r--r--lisp/mail/sendmail.el5
-rw-r--r--lisp/play/spook.el6
-rw-r--r--lisp/play/studly.el6
-rw-r--r--lisp/progmodes/simula.el6
-rw-r--r--lisp/register.el7
-rw-r--r--lisp/replace.el5
-rw-r--r--lisp/reposition.el3
-rw-r--r--lisp/rlogin.el48
-rw-r--r--lisp/rot13.el7
-rw-r--r--lisp/scroll-bar.el6
-rw-r--r--lisp/simple.el5
-rw-r--r--lisp/sort.el5
-rw-r--r--lisp/tabify.el5
-rw-r--r--lisp/textmodes/scribe.el6
-rw-r--r--lisp/textmodes/sgml-mode.el2
-rw-r--r--lisp/textmodes/spell.el9
-rw-r--r--lisp/textmodes/text-mode.el6
20 files changed, 125 insertions, 31 deletions
diff --git a/lisp/env.el b/lisp/env.el
index 721c835a187..3445d1c060e 100644
--- a/lisp/env.el
+++ b/lisp/env.el
@@ -3,7 +3,7 @@
3;;; Copyright Free Software Foundation 1991 3;;; Copyright Free Software Foundation 1991
4 4
5;; Maintainer: FSF 5;; Maintainer: FSF
6;; Keywords: extensions 6;; Keywords: processes, unix
7 7
8;;; This file is part of GNU Emacs. 8;;; This file is part of GNU Emacs.
9 9
@@ -21,6 +21,13 @@
21;;; along with GNU Emacs; see the file COPYING. If not, write to 21;;; along with GNU Emacs; see the file COPYING. If not, write to
22;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 22;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 23
24;;; Commentary:
25
26;; UNIX processes inherit a list of name-to-string associations from
27;; their parents called their `environment'; these are commonly used
28;; to control program options. This package permits you to set
29;; environment variables to be passed to any sub-process run under Emacs.
30
24;;; Code: 31;;; Code:
25 32
26;;;###autoload 33;;;###autoload
diff --git a/lisp/help.el b/lisp/help.el
index 68b3f641593..5cf31dfeb78 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -21,6 +21,11 @@
21;; along with GNU Emacs; see the file COPYING. If not, write to 21;; along with GNU Emacs; see the file COPYING. If not, write to
22;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 22;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 23
24;;; Commentary:
25
26;; This code implements GNU Emac's on-line help system, the one invoked by
27;;`M-x help-for-help'.
28
24;;; Code: 29;;; Code:
25 30
26;; Get the macro make-help-screen when this is compiled, 31;; Get the macro make-help-screen when this is compiled,
diff --git a/lisp/mail/rfc822.el b/lisp/mail/rfc822.el
index f23f3029a17..373b0a85a2c 100644
--- a/lisp/mail/rfc822.el
+++ b/lisp/mail/rfc822.el
@@ -22,6 +22,11 @@
22;; along with GNU Emacs; see the file COPYING. If not, write to 22;; along with GNU Emacs; see the file COPYING. If not, write to
23;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 23;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24 24
25;;; Commentary:
26
27;; Support functions for parsing RFC-822 headers, used by mail and news
28;; modes.
29
25;;; Code: 30;;; Code:
26 31
27;; uses address-start free, throws to address 32;; uses address-start free, throws to address
diff --git a/lisp/mail/sendmail.el b/lisp/mail/sendmail.el
index f0de0525ce5..0d2cb929f81 100644
--- a/lisp/mail/sendmail.el
+++ b/lisp/mail/sendmail.el
@@ -21,6 +21,11 @@
21;; along with GNU Emacs; see the file COPYING. If not, write to 21;; along with GNU Emacs; see the file COPYING. If not, write to
22;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 22;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 23
24;;; Commentary:
25
26;; This mode provides mail-sending facilities from within Emacs. It is
27;; documented in the Emacs user's manual.
28
24;;; Code: 29;;; Code:
25 30
26;;;###autoload 31;;;###autoload
diff --git a/lisp/play/spook.el b/lisp/play/spook.el
index d1b31b757a1..1ba0b2dabb6 100644
--- a/lisp/play/spook.el
+++ b/lisp/play/spook.el
@@ -4,6 +4,7 @@
4 4
5;; Maintainer: FSF 5;; Maintainer: FSF
6;; Keywords: games 6;; Keywords: games
7;; Created: May 1987
7 8
8;; This file is part of GNU Emacs. 9;; This file is part of GNU Emacs.
9 10
@@ -26,8 +27,7 @@
26; Steve Strassmann (straz@media-lab.media.mit.edu) didn't write 27; Steve Strassmann (straz@media-lab.media.mit.edu) didn't write
27; this, and even if he did, he really didn't mean for you to use it 28; this, and even if he did, he really didn't mean for you to use it
28; in an anarchistic way. 29; in an anarchistic way.
29; May 1987 30;
30
31; To use this: 31; To use this:
32; Make sure you have the variable SPOOK-PHRASES-FILE pointing to 32; Make sure you have the variable SPOOK-PHRASES-FILE pointing to
33; a valid phrase file. Phrase files are in the same format as 33; a valid phrase file. Phrase files are in the same format as
@@ -38,7 +38,7 @@
38; Just before sending mail, do M-x spook. 38; Just before sending mail, do M-x spook.
39; A number of phrases will be inserted into your buffer, to help 39; A number of phrases will be inserted into your buffer, to help
40; give your message that extra bit of attractiveness for automated 40; give your message that extra bit of attractiveness for automated
41; keyword scanners. 41; keyword scanners. Help defeat the NSA trunk trawler!
42 42
43;;; Code: 43;;; Code:
44 44
diff --git a/lisp/play/studly.el b/lisp/play/studly.el
index 1f215003c96..b5aafcab09a 100644
--- a/lisp/play/studly.el
+++ b/lisp/play/studly.el
@@ -5,6 +5,12 @@
5 5
6;; Keywords: games 6;; Keywords: games
7 7
8;;; Commentary:
9
10;; Functions to studlycapsify a region, word, or buffer. Possibly the
11;; esoteric significance of studlycapsification escapes you; that is,
12;; you suffer from autostudlycapsifibogotification. Too bad.
13
8;;; Code: 14;;; Code:
9 15
10(defun studlify-region (begin end) 16(defun studlify-region (begin end)
diff --git a/lisp/progmodes/simula.el b/lisp/progmodes/simula.el
index e6757432ac3..6c3a41735a8 100644
--- a/lisp/progmodes/simula.el
+++ b/lisp/progmodes/simula.el
@@ -26,7 +26,11 @@
26 26
27;;; Commentary: 27;;; Commentary:
28 28
29;; Hans Henrik Eriksen may be reached at: 29;; A major mode for editing the Simula language. It knows about Simula
30;; syntax and standard indentation commands. It also provides convenient
31;; abbrevs for Simula keywords.
32;;
33;; Hans Henrik Eriksen (the author) may be reached at:
30;; Institutt for informatikk, 34;; Institutt for informatikk,
31;; Universitetet i Oslo 35;; Universitetet i Oslo
32 36
diff --git a/lisp/register.el b/lisp/register.el
index 447c4c4a595..24487dac7b1 100644
--- a/lisp/register.el
+++ b/lisp/register.el
@@ -21,6 +21,13 @@
21;; along with GNU Emacs; see the file COPYING. If not, write to 21;; along with GNU Emacs; see the file COPYING. If not, write to
22;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 22;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 23
24;;; Commentary:
25
26;; This package of functions emulates and somewhat extends the venerable
27;; TECO's `register' feature, which permits you to save various useful
28;; pieces of buffer state to named variables. The entry points are
29;; documented in the Emacs user's manual.
30
24;;; Code: 31;;; Code:
25 32
26(defvar register-alist nil 33(defvar register-alist nil
diff --git a/lisp/replace.el b/lisp/replace.el
index 3c195224ad9..449d5243ee3 100644
--- a/lisp/replace.el
+++ b/lisp/replace.el
@@ -18,6 +18,11 @@
18;; along with GNU Emacs; see the file COPYING. If not, write to 18;; along with GNU Emacs; see the file COPYING. If not, write to
19;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 19;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20 20
21;;; Commentary:
22
23;; This package supplies the string and regular-expression replace functions
24;; documented in the Emacs user's manual.
25
21;;; Code: 26;;; Code:
22 27
23(defconst case-replace t "\ 28(defconst case-replace t "\
diff --git a/lisp/reposition.el b/lisp/reposition.el
index 9839c9afb69..d981eefec5e 100644
--- a/lisp/reposition.el
+++ b/lisp/reposition.el
@@ -3,6 +3,7 @@
3;; Copyright (C) 1991 Free Software Foundation, Inc. 3;; Copyright (C) 1991 Free Software Foundation, Inc.
4 4
5;; Author: Michael D. Ernst <mernst@theory.lcs.mit.edu> 5;; Author: Michael D. Ernst <mernst@theory.lcs.mit.edu>
6;; Created: Jan 1991
6;; Maintainer: FSF 7;; Maintainer: FSF
7 8
8;; This file is part of GNU Emacs. 9;; This file is part of GNU Emacs.
@@ -23,8 +24,6 @@
23 24
24;;; Commentary: 25;;; Commentary:
25 26
26;;; Written by Michael D. Ernst, mernst@theory.lcs.mit.edu, Jan 1991.
27
28;;; Reposition-window makes an entire function definition or comment visible, 27;;; Reposition-window makes an entire function definition or comment visible,
29;;; or, if it is already visible, places it at the top of the window; 28;;; or, if it is already visible, places it at the top of the window;
30;;; additional invocations toggle the visibility of comments preceding the 29;;; additional invocations toggle the visibility of comments preceding the
diff --git a/lisp/rlogin.el b/lisp/rlogin.el
index db0832c2d5b..bd6fc6ec3f6 100644
--- a/lisp/rlogin.el
+++ b/lisp/rlogin.el
@@ -3,28 +3,32 @@
3;; Maintainer: Noah Friedman <friedman@prep.ai.mit.edu> 3;; Maintainer: Noah Friedman <friedman@prep.ai.mit.edu>
4;; Keywords: unix, comm 4;; Keywords: unix, comm
5 5
6;;; Copyright (C) 1992 Free Software Foundation, Inc. 6;; Copyright (C) 1992 Free Software Foundation, Inc.
7;;; 7;;
8;;; This program is free software; you can redistribute it and/or modify 8;; This program is free software; you can redistribute it and/or modify
9;;; it under the terms of the GNU General Public License as published by 9;; it under the terms of the GNU General Public License as published by
10;;; the Free Software Foundation; either version 2, or (at your option) 10;; the Free Software Foundation; either version 2, or (at your option)
11;;; any later version. 11;; any later version.
12;;; 12;;
13;;; This program is distributed in the hope that it will be useful, 13;; This program is distributed in the hope that it will be useful,
14;;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16;;; GNU General Public License for more details. 16;; GNU General Public License for more details.
17;;; 17;;
18;;; You should have received a copy of the GNU General Public License 18;; You should have received a copy of the GNU General Public License
19;;; along with this program; if not, you can either send email to this 19;; along with this program; if not, you can either send email to this
20;;; program's author (see below) or write to: 20;; program's author (see below) or write to:
21;;; 21;;
22;;; The Free Software Foundation, Inc. 22;; The Free Software Foundation, Inc.
23;;; 675 Massachusetts Avenue. 23;; 675 Massachusetts Avenue.
24;;; Cambridge, MA 02139, USA. 24;; Cambridge, MA 02139, USA.
25;;; 25;;
26 26
27;;; Todo: add directory tracking using ange-ftp style patchnames for the cwd. 27;;; Commentary:
28
29;; Support for remote login over Internet using rlogin(1).
30;;
31;; Todo: add directory tracking using ange-ftp style patchnames for the cwd.
28 32
29;;; Code: 33;;; Code:
30 34
diff --git a/lisp/rot13.el b/lisp/rot13.el
index 30c1b3d41a4..75af4d1026d 100644
--- a/lisp/rot13.el
+++ b/lisp/rot13.el
@@ -23,8 +23,13 @@
23 23
24;; Commentary: 24;; Commentary:
25 25
26;; The single entry point, `rot13-other-window', oerforms a Caesar cipher
27;; encrypt/decrypt on the current buffer and displays the result in another
28;; window. Rot13 encryption is sometimes used on USENET as a read-at-yur-
29;; own-risk wrapper for material some might consider offensive, such as
30;; ethnic humor.
31;;
26;; Written by Howard Gayle. See case-table.el for details. 32;; Written by Howard Gayle. See case-table.el for details.
27
28;; This hack is mainly to show off the char table stuff. 33;; This hack is mainly to show off the char table stuff.
29 34
30;;; Code: 35;;; Code:
diff --git a/lisp/scroll-bar.el b/lisp/scroll-bar.el
index a924295faaa..2aaf0d8e163 100644
--- a/lisp/scroll-bar.el
+++ b/lisp/scroll-bar.el
@@ -23,6 +23,12 @@
23 23
24;;; Code: 24;;; Code:
25 25
26;;; Commentary:
27
28;; Window-system-independent bindings of mouse clicks on the scroll bar.
29;; Presently emulates the scroll-bar behavior of xterm.
30;;; Code:
31
26(require 'mouse) 32(require 'mouse)
27 33
28 34
diff --git a/lisp/simple.el b/lisp/simple.el
index 6577fb92d14..6d27c2122ef 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -18,6 +18,11 @@
18;; along with GNU Emacs; see the file COPYING. If not, write to 18;; along with GNU Emacs; see the file COPYING. If not, write to
19;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 19;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20 20
21;;; Commentary:
22
23;; A grab-bag of basic Emacs commands not specifically related to some
24;; major mode or to file-handling.
25
21;;; Code: 26;;; Code:
22 27
23(defun open-line (arg) 28(defun open-line (arg)
diff --git a/lisp/sort.el b/lisp/sort.el
index 8c3285e144a..0ee90121ae0 100644
--- a/lisp/sort.el
+++ b/lisp/sort.el
@@ -22,6 +22,11 @@
22;; along with GNU Emacs; see the file COPYING. If not, write to 22;; along with GNU Emacs; see the file COPYING. If not, write to
23;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 23;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24 24
25;;; Commentary:
26
27;;; This package provides the sorting facilities documented in the Emacs
28;;; user's manual.
29
25;;; Code: 30;;; Code:
26 31
27(defun sort-subr (reverse nextrecfun endrecfun &optional startkeyfun endkeyfun) 32(defun sort-subr (reverse nextrecfun endrecfun &optional startkeyfun endkeyfun)
diff --git a/lisp/tabify.el b/lisp/tabify.el
index b1a8e35fe2e..cccc99ea1a5 100644
--- a/lisp/tabify.el
+++ b/lisp/tabify.el
@@ -20,6 +20,11 @@
20;; along with GNU Emacs; see the file COPYING. If not, write to 20;; along with GNU Emacs; see the file COPYING. If not, write to
21;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 21;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
22 22
23;;; Commentary:
24
25;; Commands to optimize spaces to tabs or expand tabs to spaces in a region
26;; (`tabify' and `untabify'). The variable tab-width does the obvious.
27
23;;; Code: 28;;; Code:
24 29
25;;;###autoload 30;;;###autoload
diff --git a/lisp/textmodes/scribe.el b/lisp/textmodes/scribe.el
index 6954f5c6284..d664292c3d1 100644
--- a/lisp/textmodes/scribe.el
+++ b/lisp/textmodes/scribe.el
@@ -21,6 +21,12 @@
21;; It should be in a file named COPYING. Among other things, the 21;; It should be in a file named COPYING. Among other things, the
22;; copyright notice and this notice must be preserved on all copies. 22;; copyright notice and this notice must be preserved on all copies.
23 23
24;;; Commentary:
25
26;; A major mode for editing source in written for the Scribe text formatter.
27;; Knows about Scribe syntax and standard layout rules. The command to
28;; run Scribe on a buffer is bogus; someone interested should fix it.
29
24;;; Code: 30;;; Code:
25 31
26(defvar scribe-mode-syntax-table nil 32(defvar scribe-mode-syntax-table nil
diff --git a/lisp/textmodes/sgml-mode.el b/lisp/textmodes/sgml-mode.el
index b6200ac0bc7..676edaf0519 100644
--- a/lisp/textmodes/sgml-mode.el
+++ b/lisp/textmodes/sgml-mode.el
@@ -24,6 +24,8 @@
24 24
25;;; Commentary: 25;;; Commentary:
26 26
27;; Major mode for editing the SGML document-markup language.
28;;
27;; Some suggestions for your .emacs file: 29;; Some suggestions for your .emacs file:
28;; 30;;
29;; (autoload 'sgml-mode "sgml-mode" "SGML mode" t) 31;; (autoload 'sgml-mode "sgml-mode" "SGML mode" t)
diff --git a/lisp/textmodes/spell.el b/lisp/textmodes/spell.el
index 6e05a8c0fad..e1ed847ca79 100644
--- a/lisp/textmodes/spell.el
+++ b/lisp/textmodes/spell.el
@@ -3,7 +3,7 @@
3;; Copyright (C) 1985 Free Software Foundation, Inc. 3;; Copyright (C) 1985 Free Software Foundation, Inc.
4 4
5;; Maintainer: FSF 5;; Maintainer: FSF
6;; Keywords: wp 6;; Keywords: wp, unix
7 7
8;; This file is part of GNU Emacs. 8;; This file is part of GNU Emacs.
9 9
@@ -21,6 +21,13 @@
21;; along with GNU Emacs; see the file COPYING. If not, write to 21;; along with GNU Emacs; see the file COPYING. If not, write to
22;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 22;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 23
24;;; Commentary:
25
26;; This mode orovides an Emacs interface to the UNIX spell(1) program.
27;; Entry points are `spell-buffer', `spell-word', `spell-region' and
28;; `spell-string'. These facilities are documented in the Emacs user's
29;; manual.
30
24;;; Code: 31;;; Code:
25 32
26(defvar spell-command "spell" 33(defvar spell-command "spell"
diff --git a/lisp/textmodes/text-mode.el b/lisp/textmodes/text-mode.el
index 0f9229e80a3..b4b543f9a47 100644
--- a/lisp/textmodes/text-mode.el
+++ b/lisp/textmodes/text-mode.el
@@ -20,6 +20,12 @@
20;; along with GNU Emacs; see the file COPYING. If not, write to 20;; along with GNU Emacs; see the file COPYING. If not, write to
21;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 21;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
22 22
23
24;;; Commentary:
25
26;; This package provides the fundamental text mode documented in the
27;; Emacs user's manual.
28
23;;; Code: 29;;; Code:
24 30
25(defvar text-mode-syntax-table nil 31(defvar text-mode-syntax-table nil