1
0
Fork 0

Improve PHPDoc for package requires

pull/4676/head
Sullivan SENECHAL 2015-12-07 15:20:46 +01:00
parent 09b644faa6
commit 5d625c2231
3 changed files with 23 additions and 13 deletions

View File

@ -27,10 +27,15 @@ class AliasPackage extends BasePackage implements CompletePackageInterface
protected $rootPackageAlias = false;
protected $stability;
/** @var Link[] */
protected $requires;
/** @var Link[] */
protected $devRequires;
/** @var Link[] */
protected $conflicts;
/** @var Link[] */
protected $provides;
/** @var Link[] */
protected $replaces;
/**
@ -160,10 +165,10 @@ class AliasPackage extends BasePackage implements CompletePackageInterface
}
/**
* @param array $links
* @param Link[] $links
* @param string $linkType
* @internal param string $prettyVersion
* @return array
*
* @return Link[]
*/
protected function replaceSelfVersionDependencies(array $links, $linkType)
{

View File

@ -43,10 +43,15 @@ class Package extends BasePackage
protected $stability;
protected $notificationUrl;
/** @var Link[] */
protected $requires = array();
/** @var Link[] */
protected $conflicts = array();
/** @var Link[] */
protected $provides = array();
/** @var Link[] */
protected $replaces = array();
/** @var Link[] */
protected $devRequires = array();
protected $suggests = array();
protected $autoload = array();
@ -369,7 +374,7 @@ class Package extends BasePackage
/**
* Set the required packages
*
* @param array $requires A set of package links
* @param Link[] $requires A set of package links
*/
public function setRequires(array $requires)
{
@ -387,7 +392,7 @@ class Package extends BasePackage
/**
* Set the conflicting packages
*
* @param array $conflicts A set of package links
* @param Link[] $conflicts A set of package links
*/
public function setConflicts(array $conflicts)
{
@ -405,7 +410,7 @@ class Package extends BasePackage
/**
* Set the provided virtual packages
*
* @param array $provides A set of package links
* @param Link[] $provides A set of package links
*/
public function setProvides(array $provides)
{
@ -423,7 +428,7 @@ class Package extends BasePackage
/**
* Set the packages this one replaces
*
* @param array $replaces A set of package links
* @param Link[] $replaces A set of package links
*/
public function setReplaces(array $replaces)
{
@ -441,7 +446,7 @@ class Package extends BasePackage
/**
* Set the recommended packages
*
* @param array $devRequires A set of package links
* @param Link[] $devRequires A set of package links
*/
public function setDevRequires(array $devRequires)
{

View File

@ -61,35 +61,35 @@ interface RootPackageInterface extends CompletePackageInterface
/**
* Set the required packages
*
* @param array $requires A set of package links
* @param Link[] $requires A set of package links
*/
public function setRequires(array $requires);
/**
* Set the recommended packages
*
* @param array $devRequires A set of package links
* @param Link[] $devRequires A set of package links
*/
public function setDevRequires(array $devRequires);
/**
* Set the conflicting packages
*
* @param array $conflicts A set of package links
* @param Link[] $conflicts A set of package links
*/
public function setConflicts(array $conflicts);
/**
* Set the provided virtual packages
*
* @param array $provides A set of package links
* @param Link[] $provides A set of package links
*/
public function setProvides(array $provides);
/**
* Set the packages this one replaces
*
* @param array $replaces A set of package links
* @param Link[] $replaces A set of package links
*/
public function setReplaces(array $replaces);