Test::Pod::Coverage - Check for pod coverage in your distribution.
Version 1.10
In one of your dist's test files (eg t/pod-coverage.t):
use Test::Pod::Coverage tests=>1;
pod_coverage_ok( "Foo::Bar", "Foo::Bar is covered" );
Test::Pod::Coverage is used to create a test for your distribution,
to ensure that all relevant files in your distribution are appropriately
documented in pod.
Can also be called with the Pod::Coverage manpage 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 the Pod::Coverage manpage parms are also useful for subclasses that don't
re-document the parent class's methods. Here's an example from
the Mail::SRS manpage.
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 the Pod::Coverage::CountParents manpage, 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();
All functions listed below are exported to the calling namespace.
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
the Pod::Coverage manpage manual for what those can be.
The exception is the coverage_class parameter, which specifies a class to
use for coverage testing. It defaults to Pod::Coverage.
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
the Pod::Coverage manpage manual for what those can be.
The exception is the coverage_class parameter, which specifies a class to
use for coverage testing. It defaults to Pod::Coverage.
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.
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.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
You can find documentation for this module with the perldoc command.
perldoc Test::Pod::Coverage
You can also look for information at:
https://github.com/neilbowers/Test-Pod-Coverage
Written by Andy Lester, <andy at petdance.com>.
Thanks to Ricardo Signes for patches, and Richard Clamp for
writing Pod::Coverage.
Copyright 2006, Andy Lester, All Rights Reserved.
This program is free software; you can redistribute it and/or modify it
under the terms of the Artistic License version 2.0.
See http://dev.perl.org/licenses/ for more information
|