fix comments.

8 files changed, 53 insertions, 36 deletions

diff --git a/fml/lib/FML/Config.pm b/fml/lib/FML/Config.pm
index f006fdd8..defdeba8 100644
--- a/fml/lib/FML/Config.pm
+++ b/fml/lib/FML/Config.pm
@@ -1,9 +1,9 @@
 #-*- perl -*-
-# Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
+# Copyright (C) 2000,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: Config.pm,v 1.75 2002/12/22 04:43:05 fukachan Exp $
+# $FML: Config.pm,v 1.76 2002/12/24 10:19:41 fukachan Exp $
 #
 
 package FML::Config;
@@ -197,7 +197,7 @@ sub get_as_array_ref
 
 # Descriptions: set vaule for $key.
 #               flag on we need to re-evaludate variable expansion.
-#    Arguments: OBJ($self) STR($key)
+#    Arguments: OBJ($self) STR($key) STR($value)
 # Side Effects: update internal area
 # Return Value: STR
 sub set
@@ -384,7 +384,8 @@ sub _read_file
 
 
 # Descriptions: update $config by re-evaluating variables relation.
-#    Arguments: OBJ($obj) STR($key) STR($value) STR($name_space) STR($mode)
+#    Arguments: HASH_REF($config) 
+#               STR($key) STR($value) STR($name_space) STR($mode)
 # Side Effects: update $config on memory.
 # Return Value: none
 sub __update_config
@@ -412,7 +413,8 @@ sub __update_config
 
 
 # Descriptions: append $value into $config
-#    Arguments: OBJ($obj) STR($key) STR($value) STR($name_space) STR($mode)
+#    Arguments: HASH_REF($config) 
+#               STR($key) STR($value) STR($name_space) STR($mode)
 # Side Effects: update $config
 # Return Value: none
 sub __append_config
@@ -436,7 +438,8 @@ sub __append_config
 #                  key becomes "value1 value3".
 #               If "key += value4, key becomes
 #                  "value1 value2 value3 value4".
-#    Arguments: OBJ($config) STR($key) STR($mode) STR($value)
+#    Arguments: HASH_REF($config) 
+#               STR($key) STR($mode) STR($value) STR($name_space)
 # Side Effects: update $config by $mode
 # Return Value: STR(new value for $config{ $key })
 sub _evaluate
