clean up document

1 files changed, 47 insertions, 10 deletions

diff --git a/fml/lib/FML/Process/TicketSystem.pm b/fml/lib/FML/Process/TicketSystem.pm
index 19613060..980e0202 100644
--- a/fml/lib/FML/Process/TicketSystem.pm
+++ b/fml/lib/FML/Process/TicketSystem.pm
@@ -1,7 +1,7 @@
 #!/usr/local/bin/perl -w
 #-*- perl -*-
 #
-# Copyright (C) 2000 Ken'ichi Fukamachi
+# Copyright (C) 2000-2001 Ken'ichi Fukamachi
 #          All rights reserved. 
 #
 # $FML$
@@ -17,7 +17,27 @@ use FML::Process::Kernel;
 use FML::Log qw(Log);
 use FML::Config;
 
-require Exporter;
+=head1 NAME
+
+FML::Process::TicketSystem -- primitive fml5 ticket system
+
+=head1 SYNOPSIS
+
+    use FML::Process::TicketSystem;
+         ... snip ...
+
+    use FML::Ticket::Model::toymodel;
+    $ticket = FML::Ticket::Model::toymodel->new($curproc, $args);
+    $ticket->$method($curproc, $args);
+
+=head1 DESCRIPTION
+
+
+=head1 METHOD
+
+=cut
+
+
 @ISA = qw(FML::Process::Kernel Exporter);
 
 
@@ -30,7 +50,10 @@ sub new
 }
 
 
-# dummy
+# Descriptions: dummy to avoid to take data from STDIN 
+#    Arguments: $self $args
+# Side Effects: 
+# Return Value: none
 sub prepare
 {
     ;
@@ -46,7 +69,7 @@ sub run
     my $argv    = $args->{ ARGV };
     my $command = $argv->[ 0 ] || 'list';
 
-    # fake use() to do "use FML::Ticket::$model;"
+    # fake "use FML::Ticket::Model::$model;"
     eval qq{ require $pkg; $pkg->import();};
     unless ($@) {
 	my $ticket = $pkg->new($curproc, $args);
@@ -81,23 +104,37 @@ sub run
 }
 
 
+sub DESTROY {}
+
+# Descriptions: dummy routine to avoid errors
+#               since we need all methods defined in FML::Process::Flow.
+#    Arguments: $self $args
+# Side Effects: none
+# Return Value: none
 sub AUTOLOAD
 {
     my ($curproc, $args) = @_;
-    ;
+    1;
 }
 
 
-=head1 NAME
+=head1 AUTHOR
 
-TicketSystem -- primitive fml5 ticket system
+Ken'ichi Fukamachi
 
-=head1 SYNOPSIS
+=head1 COPYRIGHT
 
-C<NOT YET IMPLEMENTED>.
+Copyright (C) 2001 Ken'ichi Fukamachi
 
-=head1 DESCRIPTION
+All rights reserved. This program is free software; you can
+redistribute it and/or modify it under the same terms as Perl itself. 
+
+=head1 HISTORY
+
+FML::Process::Kernel appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
 
 =cut
 
+
 1;