clean up documents

5 files changed, 47 insertions, 35 deletions

diff --git a/fml/lib/FML/Process/Configure.pm b/fml/lib/FML/Process/Configure.pm
index e7476548..db845320 100644
--- a/fml/lib/FML/Process/Configure.pm
+++ b/fml/lib/FML/Process/Configure.pm
@@ -4,7 +4,7 @@
 # Copyright (C) 2000,2001 Ken'ichi Fukamachi
 #          All rights reserved. 
 #
-# $FML: Configure.pm,v 1.21 2001/04/03 09:45:43 fukachan Exp $
+# $FML: Configure.pm,v 1.22 2001/05/29 16:21:16 fukachan Exp $
 #
 
 package FML::Process::Configure;
@@ -22,7 +22,7 @@ use FML::Config;
 
 =head1 NAME
 
-FML::Process::Configure -- fmlconf and makefml wrapper
+FML::Process::Configure -- fmlconf and makefml main functions
 
 =head1 SYNOPSIS
 
@@ -32,11 +32,10 @@ FML::Process::Configure -- fmlconf and makefml wrapper
 
 =head1 DESCRIPTION
 
-FML::Process::Configure is the wrapper for fmlconf and makefml.
-
-See C<FML::Process::Flow> for each program flow.
-
-=head2 MODULES
+FML::Process::Configure provides the main function for 
+C<fmlconf>
+ and 
+C<makefml>.
 
 These programs, 
 C<fmlconf> and C<makefml>,
@@ -44,6 +43,8 @@ bootstrap by using these modules in this order.
 
    libexec/loader -> FML::Process::Switch -> FML::Process::Configure
 
+See C<FML::Process::Flow> for the flow detail.
+
 =head1 METHODS
 
 =head2 C<new($args)>
diff --git a/fml/lib/Mail/Bounce/SimpleMatch.pm b/fml/lib/Mail/Bounce/SimpleMatch.pm
index 3f7d10fa..4252e313 100644
--- a/fml/lib/Mail/Bounce/SimpleMatch.pm
+++ b/fml/lib/Mail/Bounce/SimpleMatch.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: SimpleMatch.pm,v 1.17 2001/05/20 12:58:24 fukachan Exp $
+# $FML: SimpleMatch.pm,v 1.18 2001/05/20 13:20:55 fukachan Exp $
 #
 
 
@@ -22,8 +22,12 @@ Mail::Bounce::SimpleMatch - SimpleState error message format parser
 
 =head1 SYNOPSIS
 
+See C<Mail::Bounce> for more details.
+
 =head1 DESCRIPTION
 
+sub class used in C<Mail::Bounce>.
+
 =head1 SIMPLE STATE MACHINE
 
 Please write C<regexp> pattern to clarify the following states.
@@ -36,13 +40,8 @@ Please write C<regexp> pattern to clarify the following states.
 When we trap C<start>, the state changes from 0 to 1.
 When we trap C<end>,   the state changes from l to 0.
 
-=head1 METHODS
-
-=head2 C<new()>
-
 =cut
 
-
 my $debug = $ENV{'debug'} ? 1 : 0;
 
 my $address_trap_regexp = {
diff --git a/fml/lib/Mail/Delivery.pm b/fml/lib/Mail/Delivery.pm
index 2fdb4264..8b7c96fb 100644
--- a/fml/lib/Mail/Delivery.pm
+++ b/fml/lib/Mail/Delivery.pm
@@ -4,8 +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. 
 #
-# $Id$
-# $FML: Delivery.pm,v 1.1.1.1 2001/04/03 09:53:28 fukachan Exp $
+# $FML: Delivery.pm,v 1.2 2001/05/05 12:54:02 fukachan Exp $
 #
 
 package Mail::Delivery;
@@ -29,7 +28,6 @@ Mail::Delivery - mail delivery system interface
     };
     if ($service->error) { Log($service->error); return;}
 
