Name : perl-Test-Pod-Coverage
| |
Version : 1.10
| Vendor : openSUSE
|
Release : lp152.3.2
| Date : 2019-09-20 19:32:53
|
Group : Development/Libraries/Perl
| Source RPM : perl-Test-Pod-Coverage-1.10-lp152.3.2.src.rpm
|
Size : 0.01 MB
| |
Packager : https://bugs_opensuse_org
| |
Summary : 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 $AATT;
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 $AATT; all_pod_coverage_ok();
|
RPM found in directory: /vol/rzm3/linux-opensuse/distribution/leap/15.2/repo/oss/noarch |