Skip to content

Commit 2a5ea4c

Browse files
authored
ENGCOM-3525: correct param, var and return annotation values #19325
2 parents 92aa6a8 + c7ac6a0 commit 2a5ea4c

File tree

38 files changed

+146
-95
lines changed

38 files changed

+146
-95
lines changed

lib/internal/Magento/Framework/Acl/Loader/ResourceLoader.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,15 @@
1212
use Magento\Framework\Acl\AclResource\ProviderInterface;
1313
use Magento\Framework\Acl\AclResourceFactory;
1414

15+
/**
16+
* ACL Loader
17+
*/
1518
class ResourceLoader implements \Magento\Framework\Acl\LoaderInterface
1619
{
1720
/**
1821
* Acl resource config
1922
*
20-
* @var ProviderInterface $resourceProvider
23+
* @var ProviderInterface
2124
*/
2225
protected $_resourceProvider;
2326

lib/internal/Magento/Framework/Amqp/Queue.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class Queue implements QueueInterface
3737
private $envelopeFactory;
3838

3939
/**
40-
* @var LoggerInterface $logger
40+
* @var LoggerInterface
4141
*/
4242
private $logger;
4343

@@ -63,7 +63,7 @@ public function __construct(
6363
}
6464

6565
/**
66-
* {@inheritdoc}
66+
* @inheritdoc
6767
* @since 100.0.0
6868
*/
6969
public function dequeue()
@@ -98,7 +98,7 @@ public function dequeue()
9898
}
9999

100100
/**
101-
* {@inheritdoc}
101+
* @inheritdoc
102102
* @since 100.0.0
103103
*/
104104
public function acknowledge(EnvelopeInterface $envelope)
@@ -119,7 +119,7 @@ public function acknowledge(EnvelopeInterface $envelope)
119119
}
120120

121121
/**
122-
* {@inheritdoc}
122+
* @inheritdoc
123123
* @since 100.0.0
124124
*/
125125
public function subscribe($callback)
@@ -153,7 +153,7 @@ public function subscribe($callback)
153153
}
154154

155155
/**
156-
* (@inheritdoc)
156+
* @inheritdoc
157157
* @since 100.0.0
158158
*/
159159
public function reject(EnvelopeInterface $envelope, $requeue = true, $rejectionMessage = null)
@@ -172,7 +172,7 @@ public function reject(EnvelopeInterface $envelope, $requeue = true, $rejectionM
172172
}
173173

174174
/**
175-
* (@inheritdoc)
175+
* @inheritdoc
176176
* @since 100.0.0
177177
*/
178178
public function push(EnvelopeInterface $envelope)

lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/JoinProcessor.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
use Magento\Framework\Api\SearchCriteriaInterface;
1111
use Magento\Framework\Data\Collection\AbstractDb;
1212

13+
/**
14+
* Search criteria join processor
15+
*/
1316
class JoinProcessor implements CollectionProcessorInterface
1417
{
1518
/**
@@ -28,7 +31,7 @@ class JoinProcessor implements CollectionProcessorInterface
2831
private $appliedFields = [];
2932

3033
/**
31-
* @param CustomJoinInterface[] $customFilters
34+
* @param CustomJoinInterface[] $customJoins
3235
* @param array $fieldMapping
3336
*/
3437
public function __construct(

lib/internal/Magento/Framework/Api/Test/Unit/ExtensionAttribute/Config/SchemaLocatorTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class SchemaLocatorTest extends \PHPUnit\Framework\TestCase
1515
*/
1616
protected $model;
1717

18-
/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
18+
/** @var \Magento\Framework\Config\Dom\UrnResolver */
1919
protected $urnResolver;
2020

2121
protected function setUp()

lib/internal/Magento/Framework/App/ResourceConnection.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111

1212
/**
1313
* Application provides ability to configure multiple connections to persistent storage.
14+
*
1415
* This class provides access to all these connections.
16+
*
1517
* @api
1618
*/
1719
class ResourceConnection
@@ -53,7 +55,7 @@ class ResourceConnection
5355
protected $connectionFactory;
5456

5557
/**
56-
* @var DeploymentConfig $deploymentConfig
58+
* @var DeploymentConfig
5759
*/
5860
private $deploymentConfig;
5961

lib/internal/Magento/Framework/App/Test/Unit/Request/HttpTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,8 @@ public function testIsAjax()
246246
}
247247

248248
/**
249-
* @param $serverVariables array
250-
* @param $expectedResult string
249+
* @param array $serverVariables
250+
* @param string $expectedResult
251251
* @dataProvider serverVariablesProvider
252252
*/
253253
public function testGetDistroBaseUrl($serverVariables, $expectedResult)
@@ -374,7 +374,7 @@ public function testIsSecure($isSecure, $serverHttps, $headerOffloadKey, $header
374374
/**
375375
* @dataProvider httpSafeMethodProvider
376376
* @backupGlobals enabled
377-
* @param string $method value of $_SERVER['REQUEST_METHOD']
377+
* @param string $httpMethod value of $_SERVER['REQUEST_METHOD']
378378
*/
379379
public function testIsSafeMethodTrue($httpMethod)
380380
{
@@ -386,7 +386,7 @@ public function testIsSafeMethodTrue($httpMethod)
386386
/**
387387
* @dataProvider httpNotSafeMethodProvider
388388
* @backupGlobals enabled
389-
* @param string $method value of $_SERVER['REQUEST_METHOD']
389+
* @param string $httpMethod value of $_SERVER['REQUEST_METHOD']
390390
*/
391391
public function testIsSafeMethodFalse($httpMethod)
392392
{

lib/internal/Magento/Framework/App/Test/Unit/ResourceConnection/Config/SchemaLocatorTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class SchemaLocatorTest extends \PHPUnit\Framework\TestCase
1313
*/
1414
protected $model;
1515

16-
/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
16+
/** @var \Magento\Framework\Config\Dom\UrnResolver */
1717
protected $urnResolver;
1818

1919
protected function setUp()

lib/internal/Magento/Framework/App/Test/Unit/Route/Config/SchemaLocatorTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ class SchemaLocatorTest extends \PHPUnit\Framework\TestCase
1212
*/
1313
protected $config;
1414

15-
/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
15+
/** @var \Magento\Framework\Config\Dom\UrnResolver */
1616
protected $urnResolver;
1717

18-
/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
18+
/** @var \Magento\Framework\Config\Dom\UrnResolver */
1919
protected $urnResolverMock;
2020

2121
protected function setUp()

lib/internal/Magento/Framework/App/Utility/Classes.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99

1010
use Magento\Framework\Component\ComponentRegistrar;
1111

12+
/**
13+
* Utility for class names processing
14+
*/
1215
class Classes
1316
{
1417
/**
@@ -236,7 +239,7 @@ public static function getVirtualClasses()
236239
/**
237240
* Check if instance is virtual type
238241
*
239-
* @param $className string
242+
* @param string $className
240243
* @return bool
241244
*/
242245
public static function isVirtual($className)

lib/internal/Magento/Framework/Cache/Test/Unit/Backend/Decorator/DecoratorAbstractTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public function testConstructor()
5454
}
5555

5656
/**
57-
* @param array options
57+
* @param array $options
5858
* @expectedException \Zend_Cache_Exception
5959
* @dataProvider constructorExceptionDataProvider
6060
*/

0 commit comments

Comments
 (0)