summaryrefslogtreecommitdiff
path: root/fml/lib/FML/Command.pm
diff options
context:
space:
mode:
authorfukachan <fukachan>2002-12-22 03:39:43 +0000
committerfukachan <fukachan>2002-12-22 03:39:43 +0000
commitbb988212c5f9965e76c6ee45ba1865326debb61b (patch)
treee14bcb385dbb23b6c422ad9a20863799fd5ad399 /fml/lib/FML/Command.pm
parent6ea603787b3d0742e6d8a0a27dcf6f4808a0fa41 (diff)
downloadfml8-bb988212c5f9965e76c6ee45ba1865326debb61b.tar.gz
fml8-bb988212c5f9965e76c6ee45ba1865326debb61b.tar.bz2
fml8-bb988212c5f9965e76c6ee45ba1865326debb61b.zip
fix comments
Diffstat (limited to 'fml/lib/FML/Command.pm')
-rw-r--r--fml/lib/FML/Command.pm29
1 files changed, 20 insertions, 9 deletions
diff --git a/fml/lib/FML/Command.pm b/fml/lib/FML/Command.pm
index 38263430..579b1633 100644
--- a/fml/lib/FML/Command.pm
+++ b/fml/lib/FML/Command.pm
@@ -4,9 +4,14 @@
# All rights reserved. This program is free software; you can
# redistribute it and/or modify it under the same terms as Perl itself.
#
-# $FML: Command.pm,v 1.32 2002/09/11 23:18:01 fukachan Exp $
+# $FML: Command.pm,v 1.33 2002/09/22 14:56:39 fukachan Exp $
#
+# XXX
+# XXX FML::Command should be simple since all program uses this wrapper.
+# XXX So, complicated checks are moved to FML::Process::* and each module.
+# XXX
+
package FML::Command;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
@@ -28,20 +33,20 @@ FML::Command - fml command dispatcher
C<FML::Command> is a wrapper and dispathcer for fml commands.
AUTOLOAD() picks up the command request and dispatches
-C<FML::Command::User::somoting> suitable for the request.
-Also, C<FML::Command::Admin::somoting> for the admin command request
-and makefml commands.
+C<FML::Command::User::something> suitable for the request.
+Also, it kicks off C<FML::Command::Admin::something> for the admin
+command request and makefml commands.
=head1 METHODS
=head2 C<new()>
-ordinary constructor.
+constructor.
=cut
-# Descriptions: ordinary constructor
+# Descriptions: constructor.
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: OBJ
@@ -54,7 +59,7 @@ sub new
}
-# Descriptions: ordinary destructor
+# Descriptions: destructor (dummy).
# Arguments: none
# Side Effects: none
# Return Value: none
@@ -68,6 +73,9 @@ $rbuf is rewritten as a result.
For example, this function is used to hide the password in the $rbuf
buffer.
+Each module such as C<FML::Command::$MODE::$SOMETING> specifies
+how to rewrite by rewrite_prompt() method in it.
+
=cut
@@ -99,6 +107,9 @@ sub rewrite_prompt
return addresses to inform for the command reply.
+Each module such as C<FML::Command::$MODE::$SOMETING> specifies
+recipients by notice_cc_recipient() method in it.
+
=cut
@@ -127,8 +138,8 @@ sub notice_cc_recipient
=head2 C<AUTOLOAD()>
the command dispatcher.
-It hooks up the C<command> request and loads the module in
-C<FML::Command::command>.
+It hooks up the C<$command> request and loads the module in
+C<FML::Command::$MODE::$command>.
=cut