fix comments (FNF)

11 files changed, 42 insertions, 38 deletions

diff --git a/fml/lib/Mail/Message/Address.pm b/fml/lib/Mail/Message/Address.pm
index eedda186..ab58c27c 100644
--- a/fml/lib/Mail/Message/Address.pm
+++ b/fml/lib/Mail/Message/Address.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: Address.pm,v 1.4 2004/06/29 10:03:48 fukachan Exp $
+# $FML: Address.pm,v 1.5 2004/07/06 23:55:58 fukachan Exp $
 #
 
 package Mail::Message::Address;
@@ -26,7 +26,7 @@ This class is an adapter for Mail::Address for convenience.
 
 =head1 METHODS
 
-=head2 C<new()>
+=head2 new()
 
 constructor.
 
diff --git a/fml/lib/Mail/Message/Charset.pm b/fml/lib/Mail/Message/Charset.pm
index f8f89d89..0f130ad8 100644
--- a/fml/lib/Mail/Message/Charset.pm
+++ b/fml/lib/Mail/Message/Charset.pm
@@ -2,7 +2,7 @@
 #
 # Copyright (C) 2003,2004 Ken'ichi Fukamachi
 #
-# $FML: Charset.pm,v 1.3 2004/02/06 13:29:47 fukachan Exp $
+# $FML: Charset.pm,v 1.4 2004/02/26 12:59:07 fukachan Exp $
 #
 
 package Mail::Message::Charset;
@@ -10,7 +10,7 @@ use strict;
 
 =head1 NAME
 
-Mail::Message::Charset - charset map
+Mail::Message::Charset - charset map.
 
 =head1 SYNOPSIS
 
@@ -209,7 +209,7 @@ sub new
 }
 
 
-# Descriptions: return default charset.
+# Descriptions: return default charset for internal usage.
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
@@ -220,7 +220,7 @@ sub internal_default_charset
 }
 
 
-# Descriptions: return default charset.
+# Descriptions: return default charset for message handling.
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
@@ -231,7 +231,7 @@ sub message_default_charset
 }
 
 
-# Descriptions: get charset info: e.g. japanese => euc-jp.
+# Descriptions: convert charset info: e.g. japanese => euc-jp.
 #    Arguments: OBJ($self) STR($language)
 # Side Effects: none
 # Return Value: STR
@@ -243,7 +243,7 @@ sub language_to_internal_charset
 }
 
 
-# Descriptions: get charset info: e.g. ja or japanese => iso-2022-jp.
+# Descriptions: convert charset info: e.g. ja or japanese => iso-2022-jp.
 #    Arguments: OBJ($self) STR($language)
 # Side Effects: none
 # Return Value: STR
diff --git a/fml/lib/Mail/Message/Checksum.pm b/fml/lib/Mail/Message/Checksum.pm
index 57e230ba..0ca64a8b 100644
--- a/fml/lib/Mail/Message/Checksum.pm
+++ b/fml/lib/Mail/Message/Checksum.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: Checksum.pm,v 1.10 2003/08/23 05:15:14 fukachan Exp $
+# $FML: Checksum.pm,v 1.11 2004/01/24 09:03:59 fukachan Exp $
 #
 
 package Mail::Message::Checksum;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-Mail::Message::Checksum - utilities for checksum
+Mail::Message::Checksum - utilities for checksum.
 
 =head1 SYNOPSIS
 
@@ -26,14 +26,14 @@ Mail::Message::Checksum - utilities for checksum
 
 =head2 new()
 
-the constructor.
+constructor.
 It checks we can use MD5 perl module or we need to use external programs
 such as C<md5>, C<cksum>, et.al.
 
 =cut
 
 
-# Descriptions: ordinary constructor.
+# Descriptions: constructor.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: OBJ
@@ -193,7 +193,7 @@ See POSIX 1003.2 for more details.
 =cut
 
 
-# Descriptions: return the traditional checksum of the given $file
+# Descriptions: return the traditional checksum of the given $file.
 #    Arguments: OBJ($self) STR($file)
 # Side Effects: none
 # Return Value: ARRAY(STR, STR)
@@ -202,6 +202,7 @@ sub cksum2
     my ($self, $file) = @_;
     my ($crc, $total, $nr, $buf, $r);
 
+    # XXX-TODO: style
     $crc = $total = 0;
     if (open($file, $file)) {
         while (($nr = sysread($file, $buf, 1024)) > 0) {
diff --git a/fml/lib/Mail/Message/Language.pm b/fml/lib/Mail/Message/Language.pm
index 32d5d795..7a94537e 100644
--- a/fml/lib/Mail/Message/Language.pm
+++ b/fml/lib/Mail/Message/Language.pm
@@ -2,7 +2,7 @@
 #
 # Copyright (C) 2003,2004 Ken'ichi Fukamachi
 #
-# $FML: Language.pm,v 1.3 2004/02/29 15:57:26 fukachan Exp $
+# $FML: Language.pm,v 1.4 2004/02/29 15:59:41 fukachan Exp $
 #
 
 package Mail::Message::Language;
@@ -10,7 +10,7 @@ use strict;
 
 =head1 NAME
 
-Mail::Message::Language - handle *-Language:
+Mail::Message::Language - handle *-Language: field.
 
 =head1 SYNOPSIS
 
diff --git a/fml/lib/Mail/Message/Language/Japanese/Subject.pm b/fml/lib/Mail/Message/Language/Japanese/Subject.pm
index 926db889..96904077 100644
--- a/fml/lib/Mail/Message/Language/Japanese/Subject.pm
+++ b/fml/lib/Mail/Message/Language/Japanese/Subject.pm
@@ -1,10 +1,10 @@
 #-*- perl -*-
 #
-#  Copyright (C) 2001,2002,2003 Ken'ichi Fukamachi
+#  Copyright (C) 2001,2002,2003,2004 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.
 #
-# $FML: Subject.pm,v 1.15 2003/07/21 13:26:05 fukachan Exp $
+# $FML: Subject.pm,v 1.16 2003/08/23 04:35:48 fukachan Exp $
 #
 
 
@@ -21,7 +21,7 @@ use Jcode;
 
 =head1 NAME
 
-Mail::Message::Language::Japanese::Subject - functions for Japanese subject
+Mail::Message::Language::Japanese::Subject - functions for Japanese subject.
 
 =head1 SYNOPSIS
 
@@ -120,7 +120,7 @@ within C<Subject:>.
 # ¥ì¥ì¥ìÂкö
 
 
-# Descriptions: remove Re:
+# Descriptions: remove Re: strings.
 #    Arguments: OBJ($self) STR($subject)
 # Side Effects: none
 # Return Value: STR
@@ -157,11 +157,11 @@ See C<http://www.fml.org/software/FNF/> on fml coding style guide.
 
 =head1 AUTHOR
 
- Ken'ichi Fukamachi
+Ken'ichi Fukamachi
 
 =head1 COPYRIGHT
 
-Copyright (C) 2001,2002,2003 Ken'ichi Fukamachi
+Copyright (C) 2001,2002,2003,2004 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.
diff --git a/fml/lib/Mail/Message/MH.pm b/fml/lib/Mail/Message/MH.pm
index 6bca29ae..56c23a6e 100644
--- a/fml/lib/Mail/Message/MH.pm
+++ b/fml/lib/Mail/Message/MH.pm
@@ -2,7 +2,7 @@
 #
 # Copyright (C) 2001,2002,2003,2004 Ken'ichi Fukamachi
 #
-# $FML: MH.pm,v 1.17 2004/01/24 09:04:00 fukachan Exp $
+# $FML: MH.pm,v 1.18 2004/03/27 09:25:45 fukachan Exp $
 #
 
 package Mail::Message::MH;
@@ -10,7 +10,7 @@ use strict;
 
 =head1 NAME
 
-Mail::Message::MH - utilities to handle MH style format
+Mail::Message::MH - utilities to handle MH style format.
 
 =head1 SYNOPSIS
 
diff --git a/fml/lib/Mail/Message/Parse.pm b/fml/lib/Mail/Message/Parse.pm
index 778ed4a5..714ae0c8 100644
--- a/fml/lib/Mail/Message/Parse.pm
+++ b/fml/lib/Mail/Message/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.8 2002/09/22 14:57:04 fukachan Exp $
+# $FML: Parse.pm,v 1.9 2004/01/02 14:42:48 fukachan Exp $
 #
 
 
@@ -32,7 +32,7 @@ sub new
 
 =head1 NAME
 
-Mail::Message::Parse - parse a mail message
+Mail::Message::Parse - parse a mail message.
 
 =head1 SYNOPSIS
 
diff --git a/fml/lib/Mail/Message/Spool.pm b/fml/lib/Mail/Message/Spool.pm
index 95442ccb..e8d524d4 100644
--- a/fml/lib/Mail/Message/Spool.pm
+++ b/fml/lib/Mail/Message/Spool.pm
@@ -2,7 +2,7 @@
 #
 # Copyright (C) 2002,2003,2004 Ken'ichi Fukamachi
 #
-# $FML: Spool.pm,v 1.11 2003/03/03 15:53:50 fukachan Exp $
+# $FML: Spool.pm,v 1.12 2004/01/24 09:04:00 fukachan Exp $
 #
 
 package Mail::Message::Spool;
@@ -12,7 +12,7 @@ use Carp;
 
 =head1 NAME
 
-Mail::Message::Spool - utilities to handle directory such as article spool
+Mail::Message::Spool - utilities to handle directory such as article spool.
 
 =head1 SYNOPSIS
 
@@ -29,7 +29,7 @@ directory such as article spool.
 
 =head2 new()
 
-standard constructor.
+constructor.
 
 =cut
 
diff --git a/fml/lib/Mail/Message/String.pm b/fml/lib/Mail/Message/String.pm
index 8d5f0b1e..29bbaf85 100644
--- a/fml/lib/Mail/Message/String.pm
+++ b/fml/lib/Mail/Message/String.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: String.pm,v 1.6 2004/03/27 09:25:13 fukachan Exp $
+# $FML: String.pm,v 1.7 2004/03/31 02:48:22 fukachan Exp $
 #
 
 package Mail::Message::String;
@@ -35,7 +35,9 @@ Mail::Message::String - base class of string used in message (header).
 
 =head1 METHODS
 
-=head2 C<new()>
+=head2 new()
+
+constructor.
 
 =cut
 
@@ -75,7 +77,7 @@ get (converted) data in this object as string (same as as_str()).
 =cut
 
 
-# Descriptions: initialize data in this object.
+# Descriptions: set string data in this object.
 #    Arguments: OBJ($self) STR($str)
 # Side Effects: none
 # Return Value: OBJ
@@ -86,7 +88,7 @@ sub set
 }
 
 
-# Descriptions: get data in this object as string (same as as_str()).
+# Descriptions: get string data in this object as string (same as as_str()).
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
@@ -99,12 +101,12 @@ sub get
 
 =head2 as_str()
 
-return data (converted data) by string.
+return data (converted data) as string.
 
 =cut
 
 
-# Descriptions: return data (converted data) by string.
+# Descriptions: return data (converted data) as string.
 #    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: STR
diff --git a/fml/lib/Mail/Message/Subject.pm b/fml/lib/Mail/Message/Subject.pm
index 2b2800b3..886ffd9e 100644
--- a/fml/lib/Mail/Message/Subject.pm
+++ b/fml/lib/Mail/Message/Subject.pm
@@ -2,7 +2,7 @@
 #
 # Copyright (C) 2004 Ken'ichi Fukamachi
 #
-# $FML: Subject.pm,v 1.3 2004/03/28 11:11:55 fukachan Exp $
+# $FML: Subject.pm,v 1.4 2004/06/23 00:05:38 fukachan Exp $
 #
 
 package Mail::Message::Subject;
@@ -66,7 +66,7 @@ sub delete_dup_reply_tag
 
     # XXX-TODO: care for not Japanese string!
     # XXX-TODO: call this module if $subject is Japanese or English.
-    # XXX-TODO: but what should we do when the code is not the two ?
+    # XXX-TODO: but what should we do when the code is not the two above ?
     if (1) {
 	use Mail::Message::Language::Japanese::Subject;
 	my $sbj  = new Mail::Message::Language::Japanese::Subject;
@@ -116,6 +116,7 @@ sub delete_tag
     my ($self, $tag) = @_;
     my $subject = $self->as_str();
 
+    # XXX $subject SHOULD BE MIME DECODED ALREADY. 
     # for example, ml_name = elena
     # if $tag has special regexp such as \U$ml_name\E or \L$ml_name\E
     if (defined $tag) {
diff --git a/fml/lib/Mail/Message/Utils.pm b/fml/lib/Mail/Message/Utils.pm
index 29270458..202e539c 100644
--- a/fml/lib/Mail/Message/Utils.pm
+++ b/fml/lib/Mail/Message/Utils.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: Utils.pm,v 1.9 2003/08/23 04:35:48 fukachan Exp $
+# $FML: Utils.pm,v 1.10 2004/01/24 09:04:00 fukachan Exp $
 #
 
 package Mail::Message::Utils;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-Mail::Message::Utils - utility functions for Mail::Message
+Mail::Message::Utils - utility functions for Mail::Message.
 
 =head1 SYNOPSIS