public-mirrors
/
composer
mirror of https://github.com/composer/composer
1
0
Fork 0
Code

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/Composer/Package/AliasPackage.php
View File

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

15
src/Composer/Package/Package.php
View File

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

10
src/Composer/Package/RootPackageInterface.php
View File

@ -61,35 +61,35 @@ interface RootPackageInterface extends CompletePackageInterface
/** /**
* Set the required packages * 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); public function setRequires(array $requires);
/** /**
* Set the recommended packages * 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); public function setDevRequires(array $devRequires);
/** /**
* Set the conflicting packages * 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); public function setConflicts(array $conflicts);
/** /**
* Set the provided virtual packages * 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); public function setProvides(array $provides);
/** /**
* Set the packages this one replaces * 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); public function setReplaces(array $replaces);