fix comments (FNF)

7 files changed, 36 insertions, 34 deletions

diff --git a/fml/lib/FML/Command/Admin/newdomain.pm b/fml/lib/FML/Command/Admin/newdomain.pm
index 7195ad1c..0bae0e1c 100644
--- a/fml/lib/FML/Command/Admin/newdomain.pm
+++ b/fml/lib/FML/Command/Admin/newdomain.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: newdomain.pm,v 1.6 2004/01/02 14:49:25 fukachan Exp $
+# $FML: newdomain.pm,v 1.7 2004/01/02 16:08:38 fukachan Exp $
 #
 
 package FML::Command::Admin::newdomain;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::newdomain - declare a new domain we use
+FML::Command::Admin::newdomain - declare a new domain we use.
 
 =head1 SYNOPSIS
 
@@ -28,7 +28,7 @@ declare a new domain we use.
 =cut
 
 
-# Descriptions: standard constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
@@ -41,14 +41,14 @@ sub new
 }
 
 
-# Descriptions: not need lock in the first time
+# Descriptions: not need lock in the first time.
 #    Arguments: none
 # Side Effects: none
 # Return Value: NUM( 1 or 0)
 sub need_lock { 0;}
 
 
-# Descriptions: declare a new domain we use
+# Descriptions: declare a new domain we use.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: forward request to dir module
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/newml.pm b/fml/lib/FML/Command/Admin/newml.pm
index 637197f1..a1a71f51 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.78 2004/02/15 04:38:29 fukachan Exp $
+# $FML: newml.pm,v 1.79 2004/03/16 12:53:40 fukachan Exp $
 #
 
 package FML::Command::Admin::newml;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::newml - set up a new mailing list
+FML::Command::Admin::newml - set up a new mailing list.
 
 =head1 SYNOPSIS
 
@@ -38,7 +38,7 @@ install config.cf, include, include-ctl et. al.
 =cut
 
 
-# Descriptions: standard constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
@@ -51,14 +51,14 @@ sub new
 }
 
 
-# Descriptions: not need lock in the first time
+# Descriptions: not need lock in the first time.
 #    Arguments: none
 # Side Effects: none
 # Return Value: NUM( 1 or 0)
 sub need_lock { 0;}
 
 
-# Descriptions: set up a new mailing list
+# 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.
@@ -162,6 +162,7 @@ sub cgi_menu
     my ($self, $curproc, $command_args) = @_;
     my $r = '';
 
+    # XXX-TODO: $command_args checked ?
     eval q{
         use FML::CGI::ML;
         my $obj = new FML::CGI::ML;
diff --git a/fml/lib/FML/Command/Admin/password.pm b/fml/lib/FML/Command/Admin/password.pm
index 1649a660..0779daa3 100644
--- a/fml/lib/FML/Command/Admin/password.pm
+++ b/fml/lib/FML/Command/Admin/password.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: password.pm,v 1.13.2.1 2004/03/04 04:00:20 fukachan Exp $
+# $FML: password.pm,v 1.14 2004/03/04 04:30:13 fukachan Exp $
 #
 
 package FML::Command::Admin::password;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::password - authenticate the remote admin password
+FML::Command::Admin::password - authenticate the remote admin password.
 
 =head1 SYNOPSIS
 
@@ -45,21 +45,21 @@ sub new
 }
 
 
-# Descriptions: need lock or not
+# Descriptions: need lock or not.
 #    Arguments: none
 # Side Effects: none
 # Return Value: NUM( 1 or 0)
 sub need_lock { 1;}
 
 
-# Descriptions: lock channel
+# Descriptions: lock channel.
 #    Arguments: none
 # Side Effects: none
 # Return Value: STR
 sub lock_channel { return 'command_serialize';}
 
 
-# Descriptions: rewrite buffer to hide the password phrase in $rbuf
+# Descriptions: rewrite buffer to hide the password phrase in $rbuf.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) STR_REF($rbuf)
 # Side Effects: none
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/rmdomain.pm b/fml/lib/FML/Command/Admin/rmdomain.pm
index f6a6ef35..01609c23 100644
--- a/fml/lib/FML/Command/Admin/rmdomain.pm
+++ b/fml/lib/FML/Command/Admin/rmdomain.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: rmdomain.pm,v 1.4 2003/11/16 23:49:12 fukachan Exp $
+# $FML: rmdomain.pm,v 1.5 2003/12/28 13:23:16 fukachan Exp $
 #
 
 package FML::Command::Admin::rmdomain;
@@ -28,7 +28,7 @@ an alias of C<FML::Command::Admin::dir>.
 =cut
 
 
-# Descriptions: standard constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
@@ -41,7 +41,7 @@ sub new
 }
 
 
-# Descriptions: not need lock in the first time
+# Descriptions: not need lock in the first time.
 #    Arguments: none
 # Side Effects: none
 # Return Value: NUM( 1 or 0)
