.\" -*- 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 "XSBuilder::PODTemplate 3"
.TH XSBuilder::PODTemplate 3 2023-07-25 "perl v5.38.0" "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
$module
.SH FUNCTIONS
.IX Header "FUNCTIONS"
} ;
    }
.PP
# \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.PP
sub gen_pod_func
.PP
.Vb 2
\&    {
\&    my ($self, $objclass, $obj, $method, $args, $retclass, $ret, $comment, $since) = @_ ; 
\&
\&    my $argnames = join (\*(Aq,\*(Aq, map {  $_ \-> {name} } @{$args}[($objclass?1:0)..$#$args]) ;
\&    my $rettext  = $retclass?\*(Aq$ret = \*(Aq:\*(Aq\*(Aq ;
\&    my $objtext  = $objclass?"$obj \-> ":\*(Aq\*(Aq ;
\&
\&    my $data = qq{
.Ve
.SS "\e@func: $\fBmethod()\fP"
.IX Subsection "@func: $method()"
\&\f(CW$rettext\fR$objtext \f(CW$metho\fRd($argnames)
.Sp
.RS 4
} ;
.Sp
.Vb 3
\&    foreach $arg (@$args)
\&        {
\&        $data .= qq{
.Ve
.Sp
\&\e@param: \f(CW$arg\fR\->{class} \f(CW$arg\fR\->{name}
.Sp
\&\f(CW$arg\fR\->{comment}
} ;
        }
.Sp
.Vb 3
\&    if ($retclass)
\&        {
\&        $data .= qq{
.Ve
.Sp
\&\e@ret: \f(CW$retclass\fR
.Sp
\&\f(CW$retcomment\fR
} ;
        }
.Sp
.Vb 1
\&    $data .= qq{
.Ve
.Sp
\&\e@since: \f(CW$since\fR
.RE
.PP
\&\f(CW$comment\fR
.PP
} ;
.PP
.Vb 2
\&    return $data ;
\&    }
.Ve
.PP
# \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.PP
sub gen_pod_struct_member
.PP
.Vb 2
\&    {
\&    my ($self, $objclass, $obj, $memberclass, $member, $comment, $since) = @_ ;
.Ve
.PP
qq{
.SS "\e@func: $\fBmember()\fP"
.IX Subsection "@func: $member()"
\&\e$val = \f(CW$obj\fR \-> \f(CW$membe\fRr(\e$newval)
.ie n .IP "\e@param: $objclass $obj" 4
.el .IP "\e@param: \f(CW$objclass\fR \f(CW$obj\fR" 4
.IX Item "@param: $objclass $obj"
.PD 0
.ie n .IP "\e@param: $memberclass \e$newval" 4
.el .IP "\e@param: \f(CW$memberclass\fR \e$newval" 4
.IX Item "@param: $memberclass $newval"
.PD
} .
.Sp
($since?"=item \e@since: \f(CW$since\fR\en\en":'') .
.Sp
qq{
=back
.Sp
\&\f(CW$comment\fR
.Sp
} ;
.Sp
.Vb 1
\&    }
\&
\& 1;
.Ve
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 57:" 4
.IX Item "Around line 57:"
You can't have =items (as at line 65) unless the first thing after the =over is an =item
.IP "Around line 110:" 4
.IX Item "Around line 110:"
=over without closing =back