fix comments

10 files changed, 59 insertions, 54 deletions

diff --git a/fml/lib/FML/Process/Addr.pm b/fml/lib/FML/Process/Addr.pm
index 680a3af2..a10d9890 100644
--- a/fml/lib/FML/Process/Addr.pm
+++ b/fml/lib/FML/Process/Addr.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2001,2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Addr.pm,v 1.17 2004/01/31 04:06:31 fukachan Exp $
+# $FML: Addr.pm,v 1.18 2004/04/23 04:10:35 fukachan Exp $
 #
 
 package FML::Process::Addr;
@@ -54,7 +54,7 @@ dummy.
 =cut
 
 
-# Descriptions: ordinary constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: OBJ
@@ -173,7 +173,7 @@ show help.
 =cut
 
 
-# Descriptions: show help
+# Descriptions: show help.
 #    Arguments: none
 # Side Effects: none
 # Return Value: none
@@ -236,7 +236,7 @@ sub _fmladdr
     my $list = $sys->get_user_list();
 
     for my $user (keys %$list) {
-	# which definition survives ? alias > user ?
+	# hmm, user is important than alias ? or not ?
 	unless (defined $aliases->{ $user }) {
 	    $aliases->{ $user } = "$user (LOCAL USER)";
 	}
diff --git a/fml/lib/FML/Process/Alias.pm b/fml/lib/FML/Process/Alias.pm
index e8638f3b..4f95ac31 100644
--- a/fml/lib/FML/Process/Alias.pm
+++ b/fml/lib/FML/Process/Alias.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2001,2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Alias.pm,v 1.18 2004/01/31 04:06:31 fukachan Exp $
+# $FML: Alias.pm,v 1.19 2004/04/23 04:10:35 fukachan Exp $
 #
 
 package FML::Process::Alias;
@@ -54,7 +54,7 @@ dummy.
 =cut
 
 
-# Descriptions: ordinary constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: OBJ
diff --git a/fml/lib/FML/Process/Calendar.pm b/fml/lib/FML/Process/Calendar.pm
index 7aa98836..55605a33 100644
--- a/fml/lib/FML/Process/Calendar.pm
+++ b/fml/lib/FML/Process/Calendar.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Calendar.pm,v 1.12 2004/01/31 04:06:31 fukachan Exp $
+# $FML: Calendar.pm,v 1.13 2004/02/15 04:38:33 fukachan Exp $
 #
 
 package FML::Process::Calendar;
@@ -17,7 +17,7 @@ use FML::Process::Kernel;
 
 =head1 NAME
 
-FML::Process::Calendar -- demonstration of FML module usage
+FML::Process::Calendar -- demonstration of FML module usage.
 
 =head1 SYNOPSIS
 
@@ -35,7 +35,7 @@ scheduler based on Calendar::Lite class.
 
 =head2 new($args)
 
-standard constructor.
+constructor.
 
 =head2 prepare($args)
 
@@ -60,7 +60,7 @@ dummy.
 =cut
 
 
-# Descriptions: dummy constructor.
+# Descriptions: constructor.
 #               avoid the default fml new() since we do not need it.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
@@ -92,14 +92,14 @@ sub prepare
 }
 
 
-# Descriptions: dummy
+# Descriptions: dummy.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
 sub verify_request { 1; }
 
 
-# Descriptions: dummy
+# Descriptions: dummy.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -187,7 +187,7 @@ sub run
 
 
 
-# Descriptions: show help
+# Descriptions: show help.
 #    Arguments: OBJ($curproc)
 # Side Effects: none
 # Return Value: none
diff --git a/fml/lib/FML/Process/ConfViewer.pm b/fml/lib/FML/Process/ConfViewer.pm
index 19357a63..0e383382 100644
--- a/fml/lib/FML/Process/ConfViewer.pm
+++ b/fml/lib/FML/Process/ConfViewer.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2000,2001,2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: ConfViewer.pm,v 1.29 2004/01/31 04:06:32 fukachan Exp $
+# $FML: ConfViewer.pm,v 1.30 2004/04/23 04:10:36 fukachan Exp $
 #
 
 package FML::Process::ConfViewer;
