Test::Pod::Coverage Test::Pod::Coverage is a Perl module to check for pod coverage in your distribution.
Download

Test::Pod::Coverage Ranking & Summary

Test::Pod::Coverage Tags

Perl module perl POD coverage pod coverage coverage checker

Test::Pod::Coverage Description

Test::Pod::Coverage is a Perl module to check for pod coverage in your distribution. Test::Pod::Coverage is a Perl module to check for pod coverage in your distribution.SYNOPSISChecks 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 => +$/ ], }, "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 => }; 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();FUNCTIONSAll functions listed below are exported to the calling namespace.all_pod_coverage_ok( $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 to Pod::Coverage.pod_coverage_ok( $module, $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 to Pod::Coverage.all_modules( )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.Requirements:· Perl Requirements: · Perl

Test::Pod::Coverage Related Software