fix comments. cosmetic changes.

3 files changed, 21 insertions, 15 deletions

diff --git a/fml/lib/FML/Process/Distribute.pm b/fml/lib/FML/Process/Distribute.pm
index b4212a70..59c7b87d 100644
--- a/fml/lib/FML/Process/Distribute.pm
+++ b/fml/lib/FML/Process/Distribute.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Distribute.pm,v 1.100 2002/11/26 14:13:29 fukachan Exp $
+# $FML: Distribute.pm,v 1.101 2002/12/01 13:46:13 fukachan Exp $
 #
 
 package FML::Process::Distribute;
@@ -255,8 +255,8 @@ print <<"_EOF_";
 
 Usage: $0 \$ml_home_prefix/\$ml_name [options]
 
-   For example, distribute of elena ML
-   $0 /var/spool/ml/elena
+   For example, distribute of elena\@fml.org ML
+   $0 elena\@fml.org
 
 _EOF_
 }
@@ -375,6 +375,7 @@ sub _header_rewrite
     my $rules  = $config->{ article_header_rewrite_rules };
     my $id     = $args->{ id };
 
+    # XXX-TODO: use $config->get_as_array_ref()
     for my $rule (split(/\s+/, $rules)) {
 	Log("_header_rewrite( $rule )") if $config->yes('debug');
 
@@ -404,6 +405,7 @@ sub _deliver_article
     my $body    = $curproc->article_message_body();   # Mail::Message object
 
     unless ( $config->yes( 'use_article_delivery' ) ) {
+	Log("not delivery (\$use_article_delivery = no)");
 	return;
     }
 
@@ -418,6 +420,7 @@ sub _deliver_article
     my $sfp = sub { my ($s) = @_; print $s; print "\n" if $s !~ /\n$/o;};
     my $handle = undef;
 
+    # overload $sfp log function pointer.
     my $wh = $curproc->open_outgoing_message_channel();
     if (defined $wh) {
 	$sfp = sub { print $wh @_;};
@@ -511,6 +514,8 @@ sub htmlify
     my $article_id     = $pcb->get('article', 'id');
     my $article_file   = $article->filepath($article_id);
     my $index_order    = $config->{ html_archive_index_order_type };
+
+    # XXX-TODO: care for non Japanese.
     my $htmlifier_args = {
 	directory   => $html_dir,
 	charset     => 'euc-jp',
diff --git a/fml/lib/FML/Process/Kernel.pm b/fml/lib/FML/Process/Kernel.pm
index 47fd0e56..30a8c9c7 100644
--- a/fml/lib/FML/Process/Kernel.pm
+++ b/fml/lib/FML/Process/Kernel.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: Kernel.pm,v 1.145 2002/12/10 12:00:50 fukachan Exp $
+# $FML: Kernel.pm,v 1.146 2002/12/23 14:51:03 fukachan Exp $
 #
 
 package FML::Process::Kernel;
@@ -925,7 +925,7 @@ The restriction rules follows the order of C<command_restrictions>.
 
 # Descriptions: permit this post process
 #    Arguments: OBJ($self) HASH_REF($args)
-# Side Effects: none
+# Side Effects: set the error reason at "check_restriction" in pcb.
 # Return Value: NUM(1 or 0)
 sub permit_post
 {
@@ -936,7 +936,7 @@ sub permit_post
 
 # Descriptions: permit this command process
 #    Arguments: OBJ($self) HASH_REF($args)
-# Side Effects: none
+# Side Effects: set the error reason at "check_restriction" in pcb.
 # Return Value: NUM(1 or 0)
 sub permit_command
 {
@@ -948,7 +948,7 @@ sub permit_command
 # Descriptions: permit this $type process based on the rules defined
 #               in ${type}_restrictions.
 #    Arguments: OBJ($self) HASH_REF($args) STR($type)
-# Side Effects: none
+# Side Effects: set the error reason at "check_restriction" n pcb.
 # Return Value: NUM(1 or 0)
 sub _check_restrictions
 {
diff --git a/fml/lib/FML/Process/ThreadTrack.pm b/fml/lib/FML/Process/ThreadTrack.pm
index 05fd2359..b08a0167 100644
--- a/fml/lib/FML/Process/ThreadTrack.pm
+++ b/fml/lib/FML/Process/ThreadTrack.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2001,2002 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: ThreadTrack.pm,v 1.35 2002/10/28 09:58:12 tmu Exp $
+# $FML: ThreadTrack.pm,v 1.36 2002/12/22 03:46:20 fukachan Exp $
 #
 
 package FML::Process::ThreadTrack;
@@ -205,10 +205,10 @@ sub run
 }
 
 
-# Descriptions:
+# Descriptions: speculate the last id our thread system processed.
 #    Arguments: OBJ($curproc) OBJ($thread)
 # Side Effects: none
-# Return Value: none
+# Return Value: NUM
 sub _speculate_last_id
 {
     my ($curproc, $thread) = @_;
@@ -231,7 +231,7 @@ sub _speculate_last_id
 
     # The condition "$sf_last_modified < $db_last_modified" is always
     # true since FML::Process::Distribute updates the thread db after
-    # updaiteing $seq_file.
+    # updating $seq_file.
     # XXX 3600 is the magic number. How long time is appropriate ?
     if (-f $seq_file &&
 	($sf_last_modified + 3600 > $db_last_modified)) {
@@ -267,7 +267,7 @@ sub _speculate_last_id
 }
 
 
-# Descriptions: speculate maximum sequence number for ML article
+# Descriptions: speculate the maximum sequence number for ML articles.
 #    Arguments: OBJ($curproc) STR($spool_dir)
 # Side Effects: none
 # Return Value: NUM
@@ -353,7 +353,9 @@ sub _close
 
     for my $id (@$ra) {
 	# e.g. 100 -> elena/100
-	if ($id =~ /^\d+$/) { $id = $thread->_create_thread_id_strings($id);}
+	if ($id =~ /^\d+$/) { 
+	    $id = $thread->_create_thread_id_strings($id);
+	}
 
 	# check "elena/100" exists ?
 	if ($thread->exist($id)) {
@@ -391,8 +393,7 @@ _EOF_
 }
 
 
-# Descriptions: clean up in the end of the curreen process.
-#               return error messages et. al.
+# Descriptions: dummy.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: queue flush
 # Return Value: none