@@ -16,7 +16,7 @@ use FML::Process::Kernel;
 
 =head1 NAME
 
-FML::Process::ConfViewer -- show configuration variables
+FML::Process::ConfViewer -- show configuration variables.
 
 =head1 SYNOPSIS
 
@@ -34,7 +34,7 @@ FML::Process::ConfViewer provides the main function for C<fmlconf>.
 
 =head2 new($args)
 
-ordinary constructor.
+constructor.
 It make a C<FML::Process::Kernel> object and return it.
 
 =head2 prepare($args)
@@ -48,7 +48,7 @@ show help unless @ARGV.
 =cut
 
 
-# Descriptions: ordinary constructor
+# Descriptions: constructor
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: FML::Process::ConfViewer object
@@ -125,7 +125,7 @@ the top level dispatcher for C<fmlconf>.
 =cut
 
 
-# Descriptions: just a switch, call _fmlconf()
+# Descriptions: just a switch, call _fmlconf().
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -157,7 +157,7 @@ show help.
 =cut
 
 
-# Descriptions: show help
+# Descriptions: show help.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
diff --git a/fml/lib/FML/Process/Configure.pm b/fml/lib/FML/Process/Configure.pm
index 4a465ec0..b4214b0c 100644
--- a/fml/lib/FML/Process/Configure.pm
+++ b/fml/lib/FML/Process/Configure.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2001,2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Configure.pm,v 1.64 2004/03/13 11:46:32 fukachan Exp $
+# $FML: Configure.pm,v 1.65 2004/04/23 04:10:36 fukachan Exp $
 #
 
 package FML::Process::Configure;
@@ -19,7 +19,7 @@ use FML::Process::Kernel;
 
 =head1 NAME
 
-FML::Process::Configure -- makefml main functions
+FML::Process::Configure -- makefml main functions.
 
 =head1 SYNOPSIS
 
@@ -140,7 +140,8 @@ sub run
 }
 
 
-# Descriptions: dummy.
+# Descriptions: send if --allow-send-message or --allow-reply-message
+#               option specified.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -234,7 +235,7 @@ _EOF_
 }
 
 
-# Descriptions: show help usage
+# Descriptions: show help usage.
 #    Arguments: STR($name)
 # Side Effects: none
 # Return Value: none
@@ -260,7 +261,7 @@ _EOF_
 =head2 _makefml($args)
 
 switch of C<makefml> command.
-It kicks off <FML::Command::$command> corrsponding with
+It kicks off <FML::Command::$command> corresponding with
 C<@$argv> ( $argv = $args->{ ARGV } ).
 
 C<Caution:>
diff --git a/fml/lib/FML/Process/Debug.pm b/fml/lib/FML/Process/Debug.pm
index 59abe83a..b40dd283 100644
--- a/fml/lib/FML/Process/Debug.pm
+++ b/fml/lib/FML/Process/Debug.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: Debug.pm,v 1.8 2004/01/04 13:19:10 fukachan Exp $
+# $FML: Debug.pm,v 1.9 2004/04/27 12:54:50 fukachan Exp $
 #
 
 package FML::Process::Debug;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Process::Debug - debug tool / tiny FML::Process emulator
+FML::Process::Debug - debug tool / tiny FML::Process emulator.
 
 =head1 SYNOPSIS
 
diff --git a/fml/lib/FML/Process/DocViewer.pm b/fml/lib/FML/Process/DocViewer.pm
index efa90eab..0b1164b7 100644
--- a/fml/lib/FML/Process/DocViewer.pm
+++ b/fml/lib/FML/Process/DocViewer.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2000,2001,2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: DocViewer.pm,v 1.31 2004/01/31 04:06:32 fukachan Exp $
+# $FML: DocViewer.pm,v 1.32 2004/04/23 04:10:36 fukachan Exp $
 #
 
 package FML::Process::DocViewer;
