ModuleInfo - Gather package and POD information from a perl module files
Construct a ModuleInfo object given the path to a file. Takes an optional arguement collect_pod which is a boolean that determines whether POD data is collected and stored for reference. POD data is not collected by default. POD headings are always collected.
collect_pod
Construct a ModuleInfo object given a module or package name. In addition to accepting the collect_pod argument as described above, this method accepts a inc arguemnt which is a reference to an array of of directories to search for the module. If none are given, the default is @INC.
inc
Returns the name of the package represented by this module. If there are more than one packages, it makes a best guess based on the filename. If it's a script (i.e. not a *.pm) the package name is 'main'.
Returns the version as defined by the $VERSION variable for the package as returned by the name method if no arguments are given. If given the name of a package it will attempt to return the version of that package if it is specified in the file.
name
Returns the absolute path to the file.
Returns a list of packages.
Returns a list of POD sections.
Returns true if there is any POD in the file.
Returns the POD data in the given section.
Returns the path to a module given the module or package name. A list of directories can be passed in as an optional paramater, otherwise @INC is searched.
Can be called as either an object or a class method.
Returns the entry in @dirs (or @INC by default) that contains the module $module. A list of directories can be passed in as an optional paramater, otherwise @INC is searched.
@dirs
@INC
$module
Ken Williams <kwilliams@cpan.org>, Randy W. Sims <RandyS@ThePierianSpring.org>
Copyright (c) 2001-2006 Ken Williams. All rights reserved.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
perl(1), Module::Build(3)
To install Module::Build, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Module::Build
CPAN shell
perl -MCPAN -e shell install Module::Build
For more information on module installation, please visit the detailed CPAN module installation guide.