fix/update comments.

11 files changed, 83 insertions, 86 deletions

diff --git a/fml/lib/FML/Command/Admin/newdomain.pm b/fml/lib/FML/Command/Admin/newdomain.pm
index eb72d52e..7195ad1c 100644
--- a/fml/lib/FML/Command/Admin/newdomain.pm
+++ b/fml/lib/FML/Command/Admin/newdomain.pm
@@ -1,10 +1,10 @@
 #-*- perl -*-
 #
-#  Copyright (C) 2003 Ken'ichi Fukamachi
+#  Copyright (C) 2003,2004 Ken'ichi Fukamachi
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: newdomain.pm,v 1.5 2003/12/28 13:23:16 fukachan Exp $
+# $FML: newdomain.pm,v 1.6 2004/01/02 14:49:25 fukachan Exp $
 #
 
 package FML::Command::Admin::newdomain;
@@ -92,7 +92,7 @@ Ken'ichi Fukamachi
 
 =head1 COPYRIGHT
 
-Copyright (C) 2003 Ken'ichi Fukamachi
+Copyright (C) 2003,2004 Ken'ichi Fukamachi
 
 All rights reserved. This program is free software; you can
 redistribute it and/or modify it under the same terms as Perl itself.
diff --git a/fml/lib/FML/Crypt.pm b/fml/lib/FML/Crypt.pm
index 3dacf02c..54169d7b 100644
--- a/fml/lib/FML/Crypt.pm
+++ b/fml/lib/FML/Crypt.pm
@@ -1,10 +1,10 @@
 #-*- perl -*-
 #
-#  Copyright (C) 2003 Ken'ichi Fukamachi
+#  Copyright (C) 2003,2004 Ken'ichi Fukamachi
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: Crypt.pm,v 1.3 2003/02/09 12:31:40 fukachan Exp $
+# $FML: Crypt.pm,v 1.4 2003/08/23 04:35:27 fukachan Exp $
 #
 
 package FML::Crypt;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Crypt - crypt library
+FML::Crypt - raw level crypt library wrapper
 
 =head1 SYNOPSIS
 
@@ -49,6 +49,10 @@ sub new
 }
 
 
+# XXX-TODO: hmm, strange object framework ?
+# XXX-TODO: $str = FML::String; $str->unix_crypt(); ???
+
+
 # Descriptions: unix crypt(3).
 #    Arguments: OBJ($self) STR($text) STR($salt)
 # Side Effects: none
@@ -73,7 +77,7 @@ Ken'ichi Fukamachi
 
 =head1 COPYRIGHT
 
-Copyright (C) 2003 Ken'ichi Fukamachi
+Copyright (C) 2003,2004 Ken'ichi Fukamachi
 
 All rights reserved. This program is free software; you can
 redistribute it and/or modify it under the same terms as Perl itself.
diff --git a/fml/lib/FML/IPC/Message.pm b/fml/lib/FML/IPC/Message.pm
index 1071c9eb..95861597 100644
--- a/fml/lib/FML/IPC/Message.pm
+++ b/fml/lib/FML/IPC/Message.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: Message.pm,v 1.2 2003/12/06 04:48:20 fukachan Exp $
+# $FML: Message.pm,v 1.3 2004/01/02 14:42:46 fukachan Exp $
 #
 
 package FML::IPC::Message;
@@ -22,8 +22,8 @@ FML::IPC::Message - basic message abstaction for IPC.
 
 =head1 DESCRIPTION
 
-FML::IPC::Message provides basic message abstraction and queue
-operations.
+FML::IPC::Message provides basic message abstraction suitable for
+message queue library.
 
 =head1 METHODS
 
diff --git a/fml/lib/FML/IPC/Queue.pm b/fml/lib/FML/IPC/Queue.pm
index 91ade6f0..2587cecb 100644
--- a/fml/lib/FML/IPC/Queue.pm
+++ b/fml/lib/FML/IPC/Queue.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: Queue.pm,v 1.2 2003/10/15 01:03:32 fukachan Exp $
+# $FML: Queue.pm,v 1.3 2004/01/02 14:42:46 fukachan Exp $
 #
 
 package FML::IPC::Queue;
