.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Coverage 3"
.TH Coverage 3 "2006-01-26" "perl v5.8.7" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test::Pod::Coverage \- Check for pod coverage in your distribution.
.SH "VERSION"
.IX Header "VERSION"
Version 1.08
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Checks for \s-1POD\s0 coverage in files for your distribution.
.PP
.Vb 2
\&    use Test::Pod::Coverage tests=>1;
\&    pod_coverage_ok( "Foo::Bar", "Foo::Bar is covered" );
.Ve
.PP
Can also be called with Pod::Coverage parms.
.PP
.Vb 6
\&    use Test::Pod::Coverage tests=>1;
\&    pod_coverage_ok(
\&        "Foo::Bar",
\&        { also_private => [ qr/^[A\-Z_]+$/ ], },
\&        "Foo::Bar, with all\-caps functions as privates",
\&    );
.Ve
.PP
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.
.PP
.Vb 1
\&    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 );
.Ve
.PP
Alternately, you could use Pod::Coverage::CountParents, which always allows
a subclass to reimplement its parents' methods without redocumenting them.  For
example:
.PP
.Vb 2
\&    my $trustparents = { coverage_class => \*(AqPod::Coverage::CountParents\*(Aq };
\&    pod_coverage_ok( "IO::Handle::Frayed", $trustparents );
.Ve
.PP
(The \f(CW\*(C`coverage_class\*(C'\fR parameter is not passed to the coverage class with other
parameters.)
.PP
If you want \s-1POD\s0 coverage for your module, but don't want to make
Test::Pod::Coverage a prerequisite for installing, create the following
as your \fIt/pod\-coverage.t\fR file:
.PP
.Vb 3
\&    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");
.Ve
.PP
Finally, Module authors can include the following in a \fIt/pod\-coverage.t\fR
file and have \f(CW\*(C`Test::Pod::Coverage\*(C'\fR automatically find and check all
modules in the module distribution:
.PP
.Vb 4
\&    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();
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
All functions listed below are exported to the calling namespace.
.ie n .SS "all_pod_coverage_ok( [$parms, ] $msg )"
.el .SS "all_pod_coverage_ok( [$parms, ] \f(CW$msg\fP )"
.IX Subsection "all_pod_coverage_ok( [$parms, ] $msg )"
Checks that the \s-1POD\s0 code in all modules in the distro have proper \s-1POD\s0
coverage.
.PP
If the \fI\f(CI$parms\fI\fR hashref if passed in, they're passed into the
\&\f(CW\*(C`Pod::Coverage\*(C'\fR object that the function uses.  Check the
Pod::Coverage manual for what those can be.
.PP
The exception is the \f(CW\*(C`coverage_class\*(C'\fR parameter, which specifies a class to
use for coverage testing.  It defaults to \f(CW\*(C`Pod::Coverage\*(C'\fR.
.ie n .SS "pod_coverage_ok( $module, [$parms, ] $msg )"
.el .SS "pod_coverage_ok( \f(CW$module\fP, [$parms, ] \f(CW$msg\fP )"
.IX Subsection "pod_coverage_ok( $module, [$parms, ] $msg )"
Checks that the \s-1POD\s0 code in \fI\f(CI$module\fI\fR has proper \s-1POD\s0 coverage.
.PP
If the \fI\f(CI$parms\fI\fR hashref if passed in, they're passed into the
\&\f(CW\*(C`Pod::Coverage\*(C'\fR object that the function uses.  Check the
Pod::Coverage manual for what those can be.
.PP
The exception is the \f(CW\*(C`coverage_class\*(C'\fR parameter, which specifies a class to
use for coverage testing.  It defaults to \f(CW\*(C`Pod::Coverage\*(C'\fR.
.SS "all_modules( [@dirs] )"
.IX Subsection "all_modules( [@dirs] )"
Returns a list of all modules in \fI\f(CI$dir\fI\fR and in directories below. If
no directories are passed, it defaults to \fIblib\fR if \fIblib\fR exists,
or \fIlib\fR if not.
.PP
Note that the modules are as \*(L"Foo::Bar\*(R", not \*(L"Foo/Bar.pm\*(R".
.PP
The order of the files returned is machine-dependent.  If you want them
sorted, you'll have to sort them yourself.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-test\-pod\-coverage at rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test\-Pod\-Coverage>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Test::Pod::Coverage
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/Test\-Pod\-Coverage>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/Test\-Pod\-Coverage>
.IP "\(bu" 4
\&\s-1RT:\s0 \s-1CPAN\s0's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test\-Pod\-Coverage>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/Test\-Pod\-Coverage>
.SH "AUTHOR"
.IX Header "AUTHOR"
Written by Andy Lester, \f(CW\*(C`<andy at petdance.com>\*(C'\fR.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Thanks to Ricardo Signes for patches, and Richard Clamp for
writing Pod::Coverage.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2006, Andy Lester, All Rights Reserved.
.PP
You may use, modify, and distribute this package under the
same terms as Perl itself.