SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE




YUM REPOSITORY

 
 

Pod::Elemental::PerlMunger

Section: User Contributed Perl Documentation (3)
Updated: 2009-11-29
Index 

NAME

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

VERSION

version 0.093330 

OVERVIEW

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

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

When calling the "munge_perl_string" method, arguments should be passed likethis:

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

%arg may contain any input for the underlying procedure. The only key withassociated meaning is "filename" which may be omitted. If given, it should bethe 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 expectsto 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 <rjbsAATTcpan.org>
 

COPYRIGHT AND LICENSE

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

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


 

Index

NAME
VERSION
OVERVIEW
AUTHOR
COPYRIGHT AND LICENSE

This document was created byman2html,using the manual pages.