[Summary view] [Print] [Text view]

   1  
   2  require 5;
   3  package Pod::Perldoc::ToChecker;
   4  use strict;
   5  use warnings;
   6  use vars qw(@ISA);
   7  
   8  # Pick our superclass...
   9  #
  10  eval 'require Pod::Simple::Checker';
  11  if($@) {
  12    require Pod::Checker;
  13    @ISA = ('Pod::Checker');
  14  } else {
  15    @ISA = ('Pod::Simple::Checker');
  16  }
  17  
  18  sub is_pageable        { 1 }
  19  sub write_with_binmode { 0 }
  20  sub output_extension   { 'txt' }
  21  
  22  sub if_zero_length {
  23    my( $self, $file, $tmp, $tmpfd ) = @_;
  24    print "No Pod errors in $file\n";
  25  }
  26  
  27  
  28  1;
  29  
  30  __END__
  31  
  32  =head1 NAME
  33  
  34  Pod::Perldoc::ToChecker - let Perldoc check Pod for errors
  35  
  36  =head1 SYNOPSIS
  37  
  38    % perldoc -o checker SomeFile.pod
  39    No Pod errors in SomeFile.pod
  40    (or an error report)
  41  
  42  =head1 DESCRIPTION
  43  
  44  This is a "plug-in" class that allows Perldoc to use
  45  Pod::Simple::Checker as a "formatter" class (or if that is
  46  not available, then Pod::Checker), to check for errors in a given
  47  Pod file.
  48  
  49  This is actually a Pod::Simple::Checker (or Pod::Checker) subclass, and
  50  inherits all its options.
  51  
  52  =head1 SEE ALSO
  53  
  54  L<Pod::Simple::Checker>, L<Pod::Simple>, L<Pod::Checker>, L<Pod::Perldoc>
  55  
  56  =head1 COPYRIGHT AND DISCLAIMERS
  57  
  58  Copyright (c) 2002 Sean M. Burke.  All rights reserved.
  59  
  60  This library is free software; you can redistribute it and/or modify it
  61  under the same terms as Perl itself.
  62  
  63  This program is distributed in the hope that it will be useful, but
  64  without any warranty; without even the implied warranty of
  65  merchantability or fitness for a particular purpose.
  66  
  67  =head1 AUTHOR
  68  
  69  Sean M. Burke C<sburke@cpan.org>
  70  
  71  =cut
  72