@@ -21,7 +21,7 @@ FML::IPC::Queue - basic message queue operation
     my $queue = new FML::IPC::Queue;
 
     my $msg = new UserDefinedMessageObject { .. } # user defined object.
-    $queue->add($msg);
+    $queue->append($msg);
 
     my $qlist = $queue->list();
     for my $m (@$qlist) { $m->print();}
@@ -36,8 +36,12 @@ list up queue et.al.
 
 =head2 new()
 
+constructor.
+
 =head2 append($msg)
 
+append user defined message $msg into the message queue.
+
 =cut
 
 
diff --git a/fml/lib/FML/Process/Addr.pm b/fml/lib/FML/Process/Addr.pm
index 1848debc..417ecc17 100644
--- a/fml/lib/FML/Process/Addr.pm
+++ b/fml/lib/FML/Process/Addr.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2001,2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Addr.pm,v 1.14 2004/01/02 02:11:25 fukachan Exp $
+# $FML: Addr.pm,v 1.15 2004/01/02 14:50:33 fukachan Exp $
 #
 
 package FML::Process::Addr;
@@ -98,8 +98,8 @@ sub prepare
 sub verify_request
 {
     my ($curproc, $args) = @_;
-    my $argv = $curproc->command_line_argv();
-    my $len  = $#$argv + 1;
+    my $argv   = $curproc->command_line_argv();
+    my $len    = $#$argv + 1;
     my $config = $curproc->config();
 
     my $eval = $config->get_hook( 'fmladdr_verify_request_start_hook' );
@@ -136,15 +136,22 @@ See <FML::Process::Switch()> on C<$args> for more details.
 sub run
 {
     my ($curproc, $args) = @_;
-    my $config  = $curproc->config();
-    my $myname  = $curproc->myname();
-    my $argv    = $curproc->command_line_argv();
+    my $config = $curproc->config();
+    my $myname = $curproc->myname();
+    my $argv   = $curproc->command_line_argv();
 
     $curproc->_fmladdr();
 }
 
 
-# Descriptions: dummy
+=head2 finish
+
+dummy.
+
+=cut
+
+
+# Descriptions: dummy.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -210,7 +217,7 @@ show only accounts if -n option specified.
 sub _fmladdr
 {
     my ($curproc) = @_;
-    my $config = $curproc->config();
+    my $config    = $curproc->config();
 
     my $eval = $config->get_hook( 'fmladdr_run_start_hook' );
     if ($eval) { eval qq{ $eval; }; $curproc->logwarn($@) if $@; }
diff --git a/fml/lib/FML/Process/Alias.pm b/fml/lib/FML/Process/Alias.pm
index eedd2860..785d7059 100644
--- a/fml/lib/FML/Process/Alias.pm
+++ b/fml/lib/FML/Process/Alias.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2001,2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Alias.pm,v 1.15 2004/01/02 02:11:26 fukachan Exp $
+# $FML: Alias.pm,v 1.16 2004/01/02 14:50:33 fukachan Exp $
 #
 
 package FML::Process::Alias;
@@ -46,6 +46,10 @@ It make a C<FML::Process::Kernel> object and return it.
 
 =head2 prepare($args)
 
+load config files and fix @INC.
+
+=head2 verify_request($args)
+
 dummy.
 
 =cut
@@ -94,8 +98,8 @@ sub prepare
 sub verify_request
 {
     my ($curproc, $args) = @_;
-    my $argv = $curproc->command_line_argv();
-    my $len  = $#$argv + 1;
+    my $argv   = $curproc->command_line_argv();
+    my $len    = $#$argv + 1;
     my $config = $curproc->config();
 
     my $eval = $config->get_hook( 'fmlalias_verify_request_start_hook' );
@@ -138,7 +142,14 @@ sub run
 }
 
 
-# Descriptions: dummy
+=head2 finish($args)
+
+dummy.
+
+=cut
+
+
+# Descriptions: dummy.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -162,7 +173,7 @@ show help.
 =cut
 
 
-# Descriptions: show help
+# Descriptions: show help.
 #    Arguments: none
 # Side Effects: none
 # Return Value: none
@@ -187,23 +198,7 @@ _EOF_
 }
 
 
-=head2 _fmlalias()
-
-switch of C<fmlalias> command.
-
-C<Caution:>
-C<$args> is passed from parrent libexec/loader.
-We construct a new struct C<$command_args> here to pass parameters
-to child objects.
-C<FML::Command::$command> object takes them as arguments not pure
-C<$args>. It is a little mess. Pay attention.
-
-See <FML::Process::Switch()> on C<$args> for more details.
-
-=cut
-
-
-# Descriptions: fmlalias top level dispacher
+# Descriptions: fmlalias top level dispacher.
 #    Arguments: OBJ($curproc)
 # Side Effects: load FML::Command::command module and execute it.
 # Return Value: none
diff --git a/fml/lib/FML/Process/ConfViewer.pm b/fml/lib/FML/Process/ConfViewer.pm
index 4a65a7ab..09fd57e9 100644
--- a/fml/lib/FML/Process/ConfViewer.pm
+++ b/fml/lib/FML/Process/ConfViewer.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2000,2001,2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: ConfViewer.pm,v 1.26 2004/01/02 02:11:26 fukachan Exp $
+# $FML: ConfViewer.pm,v 1.27 2004/01/02 14:50:34 fukachan Exp $
 #
 
 package FML::Process::ConfViewer;
@@ -124,12 +124,6 @@ sub verify_request
 
 the top level dispatcher for C<fmlconf>.
 
-It kicks off internal function C<_fmlconf()> for C<fmlconf>.
-
-NOTE:
-C<$args> is passed from parrent libexec/loader.
-See <FML::Process::Switch()> on C<$args> for more details.
-
 =cut
 
 
@@ -141,8 +135,6 @@ sub run
 {
     my ($curproc, $args) = @_;
     my $config = $curproc->config();
-    my $myname = $curproc->myname();
-    my $argv   = $curproc->command_line_argv();
 
     my $eval = $config->get_hook( 'fmlconf_run_start_hook' );
     if ($eval) {
@@ -188,7 +180,7 @@ _EOF_
 }
 
 
-# Descriptions: dummy
+# Descriptions: dummy.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -211,13 +203,6 @@ sub finish
 }
 
 
-=head2 _fmlconf()
-
-run dump_variables of C<FML::Config>.
-
-=cut
-
-
 # Descriptions: show configurations variables in the sytle "key = value".
 #    Arguments: OBJ($curproc)
 # Side Effects: none
diff --git a/fml/lib/FML/Process/DocViewer.pm b/fml/lib/FML/Process/DocViewer.pm
index 50fb9da5..3215109c 100644
--- a/fml/lib/FML/Process/DocViewer.pm
+++ b/fml/lib/FML/Process/DocViewer.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2000,2001,2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: DocViewer.pm,v 1.28 2004/01/02 02:11:27 fukachan Exp $
+# $FML: DocViewer.pm,v 1.29 2004/01/02 14:50:35 fukachan Exp $
 #
 
 package FML::Process::DocViewer;
@@ -117,8 +117,6 @@ sub verify_request
 =head2 run($args)
 
 the main top level dispatcher.
-It kicks off internal function C<_fmlconf($args)> for
-C<fmlconf($args)>.
 
 =cut
 
@@ -130,9 +128,6 @@ C<fmlconf($args)>.
 sub run
 {
     my ($curproc, $args) = @_;
-    my $config = $curproc->config();
-    my $myname = $curproc->myname();
-    my $argv   = $curproc->command_line_argv();
 
     $curproc->_fmldoc();
 }
@@ -205,13 +200,12 @@ _EOF_
 
 =head2 finish()
 
-finalize.
+dummy.
 
 =cut
 
 
-# Descriptions: clean up in the end of the curreen process.
-#               return error messages et. al.
+# Descriptions: dummy.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: queue flush
 # Return Value: none
diff --git a/fml/lib/FML/Process/Obsolete.pm b/fml/lib/FML/Process/Obsolete.pm
index 728f046f..a4e94ebe 100644
--- a/fml/lib/FML/Process/Obsolete.pm
+++ b/fml/lib/FML/Process/Obsolete.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: Obsolete.pm,v 1.3 2003/09/13 09:06:09 fukachan Exp $
+# $FML: Obsolete.pm,v 1.4 2004/01/02 14:42:44 fukachan Exp $
 #
 
 package FML::Process::Obsolete;
@@ -14,7 +14,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Process::Obsolete - what is this
+FML::Process::Obsolete - show obsolete message (for obsolete module)
 
 =head1 SYNOPSIS
 
@@ -22,12 +22,18 @@ FML::Process::Obsolete - what is this
 
 =head1 METHODS
 
-=head2 new()
+=head2 new($args)
+
+constructor. run help as soon as possible.
+
+=head2 help($args)
+
+show "this module is obsolete.".
 
 =cut
 
 
-# Descriptions: ordinary constructor
+# Descriptions: constructor.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -39,7 +45,7 @@ sub new
 }
 
 
