clean up/fix comments

13 files changed, 66 insertions, 60 deletions

diff --git a/fml/lib/FML/CGI/Admin/User.pm b/fml/lib/FML/CGI/Admin/User.pm
index e3e3e654..68074b4f 100644
--- a/fml/lib/FML/CGI/Admin/User.pm
+++ b/fml/lib/FML/CGI/Admin/User.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: User.pm,v 1.8 2002/06/24 11:06:11 fukachan Exp $
+# $FML: User.pm,v 1.9 2002/06/25 04:02:11 fukachan Exp $
 #
 
 package FML::CGI::Admin::User;
@@ -28,7 +28,8 @@ sub new
 }
 
 
-# Descriptions: show menu for subscribe/unsubscribe commands
+# Descriptions: show menu for user control commands such as
+#               subscribe, unsubscribe, addadmin, byeadmin, ...
 #    Arguments: OBJ($self)
 #               OBJ($curproc)
 #               HASH_REF($args)
@@ -47,7 +48,7 @@ sub cgi_menu
     my $comname      = $command_args->{ comname };
     my $address_list = [];
 
-    # prepare address list to show them at the scrolling list
+    # which address list to show at the scrolling list
     if ($comname eq 'subscribe' || $comname eq 'unsubscribe') {
 	$address_list = $curproc->get_address_list( 'member_maps' );
     }
diff --git a/fml/lib/FML/Command/UserControl.pm b/fml/lib/FML/Command/UserControl.pm
index d4cf590e..7911f80d 100644
--- a/fml/lib/FML/Command/UserControl.pm
+++ b/fml/lib/FML/Command/UserControl.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: UserControl.pm,v 1.8 2002/06/25 04:11:30 fukachan Exp $
+# $FML: UserControl.pm,v 1.9 2002/06/30 14:30:14 fukachan Exp $
 #
 
 package FML::Command::UserControl;
@@ -45,7 +45,7 @@ sub new
 
 # Descriptions: add user
 #    Arguments: OBJ($self)
-#               HASH_REF($curproc) HASH_REF($command_args) HASH_REF($uc_args)
+#               OBJ($curproc) HASH_REF($command_args) HASH_REF($uc_args)
 # Side Effects: update maps
 # Return Value: none
 sub useradd
@@ -77,7 +77,7 @@ sub useradd
 
 # Descriptions: remove user
 #    Arguments: OBJ($self)
-#               HASH_REF($curproc) HASH_REF($command_args) HASH_REF($uc_args)
+#               OBJ($curproc) HASH_REF($command_args) HASH_REF($uc_args)
 # Side Effects: update maps
 # Return Value: none
 sub userdel
@@ -107,7 +107,7 @@ sub userdel
 
 # Descriptions: show list
 #    Arguments: OBJ($self)
-#               HASH_REF($curproc) HASH_REF($command_args) HASH_REF($uc_args)
+#               OBJ($curproc) HASH_REF($command_args) HASH_REF($uc_args)
 # Side Effects: none
 # Return Value: none
 sub userlist
diff --git a/fml/lib/FML/Filter/ContentCheck.pm b/fml/lib/FML/Filter/ContentCheck.pm
index 1aba97c4..64dd1bb3 100644
--- a/fml/lib/FML/Filter/ContentCheck.pm
+++ b/fml/lib/FML/Filter/ContentCheck.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: ContentCheck.pm,v 1.7 2002/05/11 09:34:16 fukachan Exp $
+# $FML: ContentCheck.pm,v 1.8 2002/05/11 13:55:23 tmu Exp $
 #
 
 package FML::Filter::ContentCheck;
@@ -62,7 +62,7 @@ sub new
 
 =head2 C<rules( $rules )>
 
-overwrite rules by specified C<@$rules> ($rules is HASH ARRAY).
+overwrite rules by specified C<@$rules> ($rules is ARRAY_REF).
 
 =cut
 
@@ -80,7 +80,7 @@ sub rules
 
 =head2 C<permit_rules( $rules )>
 
-overwrite rules by specified C<@$rules> ($rules is HASH ARRAY).
+overwrite rules by specified C<@$rules> ($rules is ARRAY_REF).
 
 =cut
 
@@ -97,7 +97,7 @@ sub permit_rules
 
 =head2 C<reject_rules( $rules )>
 
-overwrite rules by specified C<@$rules> ($rules is HASH ARRAY).
+overwrite rules by specified C<@$rules> ($rules is ARRAY_REF).
 
 =cut
 
