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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
# This code is a part of Slash, and is released under the GPL.
# Copyright 1997-2001 by Open Source Development Network. See README
# and COPYING for more information, or see http://slashcode.com/.
# $Id: module,v 1.1.2.1 2001/03/29 17:28:49 pudge Exp $
package Slash::MODULE;
=head1 NAME
Slash::MODULE - SHORT DESCRIPTION for Slash
=head1 SYNOPSIS
# basic example of usage
=head1 DESCRIPTION
LONG DESCRIPTION.
=head1 EXPORTED FUNCTIONS
=cut
use strict;
use base 'Exporter';
use vars qw($VERSION @EXPORT @EXPORT_OK);
($VERSION) = ' $Revision: 1.1.2.1 $ ' =~ /\$Revision:\s+([^\s]+)/;
@EXPORT = qw();
@EXPORT_OK = qw();
# every function below must include name, passed paramaters
# (if applicable), return value, side effects (if applicable),
# and dependencies (if applicable). parameters in [] are
# optional.
#========================================================================
=head2 foo( [, ])
Foooooooo.
=over 4
=item Parameters
=over 4
=item
=back
=item Return value
=item Side effects
=item Dependencies
=back
=cut
sub foo {
my($param1, $param2) = @_;
my($other, @variable, $declarations, %go, $here);
# some code
return;
}
#========================================================================
=head1 NON-EXPORTED FUNCTIONS
=head2 foo2( [, ])
Foooooooo.
=over 4
=item Parameters
=over 4
=item
=back
=item Return value
=item Side effects
=item Dependencies
=back
=cut
sub foo2 {
my($param1, $param2) = @_;
my($other, @variable, $declarations, %go, $here);
# some code
return;
}
#========================================================================
=head1 PRIVATE FUNCTIONS
=head2 _foo3( [, ])
Foooooooo.
=over 4
=item Parameters
=over 4
=item
=back
=item Return value
=item Side effects
=item Dependencies
=back
=cut
sub _foo3 {
my($param1, $param2) = @_;
my($other, @variable, $declarations, %go, $here);
# some code
return;
}
1;
__END__
=head1 SEE ALSO
Slash(3).
=head1 VERSION
$Id: module,v 1.1.2.1 2001/03/29 17:28:49 pudge Exp $
|
