.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CPAN::Changes::Release 3pm"
.TH CPAN::Changes::Release 3pm 2024-03-02 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
CPAN::Changes::Release \- A release in a CPAN Changes file
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&  my $release = CPAN::Changes::Release\->new(
\&    version => \*(Aq0.01\*(Aq,
\&    date    => \*(Aq2015\-07\-20\*(Aq,
\&  );
\&
\&  $release\->add_entry(\*(AqThis is a change\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A changelog is made up of one or more releases. This object provides access to
all of the key data that embodies a release including the version number, date
of release, and all of the changelog information lines.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS version
.IX Subsection "version"
The version number of the release.
.SS date
.IX Subsection "date"
The date for the release.
.SS note
.IX Subsection "note"
The note attached to the release.
.SS entries
.IX Subsection "entries"
An array ref of entries in the release.
.SS line
.IX Subsection "line"
The line number that the release starts at.
.SH METHODS
.IX Header "METHODS"
.SS serialize
.IX Subsection "serialize"
Returns the changes entry for the release in string form.
.SS clone
.IX Subsection "clone"
Returns a new release object with the same data. Can be given any attributes to
set them differently in the new object.
.SS has_entries
.IX Subsection "has_entries"
Returns true if there are changes entries in this release.
.SS find_entry
.IX Subsection "find_entry"
Accepts a string or a regex, returns a matching entry object.
.SS add_entry
.IX Subsection "add_entry"
Adds a changes entry. Accepts a changes entry object or a string.
.SS remove_entry
.IX Subsection "remove_entry"
Given a string or a changes entry object, removes the entry from the release.
.SH "LEGACY METHODS"
.IX Header "LEGACY METHODS"
.SS changes
.IX Subsection "changes"
.SS add_changes
.IX Subsection "add_changes"
.SS set_changes
.IX Subsection "set_changes"
.SS clear_changes
.IX Subsection "clear_changes"
.SS groups
.IX Subsection "groups"
.SS add_group
.IX Subsection "add_group"
.SS delete_group
.IX Subsection "delete_group"
.SS delete_empty_groups
.IX Subsection "delete_empty_groups"
.SS get_group
.IX Subsection "get_group"
.SS attach_group
.IX Subsection "attach_group"
.SS group_values
.IX Subsection "group_values"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP \(bu 4
CPAN::Changes
.SH AUTHORS
.IX Header "AUTHORS"
See CPAN::Changes for authors.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
See CPAN::Changes for the copyright and license.