NAME

App::Zealc::UsageExtractor - Extract SYNOPSIS and DESCRIPTION sections from a module

SYNOPSIS

  use App::Zealc::UsageExtractor;
  my $parser = App::Zealc::UsageExtractor->new;
  $parser->parse_file("path/to/file.pm");

  say $parser->synopsis;    # contents of synopsis section
  say $parser->description; # contents of description, filled
  say $parser->usage; # $parser->synopsis."\n\n".$parser->description."\n"

DESCRIPTION

App::Zealc::UsageExtractor is a Pod::Simple subclass that extracts the SYNOPSIS and DESCRIPTION sections from a Pod file.

synopsis

The SYNOPSIS section of the file

description

The DESCRIPTION section of the file, filled using Text::Wrap

usage

Equivalent to $parser->synopsis."\n\n".$parser->description."\n"

SEE ALSO

zealc, Zeal

AUTHOR

Marius Gavrilescu, <marius@ieval.ro>

COPYRIGHT AND LICENSE

Copyright (C) 2015 by Marius Gavrilescu

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.20.1 or, at your option, any later version of Perl 5 you may have available.