Pod::Simple::PullParserStartToken(3p) Perl Programmers Reference Guide

Pod::Simple::PullParserStartToken(3p) Perl Programmers Reference Guide #

Pod::Simple::PullParserStartToken(3p) Perl Programmers Reference Guide

NNAAMMEE #

 Pod::Simple::PullParserStartToken -- start-tokens from
 Pod::Simple::PullParser

SSYYNNOOPPSSIISS #

 (See Pod::Simple::PullParser)

DDEESSCCRRIIPPTTIIOONN #

 When you do $parser->get_token on a Pod::Simple::PullParser object, you
 might get an object of this class.

 This is a subclass of Pod::Simple::PullParserToken and inherits all its
 methods, and adds these methods:

 $token->tagname
     This returns the tagname for this start-token object.  For example,
     parsing a "=head1 ..." line will give you a start-token with the
     tagname of "head1", token(s) for its content, and then an end-token
     with the tagname of "head1".

 $token->tagname(_s_o_m_e_s_t_r_i_n_g)
     This changes the tagname for this start-token object.  You probably
     won't need to do this.

 $token->tag(...)
     A shortcut for $token->tagname(...)

 $token->is_tag(_s_o_m_e_s_t_r_i_n_g) or $token->is_tagname(_s_o_m_e_s_t_r_i_n_g)
     These are shortcuts for "$token->tag() eq _s_o_m_e_s_t_r_i_n_g"

 $token->attr(_a_t_t_r_n_a_m_e)
     This returns the value of the _a_t_t_r_n_a_m_e attribute for this start-token
     object, or undef.

     For example, parsing a L<Foo/"Bar"> link will produce a start-token
     with a "to" attribute with the value "Foo", a "type" attribute with
     the value "pod", and a "section" attribute with the value "Bar".

 $token->attr(_a_t_t_r_n_a_m_e, _n_e_w_v_a_l_u_e)
     This sets the _a_t_t_r_n_a_m_e attribute for this start-token object to
     _n_e_w_v_a_l_u_e.  You probably won't need to do this.

 $token->attr_hash
     This returns the hashref that is the attribute set for this start-
     token.  This is useful if (for example) you want to ask what all the
     attributes are -- you can just do "keys %{$token->attr_hash}"

 You're unlikely to ever need to construct an object of this class for
 yourself, but if you want to, call
 "Pod::Simple::PullParserStartToken->new( _t_a_g_n_a_m_e, _a_t_t_r_h_a_s_h )"

SSEEEE AALLSSOO #

 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing

SSEEEE AALLSSOO #

 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing

SSUUPPPPOORRTT #

 Questions or discussion about POD and Pod::Simple should be sent to the
 pod-people@perl.org mail list. Send an empty email to
 pod-people-subscribe@perl.org to subscribe.

 This module is managed in an open GitHub repository,
 <https://github.com/perl-pod/pod-simple/>. Feel free to fork and
 contribute, or to clone <git://github.com/perl-pod/pod-simple.git> and
 send patches!

 Patches against Pod::Simple are welcome. Please send bug reports to
 <bug-pod-simple@rt.cpan.org>.

CCOOPPYYRRIIGGHHTT AANNDD DDIISSCCLLAAIIMMEERRSS #

 Copyright (c) 2002 Sean M. Burke.

 This library is free software; you can redistribute it and/or modify it
 under the same terms as Perl itself.

 This program is distributed in the hope that it will be useful, but
 without any warranty; without even the implied warranty of
 merchantability or fitness for a particular purpose.

AAUUTTHHOORR #

 Pod::Simple was created by Sean M. Burke <sburke@cpan.org>.  But don't
 bother him, he's retired.

 Pod::Simple is maintained by:

 •   Allison Randal "allison@perl.org"

 •   Hans Dieter Pearcey "hdp@cpan.org"

 •   David E. Wheeler "dwheeler@cpan.org"

perl v5.36.3 2023-02-15 Pod::Simple::PullParserStartToken(3p)