update documents, comments

10 files changed, 110 insertions, 24 deletions

diff --git a/fml/lib/FML/Command/Admin/edit.pm b/fml/lib/FML/Command/Admin/edit.pm
index db3b2646..ec4f07ae 100644
--- a/fml/lib/FML/Command/Admin/edit.pm
+++ b/fml/lib/FML/Command/Admin/edit.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: edit.pm,v 1.3 2001/10/14 00:44:39 fukachan Exp $
+# $FML: edit.pm,v 1.4 2001/12/22 09:21:03 fukachan Exp $
 #
 
 package FML::Command::Admin::edit;
@@ -17,15 +17,17 @@ use FML::Command::Utils;
 
 =head1 NAME
 
-FML::Command::Admin::edit - edit a new member
+FML::Command::Admin::edit - edit config.cf
 
 =head1 SYNOPSIS
 
+See C<FML::Command> for more details.
+
 =head1 DESCRIPTION
 
-See C<FML::Command> for more details.
+Tool to edit config.cf.
 
-=head1 METHODS
+     not implemented
 
 =head1 METHODS
 
diff --git a/fml/lib/FML/Command/Admin/htmlify.pm b/fml/lib/FML/Command/Admin/htmlify.pm
index 15080cfb..de1d694f 100644
--- a/fml/lib/FML/Command/Admin/htmlify.pm
+++ b/fml/lib/FML/Command/Admin/htmlify.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: htmlify.pm,v 1.2 2001/10/22 11:04:50 fukachan Exp $
+# $FML: htmlify.pm,v 1.3 2001/12/22 09:21:03 fukachan Exp $
 #
 
 package FML::Command::Admin::htmlify;
@@ -25,19 +25,36 @@ FML::Command::Admin::htmlify - htmlify $spool_dir
 
 See C<FML::Command>.
 
+=head1 DESCRIPTION
+
 =head2 makefml usage
 
-For example, make htmlified articles in /var/www/htdocs/mlarchives/elena
+For example, make HTMLified articles in
+/var/www/htdocs/mlarchives/elena
 
-   makefml htmlify elena outdir=/var/www/htdocs/mlarchives/elena
+   makefml htmlify elena \
+    srcdir=/var/spool/ml/elena/spool \
+    outdir=/var/www/htdocs/mlarchives/elena
 
-=head1 DESCRIPTION
+C<XXX>
+This options format is irregular, isn't it?
+We should normalized it in the following way?
+
+   makefml htmlify elena \
+    --srcdir=/var/spool/ml/elena/spool \
+    --outdir=/var/www/htdocs/mlarchives/elena
+
+Hmm, ... but it is strange.
 
 =head1 METHODS
 
 =cut
 
 