diff --git a/fml/lib/FML/Filter/HeaderCheck.pm b/fml/lib/FML/Filter/HeaderCheck.pm
index 217e453e..4a3a2b88 100644
--- a/fml/lib/FML/Filter/HeaderCheck.pm
+++ b/fml/lib/FML/Filter/HeaderCheck.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: HeaderCheck.pm,v 1.15 2002/04/10 09:57:23 fukachan Exp $
+# $FML: HeaderCheck.pm,v 1.16 2002/06/01 14:53:38 fukachan Exp $
 #
 
 package FML::Filter::HeaderCheck;
@@ -60,7 +60,7 @@ sub new
 
 =head2 C<rules( $rules )>
 
-overwrite rules by specified C<@$rules> ($rules is HASH ARRAY).
+overwrite rules by specified C<@$rules> ($rules is ARRAY_REF).
 
 =cut
 
diff --git a/fml/lib/FML/Language/Japanese/Utils.pm b/fml/lib/FML/Language/Japanese/Utils.pm
index 3a3f86fb..3d0fda32 100644
--- a/fml/lib/FML/Language/Japanese/Utils.pm
+++ b/fml/lib/FML/Language/Japanese/Utils.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: Utils.pm,v 1.8 2002/04/08 12:44:25 fukachan Exp $
+# $FML: Utils.pm,v 1.9 2002/05/11 09:45:48 fukachan Exp $
 #
 
 package FML::Language::Japanese::Utils;
@@ -111,6 +111,9 @@ sub compare_euc_string
 {
     my ($self, $a, $pat) = @_;
 
+    # XXX validate $a and $pat ???
+    #     e.g. defined($a) ?
+
     # (Refeence: jcode 2.12)
     # $re_euc_c    = '[\241-\376][\241-\376]';
     # $re_euc_kana = '\216[\241-\337]';
diff --git a/fml/lib/FML/Parse.pm b/fml/lib/FML/Parse.pm
index ac305930..49896d8e 100644
--- a/fml/lib/FML/Parse.pm
+++ b/fml/lib/FML/Parse.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: Parse.pm,v 1.23 2002/04/26 00:09:53 fukachan Exp $
+# $FML: Parse.pm,v 1.24 2002/04/26 00:25:25 fukachan Exp $
 #
 
 package FML::Parse;
@@ -23,19 +23,13 @@ FML::Parse - parse the incoming message
 
 =head1 SYNOPSIS
 
-    ($r_header, $r_body) = new FML::Parse $curproc, \*STDIN;
+    $msg = new FML::Parse $curproc, \*STDIN;
 
 =head1 DESCRIPTION
 
-FML::Parse parses the incoming message.
-C<new()> analyses the data injected from STDIN channel and
-split it to a set of mail header and body.
-C<new()> returns a set of hash references.
-
-The returned C<$r_header> is the reference to a header object,
-which is C<Mail::Header> object.
-C<$r_body> is reference to the scalar mail body variable, which is
-C<Mail::Message> object.
+FML::Parse parses the incoming message. C<new()> analyses the data
+injected from STDIN channel, by default, and split it to a set of mail
+header and body.  C<new()> returns a C<Mail::Message> object.
 
 =head1 METHODS
 
diff --git a/fml/lib/FML/Process/Calender.pm b/fml/lib/FML/Process/Calender.pm
index cf01a319..c15035b8 100644
--- a/fml/lib/FML/Process/Calender.pm
+++ b/fml/lib/FML/Process/Calender.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2002 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Calender.pm,v 1.4 2002/04/07 05:04:38 fukachan Exp $
+# $FML: Calender.pm,v 1.5 2002/06/01 02:22:06 fukachan Exp $
 #
 
 package FML::Process::Calender;
@@ -28,8 +28,8 @@ FML::Process::Calender -- demonstration of FML module usage
 =head1 DESCRIPTION
 
 FML::Process::Calender is a demonstration module to show fml module
-usage.  This module provides calender presentation for a simple
-scheduler, Calender::Lite class.
+usage.  This module provides calender presentation as a simple
+scheduler based on Calender::Lite class.
 
 =head1 METHODS
 
@@ -62,7 +62,8 @@ sub new
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
-sub prepare        { 1; }
+sub prepare { 1;}        
+
 
 # Descriptions: dummy
 #    Arguments: OBJ($self) HASH_REF($args)
@@ -70,6 +71,7 @@ sub prepare        { 1; }
 # Return Value: none
 sub verify_request { 1; }
 
+
 # Descriptions: dummy
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
@@ -120,7 +122,7 @@ sub run
 	    $schedule->print_specific_month($wh, $month);
 	}
     }
