.\" -*- 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 "PPI::Transform::UpdateCopyright 3pm"
.TH PPI::Transform::UpdateCopyright 3pm 2024-03-16 "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
PPI::Transform::UpdateCopyright \- Demonstration PPI::Transform class
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&  my $transform = PPI::Transform::UpdateCopyright\->new(
\&      name => \*(AqAdam Kennedy\*(Aq
\&  );
\&  
\&  $transform\->file(\*(AqModule.pm\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBPPI::Transform::UpdateCopyright\fR provides a demonstration of a typical
PPI::Transform class.
.PP
This class implements a document transform that will take the name of an
author and update the copyright statement to refer to the current year,
if it does not already do so.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 3
\&  my $transform = PPI::Transform::UpdateCopyright\->new(
\&      name => \*(AqAdam Kennedy\*(Aq
\&  );
.Ve
.PP
The \f(CW\*(C`new\*(C'\fR constructor creates a new transform object for a specific
author. It takes a single \f(CW\*(C`name\*(C'\fR parameter that should be the name
(or longer string) for the author.
.PP
Specifying the name is required to allow the changing of a subset of
copyright statements that refer to you from a larger set in a file.
.SS name
.IX Subsection "name"
The \f(CW\*(C`name\*(C'\fR accessor returns the author name that the transform will be
searching for copyright statements of.
.SH "TO DO"
.IX Header "TO DO"
\&\- May need to overload some methods to forcefully prevent Document
objects becoming children of another Node.
.SH SUPPORT
.IX Header "SUPPORT"
See the support section in the main module.
.SH AUTHOR
.IX Header "AUTHOR"
Adam Kennedy <adamk@cpan.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2009 \- 2011 Adam Kennedy.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
LICENSE file included with this module.