clean up doc

4 files changed, 42 insertions, 28 deletions

diff --git a/fml/lib/FML/Credential.pm b/fml/lib/FML/Credential.pm
index 81a31462..fa3da34a 100644
--- a/fml/lib/FML/Credential.pm
+++ b/fml/lib/FML/Credential.pm
@@ -40,6 +40,12 @@ bind \%Credential to $self and return it as an object.
 =cut
 
 
+# Descriptions: usual constructor
+#               bind $self ($me) to \%Credential, so
+#               you can access the same \%Credential through this object.
+#    Arguments: $self
+# Side Effects: bind $self ($me) to \%Credential
+# Return Value: object
 sub new
 {
     my ($self) = @_;
@@ -71,10 +77,10 @@ process.
 sub is_member { 1;}
 
 
-# Descriptions: 
-#    Arguments: $self $args
-# Side Effects: 
-# Return Value: none
+# Descriptions: returh the mail sender
+#    Arguments: $self
+# Side Effects: none
+# Return Value: mail address
 sub sender
 {
     my ($self) = @_;
@@ -90,9 +96,9 @@ sub sender
 
 
 # Descriptions: 
-#    Arguments: $self $args
-# Side Effects: 
-# Return Value: none
+#    Arguments: $self key
+# Side Effects: none
+# Return Value: string
 sub get
 {
     my ($self, $key) = @_;
@@ -101,9 +107,9 @@ sub get
 
 
 # Descriptions: 
-#    Arguments: $self $args
-# Side Effects: 
-# Return Value: none
+#    Arguments: $self key value
+# Side Effects: none
+# Return Value: string
 sub set
 {
     my ($self, $key, $value) = @_;
diff --git a/fml/lib/FML/Header.pm b/fml/lib/FML/Header.pm
index b1c2b742..e3f3c744 100644
--- a/fml/lib/FML/Header.pm
+++ b/fml/lib/FML/Header.pm
@@ -10,6 +10,13 @@
 
 package FML::Header;
 
+use strict;
+use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
+use Carp;
+use Mail::Header;
+use FML::Log qw(Log);
+
+
 =head1 NAME
 
 FML::Header - header manipulators
@@ -24,16 +31,10 @@ FML::Header - header manipulators
 FML::Header is an adapter for Mail::Address class.
 That is, Mail::Address is the base class. 
 
-=head1 METHOD
+=head1 METHODS
 
 =cut
 
-use strict;
-use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
-use Carp;
-use Mail::Header;
-use FML::Log qw(Log);
-
 require Exporter;
 @ISA = qw(Mail::Header Exporter);
 
@@ -211,4 +212,5 @@ See C<http://www.fml.org/> for more details.
 
 =cut
 
+
 1;
diff --git a/fml/lib/IO/Adapter/NIS.pm b/fml/lib/IO/Adapter/NIS.pm
index 1b7ded31..a33c22fe 100644
--- a/fml/lib/IO/Adapter/NIS.pm
+++ b/fml/lib/IO/Adapter/NIS.pm
@@ -45,11 +45,6 @@ IO::Adapter::NIS.pm - NIS map definition under IO::MapAdapter
     while ($x = $obj->getline) { ... }
     $obj->close;
 
-/etc/group has C<fml> entry like this:
-
-  fml:*:1000:fukachan
-
-
 =head1 DESCRIPTION
 
 fake IO for 
diff --git a/fml/lib/IO/Adapter/UnixGroup.pm b/fml/lib/IO/Adapter/UnixGroup.pm
index 11141c0b..2083ac28 100644
--- a/fml/lib/IO/Adapter/UnixGroup.pm
+++ b/fml/lib/IO/Adapter/UnixGroup.pm
@@ -32,19 +32,29 @@ sub configure
 
 =head1 NAME
 
-IO::Adapter::UnixGroup.pm - what is this
+IO::Adapter::UnixGroup - IO wrapper for /etc/group
 
 =head1 SYNOPSIS
 
-=head1 DESCRIPTION
+    $map = 'unix.group:fml';
+
+    use IO::MapAdapter;
+    $obj = new IO::MapAdapter $map;
+    $obj->open || croak("cannot open $map");
+    while ($x = $obj->getline) { ... }
+    $obj->close;
+
+/etc/group has C<fml> entry like this:
 
-=head1 CLASSES
+  fml:*:1000:fukachan
 
-=head1 METHODS
+=head1 DESCRIPTION
+
+See L<IO::Adapter::Array> for more details.
 
-=item C<new()>
+=head1 SEE ALSO
 
-... what is this ...
+L<IO::Adapter::Array>
 
 =head1 AUTHOR
 
@@ -64,4 +74,5 @@ See C<http://www.fml.org/> for more details.
 
 =cut
 
+
 1;