update documents, comments

4 files changed, 47 insertions, 9 deletions

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) = @_;