fix comments.

4 files changed, 31 insertions, 28 deletions

diff --git a/fml/lib/FML/Header.pm b/fml/lib/FML/Header.pm
index 42014118..f1071ee8 100644
--- a/fml/lib/FML/Header.pm
+++ b/fml/lib/FML/Header.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: Header.pm,v 1.67 2004/01/02 14:50:28 fukachan Exp $
+# $FML: Header.pm,v 1.68 2004/01/21 03:49:14 fukachan Exp $
 #
 
 package FML::Header;
@@ -93,7 +93,7 @@ alias of C<Mail::Header::set($key, $value)>.
 =cut
 
 
-# Descriptions: get() wrapper to remove \n$
+# Descriptions: get() wrapper to remove \n$.
 #    Arguments: OBJ($self) ARRAY(@x)
 # Side Effects: none
 # Return Value: STR
@@ -108,7 +108,7 @@ sub get
 }
 
 
-# Descriptions: set() wrapper
+# Descriptions: set() wrapper.
 #    Arguments: OBJ($self) ARRAY(@x)
 # Side Effects: none
 # Return Value: none
@@ -408,7 +408,7 @@ replace original C<Received:> to C<X-Received:>.
 =cut
 
 
-# Descriptions: rewrite subject if needed
+# Descriptions: rewrite subject if needed.
 #    Arguments: OBJ($header) OBJ($config) HASH_REF($rw_args)
 # Side Effects: update $header
 # Return Value: none
@@ -630,7 +630,7 @@ sub check_message_id
 }
 
 
-# Descriptions: check X-ML-Info: duplication against mail loop
+# Descriptions: check X-ML-Info: duplication against mail loop.
 #    Arguments: OBJ($header) OBJ($config) HASH_REF($rw_args)
 # Side Effects: none
 # Return Value: 1 or 0
@@ -649,7 +649,7 @@ sub check_x_ml_info
 }
 
 
-# Descriptions: check mail loop by List-Post: field
+# Descriptions: check mail loop by List-Post: field.
 #    Arguments: OBJ($header) OBJ($config) HASH_REF($rw_args)
 # Side Effects: none
 # Return Value: 1 or 0
diff --git a/fml/lib/FML/Header/MessageID.pm b/fml/lib/FML/Header/MessageID.pm
index 61a9b9c5..e61952b2 100644
--- a/fml/lib/FML/Header/MessageID.pm
+++ b/fml/lib/FML/Header/MessageID.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: MessageID.pm,v 1.19 2004/01/02 09:42:34 fukachan Exp $
+# $FML: MessageID.pm,v 1.20 2004/01/02 14:50:31 fukachan Exp $
 #
 
 package FML::Header::MessageID;
@@ -44,7 +44,7 @@ standard constructor.
 =cut
 
 
-# Descriptions: standard constructor
+# Descriptions: standard constructor.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: OBJ
@@ -68,12 +68,12 @@ open db and return HASH_REF for the db access.
 
 # Descriptions: open message-id database
 #    Arguments: OBJ($self) HASH_REF($db_args)
-# Side Effects: none
+# Side Effects: open database.
 # Return Value: HASH_ERF
 sub db_open
 {
     my ($self, $db_args) = @_;
-    my $dir  = $db_args->{ 'directory' };
+    my $dir  = $db_args->{ 'directory' } || '';
     my $mode = 'temporal';
     my $days = 14;
 
@@ -119,7 +119,7 @@ set value for the key $key in message-id database.
 =cut
 
 
-# Descriptions: get value for $key
+# Descriptions: get value for $key.
 #    Arguments: OBJ($self) STR($key)
 # Side Effects: none
 # Return Value: STR
@@ -137,7 +137,7 @@ sub get
 }
 
 
-# Descriptions: set value for $key
+# Descriptions: set value for $key.
 #    Arguments: OBJ($self) STR($key) STR($value)
 # Side Effects: none
 # Return Value: STR
diff --git a/fml/lib/FML/Header/Subject.pm b/fml/lib/FML/Header/Subject.pm
index a55f9789..83769ad6 100644
--- a/fml/lib/FML/Header/Subject.pm
+++ b/fml/lib/FML/Header/Subject.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: Subject.pm,v 1.41 2004/01/01 23:52:15 fukachan Exp $
+# $FML: Subject.pm,v 1.42 2004/01/02 14:50:32 fukachan Exp $
 #
 
 package FML::Header::Subject;
