@@ -866,7 +866,7 @@ discard block |
||
866 | 866 | * @param string $error The error message. |
867 | 867 | * @param int $line The line on which the error occurred. |
868 | 868 | * @param string $code A violation code unique to the sniff message. |
869 | - * @param array $data Replacements for the error message. |
|
869 | + * @param string[] $data Replacements for the error message. |
|
870 | 870 | * @param int $severity The severity level for this error. A value of 0 will be converted into the default severity level. |
871 | 871 | * will be converted into the default severity level. |
872 | 872 | * |
@@ -890,7 +890,7 @@ discard block |
||
890 | 890 | * @param string $warning The error message. |
891 | 891 | * @param int $line The line on which the warning occurred. |
892 | 892 | * @param string $code A violation code unique to the sniff message. |
893 | - * @param array $data Replacements for the warning message. |
|
893 | + * @param string[] $data Replacements for the warning message. |
|
894 | 894 | * @param int $severity The severity level for this warning. A value of 0 will be converted into the default severity level. |
895 | 895 | * will be converted into the default severity level. |
896 | 896 | * |
@@ -193,7 +193,7 @@ |
||
193 | 193 | /** |
194 | 194 | * Return the file path of the current file being processed. |
195 | 195 | * |
196 | - * @return void |
|
196 | + * @return string |
|
197 | 197 | */ |
198 | 198 | function key() |
199 | 199 | { |
@@ -356,7 +356,7 @@ discard block |
||
356 | 356 | /** |
357 | 357 | * Start recording actions for a changeset. |
358 | 358 | * |
359 | - * @return void |
|
359 | + * @return false|null |
|
360 | 360 | */ |
361 | 361 | public function beginChangeset() |
362 | 362 | { |
@@ -383,7 +383,7 @@ discard block |
||
383 | 383 | /** |
384 | 384 | * Stop recording actions for a changeset, and apply logged changes. |
385 | 385 | * |
386 | - * @return boolean |
|
386 | + * @return false|null |
|
387 | 387 | */ |
388 | 388 | public function endChangeset() |
389 | 389 | { |
@@ -27,11 +27,11 @@ |
||
27 | 27 | * its data should be counted in the grand totals. |
28 | 28 | * |
29 | 29 | * @param array $report Prepared report data. |
30 | - * @param \PHP_CodeSniffer\File $phpcsFile The file being reported on. |
|
30 | + * @param File $phpcsFile The file being reported on. |
|
31 | 31 | * @param bool $showSources Show sources? |
32 | 32 | * @param int $width Maximum allowed line width. |
33 | 33 | * |
34 | - * @return bool |
|
34 | + * @return null|boolean |
|
35 | 35 | */ |
36 | 36 | public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80) |
37 | 37 | { |
@@ -24,7 +24,7 @@ |
||
24 | 24 | * its data should be counted in the grand totals. |
25 | 25 | * |
26 | 26 | * @param array $report Prepared report data. |
27 | - * @param \PHP_CodeSniffer\File $phpcsFile The file being reported on. |
|
27 | + * @param File $phpcsFile The file being reported on. |
|
28 | 28 | * @param bool $showSources Show sources? |
29 | 29 | * @param int $width Maximum allowed line width. |
30 | 30 | * |
@@ -177,7 +177,7 @@ discard block |
||
177 | 177 | /** |
178 | 178 | * Processes the test. |
179 | 179 | * |
180 | - * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where the |
|
180 | + * @param File $phpcsFile The PHP_CodeSniffer file where the |
|
181 | 181 | * token occurred. |
182 | 182 | * @param int $stackPtr The position in the tokens stack |
183 | 183 | * where the listening token type was |
@@ -247,7 +247,7 @@ discard block |
||
247 | 247 | * for checking, which includes are |
248 | 248 | * parsed token representation of the |
249 | 249 | * pattern. |
250 | - * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where the |
|
250 | + * @param File $phpcsFile The PHP_CodeSniffer file where the |
|
251 | 251 | * token occurred. |
252 | 252 | * @param int $stackPtr The position in the tokens stack where |
253 | 253 | * the listening token type was found. |
@@ -746,7 +746,7 @@ discard block |
||
746 | 746 | /** |
747 | 747 | * Processes any tokens registered with registerSupplementary(). |
748 | 748 | * |
749 | - * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where to |
|
749 | + * @param File $phpcsFile The PHP_CodeSniffer file where to |
|
750 | 750 | * process the skip. |
751 | 751 | * @param int $stackPtr The position in the tokens stack to |
752 | 752 | * process. |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | /** |
70 | 70 | * Processes the token in the specified PHP_CodeSniffer_File. |
71 | 71 | * |
72 | - * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this |
|
72 | + * @param File $phpcsFile The PHP_CodeSniffer file where this |
|
73 | 73 | * token was found. |
74 | 74 | * @param int $stackPtr The position where the token was found. |
75 | 75 | * @param array $currScope The current scope opener token. |
@@ -143,7 +143,7 @@ discard block |
||
143 | 143 | /** |
144 | 144 | * Processes the token outside the scope in the file. |
145 | 145 | * |
146 | - * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this |
|
146 | + * @param File $phpcsFile The PHP_CodeSniffer file where this |
|
147 | 147 | * token was found. |
148 | 148 | * @param int $stackPtr The position where the token was found. |
149 | 149 | * |
@@ -171,7 +171,7 @@ discard block |
||
171 | 171 | /** |
172 | 172 | * Called to process class member vars. |
173 | 173 | * |
174 | - * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this |
|
174 | + * @param File $phpcsFile The PHP_CodeSniffer file where this |
|
175 | 175 | * token was found. |
176 | 176 | * @param int $stackPtr The position where the token was found. |
177 | 177 | * |
@@ -183,7 +183,7 @@ discard block |
||
183 | 183 | /** |
184 | 184 | * Called to process normal member vars. |
185 | 185 | * |
186 | - * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this |
|
186 | + * @param File $phpcsFile The PHP_CodeSniffer file where this |
|
187 | 187 | * token was found. |
188 | 188 | * @param int $stackPtr The position where the token was found. |
189 | 189 | * |
@@ -198,7 +198,7 @@ discard block |
||
198 | 198 | * Note that there may be more than one variable in the string, which will |
199 | 199 | * result only in one call for the string or one call per line for heredocs. |
200 | 200 | * |
201 | - * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this |
|
201 | + * @param File $phpcsFile The PHP_CodeSniffer file where this |
|
202 | 202 | * token was found. |
203 | 203 | * @param int $stackPtr The position where the double quoted |
204 | 204 | * string was found. |
@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | /** |
33 | 33 | * Registers the tokens that this sniff wants to listen for. |
34 | 34 | * |
35 | - * @return int[] |
|
35 | + * @return integer[] |
|
36 | 36 | */ |
37 | 37 | public function register() |
38 | 38 | { |
@@ -44,7 +44,7 @@ discard block |
||
44 | 44 | /** |
45 | 45 | * Processes this test, when one of its tokens is encountered. |
46 | 46 | * |
47 | - * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. |
|
47 | + * @param File $phpcsFile The file being scanned. |
|
48 | 48 | * @param int $stackPtr The position of the current token |
49 | 49 | * in the stack passed in $tokens. |
50 | 50 | * |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | /** |
103 | 103 | * Returns an array of tokens this test wants to listen for. |
104 | 104 | * |
105 | - * @return array |
|
105 | + * @return integer[] |
|
106 | 106 | */ |
107 | 107 | public function register() |
108 | 108 | { |
@@ -118,11 +118,11 @@ discard block |
||
118 | 118 | /** |
119 | 119 | * Processes this test, when one of its tokens is encountered. |
120 | 120 | * |
121 | - * @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document. |
|
121 | + * @param File $phpcsFile All the tokens found in the document. |
|
122 | 122 | * @param int $stackPtr The position of the current token |
123 | 123 | * in the stack passed in $tokens. |
124 | 124 | * |
125 | - * @return void |
|
125 | + * @return integer |
|
126 | 126 | */ |
127 | 127 | public function process(File $phpcsFile, $stackPtr) |
128 | 128 | { |