clean up English ;)

4 files changed, 97 insertions, 98 deletions

diff --git a/fml/lib/IO/Adapter/File.pm b/fml/lib/IO/Adapter/File.pm
index ef2e4c85..69794527 100644
--- a/fml/lib/IO/Adapter/File.pm
+++ b/fml/lib/IO/Adapter/File.pm
@@ -16,7 +16,7 @@ use Carp;
 
 =head1 NAME
 
-IO::Adapter::File - functions to do IO for a file
+IO::Adapter::File - IO functions for a file
 
 =head1 SYNOPSIS
 
@@ -30,14 +30,16 @@ IO::Adapter::File - functions to do IO for a file
 
 =head1 DESCRIPTION
 
-This module provides real IO functions for a file used in IO::MapAdapter.
-The map is the fully pathed file name or a file name 'file:/' prefix.
+This module provides real IO functions for a file used in
+IO::MapAdapter. 
+The map is the fully path-ed file name or a file name with 'file:/'
+prefix. 
 
 =head1 METHODS
 
 =head2 C<new()>
 
-standard constructor
+standard constructor.
 
 =cut
 
@@ -53,7 +55,7 @@ sub new
 
 =head2 C<open($args)>
 
-$args HASH REFERENCE has two parameters. 
+$args HASH REFERENCE must have two parameters. 
 C<file> is the target file to open.
 C<flag> is the mode of open().
 
diff --git a/fml/lib/IO/File/Atomic.pm b/fml/lib/IO/File/Atomic.pm
index f6bbb093..3c431752 100644
--- a/fml/lib/IO/File/Atomic.pm
+++ b/fml/lib/IO/File/Atomic.pm
@@ -31,7 +31,10 @@ IO::Atomic - atomic IO operation
     print $wh "new/updated things ...";
     $wh->close unless $wh->error;
 
-So, in usual cases, you use this module in the following way.
+In C<close()> runs, the C<$file> is replaced with the new content.
+Updating is defered until C<close()>.
+
+In usual cases, you use this module in the following way.
 
     use FileHandle;
     use IO::Atomic;
diff --git a/fml/lib/IO/MapAdapter.pm b/fml/lib/IO/MapAdapter.pm
index 406431fa..fc593a63 100644
--- a/fml/lib/IO/MapAdapter.pm
+++ b/fml/lib/IO/MapAdapter.pm
@@ -22,12 +22,6 @@ IO::MapAdapter - adapter for several IO interfaces
 
 =head1 SYNOPSIS
 
-This is just an adapter for 
-e.g. file, unix group, NIS, RDMS et. al.
-So, after you create and open the map, 
-operation method is the same as usual file IO.
-For examle
-
     use IO::MapAdapter;
     $obj = new IO::MapAdapter $map;
     $obj->open || croak("cannot open $map");
@@ -36,22 +30,31 @@ For examle
 
 =head1 DESCRIPTION
 
-This is "Adapter" (or "Wrapper") design pattern.
+This is "Adapter" (or "Wrapper") C<design pattern>.
+This is a wrapper of IO for
+e.g. file, 
+unix group, 
+NIS (Network Information System), 
+RDBMS (Relational DataBase Management System)
+et. al.
+Once you create and open a C<map>, 
+you can use the same methods as usual file IO.
+
+=head2 MAP
 
-=head1 MAP
+C<map> specifies the type of the database we read/write.  
 
-"map" is what database we read/write. 
-The basic format of the database is a file. 
-In a lot of cases, the file format is one line for one entry.
-For example,
+For example, C<file> map imples we hold our data in a file.
+The format is one line for one entry in a lot of cases.
 
    key1
    key2 value
 
-So, to get one entry is to read one line or a part of one line.
+To get one entry is to read one line or a part of one line.
 
-This wrapper maps IO for some object to usual file IO.
+This wrapper provides IO like a usual file for the specified C<$map>. 
 
+=head2 MAP TYPES
 
    map name        descriptions or examples        
    ---------------------------------------------------
@@ -141,8 +144,10 @@ sub new
 
 =item C<open([$flag])>
 
-start IO operation for the map. $flag is passed to SUPER CLASS open()
-for "file:" map but ignored in other maps now.
+open IO operation for the map. 
+C<$flag> is passed to SUPER CLASS open()
+when "file:" map is specified. 
+C<open()> is a dummy function in other maps now.
 
 =cut
 
@@ -179,14 +184,16 @@ sub open
 
 =item C<getline()>
 
-For file map, it is the same as usual getline() for file.
-For other maps, same as C<get_next_value()> method.
+In C<file> map case, it is the same as usual getline() for a file.
+In other maps, it is the same as C<get_next_value()> method below.
 
 =item C<get_next_value()>
 
-get the next value. For example, the first column in the next line for
-C<file> map. For C<array_reference>, C<unix.group>, C<nis.grouop> maps,
-return the next element of the array.
+get the next value from the specified database (map). 
+For example, this function returns the first column in the next line
+for C<file> map. 
+It return the next element of the array,
+in C<array_reference>, C<unix.group>, C<nis.grouop> maps.
 
 =item C<get_member()>
 
