27 Oct 2020 18:52:43 UTC
- Distribution: Pod-Definitions
- Module version: 0.03
- Source (raw)
- Browse (raw)
- How to Contribute
- Testers (177 / 0 / 19)
- KwaliteeBus factor: 1
- 91.32% Coverage
- License: perl_5
- Perl: v5.20.0
- Activity24 month
- Download (17.3KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionWLINDLEY William Lindley
- SEE ALSO
Pod::Definitions -- extract main sections and contained definitions from Pod
my $pod_file = Pod::Definitions->new(); $pod_file->parse_file($file_name);
This class uses Pod::Headings to parse a Pod file and extract the top-level (head1) headings, and the names of the functions, methods, events, or such as documented therein.
Heading names, presumed to be written in the English language, are simplifed for indexing purposes. (See Pod::Headings::Heuristic for details.) For example:
What is the Q function? -> Q function How can I blip the blop? -> Blip the blop Why doesn't my socket have a packet? -> Socket have a packet Where are the pockets on the port? -> Pockets on the port I need to reap the zombie -> Reap the zombie What does the error "Disk full" mean? -> Disk full What about backwards compatibility? -> Backwards compatibility Reaping the zombie from proctab -> Zombie, reaping from proctab $c = Mojo::Path->new() -> new
Currently, captialization (other than rewrites of type type shown above) is mostly left for the caller to handle.
Creates a new object of type Pod::Definitions
Parse a podfile, or Perl source file. Returns the Pod::Headings object, which, as a subclass of Pod::Simple, may give various useful information about the parsed document (e.g., the line_count() or pod_para_count() methods, or the source_dead() method which will be true if the Pod::Simple parser successfully read, and came to the end of, a document).
Local path to file as passed to parse_file
Full name of manpage (e.g., 'Mojo::Path').
Module leaf name (e.g., 'Path')
Hash (with the key being the toplevel section, e.g., "FUNCTIONS") of arrays of section names, or undef if no sections (other than the standard NAME and SEE ALSO) were given in the Pod file
This module is managed in an open GitHub repository, https://github.com/lindleyw/Pod-Definitions. Feel free to fork and contribute, or to clone and send patches.
This module was written and is maintained by William Lindley <email@example.com>.
Module Install Instructions
To install Pod::Definitions, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Pod::Definitions
For more information on module installation, please visit the detailed CPAN module installation guide.