fix comments

15 files changed, 47 insertions, 47 deletions

diff --git a/fml/lib/File/SimpleLock.pm b/fml/lib/File/SimpleLock.pm
index 0667e9c9..a0ea1bee 100644
--- a/fml/lib/File/SimpleLock.pm
+++ b/fml/lib/File/SimpleLock.pm
@@ -2,7 +2,7 @@
 #
 # Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
 #
-# $FML: SimpleLock.pm,v 1.15 2002/12/13 04:19:59 fukachan Exp $
+# $FML: SimpleLock.pm,v 1.16 2002/12/22 03:32:00 fukachan Exp $
 #
 
 package File::SimpleLock;
@@ -52,7 +52,7 @@ use Fcntl qw(:DEFAULT :flock);
 
 
 # Descriptions: standard constructor.
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: OBJ
 sub new
diff --git a/fml/lib/File/Utils.pm b/fml/lib/File/Utils.pm
index b37b1175..30eb30b9 100644
--- a/fml/lib/File/Utils.pm
+++ b/fml/lib/File/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.18 2002/09/22 14:56:57 fukachan Exp $
+# $FML: Utils.pm,v 1.19 2002/12/22 03:32:00 fukachan Exp $
 #
 
 package File::Utils;
@@ -80,7 +80,7 @@ make a directory C<$dir> by the mode C<$mode> recursively.
 
 
 # Descriptions: "mkdir -p" or "mkdirhier"
-#    Arguments: STR($cdir) STR($mode)
+#    Arguments: STR($dir) STR($mode)
 # Side Effects: set $ErrorString
 # Return Value: 1 or UNDEF
 sub mkdirhier
@@ -155,11 +155,11 @@ The default search path list is
 
 
 # Descriptions: search executable named as $file
-#    Arguments: STR($file) ARRAY_REF($path_list)
 #               The "path_list" is an ARRAY_REFERENCE.
 #               For example,
 #               search_program('md5');
 #               search_program('md5', [ '/bin', '/sbin' ]);
+#    Arguments: STR($file) ARRAY_REF($path_list)
 # Side Effects: none
 # Return Value: STR
 sub search_program
diff --git a/fml/lib/Mail/Bounce/DSN.pm b/fml/lib/Mail/Bounce/DSN.pm
index e0345501..f4b210d0 100644
--- a/fml/lib/Mail/Bounce/DSN.pm
+++ b/fml/lib/Mail/Bounce/DSN.pm
@@ -1,10 +1,10 @@
 #-*- perl -*-
 #
-#  Copyright (C) 2001,2002 Ken'ichi Fukamachi
+#  Copyright (C) 2001,2002,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.
 #
-# $FML: DSN.pm,v 1.19 2002/09/22 14:57:01 fukachan Exp $
+# $FML: DSN.pm,v 1.20 2002/12/20 03:49:15 fukachan Exp $
 #
 
 
@@ -120,7 +120,7 @@ sub analyze
 #               Status: 4.0.0
 #               Diagnostic-Code: X-Postfix; connect to mx.nuinui.net[10.1.1.1]:
 #                    Connection refused
-#    Arguments: OBJ($self) OBJ($msg) HASH_REF($result)
+#    Arguments: OBJ($self) STR($buf) HASH_REF($result)
 # Side Effects: update $result
 # Return Value: none
 sub _parse_dsn_format
@@ -171,7 +171,7 @@ Ken'ichi Fukamachi
 
 =head1 COPYRIGHT
 
-Copyright (C) 2001,2002 Ken'ichi Fukamachi
+Copyright (C) 2001,2002,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.
diff --git a/fml/lib/Mail/Bounce/Postfix19991231.pm b/fml/lib/Mail/Bounce/Postfix19991231.pm
index 58643e9b..e73a8441 100644
--- a/fml/lib/Mail/Bounce/Postfix19991231.pm
+++ b/fml/lib/Mail/Bounce/Postfix19991231.pm
@@ -1,10 +1,10 @@
 #-*- perl -*-
 #
-#  Copyright (C) 2001,2002 Ken'ichi Fukamachi
+#  Copyright (C) 2001,2002,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.
 #
-# $FML: Postfix19991231.pm,v 1.20 2002/09/22 14:57:01 fukachan Exp $
+# $FML: Postfix19991231.pm,v 1.21 2002/12/20 03:49:16 fukachan Exp $
 #
 
 
@@ -144,7 +144,7 @@ sub _analyze_broken_dsn
 
 
 # Descriptions: clean up address
