Pod::Simple::PullParserEndToken - end-tokens from Pod::Simple::PullParser


Pod-Simple documentation Contained in the Pod-Simple distribution.

Index


Code Index:

NAME

Top

Pod::Simple::PullParserEndToken -- end-tokens from Pod::Simple::PullParser

SYNOPSIS

Top

(See Pod::Simple::PullParser)

DESCRIPTION

Top

When you do $parser->get_token on a Pod::Simple::PullParser, 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 end-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(somestring)

This changes the tagname for this end-token object. You probably won't need to do this.

$token->tag(...)

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

$token->is_tag(somestring) or $token->is_tagname(somestring)

These are shortcuts for $token->tag() eq somestring

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

SEE ALSO

Top

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

SUPPORT

Top

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, http://github.com/theory/pod-simple/. Feel free to fork and contribute, or to clone git://github.com/theory/pod-simple.git and send patches!

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

COPYRIGHT AND DISCLAIMERS

Top

AUTHOR

Top

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

Pod-Simple documentation Contained in the Pod-Simple distribution.

require 5;
package Pod::Simple::PullParserEndToken;
use Pod::Simple::PullParserToken ();
use strict;
use vars qw(@ISA $VERSION);
@ISA = ('Pod::Simple::PullParserToken');
$VERSION = '3.16';

sub new {  # Class->new(tagname);
  my $class = shift;
  return bless ['end', @_], ref($class) || $class;
}

# Purely accessors:

sub tagname { (@_ == 2) ? ($_[0][1] = $_[1]) : $_[0][1] }
sub tag { shift->tagname(@_) }

# shortcut:
sub is_tagname { $_[0][1] eq $_[1] }
sub is_tag { shift->is_tagname(@_) }

1;


__END__