@@ -19,7 +19,7 @@ use FML::Process::Kernel;
 
 =head1 NAME
 
-FML::Process::DocViewer -- perldoc wrapper to show a fml module
+FML::Process::DocViewer -- perldoc wrapper to show a fml module.
 
 =head1 SYNOPSIS
 
@@ -40,7 +40,7 @@ See C<FML::Process::Flow> for the program flow.
 
 =head2 new($args)
 
-standard constructor.
+constructor.
 It inherits C<FML::Process::Kernel>.
 
 =head2 prepare($args)
@@ -54,7 +54,7 @@ show help unless @ARGV.
 =cut
 
 
-# Descriptions: constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: FML::Process::DocViewer object
@@ -88,7 +88,7 @@ sub prepare
 }
 
 
-# Descriptions: check @ARGV and show help if needed
+# Descriptions: check @ARGV and show help if needed.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: may exit.
 #               longjmp() to help() if appropriate.
@@ -131,16 +131,16 @@ sub run
 }
 
 
-# Descriptions: fmldoc wrapper / top level dispacher
+# Descriptions: fmldoc wrapper / top level dispacher.
 #    Arguments: OBJ($curproc)
 # Side Effects: none
 # Return Value: none
 sub _fmldoc
 {
     my ($curproc) = @_;
-    my $config = $curproc->config();
-    my $myname = $curproc->myname();
-    my $argv   = $curproc->command_line_argv();
+    my $config    = $curproc->config();
+    my $myname    = $curproc->myname();
+    my $argv      = $curproc->command_line_argv();
 
     my $eval = $config->get_hook( 'fmldoc_run_start_hook' );
     if ($eval) { eval qq{ $eval; }; $curproc->logwarn($@) if $@; }
@@ -173,7 +173,7 @@ show help.
 =cut
 
 
-# Descriptions: show help
+# Descriptions: show help.
 #    Arguments: none
 # Side Effects: none
 # Return Value: none
diff --git a/fml/lib/FML/Process/Flow.pm b/fml/lib/FML/Process/Flow.pm
index 28934412..66f98f91 100644
--- a/fml/lib/FML/Process/Flow.pm
+++ b/fml/lib/FML/Process/Flow.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: Flow.pm,v 1.25 2004/01/04 03:25:09 fukachan Exp $
+# $FML: Flow.pm,v 1.26 2004/05/25 03:35:16 fukachan Exp $
 #
 
 package FML::Process::Flow;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Process::Flow - the process flow
+FML::Process::Flow - the process flow.
 
 =head1 SYNOPSIS
 
@@ -34,7 +34,7 @@ programs kicked by MTA, command line interfaces and CGI's.
     # create a new process object
     my $process = $pkg->new($args);
 
-    # XXX private method to show help ASAP
+    # XXX private method to show help ASAP.
     # XXX we need to trap here since $process object is clarified after
     # XXX $pkg->new() above.
     $process->_trap_help($args);
@@ -60,11 +60,11 @@ programs kicked by MTA, command line interfaces and CGI's.
 
 
 # Descriptions: drive top level process flow
-#               1. initialize processes and load configurations from *.cf
+#               1. initialize processes and load configurations from *.cf,
 #                  switch to each process according with $0 and @ARGV.
-#               2. parse the incoming message(mail)
-#               3. start the main transaction
-#                  lock, execute main routine, unlock
+#               2. parse the incoming message(mail).
+#               3. start the main transaction.
+#                  lock, execute main routine, unlock, ...
 #               4. inform error messages, clean up and more ...
 #    Arguments: OBJ($pkg) HASH_REF($args)
 # Side Effects: ProcessSwtich() is exported to main:: Name Space.
diff --git a/fml/lib/FML/Process/Obsolete.pm b/fml/lib/FML/Process/Obsolete.pm
index a4e94ebe..26278c6d 100644
--- a/fml/lib/FML/Process/Obsolete.pm
+++ b/fml/lib/FML/Process/Obsolete.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: Obsolete.pm,v 1.4 2004/01/02 14:42:44 fukachan Exp $
+# $FML: Obsolete.pm,v 1.5 2004/01/02 16:08:39 fukachan Exp $
 #
 
 package FML::Process::Obsolete;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Process::Obsolete - show obsolete message (for obsolete module)
+FML::Process::Obsolete - show obsolete message (for obsolete module).
 
 =head1 SYNOPSIS
 
@@ -45,7 +45,7 @@ sub new
 }
 
 
