clean up description

4 files changed, 39 insertions, 30 deletions

diff --git a/fml/lib/FML/Ticket/Model/toymodel.pm b/fml/lib/FML/Ticket/Model/toymodel.pm
index ebbc9f8e..0a784c3d 100644
--- a/fml/lib/FML/Ticket/Model/toymodel.pm
+++ b/fml/lib/FML/Ticket/Model/toymodel.pm
@@ -21,26 +21,41 @@ require Exporter;
 
 =head1 NAME
 
-FML::Ticket::Model::toymodel - a toymodel of ticket systems
+FML::Ticket::Model::toymodel - a ticket system toymodel
 
 =head1 SYNOPSIS
 
-=head1 DESCRIPTION
+   use FML::Ticket::Model::toymodel;
+   my $ticket = FML::Ticket::Model::toymodel->new($curproc, $args);
+   if (defined $ticket) {
+      $ticket->assign($curproc, $args);
+      $ticket->update_status($curproc, $args);
+      $ticket->update_db($curproc, $args);
+   }
+
+=head1 DESCRIPTIONS
+
+This is the simplest model which implements a ticket system.
+This model can handle simple ticket C<open> and C<close>.
+
+This routine adds the ticket-id at the last of the subject in each
+article. We track the ticket-id in articles to follow the ticket
+status.
 
 =head2 CLASS HIERARCHY
 
         FML::Ticket::System
                 |
                 A 
-       -------------------
+        -----------------
        |        |        |
     toymodel  model2    ....
 
-=head1 METHOD
+=head1 METHODS
 
 =head2 C<new($curproc, $args)>
 
-constructor. 
+the constructor. 
 
 =cut
 
@@ -299,24 +314,22 @@ sub _update_index_db
 }
 
 
-=head1 METHOD on DB IO
-
-methods to manipulate data in DB.
-
 =head2 C<open_db($curproc, $args)>
 
-open DB's which tie() hashes to DB as a file. 
-Our toymodel uses several DB's for
+open DB.
+It uses tie() to bind a hash to a DB file.
+Our toymodel uses several DB files for
 C<%ticket_id>,
 C<%date>,
 C<%status>,
 C<%sender>,
-C<%articles>,
+C<%articles>
+and
 C<%index>.
 
 =head2 C<close_db($curproc, $args)>
 
-untie() hashes opended by C<open_db()>.
+untie() corresponding hashes opended by C<open_db()>.
 
 =cut
 
@@ -429,26 +442,25 @@ sub _set_status
 
 
 
-=head1 OUTPUT ROUTINES
+=haead1 OUTPUT ROUTINES
 
 =head2 C<show_summary($curproc, $args>)
 
 show the ticket summary. 
 See L<_simple_print()> for more detail.
-
-Intenally
+Internally either of 
 C<_simple_print()> 
 or
 C<_summary_print()>
-is used for each purpose.
+is used for purposes.
 
-Each row has a set of 
+Each row that C<show_summary()> returns has a set of 
 C<date>, C<age>, C<status>, C<ticket-id> and 
 C<articles>, which is a list of articles with the ticket-id.
 
 =head2 C<_simple_print()>
 
-show entries by the ticket_id order. 
+show entries by the ticket_id order. For example,
 
        date    age status  ticket id             articles
  ------------------------------------------------------------
@@ -466,7 +478,6 @@ The cost is evaluated by $status and $age.
 The cost is larger as $age is larger.
 It is also larger if $status is C<open>.
 
-
 =cut
 
 
diff --git a/fml/lib/File/Rotate.pm b/fml/lib/File/Rotate.pm
index 4c146414..c7a243c9 100644
--- a/fml/lib/File/Rotate.pm
+++ b/fml/lib/File/Rotate.pm
@@ -18,11 +18,11 @@ END   {}
 
 =head1 NAME
 
-FILE::Rotate - IO with rotate operations
+File::Rotate - file rotate operations
 
 =head1 SYNOPSIS
 
-    $obj = new FILE::Rotate {
+    $obj = new File::Rotate {
 	max_size    => 10000,
 	num_backlog => 4,
     };
@@ -30,9 +30,8 @@ FILE::Rotate - IO with rotate operations
 
 =head1 DESCRIPTION
 
-library to wrap Rotate IO operations. 
-It automatically rotates $file in close() operation. 
-C<rotation> rearranges files like this:
+Utility functions for file rotate operations. 
+C<rotation> renames and rearranges files like this:
 
     rm file.4
     mv file.3 file.4
diff --git a/fml/lib/File/Sequence.pm b/fml/lib/File/Sequence.pm
index 5630cc2b..5cfc90e6 100644
--- a/fml/lib/File/Sequence.pm
+++ b/fml/lib/File/Sequence.pm
@@ -47,9 +47,9 @@ $id becomes 0, 1, 2, 0, 1, 2...
 File::Sequence module maintains the sequence number for something, 
 for example, the article number.
 
-For extension, you can generate cyclic number by this module.
-If you so, use the C<modulus> parameter in new() method.
-
+As an extension, you can generate a cyclic number by this module.
+Please specify C<modulus> parameter in new() method if you want to get
+a cyclic number.
 
 =head2 C<new($args)>
 
diff --git a/fml/lib/File/SimpleLock.pm b/fml/lib/File/SimpleLock.pm
index e15fdb24..ab789d77 100644
--- a/fml/lib/File/SimpleLock.pm
+++ b/fml/lib/File/SimpleLock.pm
@@ -31,8 +31,7 @@ File::SimpleLock - simple lock by flock(2)
 
 =head1 DESCRIPTION
 
-File::SimpleLock module contains several interfaces for several files,
-for example, Lockfiles, sysLock() (not yet implemented).
+File::SimpleLock module provides simple lock using flock(2).
 
 =head1 METHODS