update documents, comments

8 files changed, 98 insertions, 16 deletions

diff --git a/fml/lib/FML/Command/User/add.pm b/fml/lib/FML/Command/User/add.pm
index 21993b78..e3541785 100644
--- a/fml/lib/FML/Command/User/add.pm
+++ b/fml/lib/FML/Command/User/add.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: add.pm,v 1.3 2001/10/14 00:32:29 fukachan Exp $
+# $FML: add.pm,v 1.4 2001/12/22 09:21:04 fukachan Exp $
 #
 
 package FML::Command::User::add;
@@ -16,12 +16,18 @@ use FML::Command::Utils;
 use FML::Command::User::subscribe;
 @ISA = qw(FML::Command::User::subscribe FML::Command::Utils);
 
+
+# Descriptions: subscribe user
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
+# Side Effects: forward request to subscribe module
+# Return Value: none
 sub process
 {
     my ($self, $curproc, $command_args) = @_;
     $self->SUPER::process($curproc, $command_args);
 }
 
+
 =head1 NAME
 
 FML::Command::User::add - add a new member
@@ -32,6 +38,8 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
+forward request to C<subscribe> module.
+
 =head1 AUTHOR
 
 Ken'ichi Fukamachi
diff --git a/fml/lib/FML/Command/User/get.pm b/fml/lib/FML/Command/User/get.pm
index 5e42749b..ffce8039 100644
--- a/fml/lib/FML/Command/User/get.pm
+++ b/fml/lib/FML/Command/User/get.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: get.pm,v 1.5 2001/10/14 00:32:29 fukachan Exp $
+# $FML: get.pm,v 1.6 2001/12/22 09:21:04 fukachan Exp $
 #
 
 package FML::Command::User::get;
@@ -24,10 +24,12 @@ FML::Command::User::get - send back articles
 
 =head1 SYNOPSIS
 
-not yet implemented
+See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
+send back articles.
+
 =head1 METHODS
 
 =head2 C<new()>
@@ -35,6 +37,10 @@ not yet implemented
 =cut
 
 
+# Descriptions: send articles by FML::Command::SendFile.
+#    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/User/guide.pm b/fml/lib/FML/Command/User/guide.pm
index a0b5406e..8ac9b62c 100644
--- a/fml/lib/FML/Command/User/guide.pm
+++ b/fml/lib/FML/Command/User/guide.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: guide.pm,v 1.2 2001/10/14 00:32:29 fukachan Exp $
+# $FML: guide.pm,v 1.3 2001/12/22 09:21:04 fukachan Exp $
 #
 
 package FML::Command::User::guide;
@@ -25,9 +25,11 @@ FML::Command::User::guide - send back guide file
 
 =head1 SYNOPSIS
 
+See C<FML::Command> for more details.
+
 =head1 DESCRIPTION
 
-See C<FML::Command> for more details.
+send back file.
 
 =head1 METHODS
 
@@ -36,6 +38,10 @@ See C<FML::Command> for more details.
 =cut
 
 
+# Descriptions: send file by FML::Command::SendFile.
+#    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/User/help.pm b/fml/lib/FML/Command/User/help.pm
index 59bcbd79..a9dac735 100644
--- a/fml/lib/FML/Command/User/help.pm
+++ b/fml/lib/FML/Command/User/help.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: help.pm,v 1.5 2001/10/14 00:32:29 fukachan Exp $
+# $FML: help.pm,v 1.6 2001/12/22 09:21:05 fukachan Exp $
 #
 
 package FML::Command::User::help;
@@ -25,6 +25,8 @@ FML::Command::User::help - send back help file
 
 =head1 SYNOPSIS
 
+See C<FML::Command> for more details.
+
 =head1 DESCRIPTION
 
 See C<FML::Command> for more details.
@@ -36,6 +38,10 @@ See C<FML::Command> for more details.
 =cut
 
 
+# Descriptions: send file by FML::Command::SendFile.
+#    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/User/summary.pm b/fml/lib/FML/Command/User/summary.pm
index c8e9e7b5..154c842b 100644
--- a/fml/lib/FML/Command/User/summary.pm
+++ b/fml/lib/FML/Command/User/summary.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: summary.pm,v 1.2 2001/10/14 00:32:30 fukachan Exp $
+# $FML: summary.pm,v 1.3 2001/12/22 09:21:05 fukachan Exp $
 #
 
 package FML::Command::User::summary;