-    # if "month" to show is specified as arguments,
+    # if "month" option is specified as an argument,
     # show the corresponding calender.
     elsif (defined(@$argv) && @$argv) {
 	# ($month, $yeer) = @$argv;
diff --git a/fml/lib/FML/Process/Command.pm b/fml/lib/FML/Process/Command.pm
index c64cb55a..308e4133 100644
--- a/fml/lib/FML/Process/Command.pm
+++ b/fml/lib/FML/Process/Command.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Command.pm,v 1.61 2002/06/01 05:09:25 fukachan Exp $
+# $FML: Command.pm,v 1.62 2002/06/27 08:25:49 fukachan Exp $
 #
 
 package FML::Process::Command;
@@ -62,11 +62,13 @@ sub new
 
 =head2 C<prepare($args)>
 
-forward the request to SUPER CLASS.
+adjust ml_* and load configuration files.
+parse the incoming message.
 
 =cut
 
-# Descriptions: dummy
+# Descriptions: adjust ml_* and load configuration files.
+#               parse the incomiung message.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -194,7 +196,7 @@ _EOF_
 =cut
 
 
-# Descriptions: finalize command process.
+# Descriptions: finalize the command process.
 #               reply messages, command results et. al.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: queue manipulation
diff --git a/fml/lib/FML/Process/ConfViewer.pm b/fml/lib/FML/Process/ConfViewer.pm
index e6c89737..460ccb9c 100644
--- a/fml/lib/FML/Process/ConfViewer.pm
+++ b/fml/lib/FML/Process/ConfViewer.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: ConfViewer.pm,v 1.12 2002/06/27 08:25:49 fukachan Exp $
+# $FML: ConfViewer.pm,v 1.13 2002/06/30 01:23:55 fukachan Exp $
 #
 
 package FML::Process::ConfViewer;
@@ -18,13 +18,15 @@ use FML::Process::Kernel;
 
 =head1 NAME
 
-FML::Process::ConfViewer -- show variables
+FML::Process::ConfViewer -- show configuration variables
 
 =head1 SYNOPSIS
 
     use FML::Process::ConfViewer;
     $curproc = new FML::Process::ConfViewer;
+       ...
     $curproc->run();
+       ...
 
 =head1 DESCRIPTION
 
@@ -39,7 +41,7 @@ It make a C<FML::Process::Kernel> object and return it.
 
 =head2 C<prepare($args)>
 
-dummy.
+adjust ml_* and load configuration files.
 
 =cut
 
@@ -57,7 +59,7 @@ sub new
 }
 
 
