Merge pull request #22253 from nextcloud/debt/noid/docblocks

MorrisJobke · web-flow · commit 00cb8e6c54d8 · 2020-08-17T17:45:11.000+02:00
Fix some MissingDocblockType or InvalidDocblock warnings.
diff --git a/apps/accessibility/lib/Controller/ConfigController.php b/apps/accessibility/lib/Controller/ConfigController.php
@@ -37,6 +37,7 @@
 use OCP\IConfig;
 use OCP\IRequest;
 use OCP\IUserSession;
+use OCP\PreConditionNotMetException;
 
 class ConfigController extends OCSController {
 
@@ -103,7 +104,7 @@ public function getConfig(): DataResponse {
 	 *
 	 * @param string $key theme or font
 	 * @return DataResponse
-	 * @throws Exception
+	 * @throws OCSBadRequestException|PreConditionNotMetException
 	 */
 	public function setConfig(string $key, $value): DataResponse {
 		if ($key === 'theme' || $key === 'font' || $key === 'highcontrast') {
@@ -137,7 +138,7 @@ public function setConfig(string $key, $value): DataResponse {
 	 *
 	 * @param string $key theme or font
 	 * @return DataResponse
-	 * @throws Exception
+	 * @throws OCSBadRequestException
 	 */
 	public function deleteConfig(string $key): DataResponse {
 		if ($key === 'theme' || $key === 'font' || $key === 'highcontrast') {
diff --git a/apps/dav/lib/CalDAV/Schedule/Plugin.php b/apps/dav/lib/CalDAV/Schedule/Plugin.php
@@ -325,7 +325,7 @@ public function propFindDefaultCalendarUrl(PropFind $propFind, INode $node) {
 	 * Returns a list of addresses that are associated with a principal.
 	 *
 	 * @param string $principal
-	 * @return string?
+	 * @return string|null
 	 */
 	protected function getCalendarUserTypeForPrincipal($principal):?string {
 		$calendarUserType = '{' . self::NS_CALDAV . '}calendar-user-type';
diff --git a/apps/dav/lib/CardDAV/AddressBookImpl.php b/apps/dav/lib/CardDAV/AddressBookImpl.php
@@ -82,7 +82,6 @@ public function getKey() {
 	/**
 	 * @return string defining the unique uri
 	 * @since 16.0.0
-	 * @return string
 	 */
 	public function getUri(): string {
 		return $this->addressBookInfo['uri'];
diff --git a/apps/dav/lib/CardDAV/PhotoCache.php b/apps/dav/lib/CardDAV/PhotoCache.php
@@ -36,6 +36,7 @@
 use OCP\Files\SimpleFS\ISimpleFolder;
 use OCP\ILogger;
 use Sabre\CardDAV\Card;
+use Sabre\VObject\Parameter;
 use Sabre\VObject\Property\Binary;
 use Sabre\VObject\Reader;
 
diff --git a/apps/dav/lib/Connector/Sabre/FilesPlugin.php b/apps/dav/lib/Connector/Sabre/FilesPlugin.php
@@ -276,7 +276,6 @@ public function httpGet(RequestInterface $request, ResponseInterface $response)
 
 		if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
 			//Add OC-Checksum header
-			/** @var $node File */
 			$checksum = $node->getChecksum();
 			if ($checksum !== null && $checksum !== '') {
 				$response->addHeader('OC-Checksum', $checksum);
@@ -383,7 +382,6 @@ public function handleGetProperties(PropFind $propFind, \Sabre\DAV\INode $node)
 
 		if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
 			$propFind->handle(self::DOWNLOADURL_PROPERTYNAME, function () use ($node) {
-				/** @var $node \OCA\DAV\Connector\Sabre\File */
 				try {
 					$directDownloadUrl = $node->getDirectDownload();
 					if (isset($directDownloadUrl['url'])) {
diff --git a/apps/encryption/lib/HookManager.php b/apps/encryption/lib/HookManager.php
@@ -26,6 +26,7 @@
 use OCA\Encryption\Hooks\Contracts\IHook;
 
 class HookManager {
+	/** @var IHook[] */
 	private $hookInstances = [];
 
 	/**
@@ -51,8 +52,6 @@ public function fireHooks() {
 		foreach ($this->hookInstances as $instance) {
 			/**
 			 * Fire off the add hooks method of each instance stored in cache
-			 *
-			 * @var $instance IHook
 			 */
 			$instance->addHooks();
 		}
diff --git a/apps/files/lib/Controller/ApiController.php b/apps/files/lib/Controller/ApiController.php
@@ -332,7 +332,7 @@ public function toggleShowFolder(int $show, string $key) {
 	 *
 	 * @NoAdminRequired
 	 *
-	 * @param string
+	 * @param string $folderpath
 	 * @return string
 	 * @throws \OCP\Files\NotFoundException
 	 */
diff --git a/apps/files/templates/index.php b/apps/files/templates/index.php
@@ -1,4 +1,4 @@
-<?php /** @var $l \OCP\IL10N */ ?>
+<?php /** @var \OCP\IL10N $l */ ?>
 <?php $_['appNavigation']->printPage(); ?>
 <div id="app-content">
 
diff --git a/apps/files/templates/recentlist.php b/apps/files/templates/recentlist.php
@@ -1,4 +1,4 @@
-<?php /** @var $l \OCP\IL10N */ ?>
+<?php /** @var \OCP\IL10N $l */ ?>
 <div id='notification'></div>
 
 <div id="emptycontent" class="hidden"></div>
diff --git a/apps/files_external/lib/Command/ListCommand.php b/apps/files_external/lib/Command/ListCommand.php
@@ -97,15 +97,13 @@ protected function configure() {
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output): int {
+		/** @var StorageConfig[] $mounts */
 		if ($input->getOption('all')) {
-			/** @var  $mounts StorageConfig[] */
 			$mounts = $this->globalService->getStorageForAllUsers();
 			$userId = self::ALL;
 		} else {
 			$userId = $input->getArgument('user_id');
 			$storageService = $this->getStorageService($userId);
-
-			/** @var  $mounts StorageConfig[] */
 			$mounts = $storageService->getAllStorages();
 		}
 
@@ -114,7 +112,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 	}
 
 	/**
-	 * @param $userId $userId
+	 * @param string $userId
 	 * @param StorageConfig[] $mounts
 	 * @param InputInterface $input
 	 * @param OutputInterface $output
diff --git a/apps/files_external/lib/Service/UserTrait.php b/apps/files_external/lib/Service/UserTrait.php
@@ -55,7 +55,7 @@ protected function getUser() {
 	 * Override the user from the session
 	 * Unset with ->resetUser() when finished!
 	 *
-	 * @param IUser
+	 * @param IUser $user
 	 * @return self
 	 */
 	public function setUser(IUser $user) {
diff --git a/apps/files_external/templates/list.php b/apps/files_external/templates/list.php
@@ -1,4 +1,4 @@
-<?php /** @var $l \OCP\IL10N */ ?>
+<?php /** @var \OCP\IL10N $l */ ?>
 <div id="controls">
 	<div id="file_action_panel"></div>
 </div>
diff --git a/apps/files_sharing/lib/Controller/ShareAPIController.php b/apps/files_sharing/lib/Controller/ShareAPIController.php
@@ -1466,7 +1466,7 @@ private function lock(\OCP\Files\Node $node) {
 
 	/**
 	 * Cleanup the remaining locks
-	 * @throws @LockedException
+	 * @throws LockedException
 	 */
 	public function cleanup() {
 		if ($this->lockedNode !== null) {
@@ -1642,7 +1642,7 @@ private function shareProviderResharingRights(string $userId, IShare $share, $no
 	 *
 	 * @param Node|null $path
 	 * @param boolean $reshares
-	 * @return void
+	 * @return IShare[]
 	 */
 	private function getAllShares(?Node $path = null, bool $reshares = false) {
 		// Get all shares
diff --git a/apps/files_sharing/lib/Controller/ShareesAPIController.php b/apps/files_sharing/lib/Controller/ShareesAPIController.php
@@ -54,7 +54,7 @@
 
 class ShareesAPIController extends OCSController {
 
-	/** @var userId */
+	/** @var string */
 	protected $userId;
 
 	/** @var IConfig */
diff --git a/apps/files_sharing/lib/Helper.php b/apps/files_sharing/lib/Helper.php
@@ -63,7 +63,7 @@ public static function generateUniqueTarget($path, $excludeList, $view) {
 	/**
 	 * get default share folder
 	 *
-	 * @param \OC\Files\View
+	 * @param \OC\Files\View $view
 	 * @return string
 	 */
 	public static function getShareFolder($view = null) {
diff --git a/apps/files_sharing/lib/SharedMount.php b/apps/files_sharing/lib/SharedMount.php
@@ -215,7 +215,7 @@ public function moveMount($target) {
 	 */
 	public function removeMount() {
 		$mountManager = \OC\Files\Filesystem::getMountManager();
-		/** @var $storage \OCA\Files_Sharing\SharedStorage */
+		/** @var \OCA\Files_Sharing\SharedStorage $storage */
 		$storage = $this->getStorage();
 		$result = $storage->unshareStorage();
 		$mountManager->removeMount($this->mountPoint);
diff --git a/apps/files_sharing/templates/list.php b/apps/files_sharing/templates/list.php
@@ -1,4 +1,4 @@
-<?php /** @var $l \OCP\IL10N */ ?>
+<?php /** @var \OCP\IL10N $l */ ?>
 <div id='notification'></div>
 
 <div id="emptycontent" class="hidden"></div>
diff --git a/apps/files_sharing/templates/public.php b/apps/files_sharing/templates/public.php
@@ -1,6 +1,6 @@
 <?php
-/** @var $l \OCP\IL10N */
-/** @var $_ array */
+/** @var \OCP\IL10N $_ */
+/** @var array $_ */
 ?>
 <div id="app-content">
 <?php if ($_['previewSupported']): /* This enables preview images for links (e.g. on Facebook, Google+, ...)*/?>
diff --git a/lib/private/Server.php b/lib/private/Server.php
@@ -290,7 +290,7 @@ public function __construct($webRoot, \OC\Config $config) {
 			return new PreviewManager(
 				$c->getConfig(),
 				$c->getRootFolder(),
-				new \OC\Preview\Storage\Root($c->getRootFolder(), $c->getSystemConfig(), 'preview'),
+				new \OC\Preview\Storage\Root($c->getRootFolder(), $c->getSystemConfig()),
 				$c->getEventDispatcher(),
 				$c->getGeneratorHelper(),
 				$c->getSession()->get('user_id')
@@ -301,7 +301,7 @@ public function __construct($webRoot, \OC\Config $config) {
 
 		$this->registerService(\OC\Preview\Watcher::class, function (Server $c) {
 			return new \OC\Preview\Watcher(
-				new \OC\Preview\Storage\Root($c->getRootFolder(), $c->getSystemConfig(), 'preview')
+				new \OC\Preview\Storage\Root($c->getRootFolder(), $c->getSystemConfig())
 			);
 		});
 
@@ -519,15 +519,15 @@ public function __construct($webRoot, \OC\Config $config) {
 				$dispatcher->dispatchTyped(new BeforeUserCreatedEvent($uid, $password));
 			});
 			$userSession->listen('\OC\User', 'postCreateUser', function ($user, $password) {
-				/** @var $user \OC\User\User */
+				/** @var \OC\User\User $user */
 				\OC_Hook::emit('OC_User', 'post_createUser', ['uid' => $user->getUID(), 'password' => $password]);
 
 				/** @var IEventDispatcher $dispatcher */
 				$dispatcher = $this->query(IEventDispatcher::class);
 				$dispatcher->dispatchTyped(new UserCreatedEvent($user, $password));
 			});
 			$userSession->listen('\OC\User', 'preDelete', function ($user) use ($legacyDispatcher) {
-				/** @var $user \OC\User\User */
+				/** @var \OC\User\User $user */
 				\OC_Hook::emit('OC_User', 'pre_deleteUser', ['run' => true, 'uid' => $user->getUID()]);
 				$legacyDispatcher->dispatch('OCP\IUser::preDelete', new GenericEvent($user));
 
@@ -536,23 +536,23 @@ public function __construct($webRoot, \OC\Config $config) {
 				$dispatcher->dispatchTyped(new BeforeUserDeletedEvent($user));
 			});
 			$userSession->listen('\OC\User', 'postDelete', function ($user) {
-				/** @var $user \OC\User\User */
+				/** @var \OC\User\User $user */
 				\OC_Hook::emit('OC_User', 'post_deleteUser', ['uid' => $user->getUID()]);
 
 				/** @var IEventDispatcher $dispatcher */
 				$dispatcher = $this->query(IEventDispatcher::class);
 				$dispatcher->dispatchTyped(new UserDeletedEvent($user));
 			});
 			$userSession->listen('\OC\User', 'preSetPassword', function ($user, $password, $recoveryPassword) {
-				/** @var $user \OC\User\User */
+				/** @var \OC\User\User $user */
 				\OC_Hook::emit('OC_User', 'pre_setPassword', ['run' => true, 'uid' => $user->getUID(), 'password' => $password, 'recoveryPassword' => $recoveryPassword]);
 
 				/** @var IEventDispatcher $dispatcher */
 				$dispatcher = $this->query(IEventDispatcher::class);
 				$dispatcher->dispatchTyped(new BeforePasswordUpdatedEvent($user, $password, $recoveryPassword));
 			});
 			$userSession->listen('\OC\User', 'postSetPassword', function ($user, $password, $recoveryPassword) {
-				/** @var $user \OC\User\User */
+				/** @var \OC\User\User $user */
 				\OC_Hook::emit('OC_User', 'post_setPassword', ['run' => true, 'uid' => $user->getUID(), 'password' => $password, 'recoveryPassword' => $recoveryPassword]);
 
 				/** @var IEventDispatcher $dispatcher */
@@ -567,7 +567,7 @@ public function __construct($webRoot, \OC\Config $config) {
 				$dispatcher->dispatchTyped(new BeforeUserLoggedInEvent($uid, $password));
 			});
 			$userSession->listen('\OC\User', 'postLogin', function ($user, $password, $isTokenLogin) {
-				/** @var $user \OC\User\User */
+				/** @var \OC\User\User $user */
 				\OC_Hook::emit('OC_User', 'post_login', ['run' => true, 'uid' => $user->getUID(), 'password' => $password, 'isTokenLogin' => $isTokenLogin]);
 
 				/** @var IEventDispatcher $dispatcher */
@@ -600,7 +600,7 @@ public function __construct($webRoot, \OC\Config $config) {
 				$dispatcher->dispatchTyped(new UserLoggedOutEvent($user));
 			});
 			$userSession->listen('\OC\User', 'changeUser', function ($user, $feature, $value, $oldValue) {
-				/** @var $user \OC\User\User */
+				/** @var \OC\User\User $user */
 				\OC_Hook::emit('OC_User', 'changeUser', ['run' => true, 'user' => $user, 'feature' => $feature, 'value' => $value, 'old_value' => $oldValue]);
 
 				/** @var IEventDispatcher $dispatcher */

Original file line number	Diff line number	Diff line change
`@@ -325,7 +325,7 @@ public function propFindDefaultCalendarUrl(PropFind $propFind, INode $node) {`
`325`	`325`	`* Returns a list of addresses that are associated with a principal.`
`326`	`326`	`*`
`327`	`327`	`* @param string $principal`
`328`		`- * @return string?`
	`328`	`+ * @return string\|null`
`329`	`329`	`*/`
`330`	`330`	`protected function getCalendarUserTypeForPrincipal($principal):?string {`
`331`	`331`	`$calendarUserType = '{' . self::NS_CALDAV . '}calendar-user-type';`
Original file line number	Diff line number	Diff line change
`@@ -332,7 +332,7 @@ public function toggleShowFolder(int $show, string $key) {`
`332`	`332`	`*`
`333`	`333`	`* @NoAdminRequired`
`334`	`334`	`*`
`335`		`- * @param string`
	`335`	`+ * @param string $folderpath`
`336`	`336`	`* @return string`
`337`	`337`	`* @throws \OCP\Files\NotFoundException`
`338`	`338`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<?php /** @var $l \OCP\IL10N */ ?>`
	`1`	`+<?php /** @var \OCP\IL10N $l */ ?>`
`2`	`2`	`<?php $_['appNavigation']->printPage(); ?>`
`3`	`3`	`<div id="app-content">`
`4`	`4`