+# Descriptions: htmlify articles
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
+# Side Effects: none
+# Return Value: none
 sub process
 {
     my ($self, $curproc, $command_args) = @_;
diff --git a/fml/lib/FML/Command/Admin/newml.pm b/fml/lib/FML/Command/Admin/newml.pm
index 518016c1..0179c8b8 100644
--- a/fml/lib/FML/Command/Admin/newml.pm
+++ b/fml/lib/FML/Command/Admin/newml.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: newml.pm,v 1.6 2001/12/11 15:38:01 fukachan Exp $
+# $FML: newml.pm,v 1.7 2001/12/22 09:21:03 fukachan Exp $
 #
 
 package FML::Command::Admin::newml;
@@ -19,7 +19,7 @@ use FML::Command::Utils;
 
 =head1 NAME
 
-FML::Command::Admin::newml - make a new mailing list
+FML::Command::Admin::newml - set up a new mailing list
 
 =head1 SYNOPSIS
 
@@ -31,6 +31,10 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
+set up a new mailing list
+create mailing list directory,
+install config.cf, include, include-ctl et. al.
+
 =head1 METHODS
 
 =head2 C<process($curproc, $command_args)>
@@ -38,6 +42,11 @@ See C<FML::Command> for more details.
 =cut
 
 
+# Descriptions: set up a new mailing list
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
+# Side Effects: create mailing list directory,
+#               install config.cf, include, include-ctl et. al.
+# Return Value: none
 sub process
 {
     my ($self, $curproc, $command_args) = @_;
@@ -56,7 +65,7 @@ sub process
     };
 
     # fundamental check
-    croak("\$ml_name is not specified")    unless $ml_name;
+    croak("\$ml_name is not specified") unless $ml_name;
 
     unless (-d $ml_home_dir) {
 	eval q{
@@ -83,6 +92,10 @@ sub process
 }
 
 
+# Descriptions: install $dst with variable expansion of $src
+#    Arguments: STR($src) STR($dst) HASH_REF($config)
+# Side Effects: create $dst 
+# Return Value: none
 sub _install
 {
     my ($src, $dst, $config) = @_;
diff --git a/fml/lib/FML/Command/Admin/subscribe.pm b/fml/lib/FML/Command/Admin/subscribe.pm
index 652ab477..dbdd14d1 100644
--- a/fml/lib/FML/Command/Admin/subscribe.pm
+++ b/fml/lib/FML/Command/Admin/subscribe.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: subscribe.pm,v 1.6 2001/10/14 00:44:40 fukachan Exp $
+# $FML: subscribe.pm,v 1.7 2001/12/22 09:21:04 fukachan Exp $
 #
 
 package FML::Command::Admin::subscribe;
@@ -23,9 +23,11 @@ FML::Command::Admin::subscribe - subscribe a new member
 
 =head1 SYNOPSIS
 
+See C<FML::Command> for more details.
+
 =head1 DESCRIPTION
 
-See C<FML::Command> for more details.
+subscribe a new address.
 
 =head1 METHODS
 
@@ -34,6 +36,10 @@ See C<FML::Command> for more details.
 =cut
 
 
+# Descriptions: subscribe a new user
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
+# Side Effects: update $member_map $recipient_map
+# Return Value: none
 sub process
 {
     my ($self, $curproc, $command_args) = @_;
diff --git a/fml/lib/FML/Command/Admin/unsubscribe.pm b/fml/lib/FML/Command/Admin/unsubscribe.pm
index 6bfc3364..94326fc1 100644
--- a/fml/lib/FML/Command/Admin/unsubscribe.pm
+++ b/fml/lib/FML/Command/Admin/unsubscribe.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: unsubscribe.pm,v 1.3 2001/10/14 00:44:40 fukachan Exp $
+# $FML: unsubscribe.pm,v 1.4 2001/12/22 09:21:04 fukachan Exp $
 #
 
 package FML::Command::Admin::unsubscribe;
@@ -26,6 +26,8 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
+unsubscribe a new user.
+
 =head1 METHODS
 
 =head2 C<process($curproc, $command_args)>
@@ -33,6 +35,10 @@ See C<FML::Command> for more details.
 =cut
 
 
+# Descriptions: unsubscribe a new user
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
+# Side Effects: update $member_map $recipient_map
+# Return Value: none
 sub process
 {
     my ($self, $curproc, $command_args) = @_;
diff --git a/fml/lib/FML/Command/User/chaddr.pm b/fml/lib/FML/Command/User/chaddr.pm
index 8c99d507..bb27ce1c 100644
--- a/fml/lib/FML/Command/User/chaddr.pm
+++ b/fml/lib/FML/Command/User/chaddr.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: chaddr.pm,v 1.2 2001/10/14 00:32:29 fukachan Exp $
+# $FML: chaddr.pm,v 1.3 2001/12/22 09:21:04 fukachan Exp $
 #
 
 package FML::Command::User::chaddr;
@@ -20,13 +20,16 @@ use FML::Log qw(Log LogWarn LogError);
 
 =head1 NAME
 
-FML::Command::User::chaddr - chaddr member
+FML::Command::User::chaddr - change subscriber address
 
 =head1 SYNOPSIS
 
+See C<FML::Command> for more details.
+
 =head1 DESCRIPTION
 
-See C<FML::Command> for more details.
+Firstly apply confirmation before chaddr (change subscriber address).
+After confirmation succeeds, chaddr process proceeds.
 
 =head1 METHODS
 
@@ -35,6 +38,11 @@ See C<FML::Command> for more details.
 =cut
 
 
+# Descriptions: chaddr adapter: confirm before chaddr operation
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
+# Side Effects: update database for confirmation.
+#               prepare reply message.
+# Return Value: none
 sub process
 {
     my ($self, $curproc, $command_args) = @_;
diff --git a/fml/lib/FML/Command/User/confirm.pm b/fml/lib/FML/Command/User/confirm.pm
index 1cc40a97..65e8fa4e 100644
--- a/fml/lib/FML/Command/User/confirm.pm
+++ b/fml/lib/FML/Command/User/confirm.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: confirm.pm,v 1.2 2001/10/14 00:32:29 fukachan Exp $
+# $FML: confirm.pm,v 1.3 2001/12/22 09:21:04 fukachan Exp $
 #
 
 package FML::Command::User::confirm;
@@ -24,9 +24,11 @@ FML::Command::User::confirm - allow action after confirmation
 
 =head1 SYNOPSIS
 
+See C<FML::Command> for more details.
+
 =head1 DESCRIPTION
 
-See C<FML::Command> for more details.
+real process after confirmation succeeds.
 
 =head1 METHODS
 
@@ -35,6 +37,11 @@ See C<FML::Command> for more details.
 =cut
 
 
+# Descriptions: real process after confirmation succeeds.
+#               run _switch_command() for real process.
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
+# Side Effects: none
+# Return Value: none
 sub process
 {
     my ($self, $curproc, $command_args) = @_;
@@ -78,6 +85,13 @@ sub process
 }
 
 
+# Descriptions: load module for real process and
+#               switched to it.
+#               We support only {subscribe,unsubscribe,chaddr} now.
+#    Arguments: OBJ($self) STR($class) STR($address)
+#               OBJ($curproc) HASH_REF($command_args)
+# Side Effects: module loaded
+# Return Value: none
 sub _switch_command
 {
     my ($self, $class, $address, $curproc, $command_args) = @_;
diff --git a/fml/lib/FML/Command/User/subscribe.pm b/fml/lib/FML/Command/User/subscribe.pm
index 2cd816c1..80318e4b 100644
--- a/fml/lib/FML/Command/User/subscribe.pm
+++ b/fml/lib/FML/Command/User/subscribe.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: subscribe.pm,v 1.6 2001/10/14 00:32:30 fukachan Exp $
+# $FML: subscribe.pm,v 1.7 2001/12/22 09:21:05 fukachan Exp $
 #
 
 package FML::Command::User::subscribe;
@@ -24,9 +24,12 @@ FML::Command::User::subscribe - subscribe a new member
 
 =head1 SYNOPSIS
 
+See C<FML::Command> for more details.
+
 =head1 DESCRIPTION
 
-See C<FML::Command> for more details.
+Firstly apply confirmation before subscribe.
+After confirmation succeeds, subcribe process proceeds.
 
 =head1 METHODS
 
@@ -35,6 +38,11 @@ See C<FML::Command> for more details.
 =cut
 
 
+# Descriptions: subscribe adapter: confirm before subscribe
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
+# Side Effects: update database for confirmation.
+#               prepare reply message.
+# Return Value: none
 sub process
 {
     my ($self, $curproc, $command_args) = @_;
diff --git a/fml/lib/FML/Command/User/unsubscribe.pm b/fml/lib/FML/Command/User/unsubscribe.pm
index 2ee8d4c4..5fa815d4 100644
--- a/fml/lib/FML/Command/User/unsubscribe.pm
+++ b/fml/lib/FML/Command/User/unsubscribe.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: unsubscribe.pm,v 1.4 2001/10/14 00:32:30 fukachan Exp $
+# $FML: unsubscribe.pm,v 1.5 2001/12/22 09:21:05 fukachan Exp $
 #
 
 package FML::Command::User::unsubscribe;
@@ -24,9 +24,12 @@ FML::Command::User::unsubscribe - unsubscribe member
 
 =head1 SYNOPSIS
 
+See C<FML::Command> for more details.
+
 =head1 DESCRIPTION
 
-See C<FML::Command> for more details.
+Firstly apply confirmation before unsubscribe.
+After confirmation succeeds, unsubcribe process proceeds.
 
 =head1 METHODS
 
@@ -35,6 +38,11 @@ See C<FML::Command> for more details.
 =cut
 
 
+# Descriptions: unsubscribe adapter: confirm before unsubscribe
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
+# Side Effects: update database for confirmation.
+#               prepare reply message.
+# Return Value: none
 sub process
 {
     my ($self, $curproc, $command_args) = @_;
diff --git a/fml/lib/FML/Command/Utils.pm b/fml/lib/FML/Command/Utils.pm
index 818f8f09..c88b9772 100644
--- a/fml/lib/FML/Command/Utils.pm
+++ b/fml/lib/FML/Command/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: @template.pm,v 1.3 2001/12/22 09:27:14 fukachan Exp $
+# $FML: Utils.pm,v 1.2 2001/12/22 16:10:50 fukachan Exp $
 #
 
 package FML::Command::Utils;
@@ -27,6 +27,10 @@ FML::Command::Utils - command utilities
 =cut
 
 
+# Descriptions: standard constructor
+#    Arguments: OBJ($self)
+# Side Effects: none
+# Return Value: OBJ
 sub new
 {
     my ($self) = @_;