Pod::Inherit 0.07

Ever written a module distribution with base classes and dependencies, that had the pod for the various methods next to them, but hard to find for the user of your modules? Ever wished POD could be inheritable? Now it can.

Pod::Inherit is a Perl module that will load each of the classes in the list of input files or directories given (default: @ARGV), auto-discover which methods each class provides, locate the actual class the method is defined in, and produce a list in pod.

The resulting documentation is written out to a separate .pod file for each class (.pm) encountered. The new file contains the original POD from the Perl Module file, plus a section called INHERITED METHODS. The new section lists each class that the current class inherits from, plus each method that can be used in the current class as a result.

By default, methods beginning with an underscore, _ are skipped, as by convention these are private methods.

SYNOPSIS

 use Pod::Inherit;

 my $config = {
 out_dir => "/usr/src/perl/dbix-class/bast/DBIx-Class/0.08/trunk/doc,
 input_files => ['/usr/src/perl/dbix-class/bast/DBIx-Class/0.08/trunk/lib/'],
 skip_underscored => 1,
 class_map =>
 {
 "DBIx::Class::Relationship::HasMany" => "DBIx::Class::Relationship",
 "DBIx::Class::Relationship::HasOne" => "DBIx::Class::Relationship",
 "DBIx::Class::Relationship::BelongsTo" => "DBIx::Class::Relationship",
 "DBIx::Class::Relationship::ManyToMany" => "DBIx::Class::Relationship",
 "DBIx::Class::ResultSourceProxy" => "DBIx::Class::ResultSource",
 "DBIx::Class::ResultSourceProxy::Table" => "DBIx::Class::ResultSource",
 }
 };

 my $pi = Pod::Inherit->new( $config });
 $pi->write_pod;


Product's homepage

Requirements:

· Perl