Renee Baecker > EPublisher > EPublisher::Utils::PPI

Download:
EPublisher-1.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.5   Source  

NAME ^

EPublisher::Utils::PPI - PPI utility for EPublisher

VERSION ^

version 1.2

SYNOPSIS ^

  use EPublisher::Utils::PPI qw(extract_pod extract_pod_from_code);
  
  my $file = '/usr/local/share/perl/5.12.1/CGI.pm';
  my $pod  = extract_pod( $file );
  
  my $code = <<PERL;
  sub test {
  }

  =head1 METHODS

  =head2 test

  Docs for subroutine "test"
  PERL
  
  my $pod_from_code = extract_pod_from_code( $code );

DESCRIPTION ^

This module provides some functions to retrieve information about modules and/or perl files. It uses PPI to analyze those files.

METHODS ^

extract_pod

Get Pod documentation from file.

extract_pod_from_code

Get the documentation of a piece of code...

extract_package

Get the namespace name of a package

COPYRIGHT & LICENSE ^

Copyright 2010 Renee Baecker, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms of Artistic License 2.0.

AUTHOR ^

Renee Baecker (<module@renee-baecker.de>)

AUTHOR ^

Renee Baecker <module@renee-baecker.de>

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2012 by Renee Baecker.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)
syntax highlighting: