View on
MetaCPAN
Robert Rothenberg > Pod-Readme > Pod::Readme::Filter

Download:
Pod-Readme-v1.1.2.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: v1.1.2   Source  

NAME ^

Pod::Readme::Filter - Filter README from POD

SYNOPSIS ^

  use Pod::Readme::Filter;

  my $prf = Pod::Readme::Filter->new(
    target      => 'readme',
    base_dir    => '.',
    input_file  => 'lib/MyApp.pm',
    output_file => 'README.pod',
  );

DESCRIPTION ^

This module provides the basic filtering and minimal processing to extract a README.pod from a module's POD. It is used internally by Pod::Readme.

syntax highlighting: