fix comments

19 files changed, 98 insertions, 90 deletions

diff --git a/fml/lib/FML/Article/Summary.pm b/fml/lib/FML/Article/Summary.pm
index 18865fc6..0e239cc8 100644
--- a/fml/lib/FML/Article/Summary.pm
+++ b/fml/lib/FML/Article/Summary.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: Summary.pm,v 1.20 2004/03/04 10:18:40 fukachan Exp $
+# $FML: Summary.pm,v 1.21 2004/04/23 04:10:26 fukachan Exp $
 #
 
 package FML::Article::Summary;
@@ -15,7 +15,7 @@ use Mail::Message::Date;
 
 =head1 NAME
 
-FML::Article::Summary - generate article summary
+FML::Article::Summary - generate article summary.
 
 =head1 SYNOPSIS
 
@@ -25,12 +25,12 @@ FML::Article::Summary - generate article summary
 
 =head2 new()
 
-standard constructor.
+constructor.
 
 =cut
 
 
-# Descriptions: standard constructor.
+# Descriptions: constructor.
 #    Arguments: OBJ($self) OBJ($curproc)
 # Side Effects: $self->{ _curproc } = $curproc;
 # Return Value: OBJ
@@ -46,9 +46,9 @@ sub new
 }
 
 
-# Descriptions: append summary to $article_summary_file
+# Descriptions: append summary to $article_summary_file.
 #    Arguments: OBJ($self) HANDLE($wh) NUM($id)
-# Side Effects: append summary to $article_summary_file
+# Side Effects: update $article_summary_file file.
 # Return Value: none
 sub print
 {
diff --git a/fml/lib/FML/Command/Admin/mergeml.pm b/fml/lib/FML/Command/Admin/mergeml.pm
index 7a9dc739..7e39e325 100644
--- a/fml/lib/FML/Command/Admin/mergeml.pm
+++ b/fml/lib/FML/Command/Admin/mergeml.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: merge.pm,v 1.3 2004/03/17 06:06:42 fukachan Exp $
+# $FML: mergeml.pm,v 1.1 2004/03/18 10:20:28 fukachan Exp $
 #
 
 package FML::Command::Admin::mergeml;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::mergeml - top level dispather of configuration merge
+FML::Command::Admin::mergeml - top level dispather of configuration merge.
 
 =head1 SYNOPSIS
 
@@ -27,7 +27,7 @@ FML::Command::Admin::mergeml - top level dispather of configuration merge
 =cut
 
 
-# Descriptions: standard constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
@@ -40,7 +40,7 @@ sub new
 }
 
 
-# Descriptions: not need lock in the first time
+# Descriptions: not need lock in the first time.
 #    Arguments: none
 # Side Effects: none
 # Return Value: NUM( 1 or 0)
@@ -67,12 +67,12 @@ sub process
     my $owner          = $config->{ newml_command_ml_admin_default_address }||
 			 $curproc->fml_owner();
     my $params         = {
-	ml_name     => $ml_name,
-	ml_domain   => $ml_domain,
-	ml_home_dir => $ml_home_dir,
+	ml_name        => $ml_name,
+	ml_domain      => $ml_domain,
+	ml_home_dir    => $ml_home_dir,
 
 	# old ml_home_dir path (e.g. /var/spool/ml/elena).
-	src_dir     => $src_dir,
+	src_dir        => $src_dir,
     };
 
 
diff --git a/fml/lib/FML/Credential.pm b/fml/lib/FML/Credential.pm
index 9f34cb4e..7380c640 100644
--- a/fml/lib/FML/Credential.pm
+++ b/fml/lib/FML/Credential.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: Credential.pm,v 1.58 2004/03/18 13:26:47 fukachan Exp $
+# $FML: Credential.pm,v 1.59 2004/04/27 13:28:06 fukachan Exp $
 #
 
 package FML::Credential;
@@ -22,7 +22,7 @@ my $debug = 0;
 
 =head1 NAME
 
-FML::Credential - functions to authenticate the mail sender
+FML::Credential - functions to authenticate the mail sender.
 
 =head1 SYNOPSIS
 
@@ -35,7 +35,7 @@ FML::Credential - functions to authenticate the mail sender
 =head1 DESCRIPTION
 
 a collection of utilitity functions to authenticate the sender of the
-message which kicks off this proces
+message which kicks off this proces.
 
 =head2 User credential information
 
diff --git a/fml/lib/FML/Crypt.pm b/fml/lib/FML/Crypt.pm
index 54169d7b..d17ade3f 100644
--- a/fml/lib/FML/Crypt.pm
+++ b/fml/lib/FML/Crypt.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: Crypt.pm,v 1.4 2003/08/23 04:35:27 fukachan Exp $
+# $FML: Crypt.pm,v 1.5 2004/01/02 16:08:37 fukachan Exp $
 #
 
 package FML::Crypt;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Crypt - raw level crypt library wrapper
+FML::Crypt - raw level crypt library wrapper.
 
 =head1 SYNOPSIS
 
@@ -53,7 +53,7 @@ sub new
 # XXX-TODO: $str = FML::String; $str->unix_crypt(); ???
 
 
-# Descriptions: unix crypt(3).
+# Descriptions: raw level unix crypt(3) interface.
 #    Arguments: OBJ($self) STR($text) STR($salt)
 # Side Effects: none
 # Return Value: STR
diff --git a/fml/lib/FML/Mailer.pm b/fml/lib/FML/Mailer.pm
index ef83f623..dfb14d3d 100644
--- a/fml/lib/FML/Mailer.pm
+++ b/fml/lib/FML/Mailer.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: Mailer.pm,v 1.27 2004/04/23 04:10:27 fukachan Exp $
+# $FML: Mailer.pm,v 1.28 2004/05/18 00:37:32 fukachan Exp $
 #
 
 package FML::Mailer;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Mailer - utilities to send mails
+FML::Mailer - utilities for sending mails.
 
 =head1 SYNOPSIS
 
@@ -54,12 +54,12 @@ This module sends Mail::Message object(s).
 
 =head2 new()
 
-standard constructor.
+constructor.
 
 =cut
 
 
-# Descriptions: standard constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($self) OBJ($curproc)
 # Side Effects: none
 # Return Value: OBJ
diff --git a/fml/lib/FML/Parse.pm b/fml/lib/FML/Parse.pm
index 0e4972fd..505e3cd9 100644
--- a/fml/lib/FML/Parse.pm
+++ b/fml/lib/FML/Parse.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: Parse.pm,v 1.32 2004/04/23 04:10:27 fukachan Exp $
+# $FML: Parse.pm,v 1.33 2004/04/23 04:15:57 fukachan Exp $
 #
 
 package FML::Parse;
@@ -18,7 +18,7 @@ use FML::Config;
 
 =head1 NAME
 
-FML::Parse - parse the incoming message
+FML::Parse - parse the incoming message.
 
 =head1 SYNOPSIS
 
@@ -28,7 +28,7 @@ FML::Parse - parse the incoming message
 
 FML::Parse parses the incoming message. C<new()> analyses the data
 injected from STDIN channel, by default, and split it to a set of mail
-header and body.  C<new()> returns a C<Mail::Message> object.
+header and body.  C<new()> returns a C<Mail::Message> object chain.
 
 =head1 METHODS
 
@@ -40,7 +40,7 @@ Normally C<$fd> is the handle for STDIN channel.
 =cut
 
 
-# Descriptions: parse message read from file handle $fd
+# Descriptions: parse message read from file handle $fd.
 #    Arguments: OBJ($self) OBJ($curproc) HANDLE($fd)
 # Side Effects: none
 # Return Value: OBJ
@@ -54,7 +54,7 @@ sub new
 }
 
 
-# Descriptions: parse message read from file handle $fd
+# Descriptions: parse message read from file handle $fd.
 #    Arguments: OBJ($self) OBJ($curproc) HANDLE($fd)
 # Side Effects: none
 # Return Value: OBJ
@@ -73,6 +73,7 @@ sub _parse
     my $body_size   = $msg->whole_message_body_size();
     $curproc->log("read header=$header_size body=$body_size");
 
+    # XXX-TODO: use $curproc->XXX_set_envelope_sender($address).
     if (defined $msg->envelope_sender()) {
 	my $pcb = $curproc->pcb();
 	if (defined $pcb) {
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
diff --git a/fml/lib/FML/Sys/Alias.pm b/fml/lib/FML/Sys/Alias.pm
index 25dfefcb..961327dc 100644
--- a/fml/lib/FML/Sys/Alias.pm
+++ b/fml/lib/FML/Sys/Alias.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: Alias.pm,v 1.1 2003/03/11 09:10:18 fukachan Exp $
+# $FML: Alias.pm,v 1.2 2003/08/23 04:35:41 fukachan Exp $
 #
 
 package FML::Sys::Alias;
@@ -18,7 +18,7 @@ my $debug = 0;
 
 =head1 NAME
 
-FML::Sys::Alias - get mail alias infomation on this system
+FML::Sys::Alias - get mail alias infomation on this system.
 
 =head1 SYNOPSIS
 
@@ -97,7 +97,7 @@ sub add_key
 }
 
 
-# Descriptions: expand $key
+# Descriptions: expand $key.
 #    Arguments: OBJ($self) STR($key)
 # Side Effects: none
 # Return Value: ARRAY_REF
diff --git a/fml/lib/FML/Sys/User.pm b/fml/lib/FML/Sys/User.pm
index a02606b6..7f5a58f2 100644
--- a/fml/lib/FML/Sys/User.pm
+++ b/fml/lib/FML/Sys/User.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: User.pm,v 1.1 2003/03/06 09:26:28 fukachan Exp $
+# $FML: User.pm,v 1.2 2003/08/23 04:35:42 fukachan Exp $
 #
 
 package FML::Sys::User;
@@ -16,7 +16,7 @@ use Config;
 
 =head1 NAME
 
-FML::Sys::User - get user infomation on this system
+FML::Sys::User - get user infomation on this system.
 
 =head1 SYNOPSIS
 
diff --git a/fml/lib/FML/User/DB.pm b/fml/lib/FML/User/DB.pm
index cac21b72..d98c1a64 100644
--- a/fml/lib/FML/User/DB.pm
+++ b/fml/lib/FML/User/DB.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: DB.pm,v 1.5 2004/01/21 03:55:12 fukachan Exp $
+# $FML: DB.pm,v 1.6 2004/04/27 13:30:51 fukachan Exp $
 #
 
 package FML::User::DB;
@@ -24,7 +24,7 @@ my $default_expire_period = 30*24*3600;
 
 =head1 NAME
 
-FML::User::DB - maintain data with expiration.
+FML::User::DB - maintain user database with expiration.
 
 =head1 SYNOPSIS
 
@@ -43,6 +43,8 @@ FML::User::DB - maintain data with expiration.
 
 =head2 C<new()>
 
+constructor.
+
 =cut