@@ -25,9 +25,11 @@ FML::Command::User::summary - send back summary file
 
 =head1 SYNOPSIS
 
+See C<FML::Command> for more details.
+
 =head1 DESCRIPTION
 
-See C<FML::Command> for more details.
+send back summary file.
 
 =head1 METHODS
 
@@ -36,6 +38,10 @@ See C<FML::Command> for more details.
 =cut
 
 
+# Descriptions: send file by FML::Command::SendFile.
+#    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/Utils.pm b/fml/lib/FML/Command/Utils.pm
index 3356c260..818f8f09 100644
--- a/fml/lib/FML/Command/Utils.pm
+++ b/fml/lib/FML/Command/Utils.pm
@@ -1,8 +1,31 @@
+#-*- perl -*-
+#
+#  Copyright (C) 2001 Ken'ichi Fukamachi
+#   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 $
+#
+
 package FML::Command::Utils;
 use strict;
 use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
 use Carp;
-use FML::Log qw(Log LogWarn LogError);
+
+=head1 NAME
+
+FML::Command::Utils - command utilities
+
+=head1 SYNOPSIS
+
+   nothing implemented yet.
+
+=head1 DESCRIPTION
+
+=head1 METHODS
+
+=cut
+
 
 sub new
 {
@@ -13,7 +36,23 @@ sub new
 }
 
 
-sub DESTROY { ;}
+=head1 AUTHOR
+
+Ken'ichi Fukamachi
+
+=head1 COPYRIGHT
+
+Copyright (C) 2001 Ken'ichi Fukamachi
+
+All rights reserved. This program is free software; you can
+redistribute it and/or modify it under the same terms as Perl itself.
+
+=head1 HISTORY
+
+FML::Command::Utils appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
+
+=cut
 
 
 1;
diff --git a/fml/lib/FML/Filter.pm b/fml/lib/FML/Filter.pm
index 2027091d..8952dbc2 100644
--- a/fml/lib/FML/Filter.pm
+++ b/fml/lib/FML/Filter.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: Filter.pm,v 1.1 2001/10/14 23:06:38 fukachan Exp $
+# $FML: Filter.pm,v 1.2 2001/12/22 09:21:01 fukachan Exp $
 #
 
 package FML::Filter;
@@ -15,7 +15,7 @@ use ErrorStatus qw(error_set error error_clear);
 
 =head1 NAME
 
-FML::Filter - entry pointer for FML::Filter::* modules
+FML::Filter - entry point for FML::Filter::* modules
 
 =head1 SYNOPSIS
 
diff --git a/fml/lib/FML/Mailer.pm b/fml/lib/FML/Mailer.pm
index f79f2d16..0370e400 100644
--- a/fml/lib/FML/Mailer.pm
+++ b/fml/lib/FML/Mailer.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: Mailer.pm,v 1.5 2001/05/28 16:17:13 fukachan Exp $
+# $FML: Mailer.pm,v 1.6 2001/12/22 09:21:01 fukachan Exp $
 #
 
 package FML::Mailer;
@@ -28,8 +28,8 @@ FML::Mailer - Utilities to send mails
     });
 
 where C<$message> is a C<Mail::Message> object to send.
-If you want to sent plural recipinets, specify ARRAY HASH of the
-recipients as a C<recipient> parameter.
+If you want to sent plural recipinets, 
+specify the recipients as ARRAY HASH at C<recipients> parameter.
 
     $obj->send( {
 	sender     => 'rudo@nuinui.net',
@@ -49,15 +49,21 @@ If you send a file, you can specify the filename as a data to send.
 
 =head1 DESCRIPTION
 
+It sends Mail::Message object.
+
 =head1 METHODS
 
 =head2 C<new()>
 
-ordinary constructor.
+standard constructor.
 
 =cut
 
 
+# Descriptions: standard constructor
+#    Arguments: OBJ($self)
+# Side Effects: none
+# Return Value: OBJ
 sub new
 {
     my ($self) = @_;
@@ -81,6 +87,11 @@ $args can take the following arguments:
 
 =cut
 
+
+# Descriptions: send messages in the queue (queue flush).
+#    Arguments: OBJ($self) HASH_REF($args)
+# Side Effects: queue changed
+# Return Value: 1 or 0
 sub send
 {
     my ($self, $args) = @_;