Pod::Index::Entry - Represents Pod search result
use Pod::Index::Entry; my $entry = Pod::Index::Entry->new( keyword => 'constructors', podname => 'perlobj', line => 42, filename => '/usr/lib/perl5/5.8.7/pod/perlobj.pod', context => 'Using POD', ); # trivial accessors my $podname = $entry->podname; my $filename = $entry->filename; my $line = $entry->line; my $context = $entry->context; my $keyword = $entry->keyword; # extract the POD for this entry my $pod = $entry->pod;
This class represents a POD index entry. An entry is defined by the podname/filename, line number, and context. The entry object also has the ability to extract the POD "scope" from the filename.
my $q = Pod::Index::Entry->new(%args);
Create a new search object. Possible arguments are:
The name of the pod, such as .
The filename for the pod, such as Data/Dumper.pm.
The line number where the scope of this entry begins.
The title of the section that contains this entry.
These are just simple accessors that return the value of these properties, as given to the constructor.
Extracts the POD for the scope of the entry from $self->filename, beginning at $self->line. For a definition of scope, see Pod::Index. The POD extraction is delegated to the Pod::Index::Extract module.
0.14
Pod::Index, Pod::Index::Search, Pod::Index::Extract
Ivan Tubert-Brohman <itub@cpan.org>
Copyright (c) 2005 Ivan Tubert-Brohman. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Pod::Index, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Index
CPAN shell
perl -MCPAN -e shell install Pod::Index
For more information on module installation, please visit the detailed CPAN module installation guide.