NAME

Pod::Index::Entry - Represents Pod search result

SYNOPSYS

use Pod::Index::Entry;

my $entry =  Pod::Index::Entry->new(
    podname  => 'perlobj.pod'
    line     => 42,
    filename => '/usr/lib/perl5/5.8.7/pod/perlobj.pod',
);

# trivial accessors
my $podname  = $entry->podname;
my $filename = $entry->filename;
my $line     = $entry->line;

# extract the POD for this entry
my $pod      = $entry->pod;

DESCRIPTION

METHODS

new

my $q = Pod::Index::Entry->new(%args);

Create a new search object. Possible arguments are:

podname

The name of the pod, as a path relative to an @INC directory.

filename

The filename for the pod.

line

The line number where the scope of this entry begins.

podname

filename

line

These are just simple accessors that return the value of these properties, as given to the constructor.

pod

Extracts the POD for the scope of the entry from $self->filename, beginning at $self->line.

SEE ALSO

Pod::Index, Pod::Index::Search, Pod::Index::Extract

AUTHOR

Ivan Tubert-Brohman <itub@cpan.org>

COPYRIGHT

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.