fix comments

10 files changed, 203 insertions, 20 deletions

diff --git a/fml/lib/FML/Command/Admin/addadmin.pm b/fml/lib/FML/Command/Admin/addadmin.pm
index f6d4da1c..3f9a2b38 100644
--- a/fml/lib/FML/Command/Admin/addadmin.pm
+++ b/fml/lib/FML/Command/Admin/addadmin.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: addadmin.pm,v 1.23 2006/03/04 13:48:28 fukachan Exp $
+# $FML: addadmin.pm,v 1.24 2006/03/05 08:08:36 fukachan Exp $
 #
 
 package FML::Command::Admin::addadmin;
@@ -27,8 +27,26 @@ add a new remote administrator mail address.
 
 =head1 METHODS
 
+=head2 new()
+
+constructor.
+
+=head2 need_lock()
+
+need lock or not.
+
+=head2 lock_channel()
+
+return lock channel name.
+
+=head2 verify_syntax($curproc, $command_context)
+
+provide command specific syntax checker.
+
 =head2 process($curproc, $command_context)
 
+main command specific routine.
+
 =cut
 
 
diff --git a/fml/lib/FML/Command/Admin/addmember.pm b/fml/lib/FML/Command/Admin/addmember.pm
index 74e6d88d..758b8ee3 100644
--- a/fml/lib/FML/Command/Admin/addmember.pm
+++ b/fml/lib/FML/Command/Admin/addmember.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: addmember.pm,v 1.7 2006/03/04 13:48:28 fukachan Exp $
+# $FML: addmember.pm,v 1.8 2006/03/05 08:08:36 fukachan Exp $
 #
 
 package FML::Command::Admin::addmember;
@@ -23,12 +23,30 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-change delivery mode from digest to real time.
+add a new member mail address as an ordinary user.
 
 =head1 METHODS
 
+=head2 new()
+
+constructor.
+
+=head2 need_lock()
+
+need lock or not.
+
+=head2 lock_channel()
+
+return lock channel name.
+
+=head2 verify_syntax($curproc, $command_context)
+
+provide command specific syntax checker.
+
 =head2 process($curproc, $command_context)
 
+main command specific routine.
+
 =cut
 
 
@@ -73,7 +91,7 @@ sub verify_syntax
 }
 
 
-# Descriptions: change delivery mode from digest to real time.
+# Descriptions: add an ordinary member.
 #    Arguments: OBJ($self) OBJ($curproc) OBJ($command_context)
 # Side Effects: update $member_map
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/addmoderator.pm b/fml/lib/FML/Command/Admin/addmoderator.pm
index 9bc7db5f..bdaf7b48 100644
--- a/fml/lib/FML/Command/Admin/addmoderator.pm
+++ b/fml/lib/FML/Command/Admin/addmoderator.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: addmoderator.pm,v 1.18 2006/03/04 13:48:28 fukachan Exp $
+# $FML: addmoderator.pm,v 1.19 2006/03/05 08:08:36 fukachan Exp $
 #
 
 package FML::Command::Admin::addmoderator;
@@ -27,8 +27,26 @@ add a new moderator address.
 
 =head1 METHODS
 
+=head2 new()
+
+constructor.
+
+=head2 need_lock()
+
+need lock or not.
+
+=head2 lock_channel()
+
+return lock channel name.
+
+=head2 verify_syntax($curproc, $command_context)
+
+provide command specific syntax checker.
+
 =head2 process($curproc, $command_context)
 
+main command specific routine.
+
 =cut
 
 
diff --git a/fml/lib/FML/Command/Admin/addrecipient.pm b/fml/lib/FML/Command/Admin/addrecipient.pm
index 5e41a12e..5dd130d3 100644
--- a/fml/lib/FML/Command/Admin/addrecipient.pm
+++ b/fml/lib/FML/Command/Admin/addrecipient.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: addrecipient.pm,v 1.7 2006/03/04 13:48:28 fukachan Exp $
+# $FML: addrecipient.pm,v 1.8 2006/03/05 08:08:36 fukachan Exp $
 #
 
 package FML::Command::Admin::addrecipient;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::addrecipient - add recipient (recipient only).
