Pod::Checker

A module to check the syntax of a POD document. It is just in the very beginning stages right now and is far from being thorough or complete. Its just a starting point that I hope others who plan to use it can help me flesh it out further. This module also collects information about hyperlink nodes of the document processed that can be used by converters later on.

This separate distribution was created to allow refactoring of Pod::Checker to use Pod::Simple instead of Pod::Parser, such that Pod::Parser can be discontinued from the Perl Core in the near future.

AUTHORS/CONTRIBUTORS

Marek Rouchal marekr@cpan.org Brad Appleton bradapp@enteract.com http://www.enteract.com/~bradapp/

rjbs for driving the transition to Pod::Simple

LICENSE

Pod-Checker is free software; you can redistribute it and/or modify it under the terms of the Artistic License distributed with Perl version 5.000 or (at your option) any later version. Please refer to the Artistic License that came with your Perl distribution for more details. If your version of Perl was not distributed under the terms of the Artistic License, than you may distribute Pod-Parser under the same terms as Perl itself.

DISCLAIMER

This software is distributed in the hope that it will be useful, but is provided “AS IS” WITHOUT WARRANTY OF ANY KIND, either expressed or implied, INCLUDING, without limitation, the implied warranties of MERCHANTABILITY and FITNESS FOR A PARTICULAR PURPOSE.

The ENTIRE RISK as to the quality and performance of the software IS WITH YOU (the holder of the software). Should the software prove defective, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT WILL ANY COPYRIGHT HOLDER OR ANY OTHER PARTY WHO MAY CREATE, MODIFY, OR DISTRIBUTE THE SOFTWARE BE LIABLE OR RESPONSIBLE TO YOU OR TO ANY OTHER ENTITY FOR ANY KIND OF DAMAGES (no matter how awful - not even if they arise from known or unknown flaws in the software).

Please refer to the Artistic License that came with your Perl distribution for more details.

REQUIREMENTS

• Perl version 5.005 or later
• Pod::Parser 1.60 or higher from CPAN (already bundled in Perl 5.005)

BUILDING & INSTALLING

Please see the perl “ExtUtils::MakeMaker” manpage for how to build and install using the Makefile.PL template. In a nutshell, simply typing:

  perl Makefile.PL

should build a Makefile with the usual targets like “all”, “clean”, “test”, and “install”.

BUGS

Please use the CPAN bug tracking to report bugs: http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-Checker