xref: /openbsd-src/gnu/usr.bin/perl/cpan/Pod-Perldoc/lib/Pod/Perldoc/ToChecker.pm (revision 9f11ffb7133c203312a01e4b986886bc88c7d74b)
1898184e3Ssthenpackage Pod::Perldoc::ToChecker;
2898184e3Ssthenuse strict;
3898184e3Ssthenuse warnings;
4898184e3Ssthenuse vars qw(@ISA);
5898184e3Ssthen
6898184e3Ssthenuse vars qw($VERSION);
7*9f11ffb7Safresh1$VERSION = '3.28';
8898184e3Ssthen
9898184e3Ssthen# Pick our superclass...
10898184e3Ssthen#
11898184e3Sstheneval 'require Pod::Simple::Checker';
12898184e3Ssthenif($@) {
13898184e3Ssthen  require Pod::Checker;
14898184e3Ssthen  @ISA = ('Pod::Checker');
15898184e3Ssthen} else {
16898184e3Ssthen  @ISA = ('Pod::Simple::Checker');
17898184e3Ssthen}
18898184e3Ssthen
19898184e3Ssthensub is_pageable        { 1 }
20898184e3Ssthensub write_with_binmode { 0 }
21898184e3Ssthensub output_extension   { 'txt' }
22898184e3Ssthen
23898184e3Ssthensub if_zero_length {
24898184e3Ssthen  my( $self, $file, $tmp, $tmpfd ) = @_;
25898184e3Ssthen  print "No Pod errors in $file\n";
26898184e3Ssthen}
27898184e3Ssthen
28898184e3Ssthen
29898184e3Ssthen1;
30898184e3Ssthen
31898184e3Ssthen__END__
32898184e3Ssthen
33898184e3Ssthen=head1 NAME
34898184e3Ssthen
35898184e3SsthenPod::Perldoc::ToChecker - let Perldoc check Pod for errors
36898184e3Ssthen
37898184e3Ssthen=head1 SYNOPSIS
38898184e3Ssthen
39898184e3Ssthen  % perldoc -o checker SomeFile.pod
40898184e3Ssthen  No Pod errors in SomeFile.pod
41898184e3Ssthen  (or an error report)
42898184e3Ssthen
43898184e3Ssthen=head1 DESCRIPTION
44898184e3Ssthen
45898184e3SsthenThis is a "plug-in" class that allows Perldoc to use
46898184e3SsthenPod::Simple::Checker as a "formatter" class (or if that is
47898184e3Ssthennot available, then Pod::Checker), to check for errors in a given
48898184e3SsthenPod file.
49898184e3Ssthen
50898184e3SsthenThis is actually a Pod::Simple::Checker (or Pod::Checker) subclass, and
51898184e3Sstheninherits all its options.
52898184e3Ssthen
53898184e3Ssthen=head1 SEE ALSO
54898184e3Ssthen
55898184e3SsthenL<Pod::Simple::Checker>, L<Pod::Simple>, L<Pod::Checker>, L<Pod::Perldoc>
56898184e3Ssthen
57898184e3Ssthen=head1 COPYRIGHT AND DISCLAIMERS
58898184e3Ssthen
59898184e3SsthenCopyright (c) 2002 Sean M. Burke.  All rights reserved.
60898184e3Ssthen
61898184e3SsthenThis library is free software; you can redistribute it and/or modify it
62898184e3Ssthenunder the same terms as Perl itself.
63898184e3Ssthen
64898184e3SsthenThis program is distributed in the hope that it will be useful, but
65898184e3Ssthenwithout any warranty; without even the implied warranty of
66898184e3Ssthenmerchantability or fitness for a particular purpose.
67898184e3Ssthen
68898184e3Ssthen=head1 AUTHOR
69898184e3Ssthen
70898184e3SsthenCurrent maintainer: Mark Allen C<< <mallen@cpan.org> >>
71898184e3Ssthen
72898184e3SsthenPast contributions from:
73898184e3Ssthenbrian d foy C<< <bdfoy@cpan.org> >>
74898184e3SsthenAdriano R. Ferreira C<< <ferreira@cpan.org> >>,
75898184e3SsthenSean M. Burke C<< <sburke@cpan.org> >>
76898184e3Ssthen
77898184e3Ssthen=cut
78898184e3Ssthen
79