NAME

Pod::Elemental::PerlMunger - a thing that takes a string of Perl and rewrites its documentation

VERSION

version 0.093332

OVERVIEW

This role is to be included in classes that rewrite the documentation of a Perl document, stripping out all the Pod, munging it, and replacing it into the Perl.

The only relevant method is munge_perl_string, which must be implemented with a different interface than will be exposed.

When calling the munge_perl_string method, arguments should be passed like this:

  $object->munge_perl_string($perl_string, \%arg);

%arg may contain any input for the underlying procedure. The only key with associated meaning is filename which may be omitted. If given, it should be the name of the file whose contents are being munged.

The method will return a string containing the rewritten and combined document.

Classes including this role must implement a munge_perl_string that expects to be called like this:

  $object->munge_perl_string(\%doc, \%arg);

%doc will have two entries:

  ppi - a PPI::Document of the Perl document with all its Pod removed
  pod - a Pod::Document with no transformations yet performed

This munge_perl_string method should return a hashref in the same format as %doc.

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.