Commits

Toby Inkster committed 76b058d

pod for tests

  • Participants
  • Parent commits d2d9309

Comments (0)

Files changed (4)

 my $iter = new_ok 'List::MapMulti::Iterator' => [ [1] ];
 
 can_ok $iter => qw(next current next_indices current_indices);
+
+=head1 PURPOSE
+
+Checks that the module loads; that the iterator class can be instantiated; and
+that an iterator object can do the following methods:
+
+=over
+
+=item *
+
+C<next>
+
+=item *
+
+C<current>
+
+=item *
+
+C<next_indices>
+
+=item *
+
+C<current_indices>
+
+=back
+
+=head1 AUTHOR
+
+Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
+
+=head1 COPYRIGHT AND LICENCE
+
+This software is copyright (c) 2012 by Toby Inkster.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
 isa_ok($type, 'List::MapMulti::Iterator');
 is_deeply(\@deck1, \@deck2);
 
+=head1 PURPOSE
+
+Checks that C<mapm> works.
+
+=head1 AUTHOR
+
+Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
+
+=head1 COPYRIGHT AND LICENCE
+
+This software is copyright (c) 2012 by Toby Inkster.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
 		is_deeply(
 			[$iter->current_indices],
 			[4, 2],
-			);
+		);
 	}
 
 	if ($n eq 'Queen')
 
 is($got, $expected);
 
+=head1 PURPOSE
+
+Checks that C<iterator_multi> works.
+
+=head1 AUTHOR
+
+Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
+
+=head1 COPYRIGHT AND LICENCE
+
+This software is copyright (c) 2012 by Toby Inkster.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+=cut
+
 __DATA__
 2 of Clubs
 2 of Diamonds
 is_deeply mapmulti_ab, traditional;
 
 done_testing;
+
+=head1 PURPOSE
+
+Checks that C<< $a >> and C<< $b >> work in C<mapm>.
+
+=head1 AUTHOR
+
+Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
+
+=head1 COPYRIGHT AND LICENCE
+
+This software is copyright (c) 2012 by Toby Inkster.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.