From: ueno <ueno>
Date: Fri, 26 Aug 2005 05:05:26 +0000 (+0000)
Subject: Add the following comment to add-on modules.
X-Git-Tag: channel-coding-branchpoint~72
X-Git-Url: http://git.chise.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2e8d72b091af0ce1e3673f90d8024739328a0d7c;p=elisp%2Friece.git

Add the following comment to add-on modules.
NOTE: This is an add-on module for Riece.
---

diff --git a/lisp/riece-alias.el b/lisp/riece-alias.el
index 0e63e58..aa1266d 100644
--- a/lisp/riece-alias.el
+++ b/lisp/riece-alias.el
@@ -1,4 +1,4 @@
-;;; riece-alias.el --- define aliases of names
+;;; riece-alias.el --- define aliases for IRC names
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -21,14 +21,15 @@
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
-;; This add-on allows you to define aliases for IRC names.
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-alias)
+;; This add-on allows you to define aliases for IRC names.
 
-;; For example, if you want to define an alias `#l' for `#Liece', you
+;; For example, if you want to define an alias `#r' for `#riece', you
 ;; can customize riece-alias-alist as follows:
-;; (setq riece-alias-alist '(("#Liece" . "#l")))
+;; (setq riece-alias-alist '(("#riece" . "#r")))
 
 ;;; Code:
 
@@ -63,7 +64,7 @@
 (defvar riece-alias-enabled nil)
 
 (defconst riece-alias-description
-  "Define aliases of channel/user names")
+  "Define aliases for IRC names.")
 
 (defun riece-alias-abbrev-percent-hack (string)
   (if (string-match (concat "^#\\([^ ]+\\):"
diff --git a/lisp/riece-async.el b/lisp/riece-async.el
index 3b24f6d..6841a0c 100644
--- a/lisp/riece-async.el
+++ b/lisp/riece-async.el
@@ -23,12 +23,11 @@
 
 ;;; Commentary:
 
+;; NOTE: This is an add-on module for Riece.
+
 ;; This program allows to connect to an IRC server via local proxy
 ;; which responds to PING requests from server.
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-async)
-
 ;; If you want to enable this feature per server, write the server
 ;; spec like this:
 ;; (add-to-list 'riece-server-alist
@@ -65,7 +64,7 @@ assumed that the file is in the same directory of this file.")
   "Command line arguments passed to `riece-async-server-program'.")
 
 (defconst riece-async-description
-  "Keep IRC connection with external process")
+  "Connect to IRC server via async proxy.")
 
 ;;;###autoload
 (defun riece-async-open-network-stream (name buffer host service)
diff --git a/lisp/riece-biff.el b/lisp/riece-biff.el
index dd7e47c..0e26d2f 100644
--- a/lisp/riece-biff.el
+++ b/lisp/riece-biff.el
@@ -1,4 +1,4 @@
-;;; riece-biff.el --- biff add-on
+;;; riece-biff.el --- be notified if messages arrives
 ;; Copyright (C) 2004 OHASHI Akira
 
 ;; Author: OHASHI Akira <bg66@koka-in.org>
@@ -23,15 +23,14 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-biff)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
 (require 'riece-message)
 
 (defgroup riece-biff nil
-  "Biff for new arrival messages."
+  "Be notified if messages arrives."
   :prefix "riece-"
   :group 'riece)
 
@@ -55,7 +54,7 @@
 (defvar riece-biff-enabled nil)
 
 (defconst riece-biff-description
-  "Biff for new arrival messages")
+  "Be notified if messages arrives.")
 
 (defun riece-biff-after-display-message-function (message)
   (when (and riece-biff-enabled
diff --git a/lisp/riece-button.el b/lisp/riece-button.el
index c33a1ec..6cd9dfe 100644
--- a/lisp/riece-button.el
+++ b/lisp/riece-button.el
@@ -1,4 +1,4 @@
-;;; riece-button.el --- adding buttons in channel buffers
+;;; riece-button.el --- display useful buttons in IRC buffers
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,8 +24,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-button)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -52,7 +51,7 @@
 (defvar riece-button-enabled nil)
 
 (defconst riece-button-description
-  "Display useful buttons in IRC buffers")
+  "Display useful buttons in IRC buffers.")
 
 (defvar help-echo-owns-message)
 (define-widget 'riece-identity-button 'push-button
diff --git a/lisp/riece-ctcp.el b/lisp/riece-ctcp.el
index 7e1948c..1199dc3 100644
--- a/lisp/riece-ctcp.el
+++ b/lisp/riece-ctcp.el
@@ -1,4 +1,4 @@
-;;; riece-ctcp.el --- CTCP add-on
+;;; riece-ctcp.el --- CTCP (Client To Client Protocol) support
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -22,6 +22,10 @@
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
+
 ;;; Code:
 
 (require 'riece-version)
@@ -53,7 +57,7 @@
 (defvar riece-ctcp-enabled nil)
 
 (defconst riece-ctcp-description
-  "CTCP (Client To Client Protocol) support")
+  "CTCP (Client To Client Protocol) support.")
 
 (defun riece-handle-ctcp-request (prefix string)
   (when (and riece-ctcp-enabled prefix string
diff --git a/lisp/riece-ctlseq.el b/lisp/riece-ctlseq.el
index 13e8490..fa8117f 100644
--- a/lisp/riece-ctlseq.el
+++ b/lisp/riece-ctlseq.el
@@ -1,4 +1,4 @@
-;;; riece-ctlseq.el --- highlight control sequences in channel buffers
+;;; riece-ctlseq.el --- mark up control sequences in IRC buffers
 ;; Copyright (C) 1998-2004 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,8 +24,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-ctlseq)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -33,7 +32,7 @@
 (require 'riece-misc)
 
 (defgroup riece-ctlseq nil
-  "Control sequences in IRC buffer."
+  "Mark up control sequences in IRC buffer."
   :prefix "riece-"
   :group 'riece)
 
@@ -61,7 +60,7 @@
 (defvar riece-ctlseq-enabled nil)
 
 (defvar riece-ctlseq-description
-  "Highlight control sequences in IRC buffers")
+  "Mark up control sequences in IRC buffers.")
 
 (defun riece-ctlseq-compatible-attributes-p (this other)
   (let ((pointer this))
diff --git a/lisp/riece-doctor.el b/lisp/riece-doctor.el
index c32304b..3239f0b 100644
--- a/lisp/riece-doctor.el
+++ b/lisp/riece-doctor.el
@@ -1,4 +1,4 @@
-;;; riece-doctor.el --- "become a psychotherapist" add-on
+;;; riece-doctor.el --- pretend to be a psychotherapist
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -23,10 +23,7 @@
 
 ;;; Commentary:
 
-;; This add-on allows you to become a psychotherapist.
-
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-doctor)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -55,7 +52,7 @@
 (defvar riece-doctor-enabled nil)
 
 (defconst riece-doctor-description
-  "Allow users in channel to talk with the classic pseudo-AI")
+  "Pretend to be a psychotherapist.")
 
 (put 'riece-doctor 'riece-addon-default-disabled t)
 
diff --git a/lisp/riece-eval-ruby.el b/lisp/riece-eval-ruby.el
index 8f0091a..7e1cd7f 100644
--- a/lisp/riece-eval-ruby.el
+++ b/lisp/riece-eval-ruby.el
@@ -1,4 +1,4 @@
-;;; riece-eval-ruby.el --- evaluate Ruby programs in channels
+;;; riece-eval-ruby.el --- evaluate input string as a Ruby program
 ;; Copyright (C) 1998-2005 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,8 +24,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-eval-ruby)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -33,7 +32,7 @@
 (require 'riece-message)
 
 (defgroup riece-eval-ruby nil
-  "Evaluate Ruby programs in channels."
+  "Evaluate input string as a Ruby program."
   :prefix "riece-"
   :group 'riece)
 
@@ -45,7 +44,7 @@
 (defvar riece-eval-ruby-enabled nil)
 
 (defconst riece-eval-ruby-description
-  "Evaluate an input string as Ruby program.")
+  "Evaluate input string as a Ruby program.")
 
 (defun riece-eval-ruby-exit-handler (name)
   (riece-ruby-inspect name)
diff --git a/lisp/riece-eval.el b/lisp/riece-eval.el
index c54079f..cbd1c85 100644
--- a/lisp/riece-eval.el
+++ b/lisp/riece-eval.el
@@ -1,4 +1,4 @@
-;;; riece-eval.el --- eval add-on
+;;; riece-eval.el --- evaluate input string as an elisp form
 ;; Copyright (C) 2005 OHASHI Akira
 
 ;; Author: OHASHI Akira <bg66@koka-in.org>
@@ -23,11 +23,7 @@
 
 ;;; Commentary:
 
-;; This add-on evaluates an input string as lisp object and sends a result
-;; as notice. Note the risky of this add-on.
-
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-eval)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -35,7 +31,7 @@
 (require 'riece-message)
 
 (defgroup riece-eval nil
-  "Evaluate an input string as lisp object."
+  "Evaluate an input string as an elisp form."
   :prefix "riece-"
   :group 'riece)
 
@@ -52,7 +48,7 @@
 (defvar riece-eval-enabled nil)
 
 (defconst riece-eval-description
-  "Evaluate an input string as lisp object.")
+  "Evaluate an input string as an elisp form.")
 
 (defun riece-eval-display-message-function (message)
   (when (and riece-eval-enabled
diff --git a/lisp/riece-foolproof.el b/lisp/riece-foolproof.el
index 75e2e97..aa7bb86 100644
--- a/lisp/riece-foolproof.el
+++ b/lisp/riece-foolproof.el
@@ -23,10 +23,7 @@
 
 ;;; Commentary:
 
-;; This add-on channel miss hold in check
-
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-foolproof)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
diff --git a/lisp/riece-google.el b/lisp/riece-google.el
index f3e0df9..de93b90 100644
--- a/lisp/riece-google.el
+++ b/lisp/riece-google.el
@@ -1,4 +1,4 @@
-;;; riece-google.el --- Interface to Google API
+;;; riece-google.el --- search keywords by Google
 ;; Copyright (C) 2005 OHASHI Akira
 
 ;; Author: OHASHI Akira <bg66@koka-in.org>
@@ -24,19 +24,16 @@
 
 ;;; Commentary:
 
-;; This add-on searches keywords by Google.
+;; NOTE: This is an add-on module for Riece.
 
 ;; Ruby code was stolen (and modified) from nadoka.
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-google)
-
 ;;; Code:
 
 (require 'riece-message)
 
 (defgroup riece-google nil
-  "Interface to Google API."
+  "Search keywords by Google."
   :prefix "riece-"
   :group 'riece)
 
diff --git a/lisp/riece-guess.el b/lisp/riece-guess.el
index 972504b..7c54a05 100644
--- a/lisp/riece-guess.el
+++ b/lisp/riece-guess.el
@@ -21,13 +21,17 @@
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
+
 ;;; Code:
 
 (require 'riece-identity)
 (require 'riece-commands)
 
 (defgroup riece-guess nil
-  "Guess the next channel to be switched."
+  "Guess the next channel."
   :tag "Guess"
   :prefix "riece-"
   :group 'riece)
@@ -40,7 +44,7 @@
 (defvar riece-guess-enabled nil)
 
 (defconst riece-guess-description
-  "Guess the next channel, using multiple methods")
+  "Guess the next channel, using multiple methods.")
 
 (defvar riece-current-channels)
 
diff --git a/lisp/riece-hangman.el b/lisp/riece-hangman.el
index d049e0e..8865638 100644
--- a/lisp/riece-hangman.el
+++ b/lisp/riece-hangman.el
@@ -1,4 +1,4 @@
-;;; riece-hangman.el --- hangman
+;;; riece-hangman.el --- allow channel members to play the hangman game
 ;; Copyright (C) 1998-2004 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -23,8 +23,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-hangman)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -34,7 +33,7 @@
 (require 'riece-server)
 
 (defgroup riece-hangman nil
-  "Interface to hangman.el."
+  "Allow channel members to play the hangman game."
   :prefix "riece-"
   :group 'riece)
 
@@ -59,7 +58,7 @@
 (defvar riece-hangman-enabled nil)
 
 (defconst riece-hangman-description
-  "Allow users in channel to play classic textual game \"hangman\"")
+  "Allow channel members to play the hangman game.")
 
 (put 'riece-hangman 'riece-addon-default-disabled t)
 
diff --git a/lisp/riece-highlight.el b/lisp/riece-highlight.el
index 329645a..7ea6e09 100644
--- a/lisp/riece-highlight.el
+++ b/lisp/riece-highlight.el
@@ -22,6 +22,10 @@
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
+
 ;;; Code:
 
 (require 'riece-globals)
@@ -200,7 +204,7 @@
 (defvar riece-highlight-enabled nil)
 
 (defconst riece-highlight-description
-  "Highlight IRC buffers")
+  "Highlight IRC buffers.")
 
 (defun riece-highlight-server-match (limit)
   (and (re-search-forward "(from [^)]+)$" limit t)
diff --git a/lisp/riece-history.el b/lisp/riece-history.el
index 379e58a..79dd389 100644
--- a/lisp/riece-history.el
+++ b/lisp/riece-history.el
@@ -1,4 +1,4 @@
-;;; riece-history.el --- channel history management add-on
+;;; riece-history.el --- manage history of channel shifting
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -23,6 +23,8 @@
 
 ;;; Commentary:
 
+;; NOTE: This is an add-on module for Riece.
+
 ;; You can check recently visited channels via `C-c g' in the commands
 ;; buffer, by adding the following lines to ~/.riece/init.el:
 
@@ -39,7 +41,7 @@
 (require 'ring)
 
 (defgroup riece-history nil
-  "Channel switch history."
+  "Manage history of channel shifting."
   :tag "History"
   :prefix "riece-"
   :group 'riece)
@@ -77,7 +79,7 @@
 (defvar riece-history-enabled nil)
 
 (defconst riece-history-description
-  "Keep track channel history")
+  "Manage history of channel shifting.")
 
 (defun riece-guess-channel-from-history ()
   (let ((length (ring-length riece-channel-history))
diff --git a/lisp/riece-icon.el b/lisp/riece-icon.el
index 9e99799..890fa95 100644
--- a/lisp/riece-icon.el
+++ b/lisp/riece-icon.el
@@ -1,8 +1,8 @@
-;;; riece-icon.el --- iconify buffer strings
-;; Copyright (C) 1'center8-2003 Daiki Ueno
+;;; riece-icon.el --- display icons in IRC buffers
+;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
-;; Created: 1'center8-09-28
+;; Created: 1998-09-28
 ;; Keywords: IRC, riece
 
 ;; This file is part of Riece.
@@ -24,8 +24,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-icon)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -185,7 +184,7 @@ static char * a_xpm[] = {
 (defvar riece-icon-enabled nil)
 
 (defconst riece-icon-description
-  "Add icon images on IRC buffers")
+  "Display icons in IRC buffers.")
 
 (defun riece-icon-available-p ()
   (if (featurep 'xemacs)
diff --git a/lisp/riece-ignore.el b/lisp/riece-ignore.el
index d2fb411..6b091d7 100644
--- a/lisp/riece-ignore.el
+++ b/lisp/riece-ignore.el
@@ -1,4 +1,4 @@
-;;; riece-ignore.el --- ignore user
+;;; riece-ignore.el --- ignore messages from some users
 ;; Copyright (C) 1998-2004 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,8 +24,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-ignore)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -34,7 +33,7 @@
 (require 'riece-message)
 
 (defgroup riece-ignore nil
-  "Ignore messages in IRC buffers."
+  "Ignore messages from some users."
   :prefix "riece-"
   :group 'riece)
 
@@ -64,7 +63,7 @@ Otherwise, they are not removed from IRC buffers, but are hidden with
 (defvar riece-ignore-enabled nil)
 
 (defconst riece-ignore-description
-  "Ignore users")
+  "Ignore messages from some users.")
 (defvar riece-ignored-user-list nil)
 
 (defun riece-ignore-user-rename-signal-function (signal handback)
diff --git a/lisp/riece-kakasi.el b/lisp/riece-kakasi.el
index 62f3e1f..9d5f13a 100644
--- a/lisp/riece-kakasi.el
+++ b/lisp/riece-kakasi.el
@@ -1,4 +1,4 @@
-;;; riece-kakasi.el --- convert Japanese to roman string by kakasi
+;;; riece-kakasi.el --- convert Japanese to roman string by KAKASI
 ;; Copyright (C) 1998-2004 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,15 +24,14 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-kakasi)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
 (defvar riece-kakasi-enabled nil)
 
 (defvar riece-kakasi-description
-  "Convert Japanese to roman string by kakasi")
+  "Convert Japanese to roman string by KAKASI.")
 
 (defvar riece-kakasi-process nil)
 
diff --git a/lisp/riece-keepalive.el b/lisp/riece-keepalive.el
index 6526d5c..d357297 100644
--- a/lisp/riece-keepalive.el
+++ b/lisp/riece-keepalive.el
@@ -24,8 +24,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-keepalive)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
diff --git a/lisp/riece-keyword.el b/lisp/riece-keyword.el
index 1973910..03b1727 100644
--- a/lisp/riece-keyword.el
+++ b/lisp/riece-keyword.el
@@ -1,4 +1,4 @@
-;;; riece-keyword.el --- highlight keywords in channel buffers
+;;; riece-keyword.el --- detect keywords in IRC buffers
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,15 +24,14 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-keyword)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
 (require 'riece-message)
 
 (defgroup riece-keyword nil
-  "Highlight keyword in IRC buffer."
+  "Detect keywords in IRC buffers."
   :prefix "riece-"
   :group 'riece)
 
@@ -70,7 +69,7 @@ and the matched message object."
 (defvar riece-keyword-enabled nil)
 
 (defconst riece-keyword-description
-  "Highlight keywords in IRC buffers")
+  "Detect keywords in IRC buffers.")
 
 ;;; The old XEmacs package doesn't have autoload setting for regexp-opt.
 (autoload 'regexp-opt "regexp-opt")
diff --git a/lisp/riece-log.el b/lisp/riece-log.el
index 0dfd3ef..f5ef680 100644
--- a/lisp/riece-log.el
+++ b/lisp/riece-log.el
@@ -1,4 +1,4 @@
-;;; riece-log.el --- saving irc logs add-on
+;;; riece-log.el --- Save IRC logs
 ;; Copyright (C) 2003 OHASHI Akira
 ;; Copyright (C) 2004 Daiki Ueno
 
@@ -25,10 +25,7 @@
 
 ;;; Commentary:
 
-;; This add-on saves irc logs for every channel.
-
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-log)
+;;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -95,7 +92,7 @@ It is created if there is at least one instance of Emacs running riece-log.")
 (defvar riece-log-enabled nil)
 
 (defconst riece-log-description
-  "Saving IRC logs")
+  "Save IRC logs.")
 
 (defun riece-log-display-message-function (message)
   (if riece-log-enabled
diff --git a/lisp/riece-lsdb.el b/lisp/riece-lsdb.el
index bec5701..43d88e6 100644
--- a/lisp/riece-lsdb.el
+++ b/lisp/riece-lsdb.el
@@ -1,4 +1,4 @@
-;;; riece-lsdb.el --- interface to LSDB
+;;; riece-lsdb.el --- help register nicknames in LSDB rolodex program
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,8 +24,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-lsdb)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -46,7 +45,7 @@
 (defvar riece-lsdb-enabled nil)
 
 (defconst riece-lsdb-description
-  "Use LSDB (Lovely Sister Database)")
+  "Help register nicknames in LSDB rolodex program.")
 
 (defun riece-lsdb-update-cache (record)
   (let ((irc (cdr (assq 'irc record))))
diff --git a/lisp/riece-menu.el b/lisp/riece-menu.el
index d11641e..f658600 100644
--- a/lisp/riece-menu.el
+++ b/lisp/riece-menu.el
@@ -1,4 +1,4 @@
-;;; riece-menu.el --- define command menu on menubar
+;;; riece-menu.el --- setup Riece's command menus
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,8 +24,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-menu)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -70,7 +69,7 @@
   "Menu used in command mode.")
 
 (defconst riece-menu-description
-  "Setup command menus on menubar")
+  "Setup Riece's command menus.")
 
 (defun riece-menu-create-layouts-menu (menu)
   (mapcar (lambda (entry)
diff --git a/lisp/riece-mini.el b/lisp/riece-mini.el
index fcadb6b..df08384 100644
--- a/lisp/riece-mini.el
+++ b/lisp/riece-mini.el
@@ -1,4 +1,4 @@
-;;; riece-mini.el --- "riece on minibuffer" add-on
+;;; riece-mini.el --- use Riece only on the minibuffer
 ;; Copyright (C) 2003 OHASHI Akira
 
 ;; Author: OHASHI Akira <bg66@koka-in.org>
@@ -23,6 +23,8 @@
 
 ;;; Commentary:
 
+;; NOTE: This is an add-on module for Riece.
+
 ;; This add-on shows arrival messages to minibuffer. And you can send
 ;; message using minibuffer.
 ;;
@@ -44,7 +46,7 @@
 (require 'riece-biff)
 
 (defgroup riece-mini nil
-  "Riece on minibuffer."
+  "Use Riece only on the minibuffer."
   :group 'riece)
 
 (defcustom riece-mini-backlog-size 5
@@ -59,7 +61,7 @@
 (defvar riece-mini-enabled nil)
 
 (defconst riece-mini-description
-  "Send arrival messages to minibuffer")
+  "Use Riece only on the minibuffer.")
 
 (defun riece-mini-message-no-log (string &rest args)
   "Like `message', except that message logging is disabled."
diff --git a/lisp/riece-rdcc.el b/lisp/riece-rdcc.el
index 5cd94a1..201fd69 100644
--- a/lisp/riece-rdcc.el
+++ b/lisp/riece-rdcc.el
@@ -1,4 +1,4 @@
-;;; riece-rdcc.el --- Ruby implementation of DCC add-on
+;;; riece-rdcc.el --- DCC file sending protocol support (written in Ruby)
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -21,6 +21,10 @@
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
+
 ;;; Code:
 
 (require 'riece-globals)
@@ -101,7 +105,7 @@ end
 (defvar riece-rdcc-enabled nil)
 
 (defconst riece-rdcc-description
-  "DCC file sending extension implemented in Ruby")
+  "DCC file sending protocol support (written in Ruby.)")
 
 (defvar temporary-file-directory)
 (defvar jka-compr-compression-info-list)
diff --git a/lisp/riece-skk-kakutei.el b/lisp/riece-skk-kakutei.el
index 35ac4f1..6e79db9 100644
--- a/lisp/riece-skk-kakutei.el
+++ b/lisp/riece-skk-kakutei.el
@@ -1,4 +1,4 @@
-;;; riece-skk-kakutei.el --- add-on skk-kakutei
+;;; riece-skk-kakutei.el --- remove SKK's preedit mark before sending messages
 ;; Copyright (C) 2003 TAKAHASHI Kaoru
 
 ;; Author: TAKAHASHI "beatmaria" Kaoru <kaoru@kaisei.org>
@@ -23,10 +23,7 @@
 
 ;;; Commentary:
 
-;; This add-on deny SKK's sankaku send.
-
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-skk-kakutei)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -35,7 +32,7 @@
 (defvar riece-skk-kakutei-enabled nil)
 
 (defconst riece-skk-kakutei-description
-  "Deny SKK's sankaku send")
+  "Remove SKK's preedit mark before sending messages.")
 
 (defun riece-skk-kakutei-command-enter-message ()
   "Send the current line to the current channel."
diff --git a/lisp/riece-toolbar.el b/lisp/riece-toolbar.el
index 3c076e5..ef466ce 100644
--- a/lisp/riece-toolbar.el
+++ b/lisp/riece-toolbar.el
@@ -1,4 +1,4 @@
-;;; riece-toolbar.el --- show toolbar icons
+;;; riece-toolbar.el --- display toolbar icons
 ;; Copyright (C) 1998-2004 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,15 +24,14 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-toolbar)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
 (require 'riece-menu)
 
 (defconst riece-toolbar-description
-  "Show toolbar icons.")
+  "Display toolbar icons.")
 
 (defvar riece-toolbar-items
   '(riece-command-quit
diff --git a/lisp/riece-unread.el b/lisp/riece-unread.el
index 8cb745c..e35c0e3 100644
--- a/lisp/riece-unread.el
+++ b/lisp/riece-unread.el
@@ -1,4 +1,4 @@
-;;; riece-unread.el --- "unread message mark" add-on
+;;; riece-unread.el --- mark channels where new messages arrived
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -23,7 +23,9 @@
 
 ;;; Commentary:
 
-;; This add-on marks channels where new messages are arrived.
+;; NOTE: This is an add-on module for Riece.
+
+;; This add-on marks channels where new messages arrived.
 
 ;; You can check the unread channels via `C-c g' in the commands
 ;; buffer, by adding the following lines to ~/.riece/init.el:
@@ -71,7 +73,7 @@
 (defvar riece-unread-enabled nil)
 
 (defconst riece-unread-description
-  "Mark channels where \"unread\" messages arrived")
+  "Mark channels where new messages arrived.")
 
 (defun riece-unread-after-display-message-function (message)
   (if riece-unread-enabled
diff --git a/lisp/riece-url.el b/lisp/riece-url.el
index 6a0035a..848d24d 100644
--- a/lisp/riece-url.el
+++ b/lisp/riece-url.el
@@ -1,4 +1,4 @@
-;;; riece-url.el --- URL collector add-on
+;;; riece-url.el --- collect URL in IRC buffers
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,8 +24,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-url)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -63,7 +62,7 @@ This maps a string \"Bug#12345\" to a URL
 (defvar riece-url-enabled nil)
 
 (defconst riece-url-description
-  "Collect URL in IRC buffers")
+  "Collect URL in IRC buffers.")
 
 (autoload 'widget-convert-button "wid-edit")
 
diff --git a/lisp/riece-xface.el b/lisp/riece-xface.el
index 1ec5066..005181b 100644
--- a/lisp/riece-xface.el
+++ b/lisp/riece-xface.el
@@ -1,4 +1,4 @@
-;;; riece-xface.el --- display X-Face in user list buffer
+;;; riece-xface.el --- display X-Face in IRC buffers
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
@@ -24,8 +24,7 @@
 
 ;;; Commentary:
 
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-xface)
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
@@ -37,7 +36,7 @@
 (defvar riece-xface-enabled nil)
 
 (defconst riece-xface-description
-  "Display X-Face in user list buffer")
+  "Display X-Face in IRC buffers.")
 
 (defvar lsdb-insert-x-face-function)
 
diff --git a/lisp/riece-yank.el b/lisp/riece-yank.el
index 177ff0b..d959c32 100644
--- a/lisp/riece-yank.el
+++ b/lisp/riece-yank.el
@@ -1,4 +1,4 @@
-;;; riece-yank.el --- enter the element in kill-ring
+;;; riece-yank.el --- enter the element of kill-ring
 ;; Copyright (C) 2004 Masatake YAMATO
 
 ;; Author: Masatake YAMATO <jet@gyve.org>
@@ -20,16 +20,14 @@
 ;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
-;;
-;; In riece's command buffer, you can send the top element of kill-ring
-;; by C-c y. 
-;; Don't forget do (riece-command-enable-addon 'riece-yank) to test.
-;;
+
+;; NOTE: This is an add-on module for Riece.
+
 ;;; Code:
 (require 'riece-commands)
 
 (defgroup riece-yank nil
-  "Enter the element of `kill-ring'."
+  "Enter the element of kill-ring."
   :tag "Yank"
   :prefix "riece-"
   :group 'riece)
@@ -45,6 +43,9 @@ before/after the first/last non-blank line."
   :type 'boolean
   :group 'riece-yank)
 
+(defvar riece-yank-description
+  "Enter the element of kill-ring.")
+
 (defvar riece-yank-enabled nil)
 
 (defun riece-yank-insinuate ()