NAME

Test::Pod - check for POD errors in files

SYNOPSIS

use Test::Pod;

plan tests => $num_tests;

pod_ok( $file );

DESCRIPTION

THIS IS ALPHA SOFTWARE.

Check POD files for errors or warnings in a test file, using Pod::Checker to do the heavy lifting.

FUNCTIONS

pod_ok( FILENAME, [EXPECTED. [NAME] ] )

pod_ok parses the POD in filename and returns one of five symbolic constants starting from the top of this list:

NO_FILE       Could not find the file
NO_POD        File had no pod directives
POD_ERRORS	  POD had errors
POD_WARNINGS  POD had warnings
POD_OK	      No errors or warnings

pod_ok will okay the test if you don't specify any expected result and it finds no errors or warnings, or if you specify what you expect and it finds that condition. For instance, if you can live with warnings,

pod_ok( $file, POD_WARNINGS );

When it fails, pod_ok will show any pod checking errors.

The optional third argument NAME is the name of the test which pod_ok passes through to Test::Builder. Otherwise, it choose a default test name "POD test for FILENAME".

AUTHOR

brian d foy, <bdfoy@cpan.org>

COPYRIGHT

Copyright 2002, brian d foy, All Rights Reserved.

You may use, modify, and distribute this package under the same terms as Perl itself.