-# Descriptions: show help
+# Descriptions: show help.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
diff --git a/fml/lib/FML/Process/QueueManager.pm b/fml/lib/FML/Process/QueueManager.pm
index 207ce6a1..ef5aecde 100644
--- a/fml/lib/FML/Process/QueueManager.pm
+++ b/fml/lib/FML/Process/QueueManager.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: QueueManager.pm,v 1.16 2004/01/02 10:23:58 fukachan Exp $
+# $FML: QueueManager.pm,v 1.17 2004/01/02 14:50:37 fukachan Exp $
 #
 
 package FML::Process::QueueManager;
@@ -18,13 +18,15 @@ FML::Process::QueueManager - provide queue manipulation functions
 
 =head1 SYNOPSIS
 
+To flush all entries in the queue, 
+
     use FML::Process::QueueManager;
-    my $obj = new FML::Process::QueueManager { directory => $queue_dir };
-    $obj->send($curproc);
+    my $queue = new FML::Process::QueueManager { directory => $queue_dir };
+    $queue->send($curproc);
 
 or if you send specific queue C<$queue_id>, use
 
-    $obj->send($curproc, $queue_id);
+    $queue->send($curproc, $queue_id);
 
 where C<$queue_id> is queue id such as 1000390413.14775.1,
 not file path.
