.\" -*- 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::Parser 3"
.TH CPAN::Changes::Parser 3 2024-06-08 "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::Parser \- Parse a CPAN Changelog file
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&  my $parser = CPAN::Changes::Parser\->new(
\&    version_like => qr/\e{\e{\e$NEXT\e}\e}/,
\&    version_prefix => qr/=head\ed\es+/,
\&  );
\&
\&  my $changelog = $parser\->parse_file(\*(AqChanges\*(Aq, \*(Aq:utf8\*(Aq);
\&  my $changelog = $parser\->parse_string($content);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Parses a file or string into a CPAN::Changes object.  Many forms of change
log are accepted.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS version_like
.IX Subsection "version_like"
A regular expression for a token that will be accepted in place of a version
number.  For example, this could be set to \f(CW\*(C`qr/\e{\e{\e$NEXT\e}\e}/\*(C'\fR if the
Dist::Zilla plugin [NextRelease] is
managing the file.
.SS version_prefix
.IX Subsection "version_prefix"
A regular expression for a prefix that will be matched before a version number.
\&\f(CW\*(C`qr/=head\ed\es+/\*(C'\fR could be used if the change log is using Pod headings for the
release headings.
.SH METHODS
.IX Header "METHODS"
.SS parse_file
.IX Subsection "parse_file"
Parses a file into a CPAN::Changes object.  Optionally accepts a string of
layers to be used when reading the file.
.SS parse_string
.IX Subsection "parse_string"
Parses a string into a CPAN::Changes object.
.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.