NAME

PPIx::EditorTools::Outline - PPI-based outline builder

VERSION

version 0.12

SYNOPSIS

 my $outline = PPIx::EditorTools::Outline->new->find(
       code => "package TestPackage;\nsub x { 1;\n"
     );
print Dumper $outline;

DESCRIPTION

Return a list of pragmatas, modules, methods of a PPI::Document.

METHODS

new()

Constructor. Generally shouldn't be called with any arguments.

find( ppi => PPI::Document $ppi ) =item find( code => Str $code )

Accepts either a PPI::Document to process or a string containing the code (which will be converted into a PPI::Document) to process. Return a reference to a hash.

SEE ALSO

This class inherits from PPIx::EditorTools. Also see App::EditorTools, Padre, and PPI.

AUTHORS

• Steffen Mueller smueller@cpan.org

• Repackaged by Mark Grimes mgrimes@cpan.org

• Ahmad M. Zawawi <ahmad.zawawi@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by The Padre development team as listed in Padre.pm.

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