/ 
Test-Pod-Coverage-0.06
River stage three • 474 direct dependents • 798 total dependents
/ Test::Pod::Coverage

NAME

Test::Pod::Coverage - Check for pod coverage in your distribution.

VERSION

Version 0.06

$Header: /home/cvs/test-pod-coverage/Coverage.pm,v 1.13 2004/01/26 04:36:03 andy Exp $

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",
    );

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");

FUNCTIONS

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.

AUTHOR

Written by Andy Lester, <andy@petdance.com>.

COPYRIGHT

Copyright 2004, Andy Lester, All Rights Reserved.

You may use, modify, and distribute this package under the same terms as Perl itself.