File Coverage

blib/lib/Pod/Weaver/Role/Dialect.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Pod::Weaver::Role::Dialect 4.019;
2             # ABSTRACT: something that translates Pod subdialects to standard Pod5
3              
4 5     5   3396 use Moose::Role;
  5         14  
  5         51  
5             with 'Pod::Weaver::Role::Plugin';
6              
7 5     5   27869 use namespace::autoclean;
  5         15  
  5         70  
8              
9             #pod =head1 IMPLEMENTING
10             #pod
11             #pod The Dialect role indicates that a plugin will be used to pre-process the input
12             #pod Pod document before weaving begins. The plugin must provide a
13             #pod C<translate_dialect> method which will be called with the input hashref's
14             #pod C<pod_document> entry. It is expected to modify the document in place.
15             #pod
16             #pod =cut
17              
18             requires 'translate_dialect';
19              
20             1;
21              
22             __END__
23              
24             =pod
25              
26             =encoding UTF-8
27              
28             =head1 NAME
29              
30             Pod::Weaver::Role::Dialect - something that translates Pod subdialects to standard Pod5
31              
32             =head1 VERSION
33              
34             version 4.019
35              
36             =head1 PERL VERSION
37              
38             This module should work on any version of perl still receiving updates from
39             the Perl 5 Porters. This means it should work on any version of perl released
40             in the last two to three years. (That is, if the most recently released
41             version is v5.40, then this module should work on both v5.40 and v5.38.)
42              
43             Although it may work on older versions of perl, no guarantee is made that the
44             minimum required version will not be increased. The version may be increased
45             for any reason, and there is no promise that patches will be accepted to lower
46             the minimum required perl.
47              
48             =head1 IMPLEMENTING
49              
50             The Dialect role indicates that a plugin will be used to pre-process the input
51             Pod document before weaving begins. The plugin must provide a
52             C<translate_dialect> method which will be called with the input hashref's
53             C<pod_document> entry. It is expected to modify the document in place.
54              
55             =head1 AUTHOR
56              
57             Ricardo SIGNES <cpan@semiotic.systems>
58              
59             =head1 COPYRIGHT AND LICENSE
60              
61             This software is copyright (c) 2023 by Ricardo SIGNES.
62              
63             This is free software; you can redistribute it and/or modify it under
64             the same terms as the Perl 5 programming language system itself.
65              
66             =cut