clean up documents

1 files changed, 63 insertions, 7 deletions

diff --git a/fml/lib/FML/Process/Command.pm b/fml/lib/FML/Process/Command.pm
index 804c171b..85cfb9c4 100644
--- a/fml/lib/FML/Process/Command.pm
+++ b/fml/lib/FML/Process/Command.pm
@@ -1,10 +1,10 @@
 #!/usr/local/bin/perl -w
 #-*- perl -*-
 #
-# Copyright (C) 2000 Ken'ichi Fukamachi
+# Copyright (C) 2000,2001 Ken'ichi Fukamachi
 #          All rights reserved. 
 #
-# $FML: Command.pm,v 1.8 2001/04/03 09:45:43 fukachan Exp $
+# $FML: Command.pm,v 1.9 2001/04/06 16:25:43 fukachan Exp $
 #
 
 package FML::Process::Command;
@@ -22,24 +22,38 @@ use FML::Config;
 
 =head1 NAME
 
-FML::Process::Command -- fml5 command wrapper.
+FML::Process::Command -- fml5 command dispacher.
 
 =head1 SYNOPSIS
 
    use FML::Process::Command;
    ...
 
-See L<FML::Process::Flow> for details of flow.
+See L<FML::Process::Flow> for details of fml process flow.
 
 =head1 DESCRIPTION
 
 C<FML::Process::Command> is a command wrapper and top level
-dispatcher.
-It kicks off C<FML::Command>->C<$command($curproc, $args)> for each
-C<$command>.
+dispatcher for commands.
+It kicks off corresponding 
+C<FML::Command>->C<$command($curproc,$args)> 
+for the given C<$command>.
+
+=head1 METHODS
+
+=head2 C<new($args)>
+
+make fml process object.
+
+    my $curproc = new FML::Process::Kernel $args;
+
+=head2 C<prepare($args)>
+
+forward the request to SUPER CLASS.
 
 =cut
 
+
 sub new
 {
     my ($self, $args) = @_;
@@ -56,6 +70,12 @@ sub prepare
 }
 
 
+=head2 C<verify_request($args)>
+
+verify the sender is a valid member or not.
+
+=cut
+
 sub verify_request
 {
     my ($curproc, $args) = @_;
@@ -63,6 +83,17 @@ sub verify_request
 }
 
 
+=head2 C<run($args)>
+
+dispatcher to run correspondig C<FML::Command::command> for
+C<command>.
+
+    lock
+    execute FML::Command::command
+    unlock
+
+=cut
+
 sub run
 {
     my ($curproc, $args) = @_;
@@ -81,6 +112,12 @@ sub run
 }
 
 
+=head2 C<finish($args)>
+
+    $curproc->inform_reply_messages();
+
+=cut
+
 sub finish
 {
     my ($curproc, $args) = @_;
@@ -128,4 +165,23 @@ sub _evaluate_command
 }
 
 
+=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::Command appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
+
+=cut
+
+
 1;