From 83fd3967f072d7871267789fe132a452a57a2c1b Mon Sep 17 00:00:00 2001 From: Pascal Borreli Date: Wed, 24 Oct 2012 23:44:40 +0000 Subject: [PATCH] Fixed PHPDoc --- src/Composer/Command/ShowCommand.php | 10 +++++++++- src/Composer/DependencyResolver/RuleSetGenerator.php | 3 +-- src/Composer/DependencyResolver/Solver.php | 1 + src/Composer/Downloader/FileDownloader.php | 5 ++++- src/Composer/Downloader/PearPackageExtractor.php | 5 +++-- src/Composer/Downloader/VcsDownloader.php | 2 +- src/Composer/Factory.php | 3 ++- src/Composer/Installer/InstallationManager.php | 2 +- src/Composer/Installer/InstallerInstaller.php | 3 +++ src/Composer/Installer/LibraryInstaller.php | 1 + src/Composer/Package/Link.php | 6 ++++-- src/Composer/Package/Locker.php | 8 +++++--- src/Composer/Package/PackageInterface.php | 2 +- src/Composer/Package/Version/VersionParser.php | 2 +- src/Composer/Repository/Pear/ReleaseInfo.php | 2 +- src/Composer/Repository/PearRepository.php | 3 ++- src/Composer/Repository/Vcs/VcsDriverInterface.php | 4 ++-- src/Composer/Script/EventDispatcher.php | 5 +++-- src/Composer/Util/RemoteFilesystem.php | 3 ++- src/Composer/Util/Svn.php | 2 -- 20 files changed, 47 insertions(+), 25 deletions(-) diff --git a/src/Composer/Command/ShowCommand.php b/src/Composer/Command/ShowCommand.php index 174e5e0ad..49905aa7a 100644 --- a/src/Composer/Command/ShowCommand.php +++ b/src/Composer/Command/ShowCommand.php @@ -146,6 +146,10 @@ EOT /** * 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) * @throws \InvalidArgumentException */ @@ -267,7 +271,11 @@ EOT /** * print link objects * - * @param string $linkType + * @param InputInterface $input + * @param OutputInterface $output + * @param CompletePackageInterface $package + * @param string $linkType + * @param string $title */ protected function printLinks(InputInterface $input, OutputInterface $output, CompletePackageInterface $package, $linkType, $title = null) { diff --git a/src/Composer/DependencyResolver/RuleSetGenerator.php b/src/Composer/DependencyResolver/RuleSetGenerator.php index 343653ac3..b40ce1a60 100644 --- a/src/Composer/DependencyResolver/RuleSetGenerator.php +++ b/src/Composer/DependencyResolver/RuleSetGenerator.php @@ -106,7 +106,7 @@ class RuleSetGenerator * and B the provider. * * @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 * reason for generating this rule * @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 * be added - * @param bool $allowAll Whether downgrades are allowed */ private function addRulesForUpdatePackages(PackageInterface $package) { diff --git a/src/Composer/DependencyResolver/Solver.php b/src/Composer/DependencyResolver/Solver.php index 943fad684..5a12b73e5 100644 --- a/src/Composer/DependencyResolver/Solver.php +++ b/src/Composer/DependencyResolver/Solver.php @@ -204,6 +204,7 @@ class Solver * Evaluates each term affected by the decision (linked through watches) * If we find unit rules we make new decisions based on them * + * @param integer $level * @return Rule|null A rule on conflict, otherwise null. */ protected function propagate($level) diff --git a/src/Composer/Downloader/FileDownloader.php b/src/Composer/Downloader/FileDownloader.php index c5ec96673..b567e5a5c 100644 --- a/src/Composer/Downloader/FileDownloader.php +++ b/src/Composer/Downloader/FileDownloader.php @@ -37,7 +37,10 @@ class FileDownloader implements DownloaderInterface /** * 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) { diff --git a/src/Composer/Downloader/PearPackageExtractor.php b/src/Composer/Downloader/PearPackageExtractor.php index 16df5e953..4cd7fea02 100644 --- a/src/Composer/Downloader/PearPackageExtractor.php +++ b/src/Composer/Downloader/PearPackageExtractor.php @@ -127,8 +127,9 @@ class PearPackageExtractor /** * 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 $role string package file types to extract. + * @param string $source string path to extracted files + * @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 * path, and target is destination of file (also relative to $source path) * @throws \RuntimeException diff --git a/src/Composer/Downloader/VcsDownloader.php b/src/Composer/Downloader/VcsDownloader.php index 87aadca1a..a7f63dc95 100644 --- a/src/Composer/Downloader/VcsDownloader.php +++ b/src/Composer/Downloader/VcsDownloader.php @@ -136,7 +136,7 @@ abstract class VcsDownloader implements DownloaderInterface * Prompt the user to check if changes should be stashed/removed or the operation aborted * * @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 * @throws \RuntimeException in case the operation must be aborted */ diff --git a/src/Composer/Factory.php b/src/Composer/Factory.php index c23fa710c..92701c981 100644 --- a/src/Composer/Factory.php +++ b/src/Composer/Factory.php @@ -225,7 +225,8 @@ class Factory } /** - * @param IO\IOInterface $io + * @param IO\IOInterface $io + * @param Config $config * @return Downloader\DownloadManager */ public function createDownloadManager(IOInterface $io, Config $config) diff --git a/src/Composer/Installer/InstallationManager.php b/src/Composer/Installer/InstallationManager.php index 136495c69..82604d283 100644 --- a/src/Composer/Installer/InstallationManager.php +++ b/src/Composer/Installer/InstallationManager.php @@ -137,7 +137,7 @@ class InstallationManager * Executes update operation. * * @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) { diff --git a/src/Composer/Installer/InstallerInstaller.php b/src/Composer/Installer/InstallerInstaller.php index 315334c84..f54b295dc 100644 --- a/src/Composer/Installer/InstallerInstaller.php +++ b/src/Composer/Installer/InstallerInstaller.php @@ -29,8 +29,11 @@ class InstallerInstaller extends LibraryInstaller private static $classCounter = 0; /** + * Initializes Installer installer. + * * @param IOInterface $io * @param Composer $composer + * @param string $type */ public function __construct(IOInterface $io, Composer $composer, $type = 'library') { diff --git a/src/Composer/Installer/LibraryInstaller.php b/src/Composer/Installer/LibraryInstaller.php index bac6bdf31..ba97fb1ef 100644 --- a/src/Composer/Installer/LibraryInstaller.php +++ b/src/Composer/Installer/LibraryInstaller.php @@ -40,6 +40,7 @@ class LibraryInstaller implements InstallerInterface * * @param IOInterface $io * @param Composer $composer + * @param string $type */ public function __construct(IOInterface $io, Composer $composer, $type = 'library') { diff --git a/src/Composer/Package/Link.php b/src/Composer/Package/Link.php index da6373144..159fa3ae9 100644 --- a/src/Composer/Package/Link.php +++ b/src/Composer/Package/Link.php @@ -26,14 +26,16 @@ class Link protected $target; protected $constraint; protected $description; + protected $prettyConstraint; /** * Creates a new package link. * * @param string $source * @param string $target - * @param LinkConstraintInterface $constraint Constraint applying to the target of this link - * @param string $description Used to create a descriptive string representation + * @param LinkConstraintInterface $constraint Constraint applying to the target of this link + * @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) { diff --git a/src/Composer/Package/Locker.php b/src/Composer/Package/Locker.php index 36530bea2..bd636c8f1 100644 --- a/src/Composer/Package/Locker.php +++ b/src/Composer/Package/Locker.php @@ -213,9 +213,11 @@ class Locker /** * Locks provided data into lockfile. * - * @param array $packages array of packages - * @param mixed $packages array of dev packages or null if installed without --dev - * @param array $aliases array of aliases + * @param array $packages array of packages + * @param mixed $devPackages array of dev packages or null if installed without --dev + * @param array $aliases array of aliases + * @param string $minimumStability + * @param array $stabilityFlags * * @return bool */ diff --git a/src/Composer/Package/PackageInterface.php b/src/Composer/Package/PackageInterface.php index c8b9a7f39..e034acba6 100644 --- a/src/Composer/Package/PackageInterface.php +++ b/src/Composer/Package/PackageInterface.php @@ -97,7 +97,7 @@ interface PackageInterface /** * Returns source from which this package was installed (source/dist). * - * @param string $type source/dist + * @return string source/dist */ public function getInstallationSource(); diff --git a/src/Composer/Package/Version/VersionParser.php b/src/Composer/Package/Version/VersionParser.php index a12cf41f4..e7aae0749 100644 --- a/src/Composer/Package/Version/VersionParser.php +++ b/src/Composer/Package/Version/VersionParser.php @@ -150,7 +150,7 @@ class VersionParser /** * Normalizes a branch name to be able to perform comparisons on it * - * @param string $version + * @param string $name * @return array */ public function normalizeBranch($name) diff --git a/src/Composer/Repository/Pear/ReleaseInfo.php b/src/Composer/Repository/Pear/ReleaseInfo.php index 4ad984d80..39d6e1ed6 100644 --- a/src/Composer/Repository/Pear/ReleaseInfo.php +++ b/src/Composer/Repository/Pear/ReleaseInfo.php @@ -24,7 +24,7 @@ class ReleaseInfo /** * @param string $stability - * @param DependencyInfo $dependencies + * @param DependencyInfo $dependencyInfo */ public function __construct($stability, $dependencyInfo) { diff --git a/src/Composer/Repository/PearRepository.php b/src/Composer/Repository/PearRepository.php index 6d28b081d..4fcd3233b 100644 --- a/src/Composer/Repository/PearRepository.php +++ b/src/Composer/Repository/PearRepository.php @@ -83,7 +83,8 @@ class PearRepository extends ArrayRepository /** * Builds CompletePackages from PEAR package definition data. * - * @param ChannelInfo $channelInfo + * @param ChannelInfo $channelInfo + * @param VersionParser $versionParser * @return CompletePackage */ private function buildComposerPackages(ChannelInfo $channelInfo, VersionParser $versionParser) diff --git a/src/Composer/Repository/Vcs/VcsDriverInterface.php b/src/Composer/Repository/Vcs/VcsDriverInterface.php index 47023a91a..44486f007 100644 --- a/src/Composer/Repository/Vcs/VcsDriverInterface.php +++ b/src/Composer/Repository/Vcs/VcsDriverInterface.php @@ -84,9 +84,9 @@ interface VcsDriverInterface /** * Checks if this driver can handle a given url * - * @param IOInterface $io IO instance + * @param IOInterface $io IO instance * @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 */ public static function supports(IOInterface $io, $url, $deep = false); diff --git a/src/Composer/Script/EventDispatcher.php b/src/Composer/Script/EventDispatcher.php index a1f9c163d..2b1a05767 100644 --- a/src/Composer/Script/EventDispatcher.php +++ b/src/Composer/Script/EventDispatcher.php @@ -40,8 +40,9 @@ class EventDispatcher /** * Constructor. * - * @param Composer $composer The composer instance - * @param IOInterface $io The IOInterface instance + * @param Composer $composer The composer instance + * @param IOInterface $io The IOInterface instance + * @param ProcessExecutor $process */ public function __construct(Composer $composer, IOInterface $io, ProcessExecutor $process = null) { diff --git a/src/Composer/Util/RemoteFilesystem.php b/src/Composer/Util/RemoteFilesystem.php index 537be3655..8f64b4407 100644 --- a/src/Composer/Util/RemoteFilesystem.php +++ b/src/Composer/Util/RemoteFilesystem.php @@ -35,7 +35,8 @@ class RemoteFilesystem /** * 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()) { diff --git a/src/Composer/Util/Svn.php b/src/Composer/Util/Svn.php index 865fd1387..d979a2ddb 100644 --- a/src/Composer/Util/Svn.php +++ b/src/Composer/Util/Svn.php @@ -224,8 +224,6 @@ class Svn /** * Detect Svn Auth. * - * @param string $url - * * @return bool */ protected function hasAuth()