- CONSTRUCTOR OPTIONS
- METHODS FOR SUBCLASSES
- Pod::Coverage::TrustMe vs Pod::Coverage
Pod::Coverage::TrustMe - Pod::Coverage but more powerful
use Pod::Coverage::TrustMe; Pod::Coverage::TrustMe->new(package => 'My::Package')->print_report;
Checks that all of the functions or methods provided by a package have documentation. Compatible with most uses of Pod::Coverage, but with additional features.
These options can be passed to
The package to check coverage for. The module must be loadable.
The Pod file to parse. By default, the module that is loaded will be used, or a pod file existing in the same directory, if it exists.
An array ref of regular expressions for subs to consider private and not needing to be documented. If non-regular expressions are included in the list, they will be taken as literal sub names. Defaults to "DEFAULT_PRIVATE".
An array ref of items to add to the private list. Makes it easy to augment the default list.
An array ref of subs to consider documented even if no pod can be found. Has a similar effect to "private", but will include the subs in the list of covered subs, rather than excluding them from the list entirely.
Requires that the pod section for the sub have some non-whitespace characters in it to be counted as covering the sub.
Includes Pod from parent classes in list of covered subs. Like Pod::Coverage::CountParents. Defaults to true.
Includes Pod from consumed roles in list of covered subs. Like Pod::Coverage::CountParents, but checking
DOES. Defaults to true.
Trusts subs or regexes listed in
Pod::Coverageblocks in Pod. Like Pod::Coverage::TrustPod. Defaults to true.
A section like:
=for Pod::Coverage sub1 sub2 [A-Z_]+
will allow the subs
sub2, and any sub that is all upper case to exist without being documented.
Requires a link in the Pod to parent classes or roles to include them in the coverage. If the documentation for subs is in different files, they should be linked to in some way.
Only requires subs listed in
@EXPORT_OKto be covered.
Trusts subs that were imported from other packages. If set to false, every sub in the package needs to be covered, even if it is imported from another package. Subs that aren't part of the API should be cleaned using a tool like namespace::clean, or excluded in some way. See also Test::CleanNamespaces. Defaults to true.
Returns the percentage of subs covered as a value between 0 and 1.
Returns a list of subs that are covered by the documentation.
Returns a list of subs that are not covered by the documentation.
An alias for uncovered.
Returns a text report on the covered and uncovered subroutines.
Print a text report on the covered and uncovered subroutines.
Returns the a hashref of symbols detected, with a value of true or false for if the symbol is covered by pod.
Returns the other packages that will have their pod checked for symbols to treat as covered.
There are some private methods provided that could be overridden in subclasses to adjust the behavior.
Returns the list of symbols for a given package.
Returns an array ref of all of the covered items in the pod.
Returns true if the given symbol should be considered private.
Returns true if the given symbol should be treated as covered even without any documentation found.
An array reference of the default list of private regular expressions.
See Test::Pod::Coverage::TrustMe for using this module in tests.
There are some important differences between this module and Pod::Coverage, aside from the additional features.
- No _CvGV method
Pod::Coverage provides and documents the _CvGV method, but doesn't use it itself. This module does not provide the method.
- No import method
- Uses Pod::Simple
haarg - Graham Knop (cpan:HAARG) <firstname.lastname@example.org>
None so far.
This library is free software and may be distributed under the same terms as perl itself. See https://dev.perl.org/licenses/.