overhaul: more comments.

4 files changed, 17 insertions, 11 deletions

diff --git a/fml/lib/FML/Command/Admin/get.pm b/fml/lib/FML/Command/Admin/get.pm
index ce004659..46e15b8e 100644
--- a/fml/lib/FML/Command/Admin/get.pm
+++ b/fml/lib/FML/Command/Admin/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.20 2003/08/23 07:24:43 fukachan Exp $
+# $FML: get.pm,v 1.21 2003/09/04 12:27:53 fukachan Exp $
 #
 
 package FML::Command::Admin::get;
@@ -18,7 +18,7 @@ use FML::Log qw(Log LogWarn LogError);
 
 =head1 NAME
 
-FML::Command::Admin::get - get arbitrary file in $ml_home_dir
+FML::Command::Admin::get - get arbitrary file(s) in $ml_home_dir
 
 =head1 SYNOPSIS
 
diff --git a/fml/lib/FML/Command/Admin/htmlify.pm b/fml/lib/FML/Command/Admin/htmlify.pm
index 376e5ed6..43fadae8 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.23 2004/01/02 10:23:55 fukachan Exp $
+# $FML: htmlify.pm,v 1.24 2004/01/02 14:45:04 fukachan Exp $
 #
 
 package FML::Command::Admin::htmlify;
@@ -24,7 +24,7 @@ See C<FML::Command> for more detaihtmlify.
 
 =head1 DESCRIPTION
 
-show user htmlify(s).
+convert text articles to html style.
 
 =cut
 
@@ -49,7 +49,7 @@ sub new
 sub need_lock { 0;}
 
 
-# Descriptions: convert article format from text to html.
+# Descriptions: convert article(s) from text to html format.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: forward request to dir module
 # Return Value: none
@@ -57,6 +57,8 @@ sub process
 {
     my ($self, $curproc, $command_args) = @_;
     my $config  = $curproc->config();
+
+    # XXX-TODO: $spool_dir -> $article_spool_dir ?
     my $src_dir = $config->{ spool_dir };
     my $dst_dir = $config->{ html_archive_dir };
     my $debug   = 0;
diff --git a/fml/lib/FML/Command/Admin/newml.pm b/fml/lib/FML/Command/Admin/newml.pm
index a3b355e9..1d2bb43f 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.75 2004/01/01 23:52:12 fukachan Exp $
+# $FML: newml.pm,v 1.76 2004/01/02 14:45:04 fukachan Exp $
 #
 
 package FML::Command::Admin::newml;
@@ -68,6 +68,8 @@ sub process
     my ($self, $curproc, $command_args) = @_;
     my $options        = $curproc->command_line_options();
     my $config         = $curproc->config();
+
+    # XXX-TODO: can we here use $curproc->ml_*() ?
     my $ml_name        = $config->{ ml_name };
     my $ml_domain      = $config->{ ml_domain };
     my $ml_home_prefix = $curproc->ml_home_prefix($ml_domain);
@@ -115,6 +117,7 @@ sub process
     # already exists.
     unless (defined $options->{ force } ) {
 	if (-d $ml_home_dir) {
+	    # XXX-TODO: $curproc->logwarn() ?
 	    warn("$ml_name ml_home_dir($ml_home_dir) already exists");
 	    return ;
 	}
@@ -126,6 +129,7 @@ sub process
     # XXX on all unix plathomes.
     if ($control->is_mta_alias_maps_has_ml_entry($curproc,$params,$ml_name)) {
 	unless (defined $options->{ force } ) {
+	    # XXX-TODO: $curproc->logwarn() ?
 	    warn("$ml_name already exists (somewhere in MTA aliases)");
 	    return ;
 	}
@@ -149,7 +153,7 @@ sub process
 }
 
 
-# Descriptions: show cgi menu for newml
+# Descriptions: show cgi menu for newml command.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: create home directories, update aliases, ...
 # Return Value: none
diff --git a/fml/lib/FML/Command/SendFile.pm b/fml/lib/FML/Command/SendFile.pm
index 1cab0f8c..774540b4 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.33 2003/10/15 01:03:29 fukachan Exp $
+# $FML: SendFile.pm,v 1.34 2003/10/15 11:57:02 fukachan Exp $
 #
 
 package FML::Command::SendFile;
@@ -24,7 +24,7 @@ FML::Command::SendFile - utility functions to send back file(s)
 =head1 SYNOPSIS
 
 For example, See L<FML::Command::User::get> and
-L<FML::Command::Admin::get>..
+L<FML::Command::Admin::get> on the usage detail.
 
    sub process
    {
@@ -62,7 +62,7 @@ sub num_files_in_send_article_args
     # command buffer = get 1,2,3
     # command buffer = get last:3
     my (@files) = split(/\s+/, $command);
-    shift @files; # remove get
+    shift @files; # remove prepended "get" string.
     for my $fn (@files) {
 	my $filelist = $self->_get_valid_article_list($curproc, $fn);
 	if (defined $filelist) {
@@ -74,7 +74,7 @@ sub num_files_in_send_article_args
 }
 
 
-# Descriptions: send back articles
+# Descriptions: send back articles.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: none
 # Return Value: none