Devel::PerlySense::Document::Meta - Document information generated during a parse
Package declarations.
Array ref with cloned PPI::Statement::Package objects.
Default: []
Array ref with module names that are "use"d.
Array ref with module names that are base classes.
Module names.
Hash ref with (keys: row, values: hash ref with (keys: col, values: hash with keys: oNode => cloned PPI::Node objects module => module name string ) ) )
rhRowColModule->{43}->{2}-> node
Default: {}
Method calls.
Hash ref with (keys: row, values: hash ref with (keys: col, values: { oNode => cloned PPI::Node object, oNodePrev => node to the left of the -> } ) )
POD blocks.
Array ref with Location objects, representing each pod chunk that is a heading/item. They have the following properties:
podSection pod
sub definition.
Array ref with Location objects, representing each sub declaration. They have the following properties:
nameSub source namePackage oLocationEnd
Array ref with Devel::PerlySense::Plugin::Syntax objects.
Return whatever plugins under Devel::PerlySense::Plugin::Syntax::* are found.
Readonly.
Parse the Devel::PerlySense::Document and extract metadata. Fill appropriate data structures.
Return 1 or die on errors.
Find the module mentioned on line $row (1..) at $col (1..).
Return string like "My::Module" or "Module", or undef if none was found.
Return hash ref with { oNode, oNodeObject } or undef if none was found.
Find the token mentioned in $rhRowCol on line $row (1..) at $col (1..).
Return hash ref with keys oNode and possibly oNodeObject, or undef if none was found.
Parse $oNode and add one or more Location objects to $raLocationPod.
Add pod chunks that are =head or =item. Prefix the pod chunks with their immediate pod heading level.
Return 1 on success, die on errors.
Create a Document::Location object from the sub $nameSub consisting of $oNode, found in $oDocument in $packageCurrent.
Set appropriate Location->rhProperty keys:
Return the new Location object.
Johan Lindström, <johanl[ÄT]DarSerMan.com>
<johanl[ÄT]DarSerMan.com>
Please report any bugs or feature requests to bug-devel-perlysense@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Devel-PerlySense. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-devel-perlysense@rt.cpan.org
Copyright 2005 Johan Lindström, All Rights Reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
1 POD Error
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in 'Lindström,'. Assuming CP1252
To install Devel::PerlySense, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Devel::PerlySense
CPAN shell
perl -MCPAN -e shell install Devel::PerlySense
For more information on module installation, please visit the detailed CPAN module installation guide.