File: PODTemplate.pm

package info (click to toggle)
libextutils-xsbuilder-perl 0.28-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, squeeze, wheezy
  • size: 360 kB
  • ctags: 281
  • sloc: perl: 2,836; makefile: 11
file content (129 lines) | stat: -rw-r--r-- 1,771 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

package ExtUtils::XSBuilder::PODTemplate;


# --------------------------------------------------------------------------

sub new 

    {
    my $class = shift ;
    my $self = {} ;    
    bless $self, $class ;
    return $self ;
    }


# --------------------------------------------------------------------------

sub since_default { undef } ;

# --------------------------------------------------------------------------

sub gen_pod_head

    {
    my ($self, $module) = @_ ;

    qq{
    
=head1 NAME

$module

=head1 FUNCTIONS


} ;
    }

# --------------------------------------------------------------------------

sub gen_pod_func

    {
    my ($self, $objclass, $obj, $method, $args, $retclass, $ret, $comment, $since) = @_ ; 

    my $argnames = join (',', map {  $_ -> {name} } @{$args}[($objclass?1:0)..$#$args]) ;
    my $rettext  = $retclass?'$ret = ':'' ;
    my $objtext  = $objclass?"$obj -> ":'' ;

    my $data = qq{

=head2 \@func: $method()

$rettext$objtext $method($argnames)

=over 4

} ;

    foreach $arg (@$args)
        {
        $data .= qq{

=item \@param: $arg->{class} $arg->{name}

$arg->{comment}
} ;
        }

    if ($retclass)
        {
        $data .= qq{

=item \@ret: $retclass

$retcomment
} ;
        }
    
    $data .= qq{

=item \@since: $since

=back

$comment

} ;

    return $data ;
    }




# --------------------------------------------------------------------------

sub gen_pod_struct_member

    {
    my ($self, $objclass, $obj, $memberclass, $member, $comment, $since) = @_ ; 

qq{

=head2 \@func: $member()

\$val = $obj -> $member(\$newval)

=over 4

=item \@param: $objclass $obj

=item \@param: $memberclass \$newval

} .

($since?"=item \@since: $since\n\n":'') .

qq{
=back

$comment

} ;

    }

 1;