The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Test::Pod::Coverage::TrustMe - Test Pod coverage

SYNOPSIS

  use Test::Pod::Coverage::TrustMe;

  all_pod_coverage_ok();

DESCRIPTION

Tests that all of the functions or methods provided by a package have documentation. Drop in replacement for Test::Pod::Coverage, but with additional features. Uses Pod::Coverage::TrustMe to check coverage by default.

FUNCTIONS

pod_coverage_ok ( $module[, $options][, $message] )

Tests the coverage of the $module given. Options specified will be passed along to the constructor of Pod::Coverage::TrustMe. A default test message will be used if not provided.

A special options of coverage_class can be used to specify an alternative class to use for calculating coverage. This option will not be passed along to the class constructor.

all_pod_coverage_ok ( [ $options ] [, $message ] )

Tests coverage for all modules found. This will set a test plan, so it should not be used in scripts doing other tests. Alternatively, it can be run in its own subtest.

Accepts the same options as "pod_coverage_ok", in addition to a dirs option to specify an array reference of directories to search for modules. The "all_modules" function will be used to search these directories. Note that the modules must still be loadable using a require. This module will not automatically add the specified directories to @INC.

all_modules ( @dirs )

Finds all modules in the given directories. If no directories are provided, the lib, blib/arch, and blib/lib directories will be searched, but only if they are found in @INC.

AUTHORS

See Pod::Coverage::TrustMe for authors.

COPYRIGHT AND LICENSE

See Pod::Coverage::TrustMe for the copyright and license.