pod::elemental::perlmunger(3pm) [debian man page]
Pod::Elemental::PerlMunger(3pm) User Contributed Perl Documentation Pod::Elemental::PerlMunger(3pm) NAME
Pod::Elemental::PerlMunger - a thing that takes a string of Perl and rewrites its documentation VERSION
version 0.093331 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) 2011 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. perl v5.12.4 2011-09-19 Pod::Elemental::PerlMunger(3pm)
Check Out this Related Man Page
Pod::Elemental::Paragraph(3pm) User Contributed Perl Documentation Pod::Elemental::Paragraph(3pm) NAME
Pod::Elemental::Paragraph - a paragraph in a Pod document VERSION
version 0.102362 OVERVIEW
This is probably the most important role in the Pod-Elemental distribution. Classes including this role represent paragraphs in a Pod document. The paragraph is the fundamental unit of dividing up Pod documents, so this is a often-included role. ATTRIBUTES
content This is the textual content of the element, as in a Pod::Eventual event. In other words, this Pod: =head2 content has a content of "content " start_line This attribute, which may or may not be set, indicates the line in the source document where the element began. METHODS
as_pod_string This returns the element as a string, suitable for turning elements back into a document. Some elements, like a "=over" command, will stringify to include extra content like a "=back" command. In the case of elements with children, this method will include the stringified children as well. as_debug_string This method returns a string, like "as_string", but is meant for getting an overview of the document structure, and is not suitable for reproducing a document. Its exact output is likely to change over time. 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. perl v5.14.2 2012-05-05 Pod::Elemental::Paragraph(3pm)