nextcloud / server

lib/private/Tags.php

Doc Comments +10 added lines, -2 removed lines

@@ -742,11 +742,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(array($tag, $mem)));
 			}, $haystack)
@@ -771,7 +779,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) {
@@ -782,7 +790,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/private/Template/Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -103,7 +103,7 @@
 	/**
 	 * Appends a variable
 	 * @param string $key key
-	 * @param mixed $value value
+	 * @param string $value value
 	 * @return boolean|null
 	 *
 	 * This function assigns a variable in an array context. If the key already

lib/public/AppFramework/Db/Mapper.php

Doc Comments +2 added lines, -1 removed lines

@@ -308,6 +308,7 @@ 
 	 * @param array $params the parameters of the sql query
 	 * @param int $limit the maximum number of rows
 	 * @param int $offset from which row we want to start
+	 * @param string $msg
 	 * @return string formatted error message string
 	 * @since 9.1.0
 	 */
@@ -360,7 +361,7 @@ 
 	 * Returns an db result and throws exceptions when there are more or less
 	 * results
 	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
+	 * @param string[] $params the parameters of the sql query
 	 * @param int $limit the maximum number of rows
 	 * @param int $offset from which row we want to start
 	 * @throws DoesNotExistException if the item does not exist

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

lib/public/SystemTag/ISystemTagManager.php

Doc Comments +7 added lines, -4 removed lines

@@ -102,17 +102,19 @@ 
 	 * with the same attributes
 	 *
 	 * @since 9.0.0
+	 * @return void
 	 */
 	public function updateTag($tagId, $newName, $userVisible, $userAssignable);
 
 	/**
 	 * Delete the given tags from the database and all their relationships.
 	 *
-	 * @param string|array $tagIds array of tag ids
+	 * @param string $tagIds array of tag ids
 	 *
 	 * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist
 	 *
 	 * @since 9.0.0
+	 * @return void
 	 */
 	public function deleteTags($tagIds);
 
@@ -123,7 +125,7 @@ 
 	 * @param ISystemTag $tag tag to check permission for
 	 * @param IUser $user user to check permission for
 	 *
-	 * @return true if the user is allowed to assign/unassign the tag, false otherwise
+	 * @return boolean if the user is allowed to assign/unassign the tag, false otherwise
 	 *
 	 * @since 9.1.0
 	 */
@@ -133,9 +135,9 @@ 
 	 * Checks whether the given user is allowed to see the tag with the given id.
 	 *
 	 * @param ISystemTag $tag tag to check permission for
-	 * @param IUser $user user to check permission for
+	 * @param IUser $userId user to check permission for
 	 *
-	 * @return true if the user can see the tag, false otherwise
+	 * @return boolean if the user can see the tag, false otherwise
 	 *
 	 * @since 9.1.0
 	 */
@@ -148,6 +150,7 @@ 
 	 * @param string[] $groupIds group ids of groups that can assign/unassign the tag
 	 *
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function setTagGroups(ISystemTag $tag, $groupIds);
 

lib/public/Util.php

Doc Comments +1 added lines, -1 removed lines

@@ -544,7 +544,7 @@
 	 * @param array $input The array to work on
 	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
 	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
+	 * @return string
 	 * @since 4.5.0
 	 */
 	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {

lib/private/Files/View.php

Doc Comments +4 added lines, -4 removed lines

@@ -200,7 +200,7 @@ 
 	 * and does not take the chroot into account )
 	 *
 	 * @param string $path
-	 * @return \OCP\Files\Mount\IMountPoint
+	 * @return Mount\MountPoint|null
 	 */
 	public function getMount($path) {
 		return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
@@ -963,7 +963,7 @@ 
 
 	/**
 	 * @param string $path
-	 * @return bool|string
+	 * @return string|false
 	 * @throws \OCP\Files\InvalidPathException
 	 */
 	public function toTmpFile($path) {
@@ -1078,7 +1078,7 @@ 
 	 * @param string $path
 	 * @param array $hooks (optional)
 	 * @param mixed $extraParam (optional)
-	 * @return mixed
+	 * @return string
 	 * @throws \Exception
 	 *
 	 * This method takes requests for basic filesystem functions (e.g. reading & writing
@@ -2086,7 +2086,7 @@ 
 
 	/**
 	 * @param string $filename
-	 * @return array
+	 * @return string[]
 	 * @throws \OC\User\NoUserException
 	 * @throws NotFoundException
 	 */

apps/files_sharing/lib/Helper.php

Doc Comments +1 added lines

@@ -303,6 +303,7 @@
 	 * get default share folder
 	 *
 	 * @param \OC\Files\View
+	 * @param View $view
 	 * @return string
 	 */
 	public static function getShareFolder($view = null) {

apps/dav/lib/SystemTag/SystemTagsObjectMappingCollection.php

Doc Comments +3 added lines

@@ -89,6 +89,9 @@
 		$this->user = $user;
 	}
 
+	/**
+	 * @param string $tagId
+	 */
 	function createFile($tagId, $data = null) {
 		try {
 			$tags = $this->tagManager->getTagsByIds([$tagId]);