@@ -740,7 +743,7 @@ sub _expand_variables
 # Return Value: none
 sub __expand_special_macros
 {
-    my ( $config, $x ) = @_;
+    my ($config, $x) = @_;
 
     return unless defined $config;
     return unless defined $x;
@@ -1173,7 +1176,7 @@ Ken'ichi Fukamachi
 
 =head1 COPYRIGHT
 
-Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
+Copyright (C) 2000,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/FML/Credential.pm b/fml/lib/FML/Credential.pm
index 43ea59d9..2647f303 100644
--- a/fml/lib/FML/Credential.pm
+++ b/fml/lib/FML/Credential.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: Credential.pm,v 1.38 2002/12/23 14:36:24 fukachan Exp $
+# $FML: Credential.pm,v 1.39 2002/12/24 10:19:42 fukachan Exp $
 #
 
 package FML::Credential;
@@ -153,7 +153,7 @@ are same since the last 3 top level domains are same.
 
 
 # Descriptions: compare whether the given addresses are same or not.
-#    Arguments: OBJ($self) STR($xaddr) STR($xaddr) NUM($max_level)
+#    Arguments: OBJ($self) STR($xaddr) STR($yaddr) NUM($max_level)
 # Side Effects: none
 # Return Value: NUM(1 or 0)
 sub is_same_address
@@ -263,7 +263,7 @@ sub is_recipient
 
 
 # Descriptions: sender of the current process is an ML member or not.
-#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($args) HASH_REF($optargs)
+#    Arguments: OBJ($self) HASH_REF($optargs)
 # Side Effects: none
 # Return Value: NUM(1 or 0)
 sub _is_member
@@ -521,7 +521,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/FML/Filter.pm b/fml/lib/FML/Filter.pm
index ef2c7a74..d675d339 100644
--- a/fml/lib/FML/Filter.pm
+++ b/fml/lib/FML/Filter.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: Filter.pm,v 1.17 2002/10/26 04:03:31 fukachan Exp $
+# $FML: Filter.pm,v 1.18 2002/12/20 03:36:44 fukachan Exp $
 #
 
 package FML::Filter;
@@ -128,7 +128,7 @@ sub _apply_article_header_filter
 
 
 # Descriptions: filter non MIME format message
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($args) OBJ($mesg)
 # Side Effects: none
 # Return Value: 0 (always ok, anyway)
 sub _apply_article_non_mime_filter
@@ -158,7 +158,7 @@ sub _apply_article_non_mime_filter
 
 
 # Descriptions: syntax check for text(/plain)
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($args) OBJ($mesg)
 # Side Effects: none
 # Return Value: none
 sub _apply_article_text_plain_filter
@@ -193,7 +193,7 @@ sub _apply_article_text_plain_filter
 
 
 # Descriptions: analyze MIME structure and filter it if matched.
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($args) OBJ($mesg)
 # Side Effects: none
 # Return Value: none
 sub _apply_article_mime_component_filter
@@ -238,7 +238,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/FML/Log.pm b/fml/lib/FML/Log.pm
index 97064ec3..26a621b9 100644
--- a/fml/lib/FML/Log.pm
+++ b/fml/lib/FML/Log.pm
@@ -1,8 +1,8 @@
 #-*- perl -*-
 #
-# Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
+# Copyright (C) 2000,2001,2002,2003 Ken'ichi Fukamachi
 #
-# $FML: Log.pm,v 1.24 2002/12/18 03:42:28 fukachan Exp $
+# $FML: Log.pm,v 1.25 2002/12/26 04:26:10 fukachan Exp $
 #
 
 package FML::Log;
@@ -79,7 +79,7 @@ same as Log("error: $message", $args);
 
 
 # Descriptions: write message $msg to logfile
-#    Arguments: STR($msg) HASH_REF($args)
+#    Arguments: STR($mesg) HASH_REF($args)
 # Side Effects: update logfile
 # Return Value: none
 sub Log
@@ -156,7 +156,7 @@ sub Log
 
 # Descriptions: write message "warn: $msg", call Log() ASAP.
 #               send the message into stderr if Log() failed.
-#    Arguments: STR($msg) HASH_REF($args)
+#    Arguments: STR($mesg) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
 sub LogWarn
@@ -174,7 +174,7 @@ sub LogWarn
 
 # Descriptions: write message "error: $msg", call Log() ASAP.
 #               send the message into stderr if Log() failed.
-#    Arguments: STR($msg) HASH_REF($args)
+#    Arguments: STR($mesg) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
 sub LogError
@@ -206,7 +206,7 @@ Ken'ichi Fukamachi <F<fukachan@fml.org>>
 
 =head1 COPYRIGHT
 
-Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
+Copyright (C) 2000,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/FML/Parse.pm b/fml/lib/FML/Parse.pm
index 3706f138..1ea86857 100644
--- a/fml/lib/FML/Parse.pm
+++ b/fml/lib/FML/Parse.pm
@@ -1,10 +1,10 @@
 #-*- perl -*-
 #
-#  Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
+#  Copyright (C) 2000,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: Parse.pm,v 1.27 2002/09/22 14:56:41 fukachan Exp $
+# $FML: Parse.pm,v 1.28 2002/12/18 04:34:41 fukachan Exp $
 #
 
 package FML::Parse;
@@ -56,7 +56,7 @@ sub new
 
 
 # Descriptions: parse message read from file handle $fd
-#    Arguments: OBJ($self) HASH_REF($args)
+#    Arguments: OBJ($self) OBJ($curproc) HANDLE($fd)
 # Side Effects: none
 # Return Value: OBJ
 sub _parse
@@ -107,7 +107,7 @@ Ken'ichi Fukamachi
 
 =head1 COPYRIGHT
 
-Copyright (C) 2000,2001,2002 Ken'ichi Fukamachi
+Copyright (C) 2000,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/FML/Process/Command.pm b/fml/lib/FML/Process/Command.pm
index 3d105d32..28726578 100644
--- a/fml/lib/FML/Process/Command.pm
+++ b/fml/lib/FML/Process/Command.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2000,2001,2002,2003 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Command.pm,v 1.78 2002/12/25 03:13:19 fukachan Exp $
+# $FML: Command.pm,v 1.79 2003/01/03 07:06:38 fukachan Exp $
 #
 
 package FML::Process::Command;
@@ -590,7 +590,9 @@ sub _get_command_mode
 
 # Descriptions: this command is allowd under the current $mode and $level
 #    Arguments: OBJ($curproc)
-#               HASH_REF($args) HASH_REF($status) HAS_REF($command_info)
+#               STR($mode)
+#               HASH_REF($status)
+#               HASH_REF($command_info)
 # Side Effects: none
 # Return Value: NUM
 sub _config_allow_command
diff --git a/fml/lib/FML/Process/Configure.pm b/fml/lib/FML/Process/Configure.pm
index bc65689f..611eb034 100644
--- a/fml/lib/FML/Process/Configure.pm
+++ b/fml/lib/FML/Process/Configure.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2001,2002,2003 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Configure.pm,v 1.47 2003/01/05 05:13:50 fukachan Exp $
+# $FML: Configure.pm,v 1.48 2003/01/07 08:38:34 fukachan Exp $
 #
 
 package FML::Process::Configure;
@@ -186,6 +186,10 @@ sub help
 }
 
 
+# Descriptions: show FYI help
+#    Arguments: none
+# Side Effects: none
+# Return Value: none
 sub _fyi_help
 {
 print <<"_EOF_";
@@ -203,6 +207,10 @@ _EOF_
 }
 
 
+# Descriptions: show help usage
+#    Arguments: STR($name)
+# Side Effects: none
+# Return Value: none
 sub _fml_help
 {
     my ($name) = @_;
@@ -216,6 +224,10 @@ _EOF_
 }
 
 
+# Descriptions: show help usage
+#    Arguments: STR($name)
+# Side Effects: none
+# Return Value: none
 sub _makefml_help
 {	
     my ($name) = @_;
diff --git a/fml/lib/FML/Process/QueueManager.pm b/fml/lib/FML/Process/QueueManager.pm
index 14a68118..1c6b4ab1 100644
--- a/fml/lib/FML/Process/QueueManager.pm
+++ b/fml/lib/FML/Process/QueueManager.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: QueueManager.pm,v 1.9 2002/09/22 14:56:53 fukachan Exp $
+# $FML: QueueManager.pm,v 1.10 2002/12/22 03:46:20 fukachan Exp $
 #
 
 package FML::Process::QueueManager;
@@ -70,7 +70,7 @@ If queue id C<$id> is specified, send queue for C<$id>.
 
 
 # Descriptions: send message in queue directory sequentially
-#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($args)
+#    Arguments: OBJ($self) OBJ($curproc) STR($id)
 # Side Effects: queue flush-ed
 # Return Value: none
 sub send
@@ -149,7 +149,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.