local-lib5/lib/perl5/PPI/Token/Separator.pm

   1 package PPI::Token::Separator;
   2
   3 =pod
   4
   5 =head1 NAME
   6
   7 PPI::Token::Separator - The __DATA__ and __END__ tags
   8
   9 =head1 INHERITANCE
  10
  11   PPI::Token::Separator
  12   isa PPI::Token::Word
  13       isa PPI::Token
  14           isa PPI::Element
  15
  16 =head1 DESCRIPTION
  17
  18 Although superficially looking like a normal L<PPI::Token::Word> object,
  19 when the C<__DATA__> and C<__END__> compiler tags appear at the beginning of
  20 a line (on supposedly) their own line, these tags become file section
  21 separators.
  22
  23 The indicate that the time for Perl code is over, and the rest of the
  24 file is dedicated to something else (data in the case of C<__DATA__>) or
  25 to nothing at all (in the case of C<__END__>).
  26
  27 =head1 METHODS
  28
  29 This class has no methods beyond what is provided by its
  30 L<PPI::Token::Word>, L<PPI::Token> and L<PPI::Element>
  31 parent classes.
  32
  33 =cut
  34
  35 use strict;
  36 use PPI::Token::Word ();
  37
  38 use vars qw{$VERSION @ISA};
  39 BEGIN {
  40         $VERSION = '1.206';
  41         @ISA     = 'PPI::Token::Word';
  42 }
  43
  44 1;
  45
  46 =pod
  47
  48 =head1 SUPPORT
  49
  50 See the L<support section|PPI/SUPPORT> in the main module.
  51
  52 =head1 AUTHOR
  53
  54 Adam Kennedy E<lt>adamk@cpan.orgE<gt>
  55
  56 =head1 COPYRIGHT
  57
  58 Copyright 2001 - 2009 Adam Kennedy.
  59
  60 This program is free software; you can redistribute
  61 it and/or modify it under the same terms as Perl itself.
  62
  63 The full text of the license can be found in the
  64 LICENSE file included with this module.
  65
  66 =cut