Pod::Readme::Filter (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Pod::Readme::Filter.3pm".)

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 .pod from a module's It is used internally by Pod::Readme.