File Coverage

blib/lib/Debian/Copyright/Stanza/Header.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1             =head1 NAME
2              
3             Debian::Copyright::Stanza::Header - header stanza of Debian copyright file
4              
5             =head1 VERSION
6              
7             This document describes Debian::Copyright::Stanza::Header version 0.2 .
8              
9             =head1 SYNOPSIS
10              
11             my $copy = Debian::Copyright::Stanza::Header->new(\%data);
12             print $copy; # auto-stringification
13              
14             =head1 DESCRIPTION
15              
16             Debian::Copyright::Stanza::Header can be used for representation and
17             manipulation of the header stanza of Debian copyright files in an
18             object-oriented way. Converts itself to a textual representation in string
19             context.
20              
21             =head1 FIELDS
22              
23             The supported fields for header stanzas are listed below.
24              
25             Note that real copyright fields may contain dashes in their names. These are
26             replaced with underscores.
27              
28             =over
29              
30             =item Format
31              
32             =item Upstream_Name
33              
34             =item Comment
35              
36             =item Upstream_Contact
37              
38             =item Source
39              
40             =item Disclaimer
41              
42             =item License
43              
44             =item Copyright
45              
46             =back
47              
48             =cut
49              
50             package Debian::Copyright::Stanza::Header;
51             require v5.10.1;
52 3     3   20 use strict;
  3         7  
  3         133  
53 3     3   20 use warnings;
  3         6  
  3         118  
54 3     3   17 use base qw(Debian::Copyright::Stanza);
  3         5  
  3         1861  
55              
56 3         246 use constant fields => qw (
57             Format
58             Upstream_Name
59             Upstream_Contact
60             Source
61             Disclaimer
62             Comment
63             License
64             Copyright
65 3     3   17 );
  3         6  
66              
67             our $VERSION = '0.2';
68              
69             =head1 CONSTRUCTOR
70              
71             =over
72              
73             =item new
74              
75             =item new( { field => value, ... } )
76              
77             Creates a new L object and optionally
78             initialises it with the supplied data.
79              
80             =back
81              
82             =head1 SEE ALSO
83              
84             Debian::Copyright::Stanza::Header inherits most of its functionality from
85             L
86              
87             =head1 COPYRIGHT & LICENSE
88              
89             Copyright (C) 2011-12 Nicholas Bamber L
90              
91             This module is substantially based upon L.
92             Copyright (C) 2009 Damyan Ivanov L
93              
94             This program is free software; you can redistribute it and/or modify it under
95             the terms of the GNU General Public License version 2 as published by the Free
96             Software Foundation.
97              
98             This program is distributed in the hope that it will be useful, but WITHOUT ANY
99             WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
100             PARTICULAR PURPOSE.
101              
102             =cut
103              
104             1;