Fixed wrongly returning error for valid descriptions

svera · svera · commit 0fb55fcc54a7 · 2021-09-14T10:45:50.000+02:00
diff --git a/Magento2/Sniffs/Classes/AbstractApiSniff.php b/Magento2/Sniffs/Classes/AbstractApiSniff.php
@@ -15,7 +15,7 @@ class AbstractApiSniff implements Sniff
 {
 
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Classes/DiscouragedDependenciesSniff.php b/Magento2/Sniffs/Classes/DiscouragedDependenciesSniff.php
@@ -18,7 +18,7 @@ class DiscouragedDependenciesSniff implements Sniff
     const CONSTRUCT_METHOD_NAME = '__construct';
 
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Exceptions/DirectThrowSniff.php b/Magento2/Sniffs/Exceptions/DirectThrowSniff.php
@@ -14,7 +14,7 @@
 class DirectThrowSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      * phpcs:disable Generic.Files.LineLength.TooLong
      * @var string
      */
diff --git a/Magento2/Sniffs/Exceptions/ThrowCatchSniff.php b/Magento2/Sniffs/Exceptions/ThrowCatchSniff.php
@@ -16,7 +16,7 @@
 class ThrowCatchSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Exceptions/TryProcessSystemResourcesSniff.php b/Magento2/Sniffs/Exceptions/TryProcessSystemResourcesSniff.php
@@ -15,7 +15,7 @@
 class TryProcessSystemResourcesSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Functions/StaticFunctionSniff.php b/Magento2/Sniffs/Functions/StaticFunctionSniff.php
@@ -14,7 +14,7 @@
 class StaticFunctionSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Legacy/MageEntitySniff.php b/Magento2/Sniffs/Legacy/MageEntitySniff.php
@@ -14,7 +14,7 @@
 class MageEntitySniff implements Sniff
 {
     /**
-     * Representation of error.
+     * String representation of error.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Methods/DeprecatedModelMethodSniff.php b/Magento2/Sniffs/Methods/DeprecatedModelMethodSniff.php
@@ -16,7 +16,7 @@ class DeprecatedModelMethodSniff implements Sniff
     const RESOURCE_METHOD = "getResource";
 
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/NamingConvention/InterfaceNameSniff.php b/Magento2/Sniffs/NamingConvention/InterfaceNameSniff.php
@@ -14,7 +14,7 @@
 class InterfaceNameSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/PHP/GotoSniff.php b/Magento2/Sniffs/PHP/GotoSniff.php
@@ -14,7 +14,7 @@
 class GotoSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/PHP/ReturnValueCheckSniff.php b/Magento2/Sniffs/PHP/ReturnValueCheckSniff.php
@@ -14,7 +14,7 @@
 class ReturnValueCheckSniff implements Sniff
 {
     /**
-     * Representation of error.
+     * String representation of error.
      *
      * @var string
      */
@@ -46,6 +46,8 @@ class ReturnValueCheckSniff implements Sniff
     protected $tokens = [];
 
     /**
+     * PHP_CodeSniffer file.
+     *
      * @var File
      */
     protected $file;
diff --git a/Magento2/Sniffs/PHP/VarSniff.php b/Magento2/Sniffs/PHP/VarSniff.php
@@ -14,7 +14,7 @@
 class VarSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Performance/ForeachArrayMergeSniff.php b/Magento2/Sniffs/Performance/ForeachArrayMergeSniff.php
@@ -14,7 +14,7 @@
 class ForeachArrayMergeSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/SQL/RawQuerySniff.php b/Magento2/Sniffs/SQL/RawQuerySniff.php
@@ -15,7 +15,7 @@
 class RawQuerySniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Security/LanguageConstructSniff.php b/Magento2/Sniffs/Security/LanguageConstructSniff.php
@@ -14,14 +14,14 @@
 class LanguageConstructSniff implements Sniff
 {
     /**
-     * Representation of error.
+     * String representation of error.
      *
      * @var string
      */
     protected $errorMessage = 'Use of %s language construct is discouraged.';
 
     /**
-     * Representation of backtick error.
+     * String representation of backtick error.
      *
      * phpcs:disable Generic.Files.LineLength
      *
diff --git a/Magento2/Sniffs/Security/SuperglobalSniff.php b/Magento2/Sniffs/Security/SuperglobalSniff.php
@@ -14,14 +14,14 @@
 class SuperglobalSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
     protected $warningMessage = 'Direct use of %s Superglobal detected.';
 
     /**
-     * Representation of error.
+     * String representation of error.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Security/XssTemplateSniff.php b/Magento2/Sniffs/Security/XssTemplateSniff.php
@@ -14,7 +14,7 @@
 class XssTemplateSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
@@ -85,6 +85,8 @@ class XssTemplateSniff implements Sniff
     private $statements = [];
 
     /**
+     * PHP_CodeSniffer file.
+     *
      * @var File
      */
     private $file;
diff --git a/Magento2/Sniffs/Strings/ExecutableRegExSniff.php b/Magento2/Sniffs/Strings/ExecutableRegExSniff.php
@@ -15,7 +15,7 @@
 class ExecutableRegExSniff implements Sniff
 {
     /**
-     * Representation of error.
+     * String representation of error.
      *
      * phpcs:disable Generic.Files.LineLength
      *
diff --git a/Magento2/Sniffs/Strings/StringConcatSniff.php b/Magento2/Sniffs/Strings/StringConcatSniff.php
@@ -15,7 +15,7 @@
 class StringConcatSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Templates/ThisInTemplateSniff.php b/Magento2/Sniffs/Templates/ThisInTemplateSniff.php
@@ -21,7 +21,7 @@ class ThisInTemplateSniff implements Sniff
     protected $warningCodeFoundHelper = 'FoundHelper';
 
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
@@ -35,7 +35,7 @@ class ThisInTemplateSniff implements Sniff
     protected $warningCodeFoundThis = 'FoundThis';
 
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */
diff --git a/Magento2/Sniffs/Whitespace/MultipleEmptyLinesSniff.php b/Magento2/Sniffs/Whitespace/MultipleEmptyLinesSniff.php
@@ -14,7 +14,7 @@
 class MultipleEmptyLinesSniff implements Sniff
 {
     /**
-     * Representation of warning.
+     * String representation of warning.
      *
      * @var string
      */

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class AbstractApiSniff implements Sniff`
`15`	`15`	`{`
`16`	`16`
`17`	`17`	`/**`
`18`		`- * Representation of warning.`
	`18`	`+ * String representation of warning.`
`19`	`19`	`*`
`20`	`20`	`* @var string`
`21`	`21`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class DiscouragedDependenciesSniff implements Sniff`
`18`	`18`	`const CONSTRUCT_METHOD_NAME = '__construct';`
`19`	`19`
`20`	`20`	`/**`
`21`		`- * Representation of warning.`
	`21`	`+ * String representation of warning.`
`22`	`22`	`*`
`23`	`23`	`* @var string`
`24`	`24`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`class DirectThrowSniff implements Sniff`
`15`	`15`	`{`
`16`	`16`	`/**`
`17`		`- * Representation of warning.`
	`17`	`+ * String representation of warning.`
`18`	`18`	`* phpcs:disable Generic.Files.LineLength.TooLong`
`19`	`19`	`* @var string`
`20`	`20`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`class ThrowCatchSniff implements Sniff`
`17`	`17`	`{`
`18`	`18`	`/**`
`19`		`- * Representation of warning.`
	`19`	`+ * String representation of warning.`
`20`	`20`	`*`
`21`	`21`	`* @var string`
`22`	`22`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`class TryProcessSystemResourcesSniff implements Sniff`
`16`	`16`	`{`
`17`	`17`	`/**`
`18`		`- * Representation of warning.`
	`18`	`+ * String representation of warning.`
`19`	`19`	`*`
`20`	`20`	`* @var string`
`21`	`21`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class DeprecatedModelMethodSniff implements Sniff`
`16`	`16`	`const RESOURCE_METHOD = "getResource";`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * Representation of warning.`
	`19`	`+ * String representation of warning.`
`20`	`20`	`*`
`21`	`21`	`* @var string`
`22`	`22`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -14,14 +14,14 @@`
`14`	`14`	`class LanguageConstructSniff implements Sniff`
`15`	`15`	`{`
`16`	`16`	`/**`
`17`		`- * Representation of error.`
	`17`	`+ * String representation of error.`
`18`	`18`	`*`
`19`	`19`	`* @var string`
`20`	`20`	`*/`
`21`	`21`	`protected $errorMessage = 'Use of %s language construct is discouraged.';`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * Representation of backtick error.`
	`24`	`+ * String representation of backtick error.`
`25`	`25`	`*`
`26`	`26`	`* phpcs:disable Generic.Files.LineLength`
`27`	`27`	`*`