clean up documenets

6 files changed, 29 insertions, 36 deletions

diff --git a/fml/lib/Dialect/ISO2022JP.pm b/fml/lib/Dialect/ISO2022JP.pm
index 85d1b27d..4e67cfcc 100644
--- a/fml/lib/Dialect/ISO2022JP.pm
+++ b/fml/lib/Dialect/ISO2022JP.pm
@@ -9,6 +9,7 @@
 #
 
 package Dialect::ISO2022JP;
+
 use strict;
 use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
 use Carp;
@@ -20,13 +21,17 @@ require Exporter;
 
 =head1 NAME
 
-Dialect::ISO2022JP.pm - adapter for Dialect::Japanese
+Dialect::ISO2022JP - adapter for Dialect::Japanese
 
 =head1 SYNOPSIS
 
     use Dialect::ISO2022JP qw(is_iso2022jp_string);
     if ( is_iso2022jp_string($string) ) { do_something_if_Japanese;}
 
+=head1 SEE ALSO
+
+L<Dialect::Japanese>
+
 =head1 AUTHOR
 
 Ken'ichi Fukamachi
diff --git a/fml/lib/FML/Debug.pm b/fml/lib/FML/Debug.pm
index 1d17c3a5..279c943d 100644
--- a/fml/lib/FML/Debug.pm
+++ b/fml/lib/FML/Debug.pm
@@ -17,11 +17,12 @@ FML::Debug -- debug utilities
     use FML::Debug;
     FML::Debug->show_structure( $variable );
 
-=head1 METHOD
+=head1 METHODS
 
 =item show_structure()
 
 It shows the data structure for the given variable.
+It is just an wrapper for L<Data::Dumper>.
 
 =cut
 
@@ -35,11 +36,15 @@ sub new
 }
 
 
+# Descriptions: dump the target data structure
+#    Arguments: $self target
+# Side Effects: none
+# Return Value: none
 sub show_structure
 {
-    my ($class, $ref) = @_;
+    my ($self, $r_target) = @_;
     use Data::Dumper;
-    print Dumper( $ref );
+    print Dumper( $r_target );
 }
 
 
diff --git a/fml/lib/FML/Errors.pm b/fml/lib/FML/Errors.pm
index ea3f2804..81775589 100644
--- a/fml/lib/FML/Errors.pm
+++ b/fml/lib/FML/Errors.pm
@@ -13,13 +13,15 @@ use strict;
 use vars qw(@ISA @EXPORT @EXPORT_OK);
 use Carp;
 
+use File::Errors qw(error_reason error error_reset);
+
 require Exporter;
-@ISA       = qw(Exporter);
+@ISA       = qw(File::Errors Exporter);
 @EXPORT_OK = qw(error_reason error error_reset);
 
 =head1 NAME
 
-FML::Errors.pm - error handling utilities
+FML::Errors - error handling utilities
 
 =head1 SYNOPSIS
 
@@ -38,9 +40,15 @@ When you use Something module,
 	$obj = new Something;
 	unless ($obj->error) { $obj->do_somting( ...); };
 
-
 =head1 DESCRIPTION
 
+a wrapper to L<File::Errors>.
+All requests are forwarddt to C<File::Errors>.
+
+=head1 SEE ALSO
+
+L<File::Errors>
+
 =head1 AUTHOR
 
 Ken'ichi Fukamachi
@@ -60,28 +68,4 @@ See C<http://www.fml.org/> for more details.
 =cut
 
 
-sub error_reason
-{
-    my ($self, $mesg) = @_;
-    $self->{'_error_reason'} = $mesg;
-}
-
-
-sub error
-{
-    my ($self, $args) = @_;
-    return $self->{'_error_reason'};
-}
-
-
-sub error_reset
-{
-    my ($self, $args) = @_;
-    my $msg = $self->{'_error_reason'};
-    undef $self->{'_error_reason'} if defined $self->{'_error_reason'};
-    undef $self->{'_error_action'} if defined $self->{'_error_action'};
-    return $msg;
-}
-
-
 1;
diff --git a/fml/lib/File/Errors.pm b/fml/lib/File/Errors.pm
index bf8779e7..3846eb1e 100644
--- a/fml/lib/File/Errors.pm
+++ b/fml/lib/File/Errors.pm
@@ -38,6 +38,9 @@ When you use Something module,
 	$obj = new Something;
 	unless ($obj->error) { $obj->do_somting( ...); };
 
+=head1 DESCRIPTION
+
+utility functions to manipulate error messages.
 
 =head1 METHODS
 
diff --git a/fml/lib/MailingList/ESMTP.pm b/fml/lib/MailingList/ESMTP.pm
index 34a25bb1..fb9019f8 100644
--- a/fml/lib/MailingList/ESMTP.pm
+++ b/fml/lib/MailingList/ESMTP.pm
@@ -36,6 +36,7 @@ MailingList::ESMTP - Extended SMTP class
 
 See L<MailingList::SMTP> for more details since this ESMTP class
 is an adapter for SMTP (super) class for convenience.
+All requests are forwarded to SMTP super class.
 
 =head1 AUTHOR
 
diff --git a/regress/simulation/todo/doc b/regress/simulation/todo/doc
index 8d3857ef..35f12807 100644
--- a/regress/simulation/todo/doc
+++ b/regress/simulation/todo/doc
@@ -3,13 +3,10 @@ FML/Article.pm
 FML/Config.pm
 FML/Credential.pm
 FML/Date.pm
-FML/Debug.pm
 FML/Header.pm
 FML/Log.pm
 FML/Messages.pm
 FML/Parse.pm
-FML/String.pm
-FML/Errors.pm
 FML/Ticket/Model/toymodel.pm
 FML/Ticket/System.pm
 FML/Process/Distribute.pm
@@ -33,11 +30,9 @@ IO/MapAdapter.pm
 IO/File/Atomic.pm
 Dialect/Japanese/Subject.pm
 Dialect/Japanese/Utils.pm
-Dialect/ISO2022JP.pm
 MailingList/Net/INET4.pm
 MailingList/Net/INET6.pm
 MailingList/Messages.pm
 MailingList/SMTP.pm
 MailingList/Delivery.pm
 MailingList/Utils.pm
-MailingList/ESMTP.pm