NAME
Pod::Coverage - Checks if the documentation of a module is comprehensive
SYNOPSIS
# in the beginnning...
perl -MPod::Coverage=Pod::Coverage -e666
# all in one invocation
use Pod::Coverage package => 'Fishy';
# straight OO
use Pod::Coverage;
my $pc = Pod::Coverage->new(package => 'Pod::Coverage');
print "We rock!" if $pc->coverage == 1;
DEPENDENCIES
This module has external dependencies on the following modules:
Devel::Symdump 2.01
Pod::Find 0.21
Pod::Parser 1.13
INSTALLATION
perl Build.PL
perl Build test
and if all goes well
perl Build install
HISTORY
What changed over the last 3 revisions
- 0.19 Thursday 13th September, 2007
-
Don't use _CvGV to determine if a sub was imported, there's a handy flag - GVf_IMPORTED_CV. Fixes 5.9.5 and future perls (solution by Nicholas Clark)
- 0.18 Friday 4th August, 2006
-
Rewrite _CvGV in terms of B::CV - no xs dependency anymore (suggested by Tim Bunce) Add the (FETCH|MODIFY)_$foo_ATTRIBUTES methods to the private stoplists. (rt #12451) Support documentation where the method name is documented in a ::qualified style (rt #14635) Ignores new (5.8) magic CLONE and CLONE_SKIP methods. (rt #17489) Added a nonwhitespace option (Alex - rt #14950)
- 0.17 Tuesday 23rd November, 2004
-
Fixed a further case reported by Jos Boumans where =head2 $self->foo(); was intepreted as documentation for a C<foo()> method. (more XS4ALL house style)
SEE ALSO
AUTHORS
Richard Clamp <richardc@unixbeard.net>
Michael Stevens <mstevens@etla.org>
some contributions from David Cantrell <david@cantrell.org.uk>
COPYRIGHT
Copyright (c) 2001, 2003, 2004, 2006, 2007 Richard Clamp, Michael Stevens. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.