Fixed PHPDoc

main
Pascal Borreli 12 years ago
parent 5eead93250
commit 83fd3967f0

@ -146,6 +146,10 @@ EOT
/** /**
* finds a package by name and version if provided * finds a package by name and version if provided
* *
* @param RepositoryInterface $installedRepo
* @param RepositoryInterface $repos
* @param string $name
* @param string $version
* @return array array(CompletePackageInterface, array of versions) * @return array array(CompletePackageInterface, array of versions)
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
*/ */
@ -267,7 +271,11 @@ EOT
/** /**
* print link objects * print link objects
* *
* @param InputInterface $input
* @param OutputInterface $output
* @param CompletePackageInterface $package
* @param string $linkType * @param string $linkType
* @param string $title
*/ */
protected function printLinks(InputInterface $input, OutputInterface $output, CompletePackageInterface $package, $linkType, $title = null) protected function printLinks(InputInterface $input, OutputInterface $output, CompletePackageInterface $package, $linkType, $title = null)
{ {

@ -106,7 +106,7 @@ class RuleSetGenerator
* and B the provider. * and B the provider.
* *
* @param PackageInterface $issuer The package declaring the conflict * @param PackageInterface $issuer The package declaring the conflict
* @param Package $provider The package causing the conflict * @param PackageInterface $provider The package causing the conflict
* @param int $reason A RULE_* constant describing the * @param int $reason A RULE_* constant describing the
* reason for generating this rule * reason for generating this rule
* @param mixed $reasonData Any data, e.g. the package name, that * @param mixed $reasonData Any data, e.g. the package name, that
@ -226,7 +226,6 @@ class RuleSetGenerator
* *
* @param PackageInterface $package Rules for this package's updates are to * @param PackageInterface $package Rules for this package's updates are to
* be added * be added
* @param bool $allowAll Whether downgrades are allowed
*/ */
private function addRulesForUpdatePackages(PackageInterface $package) private function addRulesForUpdatePackages(PackageInterface $package)
{ {

@ -204,6 +204,7 @@ class Solver
* Evaluates each term affected by the decision (linked through watches) * Evaluates each term affected by the decision (linked through watches)
* If we find unit rules we make new decisions based on them * If we find unit rules we make new decisions based on them
* *
* @param integer $level
* @return Rule|null A rule on conflict, otherwise null. * @return Rule|null A rule on conflict, otherwise null.
*/ */
protected function propagate($level) protected function propagate($level)

@ -38,6 +38,9 @@ class FileDownloader implements DownloaderInterface
* Constructor. * Constructor.
* *
* @param IOInterface $io The IO instance * @param IOInterface $io The IO instance
* @param Config $config The config
* @param RemoteFilesystem $rfs The remote filesystem
* @param Filesystem $filesystem The filesystem
*/ */
public function __construct(IOInterface $io, Config $config, RemoteFilesystem $rfs = null, Filesystem $filesystem = null) public function __construct(IOInterface $io, Config $config, RemoteFilesystem $rfs = null, Filesystem $filesystem = null)
{ {

@ -127,8 +127,9 @@ class PearPackageExtractor
/** /**
* Builds list of copy and list of remove actions that would transform extracted PEAR tarball into installed package. * Builds list of copy and list of remove actions that would transform extracted PEAR tarball into installed package.
* *
* @param $source string path to extracted files. * @param string $source string path to extracted files
* @param $role string package file types to extract. * @param array $roles array [role => roleRoot] relative root for files having that role
* @param array $vars list of values can be used for replacement tasks
* @return array array of 'source' => 'target', where source is location of file in the tarball (relative to source * @return array array of 'source' => 'target', where source is location of file in the tarball (relative to source
* path, and target is destination of file (also relative to $source path) * path, and target is destination of file (also relative to $source path)
* @throws \RuntimeException * @throws \RuntimeException

@ -136,7 +136,7 @@ abstract class VcsDownloader implements DownloaderInterface
* Prompt the user to check if changes should be stashed/removed or the operation aborted * Prompt the user to check if changes should be stashed/removed or the operation aborted
* *
* @param string $path * @param string $path
* @param bool $stash if true (update) the changes can be stashed and reapplied after an update, * @param bool $update if true (update) the changes can be stashed and reapplied after an update,
* if false (remove) the changes should be assumed to be lost if the operation is not aborted * if false (remove) the changes should be assumed to be lost if the operation is not aborted
* @throws \RuntimeException in case the operation must be aborted * @throws \RuntimeException in case the operation must be aborted
*/ */

@ -226,6 +226,7 @@ class Factory
/** /**
* @param IO\IOInterface $io * @param IO\IOInterface $io
* @param Config $config
* @return Downloader\DownloadManager * @return Downloader\DownloadManager
*/ */
public function createDownloadManager(IOInterface $io, Config $config) public function createDownloadManager(IOInterface $io, Config $config)

@ -137,7 +137,7 @@ class InstallationManager
* Executes update operation. * Executes update operation.
* *
* @param RepositoryInterface $repo repository in which to check * @param RepositoryInterface $repo repository in which to check
* @param InstallOperation $operation operation instance * @param UpdateOperation $operation operation instance
*/ */
public function update(RepositoryInterface $repo, UpdateOperation $operation) public function update(RepositoryInterface $repo, UpdateOperation $operation)
{ {

@ -29,8 +29,11 @@ class InstallerInstaller extends LibraryInstaller
private static $classCounter = 0; private static $classCounter = 0;
/** /**
* Initializes Installer installer.
*
* @param IOInterface $io * @param IOInterface $io
* @param Composer $composer * @param Composer $composer
* @param string $type
*/ */
public function __construct(IOInterface $io, Composer $composer, $type = 'library') public function __construct(IOInterface $io, Composer $composer, $type = 'library')
{ {

@ -40,6 +40,7 @@ class LibraryInstaller implements InstallerInterface
* *
* @param IOInterface $io * @param IOInterface $io
* @param Composer $composer * @param Composer $composer
* @param string $type
*/ */
public function __construct(IOInterface $io, Composer $composer, $type = 'library') public function __construct(IOInterface $io, Composer $composer, $type = 'library')
{ {

@ -26,6 +26,7 @@ class Link
protected $target; protected $target;
protected $constraint; protected $constraint;
protected $description; protected $description;
protected $prettyConstraint;
/** /**
* Creates a new package link. * Creates a new package link.
@ -34,6 +35,7 @@ class Link
* @param string $target * @param string $target
* @param LinkConstraintInterface $constraint Constraint applying to the target of this link * @param LinkConstraintInterface $constraint Constraint applying to the target of this link
* @param string $description Used to create a descriptive string representation * @param string $description Used to create a descriptive string representation
* @param string $prettyConstraint
*/ */
public function __construct($source, $target, LinkConstraintInterface $constraint = null, $description = 'relates to', $prettyConstraint = null) public function __construct($source, $target, LinkConstraintInterface $constraint = null, $description = 'relates to', $prettyConstraint = null)
{ {

@ -214,8 +214,10 @@ class Locker
* Locks provided data into lockfile. * Locks provided data into lockfile.
* *
* @param array $packages array of packages * @param array $packages array of packages
* @param mixed $packages array of dev packages or null if installed without --dev * @param mixed $devPackages array of dev packages or null if installed without --dev
* @param array $aliases array of aliases * @param array $aliases array of aliases
* @param string $minimumStability
* @param array $stabilityFlags
* *
* @return bool * @return bool
*/ */

@ -97,7 +97,7 @@ interface PackageInterface
/** /**
* Returns source from which this package was installed (source/dist). * Returns source from which this package was installed (source/dist).
* *
* @param string $type source/dist * @return string source/dist
*/ */
public function getInstallationSource(); public function getInstallationSource();

@ -150,7 +150,7 @@ class VersionParser
/** /**
* Normalizes a branch name to be able to perform comparisons on it * Normalizes a branch name to be able to perform comparisons on it
* *
* @param string $version * @param string $name
* @return array * @return array
*/ */
public function normalizeBranch($name) public function normalizeBranch($name)

@ -24,7 +24,7 @@ class ReleaseInfo
/** /**
* @param string $stability * @param string $stability
* @param DependencyInfo $dependencies * @param DependencyInfo $dependencyInfo
*/ */
public function __construct($stability, $dependencyInfo) public function __construct($stability, $dependencyInfo)
{ {

@ -84,6 +84,7 @@ class PearRepository extends ArrayRepository
* Builds CompletePackages from PEAR package definition data. * Builds CompletePackages from PEAR package definition data.
* *
* @param ChannelInfo $channelInfo * @param ChannelInfo $channelInfo
* @param VersionParser $versionParser
* @return CompletePackage * @return CompletePackage
*/ */
private function buildComposerPackages(ChannelInfo $channelInfo, VersionParser $versionParser) private function buildComposerPackages(ChannelInfo $channelInfo, VersionParser $versionParser)

@ -86,7 +86,7 @@ interface VcsDriverInterface
* *
* @param IOInterface $io IO instance * @param IOInterface $io IO instance
* @param string $url * @param string $url
* @param bool $shallow unless true, only shallow checks (url matching typically) should be done * @param bool $deep unless true, only shallow checks (url matching typically) should be done
* @return bool * @return bool
*/ */
public static function supports(IOInterface $io, $url, $deep = false); public static function supports(IOInterface $io, $url, $deep = false);

@ -42,6 +42,7 @@ class EventDispatcher
* *
* @param Composer $composer The composer instance * @param Composer $composer The composer instance
* @param IOInterface $io The IOInterface instance * @param IOInterface $io The IOInterface instance
* @param ProcessExecutor $process
*/ */
public function __construct(Composer $composer, IOInterface $io, ProcessExecutor $process = null) public function __construct(Composer $composer, IOInterface $io, ProcessExecutor $process = null)
{ {

@ -36,6 +36,7 @@ class RemoteFilesystem
* Constructor. * Constructor.
* *
* @param IOInterface $io The IO instance * @param IOInterface $io The IO instance
* @param array $options The options
*/ */
public function __construct(IOInterface $io, $options = array()) public function __construct(IOInterface $io, $options = array())
{ {

@ -224,8 +224,6 @@ class Svn
/** /**
* Detect Svn Auth. * Detect Svn Auth.
* *
* @param string $url
*
* @return bool * @return bool
*/ */
protected function hasAuth() protected function hasAuth()

Loading…
Cancel
Save