@@ -35,14 +37,14 @@ queue flush!
 
 =head1 METHODS
 
-=head2 new()
+=head2 new($qm_args)
 
 constructor.
 
 =cut
 
 
-use FML::Log qw(Log LogWarn LogError);
+# XXX-TODO: new FML::Process::QueueManager $curproc
 
 
 # Descriptions: standard constructor
@@ -63,13 +65,13 @@ sub new
 
 =head2 send($curproc, $id)
 
-try to send all mails in the queue.
-If queue id C<$id> is specified, send queue for C<$id>.
+try to send all messages in the queue. If the queue id C<$id> is
+specified, send only the queue corresponding to C<$id>.
 
 =cut
 
 
-# Descriptions: send message in queue directory sequentially
+# Descriptions: send message(s) in queue directory sequentially.
 #    Arguments: OBJ($self) OBJ($curproc) STR($id)
 # Side Effects: queue flush-ed
 # Return Value: none
diff --git a/fml/lib/FML/Process/Scheduler.pm b/fml/lib/FML/Process/Scheduler.pm
index e2f20e1b..fbf7cea1 100644
--- a/fml/lib/FML/Process/Scheduler.pm
+++ b/fml/lib/FML/Process/Scheduler.pm
@@ -1,9 +1,9 @@
 #-*- perl -*-
 #
-# Copyright (C) 2002,2003 Ken'ichi Fukamachi
+# Copyright (C) 2002,2003,2004 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: Scheduler.pm,v 1.22 2003/03/06 09:43:31 fukachan Exp $
+# $FML: Scheduler.pm,v 1.23 2003/04/04 05:05:03 fukachan Exp $
 #
 
 package FML::Process::Scheduler;
@@ -26,7 +26,7 @@ FML::Process::Scheduler -- scheduler.
 
 =head1 DESCRIPTION
 
-This class provides utility for scheduler.
+This class provides utility functions for scheduler.
 However this module is dummy now.
 
 =head1 METHODS
@@ -68,7 +68,7 @@ Ken'ichi Fukamachi
 
 =head1 COPYRIGHT
 
-Copyright (C) 2002,2003 Ken'ichi Fukamachi
+Copyright (C) 2002,2003,2004 Ken'ichi Fukamachi
 
 All rights reserved. This program is free software; you can
 redistribute it and/or modify it under the same terms as Perl itself.