.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pod::Index::Entry 3pm"
.TH Pod::Index::Entry 3pm "2016-09-18" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Pod::Index::Entry \- Represents Pod search result
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Pod::Index::Entry;
\&
\&    my $entry =  Pod::Index::Entry\->new(
\&        keyword  => \*(Aqconstructors\*(Aq,
\&        podname  => \*(Aqperlobj\*(Aq,
\&        line     => 42,
\&        filename => \*(Aq/usr/lib/perl5/5.8.7/pod/perlobj.pod\*(Aq,
\&        context  => \*(AqUsing POD\*(Aq,
\&    );
\&
\&    # 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;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents a \s-1POD\s0 index entry. An entry is defined by the
podname/filename, line number, and context. The entry object also has the 
ability to extract the \s-1POD \s0\*(L"scope\*(R" from the filename.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
.Vb 1
\&    my $q = Pod::Index::Entry\->new(%args);
.Ve
.Sp
Create a new search object. Possible arguments are:
.RS 4
.IP "podname" 4
.IX Item "podname"
The name of the pod, such as .
.IX Xref "Data::Dumper"
.IP "filename" 4
.IX Item "filename"
The filename for the pod, such as \fIData/Dumper.pm\fR.
.IP "line" 4
.IX Item "line"
The line number where the scope of this entry begins.
.IP "context" 4
.IX Item "context"
The title of the section that contains this entry.
.RE
.RS 4
.RE
.IP "podname" 4
.IX Item "podname"
.PD 0
.IP "filename" 4
.IX Item "filename"
.IP "line" 4
.IX Item "line"
.IP "context" 4
.IX Item "context"
.PD
These are just simple accessors that return the value of these properties,
as given to the constructor.
.IP "pod" 4
.IX Item "pod"
Extracts the \s-1POD\s0 for the scope of the entry from \f(CW$self\fR\->filename, beginning at
\&\f(CW$self\fR\->line. For a definition of \fIscope\fR, see Pod::Index. The \s-1POD\s0
extraction is delegated to the Pod::Index::Extract module.
.SH "VERSION"
.IX Header "VERSION"
0.14
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Index,
Pod::Index::Search,
Pod::Index::Extract
.SH "AUTHOR"
.IX Header "AUTHOR"
Ivan Tubert-Brohman <itub@cpan.org>
.SH "COPYRIGHT"
.IX Header "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.