owncloud / core

core/Controller/OccController.php

Doc Comments +2 added lines, -2 removed lines

@@ -131,8 +131,8 @@
 
 	/**
 	 * Check if command is allowed and has a valid security token
-	 * @param $command
-	 * @param $token
+	 * @param string $command
+	 * @param string $token
 	 */
 	protected function validateRequest($command, $token) {
 		$allowedHosts = ['::1', '127.0.0.1', 'localhost'];

lib/private/Files/Filesystem.php

Doc Comments +29 added lines, -2 removed lines

@@ -359,6 +359,10 @@ 
 		}
 	}
 
+	/**
+	 * @param string|boolean $user
+	 * @param string $root
+	 */
 	public static function init($user, $root) {
 		if (self::$defaultInstance) {
 			return false;
@@ -517,7 +521,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
 	 */
@@ -690,6 +694,9 @@ 
 		return self::$defaultInstance->is_dir($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public static function is_file($path) {
 		return self::$defaultInstance->is_file($path);
 	}
@@ -702,6 +709,9 @@ 
 		return self::$defaultInstance->filetype($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public static function filesize($path) {
 		return self::$defaultInstance->filesize($path);
 	}
@@ -714,6 +724,9 @@ 
 		return self::$defaultInstance->isCreatable($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public static function isReadable($path) {
 		return self::$defaultInstance->isReadable($path);
 	}
@@ -726,6 +739,9 @@ 
 		return self::$defaultInstance->isDeletable($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public static function isSharable($path) {
 		return self::$defaultInstance->isSharable($path);
 	}
@@ -743,6 +759,7 @@ 
 	}
 
 	/**
+	 * @param string $path
 	 * @return string
 	 */
 	public static function file_get_contents($path) {
@@ -765,6 +782,10 @@ 
 		return self::$defaultInstance->copy($path1, $path2);
 	}
 
+	/**
+	 * @param string $path
+	 * @param string $mode
+	 */
 	public static function fopen($path, $mode) {
 		return self::$defaultInstance->fopen($path, $mode);
 	}
@@ -780,6 +801,9 @@ 
 		return self::$defaultInstance->fromTmpFile($tmpFile, $path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public static function getMimeType($path) {
 		return self::$defaultInstance->getMimeType($path);
 	}
@@ -792,6 +816,9 @@ 
 		return self::$defaultInstance->free_space($path);
 	}
 
+	/**
+	 * @param string $query
+	 */
 	public static function search($query) {
 		return self::$defaultInstance->search($query);
 	}
@@ -900,7 +927,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/Node/Root.php

Doc Comments +4 added lines, -1 removed lines

@@ -175,7 +175,7 @@ 
 	 * @param string $path
 	 * @throws \OCP\Files\NotFoundException
 	 * @throws \OCP\Files\NotPermittedException
-	 * @return File|Folder
+	 * @return string
 	 */
 	public function get($path) {
 		$path = $this->normalizePath($path);
@@ -373,6 +373,9 @@ 
 		return $folder;
 	}
 
+	/**
+	 * @param string $fullPath
+	 */
 	private function resolveVirtualNode($fullPath) {
 		$pieces = \explode('/', $fullPath);
 		if ($pieces[1] !== 'meta') {

lib/private/legacy/api.php

Doc Comments +2 added lines, -2 removed lines

@@ -269,7 +269,7 @@ 
 	/**
 	 * authenticate the api call
 	 * @param array $action the action details as supplied to OC_API::register()
-	 * @return bool
+	 * @return boolean|string
 	 */
 	private static function isAuthorised($action) {
 		$level = $action['authlevel'];
@@ -318,7 +318,7 @@ 
 
 	/**
 	 * http basic auth
-	 * @return string|false (username, or false on failure)
+	 * @return string|boolean (username, or false on failure)
 	 */
 	private static function loginUser() {
 		if (self::$isLoggedIn === true) {

lib/private/Repair/RepairMismatchFileCachePath.php

Doc Comments +14 added lines, -1 removed lines

@@ -102,7 +102,7 @@ 
 	 * @param string $wrongPath wrong path of the entry to fix
 	 * @param int $correctStorageNumericId numeric idea of the correct storage
 	 * @param string $correctPath value to which to set the path of the entry
-	 * @return bool true for success
+	 * @return boolean|null true for success
 	 */
 	private function fixEntryPath(IOutput $out, $fileId, $wrongPath, $correctStorageNumericId, $correctPath) {
 		// delete target if exists
@@ -132,6 +132,9 @@ 
 		$out->advance(1, $text);
 	}
 
+	/**
+	 * @param \OCP\DB\QueryBuilder\IQueryBuilder $qb
+	 */
 	private function addQueryConditionsParentIdWrongPath($qb) {
 		// thanks, VicDeo!
 		if ($this->connection->getDatabasePlatform() instanceof MySqlPlatform) {
@@ -171,6 +174,9 @@ 
 		}
 	}
 
+	/**
+	 * @param \OCP\DB\QueryBuilder\IQueryBuilder $qb
+	 */
 	private function addQueryConditionsNonExistingParentIdEntry($qb, $storageNumericId = null) {
 		// Subquery for parent existence
 		$qbe = $this->connection->getQueryBuilder();
@@ -200,6 +206,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $storageNumericId
+	 */
 	private function countResultsToProcessParentIdWrongPath($storageNumericId = null) {
 		$qb = $this->connection->getQueryBuilder();
 		$qb->select($qb->createFunction('COUNT(*)'));
@@ -210,6 +219,9 @@ 
 		return $count;
 	}
 
+	/**
+	 * @param integer $storageNumericId
+	 */
 	private function countResultsToProcessNonExistingParentIdEntry($storageNumericId = null) {
 		$qb = $this->connection->getQueryBuilder();
 		$qb->select($qb->createFunction('COUNT(*)'));
@@ -359,6 +371,7 @@ 
 	 *
 	 * @param int $storageId storage id
 	 * @param string $path path for which to create the parent entry
+	 * @param integer $reuseFileId
 	 * @return int file id of the newly created parent
 	 */
 	private function getOrCreateEntry($storageId, $path, $reuseFileId = null) {

lib/private/Tags.php

Doc Comments +10 added lines, -2 removed lines

@@ -741,11 +741,19 @@ 
 	}
 
 	// case-insensitive array_search
+
+	/**
+	 * @param string $needle
+	 */
 	protected function array_searchi($needle, $haystack, $mem='getName') {
 		if (!\is_array($haystack)) {
 			return false;
 		}
 		return \array_search(\strtolower($needle), \array_map(
+
+			/**
+			 * @param string $tag
+			 */
 			function ($tag) use ($mem) {
 				return \strtolower(\call_user_func([$tag, $mem]));
 			}, $haystack)
@@ -770,7 +778,7 @@ 
 	* Get a tag by its name.
 	*
 	* @param string $name The tag name.
-	* @return integer|bool The tag object's offset within the $this->tags
+	* @return \OCP\AppFramework\Db\Entity The tag object's offset within the $this->tags
 	*                      array or false if it doesn't exist.
 	*/
 	private function getTagByName($name) {
@@ -781,7 +789,7 @@ 
 	* Get a tag by its ID.
 	*
 	* @param string $id The tag ID to look for.
-	* @return integer|bool The tag object's offset within the $this->tags
+	* @return \OCP\AppFramework\Db\Entity The tag object's offset within the $this->tags
 	*                      array or false if it doesn't exist.
 	*/
 	private function getTagById($id) {

lib/public/Files.php

Doc Comments +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
 	/**
 	 * Search for files by mimetype
 	 * @param string $mimetype
-	 * @return array
+	 * @return \OC\Files\FileInfo[]
 	 * @since 6.0.0
 	 */
 	public static function searchByMime($mimetype) {

lib/public/Migration/IOutput.php

Doc Comments +5 added lines, -1 removed lines

@@ -32,18 +32,21 @@ 
 	/**
 	 * @param string $message
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function info($message);
 
 	/**
 	 * @param string $message
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function warning($message);
 
 	/**
 	 * @param int $max
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function startProgress($max = 0);
 
@@ -51,12 +54,13 @@ 
 	 * @param int $step
 	 * @param string $description
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function advance($step = 1, $description = '');
 
 	/**
-	 * @param int $max
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function finishProgress();
 }

settings/ChangePassword/Controller.php

Doc Comments +3 added lines

@@ -67,6 +67,9 @@
 		}
 	}
 
+	/**
+	 * @param string|boolean $username
+	 */
 	private static function sendNotificationMail($username) {
 		$userObject = \OC::$server->getUserManager()->get($username);
 		$email = $userObject->getEMailAddress();