File Coverage

blib/lib/Pod/Weaver/Section/ReplaceAuthors.pm
Criterion Covered Total %
statement 8 8 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod 2 2 100.0
total 14 14 100.0


line stmt bran cond sub pod time code
1             package Pod::Weaver::Section::ReplaceAuthors;
2              
3             # ABSTRACT: Add or replace an AUTHOR or AUTHORS section.
4              
5 3     3   164839 use Moose;
  3         5  
  3         24  
6              
7             extends 'Pod::Weaver::Section::Authors';
8             with 'Pod::Weaver::Role::SectionReplacer';
9              
10             our $VERSION = '0.99_02';
11              
12 2     2 1 7243 sub default_section_name { 'AUTHORS' }
13 2     2 1 3818 sub default_section_aliases { [ 'AUTHOR' ] }
14              
15 3     3   15387 no Moose;
  3         6  
  3         14  
16             1;
17              
18             __END__
19              
20             =pod
21              
22             =head1 NAME
23              
24             Pod::Weaver::Section::ReplaceAuthors - Add or replace an AUTHOR or AUTHORS section.
25              
26             =head1 VERSION
27              
28             version 0.99_02
29              
30             =head1 OVERVIEW
31              
32             This section plugin provides the same behaviour as
33             L<Pod::Weaver::Section::Authors> but with the
34             L<Pod::Weaver::Role::SectionReplacer> role applied.
35              
36             It will add or replace a listing of the document's authors.
37             It expects the C<authors> input parameter to be an arrayref of strings.
38             If no C<authors> parameter is given, it will do nothing.
39             Otherwise, it produces a hunk like this:
40              
41             =head1 AUTHOR
42              
43             Author <a@example.com>
44              
45             Or in the case of multiple authors:
46              
47             =head1 AUTHORS
48              
49             =over
50            
51             =item Author One <a1@example.com>
52              
53             =item Author Two <a2@example.com>
54              
55             =back
56              
57             =for readme stop
58              
59             =begin :internal
60              
61             =head1 INTERNAL METHODS
62              
63             =over
64              
65             =item default_section_name
66              
67             Gives the name used as the heading for this section.
68              
69             =item default_section_aliases
70              
71             Gives alternative names that an existing section might be using.
72              
73             =back
74              
75             =end :internal
76              
77             =for readme continue
78              
79             =head1 AUTHOR
80              
81             Sam Graham <libpod-weaver-pluginbundle-replaceboilerplate-perl BLAHBLAH illusori.co.uk>
82              
83             =head1 COPYRIGHT AND LICENSE
84              
85             This software is copyright (c) 2010 by Sam Graham <libpod-weaver-pluginbundle-replaceboilerplate-perl BLAHBLAH illusori.co.uk>.
86              
87             This is free software; you can redistribute it and/or modify it under
88             the same terms as the Perl 5 programming language system itself.
89              
90             =cut