nextcloud / server

lib/private/Files/Cache/Scanner.php

Doc Comments +11 added lines

@@ -386,6 +386,14 @@ 
 		return $size;
 	}
 
+	/**
+	 * @param string $path
+	 * @param boolean $recursive
+	 * @param integer $reuse
+	 * @param integer|null $folderId
+	 * @param boolean $lock
+	 * @param integer $size
+	 */
 	private function handleChildren($path, $recursive, $reuse, $folderId, $lock, &$size) {
 		// we put this in it's own function so it cleans up the memory before we start recursing
 		$existingChildren = $this->getExistingChildren($folderId);
@@ -485,6 +493,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 -3 removed lines

@@ -23,15 +23,12 @@
 
 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;
 use OCP\Files\Config\IUserMountCache;
 use OCP\Files\Mount\IMountPoint;
 use OCP\Files\NotFoundException;
-use OCP\ICache;
 use OCP\IDBConnection;
 use OCP\ILogger;
 use OCP\IUser;

lib/private/Files/Filesystem.php

Doc Comments +29 added lines, -2 removed lines

@@ -355,6 +355,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $root
+	 */
 	static public function init($user, $root) {
 		if (self::$defaultInstance) {
 			return false;
@@ -494,7 +497,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
 	 */
@@ -605,6 +608,7 @@ 
 
 	/**
 	 * following functions are equivalent to their php builtin equivalents for arguments/return values.
+	 * @param string $path
 	 */
 	static public function mkdir($path) {
 		return self::$defaultInstance->mkdir($path);
@@ -626,6 +630,9 @@ 
 		return self::$defaultInstance->is_dir($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function is_file($path) {
 		return self::$defaultInstance->is_file($path);
 	}
@@ -638,6 +645,9 @@ 
 		return self::$defaultInstance->filetype($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function filesize($path) {
 		return self::$defaultInstance->filesize($path);
 	}
@@ -650,6 +660,9 @@ 
 		return self::$defaultInstance->isCreatable($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function isReadable($path) {
 		return self::$defaultInstance->isReadable($path);
 	}
@@ -662,6 +675,9 @@ 
 		return self::$defaultInstance->isDeletable($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function isSharable($path) {
 		return self::$defaultInstance->isSharable($path);
 	}
@@ -679,6 +695,7 @@ 
 	}
 
 	/**
+	 * @param string $path
 	 * @return string
 	 */
 	static public function file_get_contents($path) {
@@ -701,6 +718,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);
 	}
@@ -716,6 +737,9 @@ 
 		return self::$defaultInstance->fromTmpFile($tmpFile, $path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function getMimeType($path) {
 		return self::$defaultInstance->getMimeType($path);
 	}
@@ -728,6 +752,9 @@ 
 		return self::$defaultInstance->free_space($path);
 	}
 
+	/**
+	 * @param string $query
+	 */
 	static public function search($query) {
 		return self::$defaultInstance->search($query);
 	}
@@ -836,7 +863,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);

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;
 

lib/private/Files/Node/LazyRoot.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	 * Magic method to first get the real rootFolder and then
 	 * call $method with $args on it
 	 *
-	 * @param $method
+	 * @param string $method
 	 * @param $args
 	 * @return mixed
 	 */

Unused Use Statements -2 removed lines

@@ -20,9 +20,7 @@
  */
 namespace OC\Files\Node;
 
-use OC\Files\Mount\MountPoint;
 use OCP\Files\IRootFolder;
-use OCP\Files\NotPermittedException;
 
 /**
  * Class LazyRoot

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

lib/private/Files/Stream/StaticStream.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]);