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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
<?php
class PHP_CodeSniffer_File
{
/**
* A simple function comment.
*
* long desc here
*
* @param int $stackPtr The position in @ @unknown the stack of the token
* that opened the scope
* @param int $detph How many scope levels down we are.
* @param int $index The index
* @return
* @throws
*/
private function _functionCall($stackPtr, $depth=1, $index)
{
return $stackPtr;
}//end _functionCall()
//
// Sample function comment
//
//
//
public function invalidCommentStyle()
{
}//end invalidCommentStyle()
/**
*
*
* A simple function comment
*
*
* Long description with extra blank line before and after
*
*
* @return void
*/
public function extraDescriptionNewlines()
{
}//end extraDescriptionNewlines()
/**
* A simple function comment
* @return void
*/
public function missingNewlinesBeforeTags()
{
}//end missingNewlinesBeforeTags()
/**
* Access tag should not be treated as a long description
*
* @access public
* @return void
*/
public function accessTag()
{
}//end accessTag()
/**
* Constructor
*
* No return tag
*/
function PHP_CodeSniffer_File()
{
return;
}
/**
* Destructor
*
* No return tag too
*/
function _PHP_CodeSniffer_File()
{
return;
}
/**
* Destructor PHP5
*/
function __destruct()
{
return;
}
function missingComment()
{
return;
}
/**
* no return tag
*
*/
public function noReturn($one)
{
}//end noReturn()
/**
* Param not immediate
*
* @return
* @param int $threeSpaces
* @param int $superfluous
* @param missing
* @param
*/
public function missingDescroption($threeSpaces)
{
}//end missingDescroption()
/**
* Param not immediate
*
* @param int $one comment
* @param int $two comment
* @param string $three comment
*
* @return void
*/
public function oneSpaceAfterLongestVar($one, $two, $three)
{
}//end oneSpaceAfterLongestVar()
}//end class
/**
* A simple function comment
*
* @param string $str The string passed in by reference
*
* @return void
*/
public function functionOutsideClass(&$str)
{
return;
}//end functionOutsideClass()
function missingCommentOutsideClass()
{
return;
}//end missingCommentOutsideClass()
?><?php
function tagBeforeComment()
{
return;
}//end tagBeforeComment()
/**
* no return tag
*
*
*
*/
public function noReturnOutsideClass()
{
}//end noReturnOutsideClass()
/**
* Missing param comment
*
* @param int $one comment
*
* @return void
* @fine Unknown tag
*/
public function missingTwoParamComment($one, $two, $three)
{
}//end missingTwoParamComment()
/**
*
*/
function emptyFunctionDocComment()
{
}//end emptyFunctionDocComment()
/**
* Test function.
*
* @param string $arg1 An argument
*
* @access public
* @return bool
*/
function myFunction($arg1) {}
/**
* Test function.
*
* @param string $arg1 An argument
*
* @access public
* @return bool
*/
echo $blah;
function myFunction($arg1) {}
/**
* Test function.
*
* @access public
* @return bool
* @throws MyException
* @throws MyException When I feel like it
*/
function myFunction() {}
class MyClass() {
/**
* An abstract function.
*
* @return array(string)
*/
abstract final protected function myFunction();
}
?>
|
