phpcs-fixer: phpdoc_annotation_without_dot (#5060)

- see https://cs.symfony.com/doc/rules/phpdoc/phpdoc_annotation_without_dot.html

Author: sreichel

.php-cs-fixer.dist.php

@@ -18,6 +18,8 @@
         'nullable_type_declaration_for_default_null_value' => true,
         // Calls to PHPUnit\Framework\TestCase static methods must all be of the same type, either $this->, self:: or static::
         'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
+        // PHPDoc annotation descriptions should not be a sentence.
+        'phpdoc_annotation_without_dot' => true,
         // Docblocks should have the same indentation as the documented subject.
         'phpdoc_indent' => true,
         // Annotations in PHPDoc should be ordered in defined sequence.

app/code/core/Mage/Adminhtml/Block/Widget/Tabs.php

@@ -220,8 +220,8 @@ protected function _beforeToHtml()
      * Find the root parent Tab ID recursively.
      *
      * @param string $currentAfterTabId
-     * @param int $degree Degrees of separation between child and root parent.
-     * @return string The parent tab ID.
+     * @param int $degree degrees of separation between child and root parent
+     * @return string the parent tab ID
      */
     protected function _getRootParentTabId($currentAfterTabId, &$degree)
     {

app/code/core/Mage/Api/Helper/Data.php

@@ -115,7 +115,7 @@ public function v2AssociativeArrayUnpacker(&$obj)
     /**
      * Go through mixed and turns it to a correct look.
      *
-     * @param Mixed $mixed A link to variable that may contain associative array.
+     * @param Mixed $mixed a link to variable that may contain associative array
      */
     public function associativeArrayUnpack(&$mixed)
     {

app/code/core/Mage/Authorizenet/Model/Directpost.php

@@ -362,7 +362,7 @@ public function initialize($paymentAction, $stateObject)
     /**
      * Generate request object and fill its fields from Quote or Order object
      *
-     * @param Mage_Sales_Model_Order $order Quote or order object.
+     * @param Mage_Sales_Model_Order $order quote or order object
      * @return Mage_Authorizenet_Model_Directpost_Request
      */
     public function generateRequestFromOrder(Mage_Sales_Model_Order $order)
@@ -392,7 +392,7 @@ public function setResponseData(array $postData)
      * Validate response data. Needed in controllers.
      *
      * @throws Mage_Core_Exception in case of validation error
-     * @return bool true in case of validation success.
+     * @return bool true in case of validation success
      */
     public function validateResponse()
     {
@@ -506,7 +506,7 @@ public function checkResponseCode()
     /**
      * Check transaction id came from Authorize.net
      *
-     * @throws Mage_Core_Exception in case of bad transaction id.
+     * @throws Mage_Core_Exception in case of bad transaction id
      * @return true in case of right transaction id
      */
     public function checkTransId()

app/code/core/Mage/Authorizenet/Model/Directpost/Request.php

@@ -53,9 +53,9 @@ protected function _setTransactionKey($transKey)
      * @param string $merchantApiLoginId
      * @param string $merchantTransactionKey
      * @param string $amount
-     * @param string $fpSequence An invoice number or random number.
+     * @param string $fpSequence an invoice number or random number
      * @param string $fpTimestamp
-     * @return string The fingerprint.
+     * @return string the fingerprint
      */
     public function generateRequestSign($merchantApiLoginId, $merchantTransactionKey, $amount, $currencyCode, $fpSequence, $fpTimestamp)
     {
@@ -189,9 +189,9 @@ public function signRequestData()
      * @param string $merchantSignatureKey
      * @param string $amount
      * @param string $currencyCode
-     * @param string $fpSequence An invoice number or random number.
+     * @param string $fpSequence an invoice number or random number
      * @param string $fpTimestamp
-     * @return string The fingerprint.
+     * @return string the fingerprint
      */
     protected function _generateSha2RequestSign(
         $merchantApiLoginId,

app/code/core/Mage/Catalog/Model/Resource/Abstract.php

@@ -522,7 +522,7 @@ protected function _isAttributeValueEmpty(Mage_Eav_Model_Entity_Attribute_Abstra
      * Checks also attribute's store scope:
      * We should insert on duplicate key update values if we unchecked 'STORE VIEW' checkbox in store view.
      *
-     * @param mixed $value New value of the attribute.
+     * @param mixed $value new value of the attribute
      * @return bool
      */
     protected function _canUpdateAttribute(

app/code/core/Mage/Catalog/Model/Resource/Url.php

@@ -1317,7 +1317,7 @@ public function getRewriteByProductStore(array $products)
      *
      * @param string $requestPath
      * @param int $storeId
-     * @param array $checkedPaths internal variable to prevent infinite loops.
+     * @param array $checkedPaths internal variable to prevent infinite loops
      * @return bool|string
      */
     public function findFinalTargetPath($requestPath, $storeId, &$checkedPaths = [])

app/code/core/Mage/CatalogSearch/Model/Resource/Helper/Mysql4.php

@@ -95,10 +95,10 @@ public function prepareTerms($str, $maxWordLength = 0)
     /**
      * Use sql compatible with Full Text indexes
      *
-     * @param mixed $table The table to insert data into.
-     * @param array $data Column-value pairs or array of column-value pairs.
+     * @param mixed $table the table to insert data into
+     * @param array $data column-value pairs or array of column-value pairs
      * @param array $fields update fields pairs or values
-     * @return int The number of affected rows.
+     * @return int the number of affected rows
      */
     public function insertOnDuplicate($table, array $data, array $fields = [])
     {

app/code/core/Mage/ConfigurableSwatches/Model/Resource/Catalog/Product/Type/Configurable.php

@@ -16,7 +16,7 @@ class Mage_ConfigurableSwatches_Model_Resource_Catalog_Product_Type_Configurable
      * Retrieve Required children ids
      * Grouped by parent id.
      *
-     * @param mixed $parentId may be array of integers or scalar integer.
+     * @param mixed $parentId may be array of integers or scalar integer
      * @param bool $required
      * @return array
      * @see Mage_Catalog_Model_Resource_Product_Type_Configurable::getChildrenIds()

app/code/core/Mage/Core/Helper/Data.php

@@ -155,7 +155,7 @@ public function formatPrice($price, $includeContainer = true)
     /**
      * Format date using current locale options and time zone.
      *
-     * @param   null|int|string|Zend_Date   $date If empty, return current datetime.
+     * @param   null|int|string|Zend_Date   $date if empty, return current datetime
      * @param   string                      $format   See Mage_Core_Model_Locale::FORMAT_TYPE_* constants
      * @param   bool                        $showTime Whether to include time
      * @return  string
@@ -168,7 +168,7 @@ public function formatDate($date = null, $format = Mage_Core_Model_Locale::FORMA
     /**
      * Format date using current locale options and time zone.
      *
-     * @param   null|int|string|Zend_Date   $date If empty, return current locale datetime.
+     * @param   null|int|string|Zend_Date   $date if empty, return current locale datetime
      * @param   string                      $format   See Mage_Core_Model_Locale::FORMAT_TYPE_* constants
      * @param   bool                        $showTime Whether to include time
      * @param   bool                        $useTimezone Convert to local datetime?