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.12 Tuesday 30th September, 2003
-
Added 'trustme' so that you don't have to lie about subs being private when the module fails to find their docs. Work by David Cantrell. Pulled HISTORY out into a Changes file. Deprecated and gutted Pod::Coverage::Overloader. The ignored patterns in the base class now include qr/^\(/ which is all it really did only in a stupidly complex manner.
- 0.11 2002-02-27
-
Sort the uncovered subs reported from the import form. From a bug report from Tels.
- 0.10 2002-02-18
-
Added Pod::Coverage::CountParents which counts the Pod sections from higher in the inheritance tree (it walks @ISA). Refactored C<_get_pods> into its own method to allow this.
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, 2003 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.