nextcloud / server

lib/private/files/cache/scanner.php

Doc Comments +3 added lines

@@ -476,6 +476,9 @@
 		}
 	}
 
+	/**
+	 * @param string|boolean $path
+	 */
 	private function runBackgroundScanJob(callable $callback, $path) {
 		try {
 			$callback();

lib/private/files/cache/wrapper/cachejail.php

Doc Comments +5 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
 
 	/**
 	 * @param array $entry
-	 * @return array
+	 * @return string
 	 */
 	protected function formatCacheEntry($entry) {
 		if (isset($entry['path'])) {
@@ -189,6 +189,9 @@ 
 		return $this->cache->getStatus($this->getSourcePath($file));
 	}
 
+	/**
+	 * @param \OCP\Files\Cache\ICacheEntry[] $results
+	 */
 	private function formatSearchResults($results) {
 		$results = array_filter($results, array($this, 'filterCacheEntry'));
 		$results = array_values($results);
@@ -274,7 +277,7 @@ 
 	 * use the one with the highest id gives the best result with the background scanner, since that is most
 	 * likely the folder where we stopped scanning previously
 	 *
-	 * @return string|bool the path of the folder or false when no folder matched
+	 * @return boolean the path of the folder or false when no folder matched
 	 */
 	public function getIncomplete() {
 		// not supported

lib/private/files/config/usermountcache.php

Doc Comments +1 added lines, -1 removed lines

@@ -206,7 +206,7 @@
 	}
 
 	/**
-	 * @param $fileId
+	 * @param integer $fileId
 	 * @return array
 	 * @throws \OCP\Files\NotFoundException
 	 */

Unused Use Statements -2 removed lines

@@ -22,8 +22,6 @@
 
 namespace OC\Files\Config;
 
-use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
-use OC\Files\Filesystem;
 use OCA\Files_Sharing\SharedMount;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\Files\Config\ICachedMountInfo;

lib/private/files/filesystem.php

Unused Use Statements -1 removed lines

@@ -62,7 +62,6 @@
 use OC\Files\Mount\MountPoint;
 use OC\Files\Storage\StorageFactory;
 use OCP\Files\Config\IMountProvider;
-use OCP\Files\Mount\IMountPoint;
 use OCP\Files\NotFoundException;
 use OCP\IUserManager;
 

Doc Comments +28 added lines, -2 removed lines

@@ -338,6 +338,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $root
+	 */
 	static public function init($user, $root) {
 		if (self::$defaultInstance) {
 			return false;
@@ -521,7 +524,7 @@ 
 	/**
 	 * mount an \OC\Files\Storage\Storage in our virtual filesystem
 	 *
-	 * @param \OC\Files\Storage\Storage|string $class
+	 * @param string $class
 	 * @param array $arguments
 	 * @param string $mountpoint
 	 */
@@ -653,6 +656,9 @@ 
 		return self::$defaultInstance->is_dir($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function is_file($path) {
 		return self::$defaultInstance->is_file($path);
 	}
@@ -665,6 +671,9 @@ 
 		return self::$defaultInstance->filetype($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function filesize($path) {
 		return self::$defaultInstance->filesize($path);
 	}
@@ -677,6 +686,9 @@ 
 		return self::$defaultInstance->isCreatable($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function isReadable($path) {
 		return self::$defaultInstance->isReadable($path);
 	}
@@ -689,6 +701,9 @@ 
 		return self::$defaultInstance->isDeletable($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function isSharable($path) {
 		return self::$defaultInstance->isSharable($path);
 	}
@@ -706,6 +721,7 @@ 
 	}
 
 	/**
+	 * @param string $path
 	 * @return string
 	 */
 	static public function file_get_contents($path) {
@@ -728,6 +744,10 @@ 
 		return self::$defaultInstance->copy($path1, $path2);
 	}
 
+	/**
+	 * @param string $path
+	 * @param string $mode
+	 */
 	static public function fopen($path, $mode) {
 		return self::$defaultInstance->fopen($path, $mode);
 	}
@@ -743,6 +763,9 @@ 
 		return self::$defaultInstance->fromTmpFile($tmpFile, $path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function getMimeType($path) {
 		return self::$defaultInstance->getMimeType($path);
 	}
@@ -755,6 +778,9 @@ 
 		return self::$defaultInstance->free_space($path);
 	}
 
+	/**
+	 * @param string $query
+	 */
 	static public function search($query) {
 		return self::$defaultInstance->search($query);
 	}
@@ -868,7 +894,7 @@ 
 	 * @param string $path
 	 * @param boolean $includeMountPoints whether to add mountpoint sizes,
 	 * defaults to true
-	 * @return \OC\Files\FileInfo|bool False if file does not exist
+	 * @return \OCP\Files\FileInfo|null False if file does not exist
 	 */
 	public static function getFileInfo($path, $includeMountPoints = true) {
 		return self::$defaultInstance->getFileInfo($path, $includeMountPoints);

lib/private/files/objectstore/objectstorestorage.php

Doc Comments +3 added lines

@@ -144,6 +144,9 @@
 		return true;
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public function url_stat($path) {
 		if (isset(self::$data[$path])) {
 			$size = strlen(self::$data[$path]);

lib/private/files/storage/flysystem.php

Doc Comments +3 added lines

@@ -144,6 +144,9 @@
 		return true;
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public function url_stat($path) {
 		if (isset(self::$data[$path])) {
 			$size = strlen(self::$data[$path]);

lib/private/files/storage/storage.php

Doc Comments +3 added lines

@@ -99,6 +99,7 @@ 
 	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
 	 * @param \OCP\Lock\ILockingProvider $provider
 	 * @throws \OCP\Lock\LockedException
+	 * @return void
 	 */
 	public function acquireLock($path, $type, ILockingProvider $provider);
 
@@ -106,6 +107,7 @@ 
 	 * @param string $path The path of the file to release the lock for
 	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
 	 * @param \OCP\Lock\ILockingProvider $provider
+	 * @return void
 	 */
 	public function releaseLock($path, $type, ILockingProvider $provider);
 
@@ -114,6 +116,7 @@ 
 	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
 	 * @param \OCP\Lock\ILockingProvider $provider
 	 * @throws \OCP\Lock\LockedException
+	 * @return void
 	 */
 	public function changeLock($path, $type, ILockingProvider $provider);
 }

lib/private/files/storage/wrapper/encryption.php

Doc Comments +1 added lines, -1 removed lines

@@ -982,7 +982,7 @@
 	/**
 	 * check if path points to a files version
 	 *
-	 * @param $path
+	 * @param string $path
 	 * @return bool
 	 */
 	protected function isVersion($path) {

lib/private/files/storage/wrapper/quota.php

Doc Comments +1 added lines, -1 removed lines

@@ -159,7 +159,7 @@
 	 * Checks whether the given path is a part file
 	 *
 	 * @param string $path Path that may identify a .part file
-	 * @return string File path without .part extension
+	 * @return boolean File path without .part extension
 	 * @note this is needed for reusing keys
 	 */
 	private function isPartFile($path) {