Skip to content

Add @author to forbidden tag list #382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 30, 2023
Merged

Add @author to forbidden tag list #382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c702e0
Add @author to forbidden tag list
fredden Apr 5, 2022
1f76b15
Correct spelling/grammar
fredden Jul 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Magento2/Sniffs/Commenting/ClassAndInterfacePHPDocFormattingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class ClassAndInterfacePHPDocFormattingSniff implements Sniff
* @var string[] List of tags that can not be used in comments
*/
public $forbiddenTags = [
'@author',
'@category',
'@package',
'@subpackage'
Expand Down
4 changes: 2 additions & 2 deletions Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ class EmptyHandler
* @api is ok here
* @deprecated can be used in this context
* @see is ok here
* @author is actually ok
* @author should not be used
* @category is irrelevant
* @package is not ment to be used
* @package should not be used
* @subpackage does not belong here
*/
class ExampleHandler
Expand Down
4 changes: 2 additions & 2 deletions Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.2.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ interface EmptyHandler
* @api is ok here
* @deprecated can be used in this context
* @see is ok here
* @author is actually ok
* @author should not be used
* @category is irrelevant
* @package is not ment to be used
* @package should not be used
* @subpackage does not belong here
*/
interface ExampleHandler
Expand Down
1 change: 1 addition & 0 deletions Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public function getWarningList($testFile = '')
35 => 1,
44 => 1,
52 => 1,
63 => 1,
64 => 1,
65 => 1,
66 => 1,
Expand Down