diff --git a/regress/simulation/todo/doc b/regress/simulation/todo/doc
index 0daafdd2..51efd3ff 100644
--- a/regress/simulation/todo/doc
+++ b/regress/simulation/todo/doc
@@ -28,102 +28,89 @@ etc/defaults/cgi.cf.ja
 etc/config.cf
 
 
-lib/Dialect/Japanese/String.pm
-lib/Dialect/Japanese/Subject.pm
-lib/Dialect/Japanese/Utils.pm
-lib/Dialect/ISO2022JP.pm
+Dialect/Japanese/String.pm
+Dialect/Japanese/Subject.pm
+Dialect/Japanese/Utils.pm
+Dialect/ISO2022JP.pm
 
 
-lib/Article.pm
-lib/Checksum.pm
-lib/Config.pm
-lib/Credential.pm
-lib/Date.pm
-lib/Debug.pm
-lib/Errors.pm
-lib/Header.pm
-lib/Log.pm
-lib/MIME.pm
+Article.pm
+Checksum.pm
+Config.pm
+Credential.pm
+Date.pm
+Debug.pm
+Errors.pm
+Header.pm
+Log.pm
+MIME.pm
 
 
-lib/Messages.pm
-lib/PCB.pm
-lib/Parse.pm
-lib/CGI/TicketSystem.pm
+Messages.pm
+PCB.pm
+Parse.pm
+CGI/TicketSystem.pm
 
 
-lib/Command/mget.pm
-lib/Command/bye.pm
-lib/Command/get.pm
-lib/Command/remove.pm
-lib/Command/resign.pm
-lib/Command/subscribe.pm
-lib/Command/unsubscribe.pm
+Command/mget.pm
+Command/bye.pm
+Command/get.pm
+Command/remove.pm
+Command/resign.pm
+Command/subscribe.pm
+Command/unsubscribe.pm
 
 
-lib/Header/Subject.pm
-lib/Process/Command.pm
-lib/Process/Configure.pm
-lib/Process/Distribute.pm
-lib/Process/Flow.pm
-lib/Process/Kernel.pm
+Header/Subject.pm
+Process/Command.pm
+Process/Configure.pm
+Process/Distribute.pm
+Process/Flow.pm
+Process/Kernel.pm
 
 
-lib/Process/QMail.pm
-lib/Process/Switch.pm
-lib/Process/TicketSystem.pm
-lib/Process/CGI.pm
+Process/QMail.pm
+Process/Switch.pm
+Process/TicketSystem.pm
+Process/CGI.pm
 
 
-lib/Ticket/Model/toymodel.ja.txt
-lib/Ticket/Model/toymodel.pm
-lib/Ticket/00_DESIGN.txt
+Ticket/Model/toymodel.ja.txt
+Ticket/Model/toymodel.pm
+Ticket/00_DESIGN.txt
 
 
-lib/Ticket/System.pm
-lib/File/Errors.pm
+Ticket/System.pm
+File/Errors.pm
 
 
-lib/File/RingBuffer.pm
-lib/File/Rotate.pm
-lib/File/Sequence.pm
-lib/File/SimpleLock.pm
-lib/File/Utils.pm
+File/RingBuffer.pm
+File/Rotate.pm
+File/Sequence.pm
+File/SimpleLock.pm
+File/Utils.pm
 
 
-lib/IO/Adapter/Array.pm
-lib/IO/Adapter/File.pm
-lib/IO/Adapter/LDAP.pm
+IO/Adapter/Array.pm
+IO/Adapter/NIS.pm
+IO/Adapter/UnixGroup.pm
 
 
-lib/IO/Adapter/NIS.pm
-lib/IO/Adapter/RDBMS.pm
-lib/IO/Adapter/UnixGroup.pm
+MailingList/Net/INET4.pm
+MailingList/Net/INET6.pm
+MailingList/Delivery.ja.pod
+MailingList/Delivery.pm
+MailingList/Messages.pm
+MailingList/SMTP.pm
+MailingList/Utils.pm
 
 
-lib/IO/MapAdapter.pm
+ErrorMessages/00_PARSE.ja.txt
+ErrorMessages/00_README.ja.txt
 
 
-lib/IO/File/Atomic.pm
-
-
-lib/MailingList/Net/INET4.pm
-lib/MailingList/Net/INET6.pm
-
-
-lib/MailingList/Delivery.ja.pod
-lib/MailingList/Delivery.pm
-lib/MailingList/ESMTP.pm
-
-
-lib/MailingList/Messages.pm
-lib/MailingList/SMTP.pm
-lib/MailingList/Utils.pm
-lib/ErrorMessages/00_PARSE.ja.txt
-lib/ErrorMessages/00_README.ja.txt
-lib/Tie/JournaledFile.pm
+Tie/JournaledFile.pm
 
 
 libexec/Standalone.pm
-libexec/boot.ja.html
 libexec/loader