update documents, comments

4 files changed, 54 insertions, 13 deletions

diff --git a/fml/lib/Mail/Bounce/DSN.pm b/fml/lib/Mail/Bounce/DSN.pm
index fe1851cc..b4fa60fa 100644
--- a/fml/lib/Mail/Bounce/DSN.pm
+++ b/fml/lib/Mail/Bounce/DSN.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: DSN.pm,v 1.11 2001/10/27 04:50:40 fukachan Exp $
+# $FML: DSN.pm,v 1.12 2001/12/22 09:21:15 fukachan Exp $
 #
 
 
@@ -77,6 +77,10 @@ See C<Mail::Bounce> for more details.
 =cut
 
 
+# Descriptions: analyze DSN
+#    Arguments: OBJ($self) OBJ($msg) HASH_REF($result)
+# Side Effects: update $result
+# Return Value: none
 sub analyze
 {
     my ($self, $msg, $result) = @_;
@@ -107,12 +111,16 @@ sub analyze
 }
 
 
-# DSN Example:
-#    Final-Recipient: rfc822; rudo@nuinui.net
-#    Action: failed
-#    Status: 4.0.0
-#    Diagnostic-Code: X-Postfix; connect to mx.nuinui.net[10.1.1.1]:
-#                     Connection refused
+# Descriptions: DSN parser 
+#               [DSN Example]
+#               Final-Recipient: rfc822; rudo@nuinui.net
+#               Action: failed
+#               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)
+# Side Effects: update $result
+# Return Value: none
 sub _parse_dsn_format
 {
     my ($self, $buf, $result) = @_;
@@ -150,6 +158,7 @@ sub _parse_dsn_format
     }
 }
 
+
 =head1 AUTHOR
 
 Ken'ichi Fukamachi
diff --git a/fml/lib/Mail/Bounce/FixBrokenAddress.pm b/fml/lib/Mail/Bounce/FixBrokenAddress.pm
index 6e9a4624..361a8d52 100644
--- a/fml/lib/Mail/Bounce/FixBrokenAddress.pm
+++ b/fml/lib/Mail/Bounce/FixBrokenAddress.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: FixBrokenAddress.pm,v 1.3 2001/09/18 03:31:33 fukachan Exp $
+# $FML: FixBrokenAddress.pm,v 1.4 2001/12/22 09:21:15 fukachan Exp $
 #
 
 
@@ -37,6 +37,10 @@ See C<Mail::Bounce> for more details.
 =cut
 
 
+# Descriptions: speculate correct address
+#    Arguments: STR($hint) STR($addr)
+# Side Effects: speculate $addr
+# Return Value: STR($addr)
 sub FixIt
 {
     my ($hint, $addr) = @_;
diff --git a/fml/lib/Mail/Bounce/Postfix19991231.pm b/fml/lib/Mail/Bounce/Postfix19991231.pm
index 6f29b260..e6dc27fe 100644
--- a/fml/lib/Mail/Bounce/Postfix19991231.pm
+++ b/fml/lib/Mail/Bounce/Postfix19991231.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: Postfix19991231.pm,v 1.9 2001/07/30 14:42:34 fukachan Exp $
+# $FML: Postfix19991231.pm,v 1.10 2001/12/22 09:21:16 fukachan Exp $
 #
 
 
@@ -51,6 +51,10 @@ sub class used in C<Mail::Bounce>.
 =cut
 
 
+# Descriptions: trap error of old postfix style
+#    Arguments: OBJ($self) OBJ($msg) HASH_REF($result)
+# Side Effects: update $result
+# Return Value: none
 sub analyze
 {
     my ($self, $msg, $result) = @_;
@@ -65,6 +69,10 @@ sub analyze
 }
 
 
+# Descriptions: analyze postfix error message
+#    Arguments: OBJ($self) OBJ($msg) HASH_REF($result)
+# Side Effects: update $result
+# Return Value: none
 sub _analyze_plaintext
 {
     my ($self, $msg, $result) = @_;
@@ -103,6 +111,10 @@ sub _analyze_plaintext
 }
 
 
+# Descriptions: analyze postfix error message II
+#    Arguments: OBJ($self) OBJ($msg) HASH_REF($result)
+# Side Effects: update $result
+# Return Value: none
 sub _analyze_broken_dsn
 {
     my ($self, $msg, $result) = @_;
@@ -127,6 +139,10 @@ sub _analyze_broken_dsn
 }
 
 
+# Descriptions: clean up address
+#    Arguments: OBJ($self) OBJ($msg) HASH_REF($result)
+# Side Effects: update $result
+# Return Value: none
 sub _parse_address
 {
     my ($self, $data, $result) = @_;
diff --git a/fml/lib/Mail/Bounce/SimpleMatch.pm b/fml/lib/Mail/Bounce/SimpleMatch.pm
index 55a11467..8bbd603a 100644
--- a/fml/lib/Mail/Bounce/SimpleMatch.pm
+++ b/fml/lib/Mail/Bounce/SimpleMatch.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: SimpleMatch.pm,v 1.23 2001/09/18 03:31:33 fukachan Exp $
+# $FML: SimpleMatch.pm,v 1.24 2001/12/22 09:21:16 fukachan Exp $
 #
 
 
@@ -156,6 +156,10 @@ my $reason_trap_regexp = {
 };
 
 
+# Descriptions: analyze irregular pattern
+#    Arguments: OBJ($self) OBJ($msg) HASH_REF($result)
+# Side Effects: update $result
+# Return Value: none
 sub analyze
 {
     my ($self, $msg, $result) = @_;
@@ -198,6 +202,10 @@ sub analyze
 }
 
 
+# Descriptions: end of scan range ?
+#    Arguments: OBJ($self) HASH_REF($args)
+# Side Effects: update $result
+# Return Value: 1 or 0
 sub _reach_end
 {
     my ($self, $args) = @_;
@@ -217,9 +225,13 @@ sub _reach_end
     0;
 }
 
-# XXX
-# XXX our state check is applied to each paragraph not the whole body.
-# XXX
+
+# Descriptions: trap address in error message
+#               our state check is applied to each paragraph
+#               not the whole body.
+#    Arguments: OBJ($self) HASH_REF($args)
+# Side Effects: update $result
+# Return Value: none
 sub _address_match
 {
     my ($self, $args) = @_;