Dependency of nagios-plugins-nwc-health-8.0-1.1.src.rpm
Name: perl-Test-Pod-Coverage
Project: openSUSE_13.2
Repository: oss
Title: Check for pod coverage in your distribution.
Description:
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
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();
Version: 1.10
Release: 2.1.3
Architecture: noarch
Size: 15.9 KB
Build Time: 2014-10-06 17:19:30 +0200 (over 9 years ago)
Provides
Symbol | Required by |
---|---|
perl(Test::Pod::Coverage) =... | |
perl-Test-Pod-Coverage = 1.... |
Requires
Symbol | Provided by |
---|---|
perl(:MODULE_COMPAT_5.20.1) | perl |
perl(Pod::Coverage) | perl-Pod-Coverage |