1XSBuilder::PODTemplate(U3s)er Contributed Perl DocumentatXiSoBnuilder::PODTemplate(3)
2
3
4

NAME

6       $module
7

FUNCTIONS

9       } ;
10           }
11
12       #
13       --------------------------------------------------------------------------
14
15       sub gen_pod_func
16
17           {
18           my ($self, $objclass, $obj, $method, $args, $retclass, $ret, $comment, $since) = @_ ;
19
20           my $argnames = join (',', map {  $_ -> {name} } @{$args}[($objclass?1:0)..$#$args]) ;
21           my $rettext  = $retclass?'$ret = ':'' ;
22           my $objtext  = $objclass?"$obj -> ":'' ;
23
24           my $data = qq{
25
26   \@func: $method()
27       $rettext$objtext $method($argnames)
28
29           } ;
30
31               foreach $arg (@$args)
32                   {
33                   $data .= qq{
34
35           \@param: $arg->{class} $arg->{name}
36
37           $arg->{comment} } ;
38                   }
39
40               if ($retclass)
41                   {
42                   $data .= qq{
43
44           \@ret: $retclass
45
46           $retcomment } ;
47                   }
48
49               $data .= qq{
50
51           \@since: $since
52
53       $comment
54
55       } ;
56
57           return $data ;
58           }
59
60       #
61       --------------------------------------------------------------------------
62
63       sub gen_pod_struct_member
64
65           {
66           my ($self, $objclass, $obj, $memberclass, $member, $comment, $since) = @_ ;
67
68       qq{
69
70   \@func: $member()
71       \$val = $obj -> $member(\$newval)
72
73       \@param: $objclass $obj
74       \@param: $memberclass \$newval
75           } .
76
77           ($since?"=item \@since: $since\n\n":'') .
78
79           qq{ =back
80
81           $comment
82
83           } ;
84
85               }
86
87            1;
88

POD ERRORS

90       Hey! The above document had some coding errors, which are explained
91       below:
92
93       Around line 57:
94           You can't have =items (as at line 65) unless the first thing after
95           the =over is an =item
96
97       Around line 110:
98           =over without closing =back
99
100
101
102perl v5.30.1                      2020-01-30         XSBuilder::PODTemplate(3)