-#    Arguments: OBJ($self) OBJ($msg) HASH_REF($result)
+#    Arguments: OBJ($self) STR($data) HASH_REF($result)
 # Side Effects: update $result
 # Return Value: none
 sub _parse_address
@@ -171,7 +171,7 @@ Ken'ichi Fukamachi
 
 =head1 COPYRIGHT
 
-Copyright (C) 2001,2002 Ken'ichi Fukamachi
+Copyright (C) 2001,2002,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.
diff --git a/fml/lib/Mail/Delivery/ESMTP.pm b/fml/lib/Mail/Delivery/ESMTP.pm
index 70730b5c..2f256f3e 100644
--- a/fml/lib/Mail/Delivery/ESMTP.pm
+++ b/fml/lib/Mail/Delivery/ESMTP.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: ESMTP.pm,v 1.7 2002/09/11 23:18:23 fukachan Exp $
+# $FML: ESMTP.pm,v 1.8 2002/09/22 14:57:02 fukachan Exp $
 #
 
 package Mail::Delivery::ESMTP;
@@ -17,7 +17,7 @@ use Mail::Delivery::SMTP;
 
 
 # Descriptions: constructor. forward the request to base class (SMTP).
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self) VARARGS(@args)
 # Side Effects: none
 # Return Value: OBJ
 sub new
diff --git a/fml/lib/Mail/Message/Date.pm b/fml/lib/Mail/Message/Date.pm
index 61f7d030..077ad5cc 100644
--- a/fml/lib/Mail/Message/Date.pm
+++ b/fml/lib/Mail/Message/Date.pm
@@ -2,7 +2,7 @@
 #
 # Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
 #
-# $FML: Date.pm,v 1.15 2002/12/22 03:09:56 fukachan Exp $
+# $FML: Date.pm,v 1.16 2002/12/24 10:19:49 fukachan Exp $
 #
 
 package Mail::Message::Date;
@@ -157,7 +157,7 @@ sub YYYYMMDD
 
 
 # Descriptions: return e.g. 1999/09/13 style
-#    Arguments: OBJ($self) NUM($time)
+#    Arguments: OBJ($self) NUM($time) STR($sep)
 # Side Effects: none
 # Return Value: STR
 sub YYYYxMMxDD
diff --git a/fml/lib/Mail/Message/Encode.pm b/fml/lib/Mail/Message/Encode.pm
index 39c11970..b6793f3f 100644
--- a/fml/lib/Mail/Message/Encode.pm
+++ b/fml/lib/Mail/Message/Encode.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: Encode.pm,v 1.9 2002/11/26 13:55:46 fukachan Exp $
+# $FML: Encode.pm,v 1.10 2002/12/22 03:09:56 fukachan Exp $
 #
 
 package Mail::Message::Encode;
@@ -453,7 +453,7 @@ by $options->{ charset }.
 
 
 # Descriptions: decode MIME string
-#    Arguments: OBJ($self) STR($str) STR($encode) STR($out_code) STR($in_code)
+#    Arguments: OBJ($self) STR($str) STR($out_code) STR($in_code)
 # Side Effects: none
 # Return Value: STR
 sub decode_mime_string
diff --git a/fml/lib/Mail/Message/Language/Japanese/Subject.pm b/fml/lib/Mail/Message/Language/Japanese/Subject.pm
index 644b94e0..1d940bd1 100644
--- a/fml/lib/Mail/Message/Language/Japanese/Subject.pm
+++ b/fml/lib/Mail/Message/Language/Japanese/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.10 2002/09/22 14:57:05 fukachan Exp $
+# $FML: Subject.pm,v 1.11 2002/12/22 03:09:56 fukachan Exp $
 #
 
 
@@ -105,7 +105,7 @@ within C<Subject:>.
 
 
 # Descriptions: remove Re:
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: STR($subject)
 # Side Effects: none
 # Return Value: STR
 sub cut_off_reply_tag
diff --git a/fml/lib/Mail/Message/MH.pm b/fml/lib/Mail/Message/MH.pm
index 5d7e2ce6..685dd7b2 100644
--- a/fml/lib/Mail/Message/MH.pm
+++ b/fml/lib/Mail/Message/MH.pm
@@ -2,7 +2,7 @@
 #
 # Copyright (C) 2001,2002 Ken'ichi Fukamachi
 #
