From 8b5c00bff0e29d9093101dde1d89141d9f8b7528 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Pluchino?= Date: Wed, 16 Jul 2014 15:17:38 +0200 Subject: [PATCH] Fix phpdoc --- src/Composer/Autoload/ClassLoader.php | 4 ++++ src/Composer/Config/JsonConfigSource.php | 1 + src/Composer/Console/Application.php | 1 + src/Composer/Downloader/ArchiveDownloader.php | 1 + src/Composer/Downloader/DownloadManager.php | 1 + src/Composer/Downloader/GitDownloader.php | 4 +++- src/Composer/EventDispatcher/EventDispatcher.php | 2 +- src/Composer/Factory.php | 8 ++++++++ src/Composer/Installer.php | 2 ++ src/Composer/Package/Package.php | 2 +- src/Composer/Package/Version/VersionParser.php | 4 ++-- src/Composer/Plugin/PluginManager.php | 4 ++++ src/Composer/Util/Filesystem.php | 6 ++++++ src/Composer/Util/RemoteFilesystem.php | 3 ++- src/Composer/Util/Svn.php | 1 + 15 files changed, 38 insertions(+), 6 deletions(-) diff --git a/src/Composer/Autoload/ClassLoader.php b/src/Composer/Autoload/ClassLoader.php index 88684c526..443364959 100644 --- a/src/Composer/Autoload/ClassLoader.php +++ b/src/Composer/Autoload/ClassLoader.php @@ -143,6 +143,8 @@ class ClassLoader * @param string $prefix The prefix/namespace, with trailing '\\' * @param array|string $paths The PSR-0 base directories * @param bool $prepend Whether to prepend the directories + * + * @throws \InvalidArgumentException */ public function addPsr4($prefix, $paths, $prepend = false) { @@ -204,6 +206,8 @@ class ClassLoader * * @param string $prefix The prefix/namespace, with trailing '\\' * @param array|string $paths The PSR-4 base directories + * + * @throws \InvalidArgumentException */ public function setPsr4($prefix, $paths) { diff --git a/src/Composer/Config/JsonConfigSource.php b/src/Composer/Config/JsonConfigSource.php index 6ca613ea6..4d0a873f5 100644 --- a/src/Composer/Config/JsonConfigSource.php +++ b/src/Composer/Config/JsonConfigSource.php @@ -37,6 +37,7 @@ class JsonConfigSource implements ConfigSourceInterface * Constructor * * @param JsonFile $file + * @param bool $authConfig */ public function __construct(JsonFile $file, $authConfig = false) { diff --git a/src/Composer/Console/Application.php b/src/Composer/Console/Application.php index da5d4ff20..b46ceb738 100644 --- a/src/Composer/Console/Application.php +++ b/src/Composer/Console/Application.php @@ -129,6 +129,7 @@ class Application extends BaseApplication /** * @param InputInterface $input + * @return string * @throws \RuntimeException */ private function getNewWorkingDir(InputInterface $input) diff --git a/src/Composer/Downloader/ArchiveDownloader.php b/src/Composer/Downloader/ArchiveDownloader.php index 7c0a761c6..a454490f3 100644 --- a/src/Composer/Downloader/ArchiveDownloader.php +++ b/src/Composer/Downloader/ArchiveDownloader.php @@ -132,6 +132,7 @@ abstract class ArchiveDownloader extends FileDownloader * Returns the folder content, excluding dotfiles * * @param string $dir Directory + * @return \SplFileInfo[] */ private function getFolderContent($dir) { diff --git a/src/Composer/Downloader/DownloadManager.php b/src/Composer/Downloader/DownloadManager.php index 26c5a5301..01ccc822b 100644 --- a/src/Composer/Downloader/DownloadManager.php +++ b/src/Composer/Downloader/DownloadManager.php @@ -164,6 +164,7 @@ class DownloadManager * @param bool $preferSource prefer installation from source * * @throws \InvalidArgumentException if package have no urls to download from + * @throws \RuntimeException */ public function download(PackageInterface $package, $targetDir, $preferSource = null) { diff --git a/src/Composer/Downloader/GitDownloader.php b/src/Composer/Downloader/GitDownloader.php index f44b1514e..695996b5c 100644 --- a/src/Composer/Downloader/GitDownloader.php +++ b/src/Composer/Downloader/GitDownloader.php @@ -204,8 +204,10 @@ class GitDownloader extends VcsDownloader * @param string $path * @param string $reference * @param string $branch - * @param DateTime $date + * @param \DateTime $date * @return null|string if a string is returned, it is the commit reference that was checked out if the original could not be found + * + * @throws \RuntimeException */ protected function updateToCommit($path, $reference, $branch, $date) { diff --git a/src/Composer/EventDispatcher/EventDispatcher.php b/src/Composer/EventDispatcher/EventDispatcher.php index fb607831d..98e959c92 100644 --- a/src/Composer/EventDispatcher/EventDispatcher.php +++ b/src/Composer/EventDispatcher/EventDispatcher.php @@ -73,7 +73,7 @@ class EventDispatcher * Dispatch a script event. * * @param string $eventName The constant in ScriptEvents - * @param Script\Event $event + * @param bool $devMode */ public function dispatchScript($eventName, $devMode = false) { diff --git a/src/Composer/Factory.php b/src/Composer/Factory.php index 5c5bfd5cf..e495f05f6 100644 --- a/src/Composer/Factory.php +++ b/src/Composer/Factory.php @@ -38,6 +38,7 @@ class Factory { /** * @return string + * @throws \RuntimeException */ protected static function getHomeDir() { @@ -60,6 +61,8 @@ class Factory } /** + * @param string $home + * * @return string */ protected static function getCacheDir($home) @@ -82,6 +85,7 @@ class Factory } /** + * @param IOInterface|null $io * @return Config */ public static function createConfig(IOInterface $io = null) @@ -333,6 +337,7 @@ class Factory /** * @param Config $config * @param string $vendorDir + * @return Repository\InstalledFilesystemRepository|null */ protected function createGlobalRepository(Config $config, $vendorDir) { @@ -410,6 +415,9 @@ class Factory } /** + * @param Composer $composer + * @param IOInterface $io + * @param RepositoryInterface $globalRepository * @return Plugin\PluginManager */ protected function createPluginManager(Composer $composer, IOInterface $io, RepositoryInterface $globalRepository = null) diff --git a/src/Composer/Installer.php b/src/Composer/Installer.php index fac713226..67892d11f 100644 --- a/src/Composer/Installer.php +++ b/src/Composer/Installer.php @@ -152,6 +152,8 @@ class Installer * Run installation (or update) * * @return int 0 on success or a positive error code on failure + * + * @throws \Exception */ public function run() { diff --git a/src/Composer/Package/Package.php b/src/Composer/Package/Package.php index 2662fd32a..0c98a0e56 100644 --- a/src/Composer/Package/Package.php +++ b/src/Composer/Package/Package.php @@ -495,7 +495,7 @@ class Package extends BasePackage /** * Set the dev autoload mapping * - * @param array $autoload Mapping of dev autoloading rules + * @param array $devAutoload Mapping of dev autoloading rules */ public function setDevAutoload(array $devAutoload) { diff --git a/src/Composer/Package/Version/VersionParser.php b/src/Composer/Package/Version/VersionParser.php index ee13b77a5..812ccf5ad 100644 --- a/src/Composer/Package/Version/VersionParser.php +++ b/src/Composer/Package/Version/VersionParser.php @@ -89,7 +89,7 @@ class VersionParser * @param string $version * @param string $fullVersion optional complete version string to give more context * @throws \UnexpectedValueException - * @return array + * @return string */ public function normalize($version, $fullVersion = null) { @@ -161,7 +161,7 @@ class VersionParser * Normalizes a branch name to be able to perform comparisons on it * * @param string $name - * @return array + * @return string */ public function normalizeBranch($name) { diff --git a/src/Composer/Plugin/PluginManager.php b/src/Composer/Plugin/PluginManager.php index d7c3ae07a..0305d31df 100644 --- a/src/Composer/Plugin/PluginManager.php +++ b/src/Composer/Plugin/PluginManager.php @@ -103,6 +103,8 @@ class PluginManager * call this method as early as possible. * * @param RepositoryInterface $repo Repository to scan for plugins to install + * + * @throws \RuntimeException */ public function loadRepository(RepositoryInterface $repo) { @@ -186,6 +188,8 @@ class PluginManager * instead for BC * * @param PackageInterface $package + * + * @throws \UnexpectedValueException */ public function registerPackage(PackageInterface $package) { diff --git a/src/Composer/Util/Filesystem.php b/src/Composer/Util/Filesystem.php index d167de463..182004205 100644 --- a/src/Composer/Util/Filesystem.php +++ b/src/Composer/Util/Filesystem.php @@ -90,6 +90,8 @@ class Filesystem * * @param string $directory * @return bool + * + * @throws \RuntimeException */ public function removeDirectory($directory) { @@ -174,6 +176,8 @@ class Filesystem * * @param string $path * @return bool + * + * @throws \RuntimeException */ public function unlink($path) { @@ -198,6 +202,8 @@ class Filesystem * * @param string $path * @return bool + * + * @throws \RuntimeException */ public function rmdir($path) { diff --git a/src/Composer/Util/RemoteFilesystem.php b/src/Composer/Util/RemoteFilesystem.php index 0eed1b223..ee15f9d50 100644 --- a/src/Composer/Util/RemoteFilesystem.php +++ b/src/Composer/Util/RemoteFilesystem.php @@ -43,6 +43,7 @@ class RemoteFilesystem * Constructor. * * @param IOInterface $io The IO instance + * @param Config $config The config * @param array $options The options */ public function __construct(IOInterface $io, Config $config = null, array $options = array()) @@ -76,7 +77,7 @@ class RemoteFilesystem * @param boolean $progress Display the progression * @param array $options Additional context options * - * @return string The content + * @return bool|string The content */ public function getContents($originUrl, $fileUrl, $progress = true, $options = array()) { diff --git a/src/Composer/Util/Svn.php b/src/Composer/Util/Svn.php index a2836075f..4ec13297f 100644 --- a/src/Composer/Util/Svn.php +++ b/src/Composer/Util/Svn.php @@ -66,6 +66,7 @@ class Svn /** * @param string $url * @param \Composer\IO\IOInterface $io + * @param Config $config * @param ProcessExecutor $process */ public function __construct($url, IOInterface $io, Config $config, ProcessExecutor $process = null)