clean up doc

1 files changed, 39 insertions, 19 deletions

diff --git a/fml/lib/FML/Process/Flow.pm b/fml/lib/FML/Process/Flow.pm
index d88d11d0..fc72abcc 100644
--- a/fml/lib/FML/Process/Flow.pm
+++ b/fml/lib/FML/Process/Flow.pm
@@ -15,39 +15,40 @@ use Carp;
 
 =head1 NAME
 
-FML::Process::Flow - what is this
+FML::Process::Flow - describe process flow 
 
 =head1 SYNOPSIS
 
-=head1 DESCRIPTION
-
-=head1 CLASSES
-
-=head1 METHODS
+   use FML::Process::Flow;
+   FML::Process::Flow::ProcessStart($pkg, $args);
 
-=item C<new()>
+where C<$pkg> is the package name.
+C<$args> is HASH REFERENCE.
 
-... what is this ...
-
-=head1 AUTHOR
+=head1 DESCRIPTION
 
-Ken'ichi Fukamachi
+This is the current fml program flow. 
+Each function is implemented in each module in FML::Process class.
 
-=head1 COPYRIGHT
+    # create a new process object
+    my $process = $pkg->new($args);
 
-Copyright (C) 2001 Ken'ichi Fukamachi
+    # e.g. parse the incoming message (e.g. STDIN)
+    $process->prepare($args);
 
-All rights reserved. This program is free software; you can
-redistribute it and/or modify it under the same terms as Perl itself. 
+    # validate the request, for example,
+    #    permit post from the sender,
+    #    check the mail loop or not ...
+    $process->verify_request($args);
 
-=head1 HISTORY
+    # start main transaction
+    $process->run($args);
 
-FML::Process::Flow appeared in fml5 mailing list driver package.
-See C<http://www.fml.org/> for more details.
+    # closing the process
+    $process->finish($args);
 
 =cut
 
-
 # Descriptions: drives basic flow 
 #               1. initialize processes and load configurations from *.cf
 #                  switch to each process according with $0 and @ARGV.
@@ -82,4 +83,23 @@ sub ProcessStart
 }
 
 
+=head1 AUTHOR
+
+Ken'ichi Fukamachi
+
+=head1 COPYRIGHT
+
+Copyright (C) 2001 Ken'ichi Fukamachi
+
+All rights reserved. This program is free software; you can
+redistribute it and/or modify it under the same terms as Perl itself. 
+
+=head1 HISTORY
+
+FML::Process::Flow appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
+
+=cut
+
+
 1;