/ 
EPublisher-Source-Plugin-MetaCPAN-0.23
River stage zero No dependents
/ EPublisher::Source::Plugin::MetaCPAN

NAME

EPublisher::Source::Plugin::MetaCPAN - Get POD from distributions via MetaCPAN

VERSION

version 0.23

SYNOPSIS

my $source_options = { type => 'MetaCPAN', module => 'Moose' };
my $url_source     = EPublisher::Source->new( $source_options );
my @pod            = $url_source->load_source;

OPTIONS

Those options can be passed to this plugin:

  • module

  • onlythis

METHODS

load_source

my @pod = $url_source->load_source;

returns a list of documentation for the given distribution. Each element of the list is a hashref that looks like

{
    pod      => '=head1 EPublisher...',
    filename => 'Epublisher.pm',
    title    => 'EPublisher,
}

Where

  • pod

    Complete POD documentation extracted from the file

  • filename

    Basename of the file where the documentation was found

  • title

    Full path of the file with some substitutions:

    • removed leading "bin/" or "lib/"

    • removed file suffix (".pm", ".pl", ".pod")

    • replaced "/" with "::"

AUTHOR

Renee Baecker <module@renee-baecker.de>, Boris Daeppen <boris_daeppen@bluewin.ch>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2012 by Renee Bäcker, Boris Däppen.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)