.\" -*- 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::Token::Attribute 3pm"
.TH PPI::Token::Attribute 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::Token::Attribute \- A token for a subroutine attribute
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 3
\&  PPI::Token::Attribute
\&  isa PPI::Token
\&      isa PPI::Element
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
In Perl, attributes are a relatively recent addition to the language.
.PP
Given the code \f(CW\*(C` sub foo : bar(something) {} \*(C'\fR, the \f(CWbar(something)\fR
part is the attribute.
.PP
A \f(CW\*(C`PPI::Token::Attribute\*(C'\fR token represents the entire of the attribute,
as the braces and its contents are not parsed into the tree, and are
treated by Perl (and thus by us) as a single string.
.SH METHODS
.IX Header "METHODS"
This class provides some additional methods beyond those provided by its
PPI::Token and PPI::Element parent classes.
.SS identifier
.IX Subsection "identifier"
The \f(CW\*(C`identifier\*(C'\fR attribute returns the identifier part of the attribute.
.PP
That is, for the attribute \f(CWfoo(bar)\fR, the \f(CW\*(C`identifier\*(C'\fR method would
return \f(CW"foo"\fR.
.SS parameters
.IX Subsection "parameters"
The \f(CW\*(C`parameters\*(C'\fR method returns the parameter string for the attribute.
.PP
That is, for the attribute \f(CWfoo(bar)\fR, the \f(CW\*(C`parameters\*(C'\fR method would
return \f(CW"bar"\fR.
.PP
Returns the parameters as a string (including the null string \f(CW\*(Aq\*(Aq\fR for
the case of an attribute such as \f(CWfoo()\fR.)
.PP
Returns \f(CW\*(C`undef\*(C'\fR if the attribute does not have parameters.
.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 2001 \- 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.