local-lib5/lib/perl5/PPI/Statement/Null.pm

   1 package PPI::Statement::Null;
   2
   3 =pod
   4
   5 =head1 NAME
   6
   7 PPI::Statement::Null - A useless null statement
   8
   9 =head1 SYNOPSIS
  10
  11   my $foo = 1;
  12
  13   ; # <-- Null statement
  14
  15   my $bar = 1;
  16
  17 =head1 INHERITANCE
  18
  19   PPI::Statement::Null
  20   isa PPI::Statement
  21       isa PPI::Node
  22           isa PPI::Element
  23
  24 =head1 DESCRIPTION
  25
  26 C<PPI::Statement::Null> is a utility class designed to handle situations
  27 where PPI encounters a naked statement separator.
  28
  29 Although strictly speaking, the semicolon is a statement B<separator>
  30 and not a statement B<terminator>, PPI considers a semicolon to be a
  31 statement terminator under most circumstances.
  32
  33 In any case, the null statement has no purpose, and can be safely deleted
  34 with no ill effect.
  35
  36 =head1 METHODS
  37
  38 C<PPI::Statement::Null> has no additional methods beyond the default ones
  39 provided by L<PPI::Statement>, L<PPI::Node> and L<PPI::Element>.
  40
  41 =cut
  42
  43 use strict;
  44 use PPI::Statement ();
  45
  46 use vars qw{$VERSION @ISA};
  47 BEGIN {
  48         $VERSION = '1.206';
  49         @ISA     = 'PPI::Statement';
  50 }
  51
  52 # A null statement is not significant
  53 sub significant { '' }
  54
  55 1;
  56
  57 =pod
  58
  59 =head1 SUPPORT
  60
  61 See the L<support section|PPI/SUPPORT> in the main module.
  62
  63 =head1 AUTHOR
  64
  65 Adam Kennedy E<lt>adamk@cpan.orgE<gt>
  66
  67 =head1 COPYRIGHT
  68
  69 Copyright 2001 - 2009 Adam Kennedy.
  70
  71 This program is free software; you can redistribute
  72 it and/or modify it under the same terms as Perl itself.
  73
  74 The full text of the license can be found in the
  75 LICENSE file included with this module.
  76
  77 =cut