-# $FML: MH.pm,v 1.9 2002/09/11 23:18:25 fukachan Exp $
+# $FML: MH.pm,v 1.10 2002/09/22 14:57:04 fukachan Exp $
 #
 
 package Mail::Message::MH;
@@ -109,7 +109,7 @@ sub expand
 
 
 # Descriptions: make an array from $fist to $last number
-#    Arguments: NUM($first_number) NUM($last_number)
+#    Arguments: NUM($first) NUM($last)
 # Side Effects: none
 # Return Value: ARRAY_REF (as [ $first .. $last ])
 sub _expand_range
diff --git a/fml/lib/Mail/Message/ToHTML.pm b/fml/lib/Mail/Message/ToHTML.pm
index 17e817e4..d311851d 100644
--- a/fml/lib/Mail/Message/ToHTML.pm
+++ b/fml/lib/Mail/Message/ToHTML.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: ToHTML.pm,v 1.30 2002/10/29 09:47:15 fukachan Exp $
+# $FML: ToHTML.pm,v 1.31 2002/11/18 22:45:08 fukachan Exp $
 #
 
 package Mail::Message::ToHTML;
@@ -17,7 +17,7 @@ my $debug = 0;
 my $URL   =
     "<A HREF=\"http://www.fml.org/software/\">Mail::Message::ToHTML</A>";
 
-my $version = q$FML: ToHTML.pm,v 1.30 2002/10/29 09:47:15 fukachan Exp $;
+my $version = q$FML: ToHTML.pm,v 1.31 2002/11/18 22:45:08 fukachan Exp $;
 if ($version =~ /,v\s+([\d\.]+)\s+/) {
     $version = "$URL $1";
 }
@@ -598,20 +598,20 @@ sub _set_output_channel
 
 # Descriptions: return temporary file path.
 #               XXX temporary file is created under $db_dir not public space
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: STR
 sub _create_temporary_filename
 {
-    my ($self, $msg) = @_;
-    my $db_dir  = $self->{ _html_base_directory };
+    my ($self) = @_;
+    my $db_dir = $self->{ _html_base_directory };
 
     return "$db_dir/tmp$$";
 }
 
 
 # Descriptions: create a temporary file with the content $msg
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self) OBJ($msg)
 # Side Effects: create $tmpf file
 # Return Value: STR
 sub _create_temporary_file_in_raw_mode
@@ -686,7 +686,7 @@ sub _print_inline_object_link
 
 
 # Descriptions: return attachment filename
-#    Arguments: OBJ($self) STR($attach) STR($suffix)
+#    Arguments: STR($dst) STR($attach) STR($suffix)
 # Side Effects: none
 #         Todo: UNIX specific
 # Return Value: STR
@@ -744,7 +744,7 @@ sub _format_safe_header
 
 
 # Descriptions: show link to indexes as navigation
-#    Arguments: none
+#    Arguments: HASH_REF($args)
 # Side Effects: none
 # Return Value: none
 sub _format_index_navigator
@@ -1326,7 +1326,7 @@ sub _update_relation
 
 
 # Descriptions: return thread link relation info et.al. for $id
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self) NUM($id)
 # Side Effects: none
 # Return Value: HASH_REF
 sub evaluate_relation
@@ -2343,7 +2343,7 @@ sub _print_end_of_ul
 
 
 # Descriptions: print <LI> filename ... with proper indentation
-#    Arguments: OBJ($self) HANDLE($wh) HASH_REF($db) STR($code)
+#    Arguments: OBJ($self) HANDLE($wh) HASH_REF($db) NUM($id) STR($code)
 # Side Effects: none
 # Return Value: none
 sub _print_li_filename
@@ -2496,7 +2496,7 @@ try to convert all rfc822 messages to HTML in C<$dir> directory.
 
 
 # Descriptions: convert $file to HTML
-#    Arguments: STR($file) HASH_REF($args)
+#    Arguments: OBJ($self) STR($file) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
 sub htmlify_file
@@ -2549,7 +2549,7 @@ sub htmlify_file
 
 
 # Descriptions: convert all articles in specified directory
-#    Arguments: STR($src_dir) HASH_REF($args)
+#    Arguments: OBJ($self) STR($src_dir) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
 sub htmlify_dir
diff --git a/fml/lib/Mail/ThreadTrack.pm b/fml/lib/Mail/ThreadTrack.pm
index ecd822a5..9c7c0b3a 100755
--- a/fml/lib/Mail/ThreadTrack.pm
+++ b/fml/lib/Mail/ThreadTrack.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: ThreadTrack.pm,v 1.31 2002/12/22 03:21:32 fukachan Exp $
+# $FML: ThreadTrack.pm,v 1.32 2002/12/24 10:19:48 fukachan Exp $
 #
 
 package Mail::ThreadTrack;
