Skip to content

Commit f962816

Browse files
committed
Docs: remove redundant @package tags
`@package` tags are an arcane manner to group related files as belonging to one project. For projects using namespaces, the current recommendation is to only have `@package` tags when they have supplemental information to the namespace. That is only in a very limited way the case in VIPCS, so I'm proposing to remove the `@package` tags from the VIPCS class docblocks, though leaving them for now in the file docblocks. At the very least, this removed duplicate information for which there is no reason for the duplication. Includes cleaning up (normalizing) the tag description alignments in the class docblocks. :point_right: reviewing with whitespace changes ignored should make it easier to see that the only real change is the removal of the package tags. Refs: * https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/package.html#package * https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-tags.md#59-package
1 parent 5f34bbe commit f962816

File tree

81 files changed

+9
-171
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+9
-171
lines changed

.github/CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions

WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@
1818
* Restricts usage of some variables.
1919
*
2020
* Originally part of WordPress Coding Standards repo.
21-
*
22-
* @package VIPCS\WordPressVIPMinimum
2321
*/
2422
abstract class AbstractVariableRestrictionsSniff extends Sniff {
2523

WordPressVIPMinimum/Sniffs/Classes/DeclarationCompatibilitySniff.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@
1414

1515
/**
1616
* Class WordPressVIPMinimum_Sniffs_Classes_DeclarationCompatibilitySniff
17-
*
18-
* @package VIPCS\WordPressVIPMinimum
1917
*/
2018
class DeclarationCompatibilitySniff extends AbstractScopeSniff {
2119

WordPressVIPMinimum/Sniffs/Classes/RestrictedExtendClassesSniff.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
/**
1313
* WordPressVIPMinimum_Sniffs_Classes_RestrictedExtendClassesSniff.
1414
*
15-
* @package VIPCS\WordPressVIPMinimum
16-
*
1715
* @since 0.4.0
1816
*/
1917
class RestrictedExtendClassesSniff extends AbstractClassRestrictionsSniff {

WordPressVIPMinimum/Sniffs/Constants/ConstantStringSniff.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@
1414

1515
/**
1616
* Sniff for properly using constant name when checking whether a constant is defined.
17-
*
18-
* @package VIPCS\WordPressVIPMinimum
1917
*/
2018
class ConstantStringSniff extends Sniff {
2119

WordPressVIPMinimum/Sniffs/Constants/RestrictedConstantsSniff.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313

1414
/**
1515
* Restricts usage of some constants.
16-
*
17-
* @package VIPCS\WordPressVIPMinimum
1816
*/
1917
class RestrictedConstantsSniff extends Sniff {
2018

WordPressVIPMinimum/Sniffs/Files/IncludingFileSniff.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@
1414
* WordPressVIPMinimum_Sniffs_Files_IncludingFileSniff.
1515
*
1616
* Checks for custom variables, functions and constants, and external URLs used in file inclusion.
17-
*
18-
* @package VIPCS\WordPressVIPMinimum
1917
*/
2018
class IncludingFileSniff extends AbstractFunctionRestrictionsSniff {
2119

WordPressVIPMinimum/Sniffs/Files/IncludingNonPHPFileSniff.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515
* Ensure that non-PHP files are included via `file_get_contents()` instead of using `include/require[_once]`.
1616
*
1717
* This prevents potential PHP code embedded in those files from being automatically executed.
18-
*
19-
* @package VIPCS\WordPressVIPMinimum
2018
*/
2119
class IncludingNonPHPFileSniff extends Sniff {
2220

WordPressVIPMinimum/Sniffs/Functions/RestrictedFunctionsSniff.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212

1313
/**
1414
* Restricts usage of some functions in VIP context.
15-
*
16-
* @package VIPCS\WordPressVIPMinimum
1715
*/
1816
class RestrictedFunctionsSniff extends AbstractFunctionRestrictionsSniff {
1917

WordPressVIPMinimum/Sniffs/Functions/StripTagsSniff.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
/**
1313
* This sniff ensures proper tag stripping.
1414
*
15-
* @package VIPCS\WordPressVIPMinimum
16-
*
1715
* @since 0.4.0
1816
*/
1917
class StripTagsSniff extends AbstractFunctionParameterSniff {

0 commit comments

Comments
 (0)