.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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 "DhMakePerl::PodParser 3pm"
.TH DhMakePerl::PodParser 3pm 2024-03-14 "perl v5.38.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
DhMakePerl::PodParser \- internal helper module for DhMakePerl
.SH SYNOPSIS
.IX Header "SYNOPSIS"
DhMakePerl::PodParser is used by DhMakePerl to extract some
information from the module-to-be-packaged. It sub-classes from
Pod::Parser \- Please refer to it for further documentation.
.SH METHODS
.IX Header "METHODS"
.IP set_names 4
.IX Item "set_names"
Defines the names of the sections that should be fetched from the POD
.IP get 4
.IX Item "get"
Gets the contents for the specified POD section. The single argument should be
one of the values given to "set_names".
.IP cleanup 4
.IX Item "cleanup"
Empties the information held by the parser object
.IP command 4
.IX Item "command"
Overrides base class' Pod::Parser command method.
.Sp
Gets each of the POD's commands
(sections), and defines how it should react to each of them. In this
particular implementation, it basically filters out anything except
for the \f(CW\*(C`=head\*(C'\fR sections defined in "set_names".
.IP add_text 4
.IX Item "add_text"
Hands back the text it received as it occurred in the input stream (see the
Pod::Parser's documentation for verbatim,
textblock and
interior_sequence).
.Sp
Content is ignored if more than 15 lines away from the section start.
.IP verbatim 4
.IX Item "verbatim"
Called by Pod::Parser for verbatim paragraphs. Redirected to "add_text".
.IP textblock 4
.IX Item "textblock"
Called by Pod::Parser for ordinary text paragraphs. Redirected to
"add_text".
.IP interior_sequence 4
.IX Item "interior_sequence"
\&\fBinterior_sequence()\fR is called by
Pod::Parser when, eh, an interior sequence occurs in the text. Interior
sequences are things like I<...>.
.Sp
This implementation decodes \f(CW\*(C`gt\*(C'\fR, \f(CW\*(C`lt\*(C'\fR, \f(CW\*(C`sol\*(C'\fR, \f(CW\*(C`verbar\*(C'\fR and numeric
character codes, all used by \f(CW\*(C`E\*(C'\fR escape.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Parser
.SH AUTHOR
.IX Header "AUTHOR"
.IP "Paolo Molaro" 4
.IX Item "Paolo Molaro"
.PD 0
.IP "Documentation added by Gunnar Wolf and Damyan Ivanov" 4
.IX Item "Documentation added by Gunnar Wolf and Damyan Ivanov"
.PD
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
.IP "Copyright (C) 2001, Paolo Molaro <lupus@debian.org>" 4
.IX Item "Copyright (C) 2001, Paolo Molaro <lupus@debian.org>"
.PD 0
.IP "Copyright (C) 2008, Gunnar Wolf <gwolf@debian.org>" 4
.IX Item "Copyright (C) 2008, Gunnar Wolf <gwolf@debian.org>"
.IP "Copyright (C) 2008, Damyan Ivanov <dmn@debian.org>" 4
.IX Item "Copyright (C) 2008, Damyan Ivanov <dmn@debian.org>"
.PD
.PP
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License version 2 as published by the Free
Software Foundation.
.PP
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110\-1301 USA.