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
28       $rettext$objtext $method($argnames)
29
30           } ;
31
32               foreach $arg (@$args)
33                   {
34                   $data .= qq{
35
36       \@param: $arg->{class} $arg->{name}
37           $arg->{comment} } ;
38                   }
39
40               if ($retclass)
41                   {
42                   $data .= qq{
43
44       \@ret: $retclass
45           $retcomment } ;
46                   }
47
48               $data .= qq{
49
50       \@since: $since
51
52       $comment
53
54       } ;
55
56           return $data ;
57           }
58
59       #
60       --------------------------------------------------------------------------
61
62       sub gen_pod_struct_member
63
64           {
65           my ($self, $objclass, $obj, $memberclass, $member, $comment, $since) = @_ ;
66
67       qq{
68
69       \@func: $member()
70
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
89
90
91perl v5.8.8                       2005-08-31         XSBuilder::PODTemplate(3)