Pod::Find Find POD documents in directory trees
Download

Pod::Find Ranking & Summary

Pod::Find Tags

Perl module perl document POD find POD documents directory trees

Pod::Find Description

Find POD documents in directory trees Pod::Find is a Perl to find POD documents in directory trees.SYNOPSIS use Pod::Find qw(pod_find simplify_name); my %pods = pod_find({ -verbose => 1, -inc => 1 }); foreach(keys %pods) { print "found library POD `$pods{$_}' in $_ "; } print "podname=",simplify_name('a/b/c/mymodule.pod')," "; $location = pod_where( { -inc => 1 }, "Pod::Find" );Pod::Find provides a set of functions to locate POD files. Note that no function is exported by default to avoid pollution of your namespace, so be sure to specify them in the use statement if you need them: use Pod::Find qw(pod_find);From this version on the typical SCM (software configuration management) files/directories like RCS, CVS, SCCS, .svn are ignored.pod_find( { %opts } , @directories )The function pod_find searches for POD documents in a given set of files and/or directories. It returns a hash with the file names as keys and the POD name as value. The POD name is derived from the file name and its position in the directory tree.E.g. when searching in $HOME/perl5lib, the file $HOME/perl5lib/MyModule.pm would get the POD name MyModule, whereas $HOME/perl5lib/Myclass/Subclass.pm would be Myclass::Subclass. The name information can be used for POD translators.Only text files containing at least one valid POD command are found.A warning is printed if more than one POD file with the same POD name is found, e.g. CPAN.pm in different directories. This usually indicates duplicate occurrences of modules in the @INC search path. Requirements: · Perl

Pod::Find Related Software