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