-
     $map_params = {
 	'mysql:toymodel' => {
 	    getline        => "select ... ",
@@ -53,7 +51,8 @@ Mail::Delivery - mail delivery system interface
                       });
     if ($service->error) { Log($service->error); return;}
 
-Actually the real estate of this class is 
+This class provides the entrance for sub classes.
+Actually implementation of this class is 
 almost C<Mail::Delivery::SMTP> class.
 Please see it for more details.
 
diff --git a/fml/lib/Mail/Delivery/Net/INET6.pm b/fml/lib/Mail/Delivery/Net/INET6.pm
index b571795e..8c7c148c 100644
--- a/fml/lib/Mail/Delivery/Net/INET6.pm
+++ b/fml/lib/Mail/Delivery/Net/INET6.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: INET6.pm,v 1.2 2001/05/11 16:11:15 fukachan Exp $
+# $FML: INET6.pm,v 1.3 2001/05/25 04:45:40 fukachan Exp $
 #
 
 package Mail::Delivery::Net::INET6;
@@ -15,8 +15,8 @@ use Mail::Delivery::Utils;
 
 require Exporter;
 
-@ISA       = qw(Exporter);
-@EXPORT    = qw(is_ipv6_ready is_ipv6_mta_syntax connect6);
+@ISA     = qw(Exporter);
+@EXPORT  = qw(is_ipv6_ready is_ipv6_mta_syntax connect6);
 
 sub _we_can_use_Socket6
 {
diff --git a/fml/lib/Mail/Delivery/Queue.pm b/fml/lib/Mail/Delivery/Queue.pm
index 221a84b9..7ae63456 100644
--- a/fml/lib/Mail/Delivery/Queue.pm
+++ b/fml/lib/Mail/Delivery/Queue.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: Queue.pm,v 1.3 2001/05/18 10:39:29 fukachan Exp $
+# $FML: Queue.pm,v 1.4 2001/05/19 03:41:34 fukachan Exp $
 #
 
 package Mail::Delivery::Queue;
@@ -143,8 +143,8 @@ sub filename
 
 =head2 C<list()>
 
-return queue list array hash. 
-It is a list in C<active/> directory.
+return queue list as ARRAY REFERENCE.
+It is a list of queue filenames in C<active/> directory.
 
     $ra = $queue->list();
     for $qid (@$ra) {
@@ -176,10 +176,17 @@ sub list
 
 =head1 METHODS TO MANIPULATE INFORMATION
 
-=head2 C<getidinfo(id)>
+=head2 C<getidinfo($id)>
 
-=cut
+return information related with the queue id C<$id>.
+The returned information is
+
+	id         => $id,
+	path       => "$dir/active/$id",
+	sender     => $sender,
+	recipients => \@recipients,
 
+=cut
 
 sub getidinfo
 {
@@ -218,7 +225,6 @@ sub getidinfo
 }
 
 
-
 =head1 LOCK
 
 =head2 C<lock()>
@@ -295,6 +301,9 @@ sub in
    $queue->set('sender', $sender);
    $queue->set('recipients', [ $recipient0, $recipient1 ] );
 
+It sets up delivery information in C<info/sender/> and
+C<info/recipients/> directories.
+
 =cut
 
 sub set
@@ -331,15 +340,6 @@ This file is scheduled to be delivered.
 In fact, setrunnable() C<rename>s the queue id file from C<new/>
 directory to C<active/> directory like C<postfix> queue strategy.
 
-=head2 C<remove()>
-
-remove all queue assigned to this object C<$self>.
-
-=head2 C<valid()>
-
-It checks the queue file is broken or not.
-return 1 (valid) or 0.
-
 =cut
 
 
@@ -364,6 +364,19 @@ sub setrunnable
 }
 
 
+
+=head2 C<remove()>
+
+remove all queue assigned to this object C<$self>.
+
+=head2 C<valid()>
+
+It checks the queue file is broken or not.
+return 1 (valid) or 0.
+
+=cut
+
+
 sub remove
 {
     my ($self) = @_;