Browse Source

Fixed PHPDoc

Pascal Borreli 12 years ago
parent
commit
83fd3967f0

+ 9 - 1
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)
     {

+ 1 - 2
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)
     {

+ 1 - 0
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)

+ 4 - 1
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)
     {

+ 3 - 2
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

+ 1 - 1
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
      */

+ 2 - 1
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)

+ 1 - 1
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)
     {

+ 3 - 0
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')
     {

+ 1 - 0
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')
     {

+ 4 - 2
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)
     {

+ 5 - 3
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
      */

+ 1 - 1
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();
 

+ 1 - 1
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)

+ 1 - 1
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)
     {

+ 2 - 1
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)

+ 2 - 2
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);

+ 3 - 2
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)
     {

+ 2 - 1
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())
     {

+ 0 - 2
src/Composer/Util/Svn.php

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