-# Descriptions: show help.
+# Descriptions: show message "this command is obsolete".
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
diff --git a/fml/lib/FML/Process/State.pm b/fml/lib/FML/Process/State.pm
index f38717dd..73705b2a 100644
--- a/fml/lib/FML/Process/State.pm
+++ b/fml/lib/FML/Process/State.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: State.pm,v 1.11 2004/06/24 10:40:25 fukachan Exp $
+# $FML: State.pm,v 1.12 2004/06/25 05:09:09 fukachan Exp $
 #
 
 package FML::Process::State;
@@ -17,7 +17,7 @@ my $debug = 0;
 
 =head1 NAME
 
-FML::Process::State - interface to handle states within this process
+FML::Process::State - interface to handle states within current process.
 
 =head1 SYNOPSIS
 
@@ -171,7 +171,7 @@ sub restriction_state_reply_reason
 =cut
 
 
-# Descriptions: get the current article id on this process.
+# Descriptions: set the current article id on current process.
 #    Arguments: OBJ($curproc) NUM($id)
 # Side Effects: update pcb.
 # Return Value: NUM
@@ -184,7 +184,7 @@ sub set_article_id
 }
 
 
-# Descriptions: get the current article id on this process.
+# Descriptions: get the current article id on current process.
 #    Arguments: OBJ($curproc)
 # Side Effects: none
 # Return Value: NUM
@@ -301,15 +301,15 @@ sub _build_command_context_template
 sub _command_string_clean_up
 {
     my ($curproc, $buf) = @_;
-    my $config         = $curproc->config();
-    my $confirm_prefix = $config->{ confirm_command_prefix };
+    my $config          = $curproc->config();
+    my $confirm_prefix  = $config->{ confirm_command_prefix };
 
     $buf =~ s/^\W+$confirm_prefix/$confirm_prefix/;
     return $buf;
 }
 
 
-# Descriptions: declare the current $ml_name.
+# Descriptions: set the current $ml_name.
 #    Arguments: OBJ($curproc) STR($ml_name)
 # Side Effects: update pcb.
 # Return Value: STR
@@ -399,6 +399,7 @@ sub command_context_set_need_confirm
     my ($curproc) = @_;
     my $pcb = $curproc->pcb();
 
+    # XXX-TODO: correct ? this flag is universal over plural ML's.
     $pcb->set("process_command", "need_confirm", 1);
 }
 
@@ -414,11 +415,13 @@ sub command_context_get_need_confirm
     my ($curproc) = @_;
     my $pcb = $curproc->pcb();
 
+    # XXX-TODO: correct ? this flag is universal over plural ML's.
     return( $pcb->get("process_command", "need_confirm") || 0 );
 }
 
 
-# Descriptions: remote administrator is authenticated.
+# Descriptions: remote administrator is authenticated. 
+#               state is ml specific.
 #    Arguments: OBJ($curproc)
 # Side Effects: update pcb.
 # Return Value: NUM
@@ -434,6 +437,7 @@ sub command_context_set_admin_auth
 
 
 # Descriptions: check if remote administrator is authenticated.
+#               state is ml specific.
 #    Arguments: OBJ($curproc)
 # Side Effects: none
 # Return Value: NUM