summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfukachan <fukachan>2001-03-09 16:44:16 +0000
committerfukachan <fukachan>2001-03-09 16:44:16 +0000
commit88b55c68db1fbbd838a0fcfc8ddae05b59d5256b (patch)
treed63277ae286566dd85561f6ccc0410ea090a86df
parent77fd308cddaf5008486117fb4b5f86f1399a648c (diff)
downloadfml8-88b55c68db1fbbd838a0fcfc8ddae05b59d5256b.tar.gz
fml8-88b55c68db1fbbd838a0fcfc8ddae05b59d5256b.tar.bz2
fml8-88b55c68db1fbbd838a0fcfc8ddae05b59d5256b.zip
clean up description
-rw-r--r--fml/lib/FML/MIME.pm18
-rw-r--r--fml/lib/FML/Process/Flow.pm4
-rw-r--r--fml/lib/IO/Adapter/NIS.pm6
-rw-r--r--fml/lib/IO/Adapter/UnixGroup.pm4
-rw-r--r--regress/simulation/todo/doc16
5 files changed, 18 insertions, 30 deletions
diff --git a/fml/lib/FML/MIME.pm b/fml/lib/FML/MIME.pm
index 1468e3b7..75e15032 100644
--- a/fml/lib/FML/MIME.pm
+++ b/fml/lib/FML/MIME.pm
@@ -16,7 +16,7 @@ use Carp;
=head1 NAME
-FML::MIME - utilities to handle MIME encoded string
+FML::MIME - handle a MIME encoded string
=head1 SYNOPSIS
@@ -37,13 +37,14 @@ require Exporter;
@EXPORT_OK = qw(decode_mime_string encode_mime_string);
-=head2 C<decode_mime_string(string, [options])>
+=head2 C<decode_mime_string(string, [$options])>
-decode an base64/quoted-printable encoded string to a plain message.
+decode a base64/quoted-printable encoded string to a plain message.
The encoding method is automatically detected.
-C<options> is a HASH REFERENCE.
-You can specify the charset of string to return as C<options->{ charset }>.
+C<$options> is a HASH REFERENCE.
+You can specify the charset of the string to return
+by $options->{ charset }.
=cut
@@ -70,13 +71,14 @@ sub decode_mime_string
}
-=head2 C<decode_mime_string(string, [options])>
+=head2 C<decode_mime_string(string, [$options])>
-encode the C<string> by the encoder C<options->{ encode }>.
+encode the C<string> by the encoder $options->{ encode }.
The encode is base64 by default.
C<options> is a HASH REFERENCE.
-You can specify the charset of string to return as C<options->{ charset }>.
+You can specify the charset of string to return
+by $options->{ charset }.
=cut
diff --git a/fml/lib/FML/Process/Flow.pm b/fml/lib/FML/Process/Flow.pm
index fc72abcc..3272d4c6 100644
--- a/fml/lib/FML/Process/Flow.pm
+++ b/fml/lib/FML/Process/Flow.pm
@@ -27,8 +27,8 @@ C<$args> is HASH REFERENCE.
=head1 DESCRIPTION
-This is the current fml program flow.
-Each function is implemented in each module in FML::Process class.
+This module describes the current fml program flow.
+Each function is implemented in each module of FML::Process classes.
# create a new process object
my $process = $pkg->new($args);
diff --git a/fml/lib/IO/Adapter/NIS.pm b/fml/lib/IO/Adapter/NIS.pm
index a33c22fe..c40866af 100644
--- a/fml/lib/IO/Adapter/NIS.pm
+++ b/fml/lib/IO/Adapter/NIS.pm
@@ -33,7 +33,7 @@ sub configure
=head1 NAME
-IO::Adapter::NIS.pm - NIS map definition under IO::MapAdapter
+IO::Adapter::NIS.pm - NIS map operations
=head1 SYNOPSIS
@@ -47,7 +47,7 @@ IO::Adapter::NIS.pm - NIS map definition under IO::MapAdapter
=head1 DESCRIPTION
-fake IO for
+fake IO operations to
NIS (Network Information System, its old name is Yellow Page).
See L<IO::Adapter::Array> for more details.
@@ -55,7 +55,7 @@ C<CAUTION: this map is read only>.
=head1 METHODS
-See L<IO::Adapter::Array>
+See L<IO::Adapter::Array>.
=head1 SEE ALSO
diff --git a/fml/lib/IO/Adapter/UnixGroup.pm b/fml/lib/IO/Adapter/UnixGroup.pm
index 2083ac28..c9a4726c 100644
--- a/fml/lib/IO/Adapter/UnixGroup.pm
+++ b/fml/lib/IO/Adapter/UnixGroup.pm
@@ -32,7 +32,7 @@ sub configure
=head1 NAME
-IO::Adapter::UnixGroup - IO wrapper for /etc/group
+IO::Adapter::UnixGroup - IO wrapper to read /etc/group
=head1 SYNOPSIS
@@ -52,6 +52,8 @@ IO::Adapter::UnixGroup - IO wrapper for /etc/group
See L<IO::Adapter::Array> for more details.
+C<CAUTION: this map is read only>.
+
=head1 SEE ALSO
L<IO::Adapter::Array>
diff --git a/regress/simulation/todo/doc b/regress/simulation/todo/doc
index 734dc195..fd407517 100644
--- a/regress/simulation/todo/doc
+++ b/regress/simulation/todo/doc
@@ -23,7 +23,6 @@ etc/defaults/cgi.cf.ja
Dialect/Japanese/String.pm
Dialect/Japanese/Subject.pm
Dialect/Japanese/Utils.pm
-Dialect/ISO2022JP.pm
FML/Article.pm
@@ -35,7 +34,6 @@ FML/Debug.pm
FML/Errors.pm
FML/Header.pm
FML/Log.pm
-FML/MIME.pm
FML/Messages.pm
FML/PCB.pm
FML/Parse.pm
@@ -43,25 +41,13 @@ FML/Parse.pm
CGI/TicketSystem.pm
-
-Command/mget.pm
-Command/bye.pm
-Command/get.pm
-Command/remove.pm
-Command/resign.pm
-Command/subscribe.pm
-Command/unsubscribe.pm
-
-
Header/Subject.pm
Process/Command.pm
Process/Configure.pm
Process/Distribute.pm
-Process/Flow.pm
Process/Kernel.pm
-Process/QMail.pm
Process/Switch.pm
Process/TicketSystem.pm
Process/CGI.pm
@@ -75,8 +61,6 @@ File/Utils.pm
IO/Adapter/Array.pm
-IO/Adapter/NIS.pm
-IO/Adapter/UnixGroup.pm
MailingList/Net/INET4.pm