diff --git a/fml/lib/FML/Command/Admin/rmml.pm b/fml/lib/FML/Command/Admin/rmml.pm
index c8228098..83f998fe 100644
--- a/fml/lib/FML/Command/Admin/rmml.pm
+++ b/fml/lib/FML/Command/Admin/rmml.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: rmml.pm,v 1.24 2004/01/01 23:52:13 fukachan Exp $
+# $FML: rmml.pm,v 1.25 2004/01/02 14:45:05 fukachan Exp $
 #
 
 package FML::Command::Admin::rmml;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::rmml - remove the specified mailing list
+FML::Command::Admin::rmml - remove the specified mailing list.
 
 =head1 SYNOPSIS
 
@@ -38,7 +38,7 @@ and the corresponding alias entries.
 =cut
 
 
-# Descriptions: standard constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
@@ -51,7 +51,7 @@ sub new
 }
 
 
-# Descriptions: not need lock in the first time
+# Descriptions: not need lock in the first time.
 #    Arguments: none
 # Side Effects: none
 # Return Value: NUM( 1 or 0)
@@ -114,6 +114,7 @@ sub cgi_menu
     my ($self, $curproc, $command_args) = @_;
     my $r = '';
 
+    # XXX-TODO: $commnad_args checked ?
     eval q{
         use FML::CGI::ML;
         my $obj = new FML::CGI::ML;
diff --git a/fml/lib/FML/Command/FileUtils.pm b/fml/lib/FML/Command/FileUtils.pm
index aedaaada..ffae0c51 100644
--- a/fml/lib/FML/Command/FileUtils.pm
+++ b/fml/lib/FML/Command/FileUtils.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: FileUtils.pm,v 1.16 2004/02/15 04:38:27 fukachan Exp $
+# $FML: FileUtils.pm,v 1.17 2004/04/23 04:10:30 fukachan Exp $
 #
 
 package FML::Command::FileUtils;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::FileUtils - utilities to handle files
+FML::Command::FileUtils - utilities to handle files.
 
 =head1 SYNOPSIS
 
@@ -25,12 +25,12 @@ FML::Command::FileUtils - utilities to handle files
 
 =head2 new()
 
-standard constructor.
+constructor.
 
 =cut
 
 
-# Descriptions: standard constructor
+# Descriptions: constructor
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
@@ -60,7 +60,7 @@ in FML::Restriction class.
 =cut
 
 
-# Descriptions: remove files
+# Descriptions: remove files.
 #    Arguments: OBJ($self) VARARGS(@p)
 # Side Effects: remove files
 # Return Value: same as remove()
@@ -71,7 +71,7 @@ sub delete
 }
 
 
-# Descriptions: remove files
+# Descriptions: remove files.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($command_args) HASH_REF($du_args)
 # Side Effects: none
diff --git a/fml/lib/FML/Command/SendFile.pm b/fml/lib/FML/Command/SendFile.pm
index 4a35c472..5075d77a 100644
--- a/fml/lib/FML/Command/SendFile.pm
+++ b/fml/lib/FML/Command/SendFile.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: SendFile.pm,v 1.39 2004/03/23 06:34:15 fukachan Exp $
+# $FML: SendFile.pm,v 1.40 2004/04/23 04:10:31 fukachan Exp $
 #
 
 package FML::Command::SendFile;
@@ -18,7 +18,7 @@ my $debug = 0;
 
 =head1 NAME
 
-FML::Command::SendFile - utility functions to send back file(s)
+FML::Command::SendFile - utility functions to send back file(s).
 
 =head1 SYNOPSIS
 
@@ -50,7 +50,7 @@ C<FML::Command::Admin> modules.
 # Descriptions: return the number of files specified in $command_args.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: none
-# Return Value: none
+# Return Value: NUM
 sub num_files_in_send_article_args
 {
     my ($self, $curproc, $command_args) = @_;
@@ -137,7 +137,7 @@ sub send_article
 }
 
 
-# Descriptions: check the argument and expand it if needed
+# Descriptions: check the argument and expand it if needed.
 #    Arguments: OBJ($self) OBJ($curproc) STR($fn)
 # Side Effects: none
 # Return Value: ARRAY_REF as [ $fist .. $last ]
@@ -181,12 +181,12 @@ sub send_file
     my $config    = $curproc->config();
 
     # XXX get_charset() take Accpet-Language: header field into account.
-    my $charset  = $curproc->get_charset("reply_message");
+    my $charset   = $curproc->get_charset("reply_message");
 
     # XXX-TODO: who validate $filename and $filepath ?
     $curproc->log("send_file: $filepath");
 
-    # template substitution: kanji code, $varname expansion et. al.
+    # template substitution: kanji code, $varname expansion et.al.
     # we prepare file to send back which has proper kanji code et.al.
     my $params = {
 	src         => $filepath,