@@ -15,7 +15,7 @@ use FML::Log qw(Log LogWarn LogError);
 
 =head1 NAME
 
-FML::Header::Subject - manipule the mail header subject
+FML::Header::Subject - manipulate the mail header subject
 
 =head1 SYNOPSIS
 
@@ -35,7 +35,7 @@ constructor.
 =cut
 
 
-# Descriptions: constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
@@ -57,7 +57,7 @@ replace the subject with the newer content e.g. including the ML tag.
 =cut
 
 
-# Descriptions: add or rewrite the subject tag
+# Descriptions: add or rewrite the subject tag.
 #    Arguments: OBJ($self) OBJ($header) OBJ($config) HASH_REF($rw_args)
 # Side Effects: the header subject is rewritten
 # Return Value: none
@@ -95,13 +95,13 @@ sub rewrite_article_subject_tag
 }
 
 
-# Descriptions: delete subject tag
+# Descriptions: delete subject tag.
 #    Arguments: OBJ($self) STR($subject) STR($tag)
 # Side Effects: none
 # Return Value: STR
 sub clean_up
 {
-    my ($self, $subject, $tag) = @_;
+    my ($self, $subject, $tag)   = @_;
     my ($s, $in_code, $out_code) = $self->decode($subject, $tag);
     return $self->delete_subject_tag($s, $tag);
 }
@@ -114,7 +114,7 @@ sub clean_up
 sub decode
 {
     my ($self, $subject, $tag) = @_;
-    my ($in_code, $out_code) = ();
+    my ($in_code, $out_code)   = ();
 
     # for example, ml_name = elena
     # if $tag has special regexp such as \U$ml_name\E or \L$ml_name\E
@@ -150,6 +150,8 @@ sub decode
 sub delete_subject_tag
 {
     my ($self, $subject, $tag) = @_;
+
+    # XXX-TODO: method-fy ?
     return _delete_subject_tag($subject, $tag);
 }
 
@@ -241,6 +243,7 @@ sub is_reply
     return 1 if $subject =~ /^\s*Re:/i;
 
     # XXX-TODO: care for not Japanese string!
+    # XXX-TODO: method-ify ?
     my $pkg = 'Mail::Message::Language::Japanese::Subject';
     eval qq{ require $pkg; $pkg->import();};
     unless ($@) {
diff --git a/fml/lib/FML/Log/Print/Simple.pm b/fml/lib/FML/Log/Print/Simple.pm
index c9d3a8cb..62818e15 100644
--- a/fml/lib/FML/Log/Print/Simple.pm
+++ b/fml/lib/FML/Log/Print/Simple.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: Simple.pm,v 1.1 2003/11/29 10:24:26 fukachan Exp $
+# $FML: Simple.pm,v 1.2 2003/11/30 10:13:21 fukachan Exp $
 #
 
 package FML::Log::Print::Simple;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Log::Print::Simple - simplest engine
+FML::Log::Print::Simple - simplest print out engine
 
 =head1 SYNOPSIS
 
@@ -29,7 +29,7 @@ FML::Log::Print::Simple - simplest engine
 
 # Descriptions: constructor.
 #    Arguments: OBJ($self)
-# Side Effects: none
+# Side Effects: prepare queue object.
 # Return Value: OBJ
 sub new
 {
@@ -44,9 +44,9 @@ sub new
 }
 
 
-# Descriptions: add message to message queue
+# Descriptions: add message to message queue.
 #    Arguments: OBJ($self) OBJ($msg)
-# Side Effects: none
+# Side Effects: update queue.
 # Return Value: none
 sub add
 {
@@ -56,14 +56,14 @@ sub add
 }
 
 
-# Descriptions: output
+# Descriptions: print out to STDOUT.
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: none
 sub print
 {
     my ($self)   = @_;
-    my $queue = $self->{ _queue };
+    my $queue    = $self->{ _queue };
     my $msg_list = $queue->list();
     my ($buf);
 
@@ -81,11 +81,11 @@ See C<http://www.fml.org/software/FNF/> on fml coding style guide.
 
 =head1 AUTHOR
 
-__YOUR_NAME__
+Ken'ichi Fukamachi
 
 =head1 COPYRIGHT
 
-Copyright (C) 2003 __YOUR_NAME__
+Copyright (C) 2003 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.