1Pod::Coverage::TrustPodU(s3e)r Contributed Perl DocumentaPtoido:n:Coverage::TrustPod(3)
2
3
4
6 Pod::Coverage::TrustPod - allow a module's pod to contain Pod::Coverage
7 hints
8
10 version 0.100005
11
13 This is a Pod::Coverage subclass (actually, a subclass of
14 Pod::Coverage::CountParents) that allows the POD itself to declare
15 certain symbol names trusted.
16
17 Here is a sample Perl module:
18
19 package Foo::Bar;
20
21 =head1 NAME
22
23 Foo::Bar - a bar at which fooes like to drink
24
25 =head1 METHODS
26
27 =head2 fee
28
29 returns the bar tab
30
31 =cut
32
33 sub fee { ... }
34
35 =head2 fie
36
37 scoffs at bar tab
38
39 =cut
40
41 sub fie { ... }
42
43 sub foo { ... }
44
45 =begin Pod::Coverage
46
47 foo
48
49 =end Pod::Coverage
50
51 =cut
52
53 This file would report full coverage, because any non-empty lines
54 inside a block of POD targeted to Pod::Coverage are treated as
55 "trustme" patterns. Leading and trailing whitespace is stripped and
56 the remainder is treated as a regular expression anchored at both ends.
57
58 Remember, anywhere you could use "=begin" and "=end" as above, you
59 could instead write:
60
61 =for Pod::Coverage foo
62
63 In some cases, you may wish to make the entire file trusted. The
64 special pattern "*EVERYTHING*" may be provided to do just this.
65
66 Keep in mind that Pod::Coverage::TrustPod sets up exceptions using the
67 "trust" mechanism rather than the "privacy" mechanism in Pod::Coverage.
68 This is unlikely ever to matter to you, but it's true.
69
71 Ricardo SIGNES <rjbs@cpan.org>
72
74 Andreas Marienborg <andreas.marienborg@gmail.com>
75
77 This software is copyright (c) 2018 by Ricardo SIGNES.
78
79 This is free software; you can redistribute it and/or modify it under
80 the same terms as the Perl 5 programming language system itself.
81
82
83
84perl v5.32.1 2021-01-27 Pod::Coverage::TrustPod(3)