1Module::Build::ModuleInfPoe(r3lpmP)rogrammers ReferenceMoGduuildee::Build::ModuleInfo(3pm)
2
3
4

NAME

6       ModuleInfo - Gather package and POD information from a perl module file
7

DESCRIPTION

9       new_from_file($filename, collect_pod => 1)
10           Construct a "ModuleInfo" object given the path to a file. Takes an
11           optional argument "collect_pod" which is a boolean that determines
12           whether POD data is collected and stored for reference. POD data is
13           not collected by default. POD headings are always collected.
14
15       new_from_module($module, collect_pod => 1, inc => \@dirs)
16           Construct a "ModuleInfo" object given a module or package name. In
17           addition to accepting the "collect_pod" argument as described
18           above, this method accepts a "inc" argument which is a reference to
19           an array of of directories to search for the module. If none are
20           given, the default is @INC.
21
22       name()
23           Returns the name of the package represented by this module. If
24           there are more than one packages, it makes a best guess based on
25           the filename. If it's a script (i.e. not a *.pm) the package name
26           is 'main'.
27
28       version($package)
29           Returns the version as defined by the $VERSION variable for the
30           package as returned by the "name" method if no arguments are given.
31           If given the name of a package it will attempt to return the
32           version of that package if it is specified in the file.
33
34       filename()
35           Returns the absolute path to the file.
36
37       packages_inside()
38           Returns a list of packages.
39
40       pod_inside()
41           Returns a list of POD sections.
42
43       contains_pod()
44           Returns true if there is any POD in the file.
45
46       pod($section)
47           Returns the POD data in the given section.
48
49       find_module_by_name($module, \@dirs)
50           Returns the path to a module given the module or package name. A
51           list of directories can be passed in as an optional parameter,
52           otherwise @INC is searched.
53
54           Can be called as either an object or a class method.
55
56       find_module_dir_by_name($module, \@dirs)
57           Returns the entry in @dirs (or @INC by default) that contains the
58           module $module. A list of directories can be passed in as an
59           optional parameter, otherwise @INC is searched.
60
61           Can be called as either an object or a class method.
62

AUTHOR

64       Ken Williams <kwilliams@cpan.org>, Randy W. Sims
65       <RandyS@ThePierianSpring.org>
66

68       Copyright (c) 2001-2006 Ken Williams.  All rights reserved.
69
70       This library is free software; you can redistribute it and/or modify it
71       under the same terms as Perl itself.
72

SEE ALSO

74       perl(1), Module::Build(3)
75
76
77
78perl v5.12.4                      2011-06-07    Module::Build::ModuleInfo(3pm)
Impressum