@@ -90,7 +90,7 @@ my $dir_mode = 0755;
 
 
 # Descriptions: constructor
-#    Arguments: OBJ($self)
+#    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: OBJ
 sub new
@@ -474,7 +474,7 @@ sub set_status
 
 
 # Descriptions: set status.
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self) STR($thread_id) STR($value)
 # Side Effects: update status in db.
 # Return Value: none
 sub _set_status
diff --git a/fml/lib/Mail/ThreadTrack/Print/HTML.pm b/fml/lib/Mail/ThreadTrack/Print/HTML.pm
index 6714fab9..9db47f5b 100644
--- a/fml/lib/Mail/ThreadTrack/Print/HTML.pm
+++ b/fml/lib/Mail/ThreadTrack/Print/HTML.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: HTML.pm,v 1.13 2002/09/22 14:57:07 fukachan Exp $
+# $FML: HTML.pm,v 1.14 2002/12/22 03:21:33 fukachan Exp $
 #
 
 package Mail::ThreadTrack::Print::HTML;
@@ -160,7 +160,7 @@ sub __end_thread_summary
 
 # Descriptions: This shows summary on C<$thread_id> in HTML language.
 #               It is used in C<FML::CGI::ThreadSystem>.
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self) HASH_REF($optargs)
 # Side Effects: none
 # Return Value: none
 sub __print_thread_summary
diff --git a/fml/lib/Mail/ThreadTrack/Print/Text.pm b/fml/lib/Mail/ThreadTrack/Print/Text.pm
index 46c8b0b0..4ec42fad 100644
--- a/fml/lib/Mail/ThreadTrack/Print/Text.pm
+++ b/fml/lib/Mail/ThreadTrack/Print/Text.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: Text.pm,v 1.11 2002/09/22 14:57:07 fukachan Exp $
+# $FML: Text.pm,v 1.12 2002/12/22 03:17:27 fukachan Exp $
 #
 
 package Mail::ThreadTrack::Print::Text;
@@ -101,7 +101,7 @@ sub __start_thread_summary
 
 
 # Descriptions: print formatted brief summary
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self) HASH_REF($optargs)
 # Side Effects: none
 # Return Value: none
 sub __print_thread_summary
@@ -132,7 +132,7 @@ sub __end_thread_summary
 
 
 # Descriptions: create a string of "a b c .." style up to $num bytes
-#    Arguments: NUM($num) STR($str)
+#    Arguments: NUM($max) STR($str)
 # Side Effects: none
 # Return Value: STR
 sub _format_list
diff --git a/fml/lib/Tie/JournaledDir.pm b/fml/lib/Tie/JournaledDir.pm
index d55a8c13..a57e5407 100644
--- a/fml/lib/Tie/JournaledDir.pm
+++ b/fml/lib/Tie/JournaledDir.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: JournaledDir.pm,v 1.16 2002/09/22 14:57:07 fukachan Exp $
+# $FML: JournaledDir.pm,v 1.17 2002/12/22 03:37:15 fukachan Exp $
 #
 
 package Tie::JournaledDir;
@@ -345,7 +345,7 @@ which is by default.
 
 
 # Descriptions: get all values for the key as ARRAY_REF.
-#    Arguments: OBJ($self) STR($key)
+#    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: HASH_REF
 sub get_all_values_as_hash_ref
diff --git a/fml/lib/Tie/JournaledFile.pm b/fml/lib/Tie/JournaledFile.pm
index 5cf8be26..d33a1fb5 100644
--- a/fml/lib/Tie/JournaledFile.pm
+++ b/fml/lib/Tie/JournaledFile.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: JournaledFile.pm,v 1.25 2003/01/04 00:28:35 fukachan Exp $
+# $FML: JournaledFile.pm,v 1.26 2003/01/07 08:38:35 fukachan Exp $
 #
 
 package Tie::JournaledFile;
@@ -274,7 +274,7 @@ parameter at C<new()> method. C<first_match> by default.
 
 
 # Descriptions: return the array of line(s) with the specified key.
-#    Arguments: OBJ($self) STR($key)
+#    Arguments: OBJ($self) STR($key) STR($mode)
 # Side Effects: none
 # Return Value: ARRAY_REF
 sub find