diff options
| author | fukachan <fukachan> | 2001-05-30 14:35:09 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2001-05-30 14:35:09 +0000 |
| commit | 1149b16f28aa8f39ea7a405dcd826825125666c5 (patch) | |
| tree | dbafc7b0b8311e02b84c4edff83bb795b75b56a7 /fml/lib/IO/Adapter/Array.pm | |
| parent | 48a3f038d2969351aa63d366eb87e34bf862447b (diff) | |
| download | fml8-1149b16f28aa8f39ea7a405dcd826825125666c5.tar.gz fml8-1149b16f28aa8f39ea7a405dcd826825125666c5.tar.bz2 fml8-1149b16f28aa8f39ea7a405dcd826825125666c5.zip | |
clean up documents
Diffstat (limited to 'fml/lib/IO/Adapter/Array.pm')
| -rw-r--r-- | fml/lib/IO/Adapter/Array.pm | 47 |
1 files changed, 24 insertions, 23 deletions
diff --git a/fml/lib/IO/Adapter/Array.pm b/fml/lib/IO/Adapter/Array.pm index 7ec7c4d9..9d064638 100644 --- a/fml/lib/IO/Adapter/Array.pm +++ b/fml/lib/IO/Adapter/Array.pm @@ -4,8 +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. # -# $Id$ -# $FML: Array.pm,v 1.17 2001/04/03 09:45:45 fukachan Exp $ +# $FML: Array.pm,v 1.18 2001/04/08 13:25:40 fukachan Exp $ # package IO::Adapter::Array; @@ -17,7 +16,7 @@ use IO::Adapter::ErrorStatus qw(error_set error error_clear); =head1 NAME -IO::Adapter::Array - emulation of IO for the ARRAY +IO::Adapter::Array - IO emulation for the ARRAY =head1 SYNOPSIS @@ -37,7 +36,7 @@ emulate IO operation for the ARRAY. =item C<new()> -constructor. It is a dummy in fact now. +constructor. =cut @@ -127,6 +126,16 @@ sub get_next_value } +=head2 C<getpos()> + +return the current position in the array + +=head2 C<setpos($pos)> + +set the current position to $pos -th element. + +=cut + # Descriptions: return the current position in the array, that is, # which element in the array # Arguments: $self @@ -151,6 +160,17 @@ sub setpos } +=head2 C<eof()> + +whether the current position reaches the end of the array or not. +If it already reaches the end, return 1. + +=head2 C<close()> + +end of IO operation. It is a dummy. + +=cut + # Descriptions: whether end of the array is not now # Arguments: $self # Side Effects: none @@ -173,25 +193,6 @@ sub close } -=head2 - -=item C<getpos()> - -return the current position in the array - -=item C<setpos($pos)> - -set the current position to $pos -th element. - -=item C<eof()> - -whether the current position reaches the end of the array or not. -If it already reaches the end, return 1. - -=item C<close()> - -end of IO operation. It is a dummy. - =head1 AUTHOR Ken'ichi Fukamachi |