-# Descriptions: dummy
+# Descriptions: adjust ml_* and load configuration files.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -133,9 +135,9 @@ See <FML::Process::Switch()> on C<$args> for more details.
 sub run
 {
     my ($curproc, $args) = @_;
-    my $config  = $curproc->{ config };
-    my $myname  = $curproc->myname();
-    my $argv    = $curproc->command_line_argv();
+    my $config = $curproc->{ config };
+    my $myname = $curproc->myname();
+    my $argv   = $curproc->command_line_argv();
 
     my $eval = $config->get_hook( 'fmlconf_run_start_hook' );
     if ($eval) {
diff --git a/fml/lib/FML/Process/DocViewer.pm b/fml/lib/FML/Process/DocViewer.pm
index b76e17ba..862eaa21 100644
--- a/fml/lib/FML/Process/DocViewer.pm
+++ b/fml/lib/FML/Process/DocViewer.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: DocViewer.pm,v 1.16 2002/04/07 05:05:06 fukachan Exp $
+# $FML: DocViewer.pm,v 1.17 2002/06/27 08:25:50 fukachan Exp $
 #
 
 package FML::Process::DocViewer;
@@ -26,14 +26,16 @@ FML::Process::DocViewer -- perldoc wrapper to show a fml module
 
     use FML::Process::DocViewer;
     $curproc = new FML::Process::DocViewer;
+      ...
     $curproc->run();
+      ...
 
 =head1 DESCRIPTION
 
 FML::Process::DocViewer is the main routine of C<fmldoc> program.
 It wraps C<perldoc>.
 
-See C<FML::Process::Flow> for program flow.
+See C<FML::Process::Flow> for the program flow.
 
 =head1 METHODS
 
@@ -44,7 +46,7 @@ It inherits C<FML::Process::Kernel>.
 
 =head2 C<prepare($args)>
 
-dummy.
+load default configuration files.
 
 =cut
 
@@ -62,7 +64,7 @@ sub new
 }
 
 
-# Descriptions: dummy
+# Descriptions: load default configurations
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -90,7 +92,7 @@ sub prepare
 sub verify_request
 {
     my ($curproc, $args) = @_;
-    my $argv = $curproc->command_line_argv();
+    my $argv   = $curproc->command_line_argv();
     my $config = $curproc->{ config };
 
     my $eval = $config->get_hook( 'fmldoc_verify_request_start_hook' );
@@ -122,9 +124,9 @@ C<fmlconf($args)>.
 sub run
 {
     my ($curproc, $args) = @_;
-    my $config  = $curproc->{ config };
-    my $myname  = $curproc->myname();
-    my $argv    = $curproc->command_line_argv();
+    my $config = $curproc->{ config };
+    my $myname = $curproc->myname();
+    my $argv   = $curproc->command_line_argv();
 
     $curproc->_fmldoc($args);
 }
@@ -137,9 +139,9 @@ sub run
 sub _fmldoc
 {
     my ($curproc, $args) = @_;
-    my $config  = $curproc->{ config };
-    my $myname  = $curproc->myname();
-    my $argv    = $curproc->command_line_argv();
+    my $config = $curproc->{ config };
+    my $myname = $curproc->myname();
+    my $argv   = $curproc->command_line_argv();
 
     my $eval = $config->get_hook( 'fmldoc_run_start_hook' );
     if ($eval) { eval qq{ $eval; }; LogWarn($@) if $@; }
diff --git a/fml/lib/FML/Process/HTMLify.pm b/fml/lib/FML/Process/HTMLify.pm
index 7ea19818..3fc168fe 100644
--- a/fml/lib/FML/Process/HTMLify.pm
+++ b/fml/lib/FML/Process/HTMLify.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2001,2002 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: HTMLify.pm,v 1.19 2002/04/27 05:25:03 fukachan Exp $
+# $FML: HTMLify.pm,v 1.20 2002/06/27 08:25:50 fukachan Exp $
 #
 
 package FML::Process::HTMLify;
@@ -41,7 +41,7 @@ create a C<FML::Process::Kernel> object and return it.
 
 =head2 C<prepare()>
 
-dummy :)
+adjust ml_* and load configuration files.
 
 =cut
 
@@ -59,7 +59,7 @@ sub new
 }
 
 
-# Descriptions: dummy to avoid to take data from STDIN
+# Descriptions: adjust ml_* and load configuration files
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
diff --git a/fml/lib/FML/Process/ThreadTrack.pm b/fml/lib/FML/Process/ThreadTrack.pm
index 5e4f495f..9f5e9bb7 100644
--- a/fml/lib/FML/Process/ThreadTrack.pm
+++ b/fml/lib/FML/Process/ThreadTrack.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2001,2002 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: ThreadTrack.pm,v 1.29 2002/06/27 08:25:51 fukachan Exp $
+# $FML: ThreadTrack.pm,v 1.30 2002/06/30 01:23:00 fukachan Exp $
 #
 
 package FML::Process::ThreadTrack;
@@ -38,7 +38,7 @@ create a C<FML::Process::Kernel> object and return it.
 
 =head2 C<prepare()>
 
-dummy.
+adjust ml_* and load configuration files.
 
 =cut
 
@@ -56,7 +56,7 @@ sub new
 }
 
 
-# Descriptions: dummy to avoid to take data from STDIN
+# Descriptions: adjust ml_* and load configuration files
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
diff --git a/fml/lib/FML/Restriction/Command.pm b/fml/lib/FML/Restriction/Command.pm
index d54e8051..dd8028ff 100644
--- a/fml/lib/FML/Restriction/Command.pm
+++ b/fml/lib/FML/Restriction/Command.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: Command.pm,v 1.1 2002/02/11 12:29:27 fukachan Exp $
+# $FML: Command.pm,v 1.2 2002/04/06 14:48:03 fukachan Exp $
 #
 
 package FML::Restriction::Command;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Restriction::Command - filter rules for command input
+FML::Restriction::Command - safe regexp allowed as a command
 
 =head1 SYNOPSIS