Skip to content

Commit 6eb1af6

Browse files
authored
Merge pull request #206 from magento-commerce/imported-fredden-magento-coding-standard-382
[Imported] Add `@author` to forbidden tag list
2 parents 94041d7 + 1f76b15 commit 6eb1af6

4 files changed

+6
-4
lines changed

Magento2/Sniffs/Commenting/ClassAndInterfacePHPDocFormattingSniff.php

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ class ClassAndInterfacePHPDocFormattingSniff implements Sniff
2424
* @var string[] List of tags that can not be used in comments
2525
*/
2626
public $forbiddenTags = [
27+
'@author',
2728
'@category',
2829
'@package',
2930
'@subpackage'

Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.1.inc

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ class EmptyHandler
6060
* @api is ok here
6161
* @deprecated can be used in this context
6262
* @see is ok here
63-
* @author is actually ok
63+
* @author should not be used
6464
* @category is irrelevant
65-
* @package is not ment to be used
65+
* @package should not be used
6666
* @subpackage does not belong here
6767
*/
6868
class ExampleHandler

Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.2.inc

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ interface EmptyHandler
6060
* @api is ok here
6161
* @deprecated can be used in this context
6262
* @see is ok here
63-
* @author is actually ok
63+
* @author should not be used
6464
* @category is irrelevant
65-
* @package is not ment to be used
65+
* @package should not be used
6666
* @subpackage does not belong here
6767
*/
6868
interface ExampleHandler

Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.php

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ public function getWarningList($testFile = '')
2929
35 => 1,
3030
44 => 1,
3131
52 => 1,
32+
63 => 1,
3233
64 => 1,
3334
65 => 1,
3435
66 => 1,

0 commit comments

Comments
 (0)