Skip to content

correct param, var and return annotation values #19325

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.

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
Dec 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class ResourceLoader implements \Magento\Framework\Acl\LoaderInterface
/**
* Acl resource config
*
* @var ProviderInterface $resourceProvider
* @var ProviderInterface
*/
protected $_resourceProvider;

Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Amqp/Queue.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class Queue implements QueueInterface
private $envelopeFactory;

/**
* @var LoggerInterface $logger
* @var LoggerInterface
*/
private $logger;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class JoinProcessor implements CollectionProcessorInterface
private $appliedFields = [];

/**
* @param CustomJoinInterface[] $customFilters
* @param CustomJoinInterface[] $customJoins
* @param array $fieldMapping
*/
public function __construct(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class SchemaLocatorTest extends \PHPUnit\Framework\TestCase
*/
protected $model;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolver;

protected function setUp()
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/App/ResourceConnection.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ class ResourceConnection
protected $connectionFactory;

/**
* @var DeploymentConfig $deploymentConfig
* @var DeploymentConfig
*/
private $deploymentConfig;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,8 +246,8 @@ public function testIsAjax()
}

/**
* @param $serverVariables array
* @param $expectedResult string
* @param array $serverVariables
* @param string $expectedResult
* @dataProvider serverVariablesProvider
*/
public function testGetDistroBaseUrl($serverVariables, $expectedResult)
Expand Down Expand Up @@ -374,7 +374,7 @@ public function testIsSecure($isSecure, $serverHttps, $headerOffloadKey, $header
/**
* @dataProvider httpSafeMethodProvider
* @backupGlobals enabled
* @param string $method value of $_SERVER['REQUEST_METHOD']
* @param string $httpMethod value of $_SERVER['REQUEST_METHOD']
*/
public function testIsSafeMethodTrue($httpMethod)
{
Expand All @@ -386,7 +386,7 @@ public function testIsSafeMethodTrue($httpMethod)
/**
* @dataProvider httpNotSafeMethodProvider
* @backupGlobals enabled
* @param string $method value of $_SERVER['REQUEST_METHOD']
* @param string $httpMethod value of $_SERVER['REQUEST_METHOD']
*/
public function testIsSafeMethodFalse($httpMethod)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class SchemaLocatorTest extends \PHPUnit\Framework\TestCase
*/
protected $model;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolver;

protected function setUp()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ class SchemaLocatorTest extends \PHPUnit\Framework\TestCase
*/
protected $config;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolver;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolverMock;

protected function setUp()
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/App/Utility/Classes.php
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ public static function getVirtualClasses()
/**
* Check if instance is virtual type
*
* @param $className string
* @param string $className
* @return bool
*/
public static function isVirtual($className)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public function testConstructor()
}

/**
* @param array options
* @param array $options
* @expectedException \Zend_Cache_Exception
* @dataProvider constructorExceptionDataProvider
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
class ComposerJsonFinder
{
/**
* @var DirectoryList $directoryList
* @var DirectoryList
*/
private $directoryList;

Expand Down
4 changes: 2 additions & 2 deletions lib/internal/Magento/Framework/Config/Test/Unit/ThemeTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

class ThemeTest extends \PHPUnit\Framework\TestCase
{
/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolver;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolverMock;

protected function setUp()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ public function testGetFilesEmpty()
*
* @dataProvider getFilesDataProvider
*
* @param $libraryFiles array Files in lib directory
* @param $baseFiles array Files in base directory
* @param $themeFiles array Files in theme
* @param array $libraryFiles Files in lib directory
* @param array $baseFiles Files in base directory
* @param array $themeFiles Files in theme
* *
* @return void
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ public function testGetFilesEmpty()
*
* @dataProvider getFilesDataProvider
*
* @param $libraryFiles array Files in lib directory
* @param $themeFiles array Files in theme
* @param array $libraryFiles Files in lib directory
* @param array $themeFiles Files in theme
* *
* @return void
*/
Expand Down
6 changes: 3 additions & 3 deletions lib/internal/Magento/Framework/DataObject/Copy.php
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ protected function dispatchCopyFieldSetEvent($fieldset, $aspect, $source, $targe
* @param string $aspect a field name
* @param array|\Magento\Framework\DataObject $source
* @param string $root
* @return array $data
* @return array
*
* @api
*/
Expand Down Expand Up @@ -232,7 +232,7 @@ protected function _setFieldsetFieldValue($target, $targetCode, $value)
/**
* Access the extension get method
*
* @param \Magento\Framework\Api\ExtensibleDataInterface $object
* @param \Magento\Framework\Api\ExtensibleDataInterface $source
* @param string $code
*
* @return mixed
Expand Down Expand Up @@ -265,7 +265,7 @@ protected function getAttributeValueFromExtensibleDataObject($source, $code)
/**
* Access the extension set method
*
* @param \Magento\Framework\Api\ExtensibleDataInterface $object
* @param \Magento\Framework\Api\ExtensibleDataInterface $target
* @param string $code
* @param mixed $value
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public function setUp()

/**
* @param object $dataObject
* @param string $interfaceNames
* @param string $interfaceName
* @dataProvider resolveDataProvider
*/
public function testResolve($dataObject, $interfaceName)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ class SchemaLocatorTest extends \PHPUnit\Framework\TestCase
*/
protected $model;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolver;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolverMock;

protected function setUp()
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Exception/BulkException.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public function __construct(Phrase $phrase = null, \Exception $cause = null, $co
}

/**
* @param $data array
* @param array $data
*/
public function addData($data)
{
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/File/Mime.php
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ class Mime
/**
* List of mime types that can be defined by file extension.
*
* @var array $defineByExtensionList
* @var array
*/
private $defineByExtensionList = [
'txt' => 'text/plain',
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Filesystem/Io/Sftp.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class Sftp extends AbstractIo
const SSH2_PORT = 22;

/**
* @var \phpseclib\Net\SFTP $_connection
* @var \phpseclib\Net\SFTP
*/
protected $_connection = null;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ class SchemaLocatorTest extends \PHPUnit\Framework\TestCase
*/
protected $model;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolver;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolverMock;

protected function setUp()
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Lock/Backend/Database.php
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ public function isLocked(string $name): bool
* Limited to 64 characters in MySQL.
*
* @param string $name
* @return string $name
* @return string
* @throws InputException
*/
private function addPrefix(string $name): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class DatabaseTest extends \PHPUnit\Framework\TestCase
private $objectManager;

/**
* @var Database $database
* @var Database
*/
private $database;

Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Logger/Handler/Base.php
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ private function sanitizeFileName($fileName)
/**
* {@inheritDoc}
*
* @param $record array
* @param array $record
*
* @return void
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Logger/Handler/System.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public function __construct(
/**
* Writes formatted record through the handler.
*
* @param $record array The record metadata
* @param array $record The record metadata
* @return void
*/
public function write(array $record)
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Message/Manager.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ class Manager implements ManagerInterface
* @param Event\ManagerInterface $eventManager
* @param LoggerInterface $logger
* @param string $defaultGroup
* @param ExceptionMessageFactoryInterface|null exceptionMessageFactory
* @param ExceptionMessageFactoryInterface|null $exceptionMessageFactory
*/
public function __construct(
Session $session,
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Model/AbstractModel.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ abstract class AbstractModel extends \Magento\Framework\DataObject

/**
* Data changes flag (true after setData|unsetData call)
* @var $_hasDataChange bool
* @var bool
*/
protected $_hasDataChanges = false;

Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Module/Setup/Context.php
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public function getEventManager()
}

/**
* @return \Psr\Log\LoggerInterface $logger
* @return \Psr\Log\LoggerInterface
*/
public function getLogger()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
class Log
{
/**
* @var $this
* @var self
*/
protected static $instance;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ class SchemaLocatorTest extends \PHPUnit\Framework\TestCase
*/
protected $model;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolver;

/** @var \Magento\Framework\Config\Dom\UrnResolver $urnResolverMock */
/** @var \Magento\Framework\Config\Dom\UrnResolver */
protected $urnResolverMock;

protected function setUp()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class BuilderTest extends \PHPUnit\Framework\TestCase
private $preprocessor;

/**
* @var ConditionManager|\PHPUnit_Framework_MockObject_MockObject $conditionManager
* @var ConditionManager|\PHPUnit_Framework_MockObject_MockObject
*/
private $conditionManager;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ class Config implements \Cm\RedisSession\Handler\ConfigInterface
/**
* Deployment config
*
* @var DeploymentConfig $deploymentConfig
* @var DeploymentConfig
*/
private $deploymentConfig;

Expand Down
6 changes: 3 additions & 3 deletions lib/internal/Magento/Framework/Test/Unit/UrlTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,8 @@ protected function getUrlModel($arguments = [])
}

/**
* @param $httpHost string
* @param $url string
* @param string $httpHost
* @param string $url
* @dataProvider getCurrentUrlProvider
*/
public function testGetCurrentUrl($httpHost, $url)
Expand Down Expand Up @@ -435,7 +435,7 @@ public function testGetDirectUrl()
}

/**
* @param string $url
* @param string $inputUrl
* @dataProvider getRebuiltUrlDataProvider
*/
public function testGetRebuiltUrl($inputUrl, $outputUrl)
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Translate.php
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class Translate implements \Magento\Framework\TranslateInterface
protected $_viewDesign;

/**
* @var \Magento\Framework\Cache\FrontendInterface $cache
* @var \Magento\Framework\Cache\FrontendInterface
*/
protected $_cache;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public function getContent();
/**
* Sets the body content that is being parsed passed upon the passed in string.
*
* @param $content string
* @param string $content
* @return void
*/
public function setContent($content);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class ThemeList extends \Magento\Framework\Data\Collection implements ListInterf
protected $_itemObjectClass = ThemeInterface::class;

/**
* @var \Magento\Framework\Config\ThemeFactory $themeConfigFactory
* @var \Magento\Framework\Config\ThemeFactory
*/
protected $themeConfigFactory;

Expand Down
Loading