clean up documents

2 files changed, 31 insertions, 18 deletions

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) = @_;