fix comments

2 files changed, 19 insertions, 23 deletions

diff --git a/fml/lib/FML/MTAControl/Postfix.pm b/fml/lib/FML/MTAControl/Postfix.pm
index 8e5fc7c3..167b506a 100644
--- a/fml/lib/FML/MTAControl/Postfix.pm
+++ b/fml/lib/FML/MTAControl/Postfix.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: Postfix.pm,v 1.11 2002/09/22 14:56:51 fukachan Exp $
+# $FML: Postfix.pm,v 1.12 2002/11/07 08:38:23 fukachan Exp $
 #
 
 package FML::MTAControl::Postfix;
@@ -17,7 +17,7 @@ my $debug = 0;
 
 =head1 NAME
 
-FML::MTAControl - postfix utilities
+FML::MTAControl::Postfix - handle postfix specific configurations
 
 =head1 SYNOPSIS
 
@@ -27,8 +27,6 @@ set up aliases and virtual maps for postfix.
 
 =head1 METHODS
 
-=head2 new()
-
 =cut
 
 
@@ -48,7 +46,7 @@ sub postfix_install_alias
     my $src   = File::Spec->catfile($template_dir, 'aliases');
     my $dst   = $alias . "." . $$;
 
-    # update params
+    # update params with considering virtual domain support if needed.
     my $xparams = {};
     for my $k (keys %$params) { $xparams->{ $k } = $params->{ $k };}
     $self->_postfix_rewrite_virtual_params($curproc, $xparams);
@@ -56,6 +54,7 @@ sub postfix_install_alias
 
     print STDERR "updating $alias\n";
 
+    # XXX-TODO: we should prepare methods such as $curproc->util->append() ?
     use File::Utils qw(append);
     append($dst, $alias);
     unlink $dst;
@@ -233,6 +232,7 @@ sub postfix_alias_maps
     my $config = $curproc->{ config };
     my $prog   = $config->{ path_postconf };
 
+    # XXX-TODO: postconf returns $xxx in some cases. we need to expand it.
     my $maps   = `$prog alias_maps`;
     $maps      =~ s/,/ /g;
     $maps      =~ s/\s+hash:/ /g;
@@ -245,7 +245,7 @@ sub postfix_alias_maps
 }
 
 
-# Descriptions: install configuratin templates
+# Descriptions: install configuration templates
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: create include*
diff --git a/fml/lib/FML/MTAControl/Qmail.pm b/fml/lib/FML/MTAControl/Qmail.pm
index 5f49b434..aa0b7f72 100644
--- a/fml/lib/FML/MTAControl/Qmail.pm
+++ b/fml/lib/FML/MTAControl/Qmail.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: Qmail.pm,v 1.12 2002/09/11 23:18:13 fukachan Exp $
+# $FML: Qmail.pm,v 1.13 2002/09/22 14:56:51 fukachan Exp $
 #
 
 package FML::MTAControl::Qmail;
@@ -17,7 +17,7 @@ my $debug = 0;
 
 =head1 NAME
 
-FML::MTAControl - qmail utilities
+FML::MTAControl::Qmail - handle qmail specific configurations
 
 =head1 SYNOPSIS
 
@@ -27,18 +27,10 @@ set up aliases and virtual maps for qmail.
 
 =head1 METHODS
 
-=head2 new($args)
-
-    $args = {
-	mta_type => 'qmail',
-    };
-
-C<qmail> as C<mta_type> is available now.
-
 =cut
 
 
-# Descriptions: update alias
+# Descriptions: udummy. qmail not needs installation of alias files.
 #    Arguments: OBJ($self) HASH_REF($curproc) HASH_REF($optargs)
 # Side Effects: update aliases
 # Return Value: none
@@ -50,7 +42,7 @@ sub qmail_install_alias
 }
 
 
-# Descriptions: update alias
+# Descriptions: remove .qmail-$ml* files (remove aliases).
 #    Arguments: OBJ($self) HASH_REF($curproc) HASH_REF($optargs)
 # Side Effects: update aliases
 # Return Value: none
@@ -87,7 +79,7 @@ sub qmail_remove_alias
 }
 
 
-# Descriptions: update alias
+# Descriptions: dummy (update alias).
 #    Arguments: OBJ($self) HASH_REF($curproc) HASH_REF($optargs)
 # Side Effects: update aliases
 # Return Value: none
@@ -99,7 +91,7 @@ sub qmail_update_alias
 }
 
 
-# Descriptions: find key in aliases
+# Descriptions: dummy (find key in aliases).
 #    Arguments: OBJ($self) HASH_REF($curproc) HASH_REF($optargs)
 # Side Effects: none
 # Return Value: NUM(1 or 0)
@@ -107,6 +99,7 @@ sub qmail_find_key_in_alias_maps
 {
     my ($self, $curproc, $params, $optargs) = @_;
 
+    # XXX-TODO: implement this!
     0;
 }
 
@@ -119,6 +112,7 @@ sub qmail_get_aliases_as_hash_ref
 {
     my ($self, $curproc, $params, $optargs) = @_;
 
+    # XXX-TODO: implement this!
     0;
 }
 
@@ -131,11 +125,12 @@ sub qmail_alias_maps
 {
     my ($self, $curproc, $params, $optargs) = @_;
 
+    # XXX-TODO: implement this!
     0;
 }
 
 
-# Descriptions: install configuratin templates
+# Descriptions: create ~/.qmail-* files
 #    Arguments: OBJ($self) HASH_REF($curproc) HASH_REF($optargs)
 # Side Effects: creates ~/.qmail-XXX
 # Return Value: none
@@ -154,6 +149,7 @@ sub qmail_setup
     my $ml_name   = $config->{ ml_name };
     my $ml_domain = $config->{ ml_domain }; $ml_domain =~ s/\./:/g;
     for my $file (@$qmail_template_files) {
+	# XXX-TODO: we should define dot-qmail file name generator as method.
 	my $xfile = $file;
 	$xfile =~ s/dot-/\./;
 	$xfile =~ s/dot-/\./;
@@ -195,7 +191,7 @@ sub qmail_install_virtual_map
     my $ml_domain    = $config->{ ml_domain };
     my $virtual      = $config->{ qmail_virtual_map_file };
 
-    # 1. check the current temlate file firstly
+    # 1. check the current template file firstly
     my $found = 0;
     my $fh    = new FileHandle $virtual;
     if (defined $fh) {
@@ -216,7 +212,7 @@ sub qmail_install_virtual_map
 	}
     }
     else {
-	print STDERR "skipping $virtual\n";
+	print STDERR "skip updating $virtual\n";
     }
 }