-
-
26 Jan 2006 04:03:53 UTC
- Distribution: Test-Pod-Coverage
- Module version: 1.08
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (8)
- Testers (9115 / 50 / 2)
- Kwalitee
Bus factor: 2- License: unknown
- Activity
24 month- Tools
- Download (6.27KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- Pod::Coverage
- Test::Builder::Tester
- Test::More
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Test::Pod::Coverage - Check for pod coverage in your distribution.
VERSION
Version 1.08
SYNOPSIS
Checks for POD coverage in files for your distribution.
use Test::Pod::Coverage tests=>1; pod_coverage_ok( "Foo::Bar", "Foo::Bar is covered" );
Can also be called with Pod::Coverage parms.
use Test::Pod::Coverage tests=>1; pod_coverage_ok( "Foo::Bar", { also_private => [ qr/^[A-Z_]+$/ ], }, "Foo::Bar, with all-caps functions as privates", );
The Pod::Coverage parms are also useful for subclasses that don't re-document the parent class's methods. Here's an example from Mail::SRS.
pod_coverage_ok( "Mail::SRS" ); # No exceptions # Define the three overridden methods. my $trustme = { trustme => [qr/^(new|parse|compile)$/] }; pod_coverage_ok( "Mail::SRS::DB", $trustme ); pod_coverage_ok( "Mail::SRS::Guarded", $trustme ); pod_coverage_ok( "Mail::SRS::Reversable", $trustme ); pod_coverage_ok( "Mail::SRS::Shortcut", $trustme );
Alternately, you could use Pod::Coverage::CountParents, which always allows a subclass to reimplement its parents' methods without redocumenting them. For example:
my $trustparents = { coverage_class => 'Pod::Coverage::CountParents' }; pod_coverage_ok( "IO::Handle::Frayed", $trustparents );
(The
coverage_class
parameter is not passed to the coverage class with other parameters.)If you want POD coverage for your module, but don't want to make Test::Pod::Coverage a prerequisite for installing, create the following as your t/pod-coverage.t file:
use Test::More; eval "use Test::Pod::Coverage"; plan skip_all => "Test::Pod::Coverage required for testing pod coverage" if $@; plan tests => 1; pod_coverage_ok( "Pod::Master::Html");
Finally, Module authors can include the following in a t/pod-coverage.t file and have
Test::Pod::Coverage
automatically find and check all modules in the module distribution:use Test::More; eval "use Test::Pod::Coverage 1.00"; plan skip_all => "Test::Pod::Coverage 1.00 required for testing POD coverage" if $@; all_pod_coverage_ok();
FUNCTIONS
All functions listed below are exported to the calling namespace.
all_pod_coverage_ok( [$parms, ] $msg )
Checks that the POD code in all modules in the distro have proper POD coverage.
If the $parms hashref if passed in, they're passed into the
Pod::Coverage
object that the function uses. Check the Pod::Coverage manual for what those can be.The exception is the
coverage_class
parameter, which specifies a class to use for coverage testing. It defaults toPod::Coverage
.pod_coverage_ok( $module, [$parms, ] $msg )
Checks that the POD code in $module has proper POD coverage.
If the $parms hashref if passed in, they're passed into the
Pod::Coverage
object that the function uses. Check the Pod::Coverage manual for what those can be.The exception is the
coverage_class
parameter, which specifies a class to use for coverage testing. It defaults toPod::Coverage
.all_modules( [@dirs] )
Returns a list of all modules in $dir and in directories below. If no directories are passed, it defaults to blib if blib exists, or lib if not.
Note that the modules are as "Foo::Bar", not "Foo/Bar.pm".
The order of the files returned is machine-dependent. If you want them sorted, you'll have to sort them yourself.
BUGS
Please report any bugs or feature requests to
bug-test-pod-coverage at rt.cpan.org
, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Pod-Coverage. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Test::Pod::Coverage
You can also look for information at:
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
RT: CPAN's request tracker
Search CPAN
AUTHOR
Written by Andy Lester,
<andy at petdance.com>
.ACKNOWLEDGEMENTS
Thanks to Ricardo Signes for patches, and Richard Clamp for writing Pod::Coverage.
COPYRIGHT & LICENSE
Copyright 2006, Andy Lester, All Rights Reserved.
You may use, modify, and distribute this package under the same terms as Perl itself.
Module Install Instructions
To install Test::Pod::Coverage, copy and paste the appropriate command in to your terminal.
cpanm Test::Pod::Coverage
perl -MCPAN -e shell install Test::Pod::Coverage
For more information on module installation, please visit the detailed CPAN module installation guide.