PPI::Token::Pod - Sections of POD in Perl documents
PPI::Token::Pod isa PPI::Token isa PPI::Element
A single PPI::Token::Pod object represents a complete section of POD documentation within a Perl document.
PPI::Token::Pod
This class provides some additional methods beyond those provided by its PPI::Token and PPI::Element parent classes.
Got any ideas for more methods? Submit a report to rt.cpan.org!
The merge constructor takes a number of PPI::Token::Pod objects, and returns a new object that represents one combined POD block with the content of all of them.
merge
Returns a new PPI::Token::Pod object, or undef on error.
undef
The lines method takes the string of POD and breaks it into lines, returning them as a list.
lines
See the support section in the main module.
Adam Kennedy <adamk@cpan.org>
Copyright 2001 - 2009 Adam Kennedy.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included with this module.
To install PPI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm PPI
CPAN shell
perl -MCPAN -e shell install PPI
For more information on module installation, please visit the detailed CPAN module installation guide.