From 3e5b1084f52cd3870bbe0bfc5c8cf11500fd451e Mon Sep 17 00:00:00 2001 From: fukachan Date: Thu, 31 May 2001 11:02:32 +0000 Subject: clean up documents --- fml/lib/FML/Process/Configure.pm | 15 ++++++------- fml/lib/Mail/Bounce/SimpleMatch.pm | 11 +++++----- fml/lib/Mail/Delivery.pm | 7 +++---- fml/lib/Mail/Delivery/Net/INET6.pm | 6 +++--- fml/lib/Mail/Delivery/Queue.pm | 43 +++++++++++++++++++++++++------------- regress/simulation/todo/doc | 7 +------ 6 files changed, 48 insertions(+), 41 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 for each program flow. - -=head2 MODULES +FML::Process::Configure provides the main function for +C + and +C. These programs, C and C, @@ -44,6 +43,8 @@ bootstrap by using these modules in this order. libexec/loader -> FML::Process::Switch -> FML::Process::Configure +See C for the flow detail. + =head1 METHODS =head2 C 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 for more details. + =head1 DESCRIPTION +sub class used in C. + =head1 SIMPLE STATE MACHINE Please write C pattern to clarify the following states. @@ -36,13 +40,8 @@ Please write C pattern to clarify the following states. When we trap C, the state changes from 0 to 1. When we trap C, the state changes from l to 0. -=head1 METHODS - -=head2 C - =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 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 -return queue list array hash. -It is a list in C directory. +return queue list as ARRAY REFERENCE. +It is a list of queue filenames in C directory. $ra = $queue->list(); for $qid (@$ra) { @@ -176,10 +176,17 @@ sub list =head1 METHODS TO MANIPULATE INFORMATION -=head2 C +=head2 C -=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 @@ -295,6 +301,9 @@ sub in $queue->set('sender', $sender); $queue->set('recipients', [ $recipient0, $recipient1 ] ); +It sets up delivery information in C and +C directories. + =cut sub set @@ -331,15 +340,6 @@ This file is scheduled to be delivered. In fact, setrunnable() Cs the queue id file from C directory to C directory like C queue strategy. -=head2 C - -remove all queue assigned to this object C<$self>. - -=head2 C - -It checks the queue file is broken or not. -return 1 (valid) or 0. - =cut @@ -364,6 +364,19 @@ sub setrunnable } + +=head2 C + +remove all queue assigned to this object C<$self>. + +=head2 C + +It checks the queue file is broken or not. +return 1 (valid) or 0. + +=cut + + sub remove { my ($self) = @_; diff --git a/regress/simulation/todo/doc b/regress/simulation/todo/doc index 1036c513..a8a772bf 100644 --- a/regress/simulation/todo/doc +++ b/regress/simulation/todo/doc @@ -1,4 +1,4 @@ -$FML: doc,v 1.45 2001/05/30 04:03:22 fukachan Exp $ +$FML: doc,v 1.46 2001/05/30 14:35:12 fukachan Exp $ TODO for documents Last Modified: $Date$ @@ -6,17 +6,12 @@ $FML: doc,v 1.45 2001/05/30 04:03:22 fukachan Exp $ --------------- 2001/05 todo (document clean up) - FML/Process/Configure.pm FML/Process/Kernel.pm FML/Ticket/Model/minimal_states.pm File/Rotate.pm Language/Japanese/String.pm Language/Japanese/Subject.pm Language/Japanese/Utils.pm - Mail/Bounce/SimpleMatch.pm - Mail/Delivery.pm - Mail/Delivery/Net/INET6.pm - Mail/Delivery/Queue.pm Mail/Delivery/SMTP.pm Mail/Message.pm SQL/Schema/toymodel.pm -- cgit v1.2.1