NAME

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

SYNOPSIS

           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;

DESCRIPTION

       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.

METHODS

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

           Create a new search object. Possible arguments are:

           podname
               The name of the pod, such as .

           filename
               The filename for the pod, such as Data/Dumper.pm.

           line
               The line number where the scope of this entry begins.

           context
               The title of the section that contains this entry.

       podname
       filename
       line
       context
           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.  For  a
           definition  of  scope,  see  Pod::Index.  The  POD extraction is delegated to the Pod::Index::Extract
           module.

VERSION

       0.14

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.

perl v5.10.0                                       2005-10-16                             Pod::Index::Entry(3pm)