+FML::Command::Admin::addrecipient - add a recipient (recipient only).
 
 =head1 SYNOPSIS
 
@@ -27,8 +27,26 @@ change delivery mode from digest to real time.
 
 =head1 METHODS
 
+=head2 new()
+
+constructor.
+
+=head2 need_lock()
+
+need lock or not.
+
+=head2 lock_channel()
+
+return lock channel name.
+
+=head2 verify_syntax($curproc, $command_context)
+
+provide command specific syntax checker.
+
 =head2 process($curproc, $command_context)
 
+main command specific routine.
+
 =cut
 
 
@@ -73,9 +91,9 @@ sub verify_syntax
 }
 
 
-# Descriptions: change delivery mode from digest to real time.
+# Descriptions: add a recipient.
 #    Arguments: OBJ($self) OBJ($curproc) OBJ($command_context)
-# Side Effects: update $recipient_map
+# Side Effects: update $recipient_map.
 # Return Value: none
 sub process
 {
diff --git a/fml/lib/FML/Command/Admin/config.pm b/fml/lib/FML/Command/Admin/config.pm
index af5c09cd..76ff6ab3 100644
--- a/fml/lib/FML/Command/Admin/config.pm
+++ b/fml/lib/FML/Command/Admin/config.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: config.pm,v 1.2 2004/12/19 11:10:51 fukachan Exp $
+# $FML: config.pm,v 1.3 2006/03/04 13:48:28 fukachan Exp $
 #
 
 package FML::Command::Admin::config;
@@ -31,8 +31,26 @@ Tool to config config.cf.
 
 =head1 METHODS
 
+=head2 new()
+
+constructor.
+
+=head2 need_lock()
+
+need lock or not.
+
+=head2 lock_channel()
+
+return lock channel name.
+
+=head2 verify_syntax($curproc, $command_context)
+
+provide command specific syntax checker.
+
 =head2 process($curproc, $command_context)
 
+main command specific routine.
+
 C<TODO>:
 now we can read and write config.cf, but can not change it.
 
@@ -59,7 +77,7 @@ sub new
 sub need_lock { 0;}
 
 
-# Descriptions: run "vi" or the specified configor to config config.cf.
+# Descriptions: run "vi" or the specified editor to config config.cf.
 #               If environmental variable EDITOR is specified,
 #               try to run "$EDITOR config.cf".
 #    Arguments: OBJ($self) OBJ($curproc) OBJ($command_context)
diff --git a/fml/lib/FML/Command/Admin/deladmin.pm b/fml/lib/FML/Command/Admin/deladmin.pm
index e4acb825..ee7ab66c 100644
--- a/fml/lib/FML/Command/Admin/deladmin.pm
+++ b/fml/lib/FML/Command/Admin/deladmin.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: deladmin.pm,v 1.22 2006/03/04 13:48:28 fukachan Exp $
+# $FML: deladmin.pm,v 1.23 2006/03/05 08:08:36 fukachan Exp $
 #
 
 package FML::Command::Admin::deladmin;
@@ -27,8 +27,26 @@ remove the specified remote administrator.
 
 =head1 METHODS
 
+=head2 new()
+
+constructor.
+
+=head2 need_lock()
+
+need lock or not.
+
+=head2 lock_channel()
+
+return lock channel name.
+
+=head2 verify_syntax($curproc, $command_context)
+
+provide command specific syntax checker.
+
 =head2 process($curproc, $command_context)
 
+main command specific routine.
+
 =cut
 
 
diff --git a/fml/lib/FML/Command/Admin/error.pm b/fml/lib/FML/Command/Admin/error.pm
index 694ed825..176c4b9f 100644
--- a/fml/lib/FML/Command/Admin/error.pm
+++ b/fml/lib/FML/Command/Admin/error.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: error.pm,v 1.17 2005/08/17 12:08:43 fukachan Exp $
+# $FML: error.pm,v 1.18 2006/03/04 13:48:28 fukachan Exp $
 #
 
 package FML::Command::Admin::error;
@@ -23,12 +23,30 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-show error status.
+show error (bounce mail) status.
 
 =head1 METHODS
 
+=head2 new()
+
+constructor.
+
+=head2 need_lock()
+
+need lock or not.
+
+=head2 lock_channel()
+
+return lock channel name.
+
+=head2 verify_syntax($curproc, $command_context)
+
+provide command specific syntax checker.
+
 =head2 process($curproc, $command_context)
 
+main command specific routine.
+
 call error status generator.
 
 =cut
diff --git a/fml/lib/FML/Command/Admin/flushq.pm b/fml/lib/FML/Command/Admin/flushq.pm
index f721c563..f5fe81de 100644
--- a/fml/lib/FML/Command/Admin/flushq.pm
+++ b/fml/lib/FML/Command/Admin/flushq.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: flushq.pm,v 1.2 2004/06/26 11:47:56 fukachan Exp $
+# $FML: flushq.pm,v 1.3 2006/03/04 13:48:28 fukachan Exp $
 #
 
 package FML::Command::Admin::flushq;
@@ -22,7 +22,25 @@ FML::Command::Admin::flushq - flush outgoing mail queue.
 
 =head1 METHODS
 
-=head2 C<new()>
+=head2 new()
+
+constructor.
+
+=head2 need_lock()
+
+need lock or not.
+
+=head2 lock_channel()
+
+return lock channel name.
+
+=head2 verify_syntax($curproc, $command_context)
+
+provide command specific syntax checker.
+
+=head2 process($curproc, $command_context)
+
+main command specific routine.
 
 =cut
 
diff --git a/fml/lib/FML/Command/Admin/list.pm b/fml/lib/FML/Command/Admin/list.pm
index e47c162c..e6eb3263 100644
--- a/fml/lib/FML/Command/Admin/list.pm
+++ b/fml/lib/FML/Command/Admin/list.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: list.pm,v 1.26 2004/06/26 11:42:22 fukachan Exp $
+# $FML: list.pm,v 1.27 2006/03/04 13:48:28 fukachan Exp $
 #
 
 package FML::Command::Admin::list;
@@ -21,7 +21,27 @@ FML::Command::Admin::list - show the content of specified map(s).
 
 See C<FML::Command> for more details.
 
-=head1 DESCRIPTION
+=head1 METHODS
+
+=head2 new()
+
+constructor.
+
+=head2 need_lock()
+
+need lock or not.
+
+=head2 lock_channel()
+
+return lock channel name.
+
+=head2 verify_syntax($curproc, $command_context)
+
+provide command specific syntax checker.
+
+=head2 process($curproc, $command_context)
+
+main command specific routine.
 
 show user list(s).
 
diff --git a/fml/lib/FML/Command/Admin/log.pm b/fml/lib/FML/Command/Admin/log.pm
index 72e560f3..2569073b 100644
--- a/fml/lib/FML/Command/Admin/log.pm
+++ b/fml/lib/FML/Command/Admin/log.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: log.pm,v 1.32 2006/03/04 13:48:28 fukachan Exp $
+# $FML: log.pm,v 1.33 2006/07/09 12:11:12 fukachan Exp $
 #
 
 package FML::Command::Admin::log;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::log - log file operations.
+FML::Command::Admin::log - show log file content.
 
 =head1 SYNOPSIS
 
@@ -27,8 +27,26 @@ show log file(s).
 
 =head1 METHODS
 
+=head2 new()
+
+constructor.
+
+=head2 need_lock()
+
+need lock or not.
+
+=head2 lock_channel()
+
+return lock channel name.
+
+=head2 verify_syntax($curproc, $command_context)
+
+provide command specific syntax checker.
+
 =head2 process($curproc, $command_context)
 
+main command specific routine.
+
 =cut
 
 
@@ -192,6 +210,7 @@ sub _show_log_tail
     my $fh = new FileHandle $log_file;
     my $wh = \*STDOUT;
 
+    # XXX-TODO: use seek().
     if (defined $fh) {
 	while (<$fh>) { $line_max++;}
 	$fh->close();