From 6f8147b18fadd749b6060ab540292c9ac6f85d61 Mon Sep 17 00:00:00 2001
From: Daniel Kesselberg <mail@danielkesselberg.de>
Date: Fri, 14 Aug 2020 15:10:48 +0200
Subject: [PATCH] Fix some MissingDocblockType or InvalidDocblock warnings.
Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
---
apps/accessibility/lib/Controller/ConfigController.php | 5 +++--
apps/dav/lib/CalDAV/Schedule/Plugin.php | 2 +-
apps/dav/lib/CardDAV/AddressBookImpl.php | 1 -
apps/dav/lib/CardDAV/PhotoCache.php | 1 +
apps/dav/lib/Connector/Sabre/FilesPlugin.php | 2 --
apps/encryption/lib/HookManager.php | 3 +--
apps/files/lib/Controller/ApiController.php | 2 +-
apps/files/templates/index.php | 2 +-
apps/files/templates/recentlist.php | 2 +-
apps/files_external/lib/Command/ListCommand.php | 6 ++----
apps/files_external/lib/Service/UserTrait.php | 2 +-
apps/files_external/templates/list.php | 2 +-
apps/files_sharing/lib/Controller/ShareAPIController.php | 4 ++--
apps/files_sharing/lib/Controller/ShareesAPIController.php | 2 +-
apps/files_sharing/lib/Helper.php | 2 +-
apps/files_sharing/lib/SharedMount.php | 2 +-
apps/files_sharing/templates/list.php | 2 +-
apps/files_sharing/templates/public.php | 4 ++--
18 files changed, 21 insertions(+), 25 deletions(-)
diff --git a/apps/accessibility/lib/Controller/ConfigController.php b/apps/accessibility/lib/Controller/ConfigController.php
index 65173ccacea..d2eb9fc707d 100644
--- a/apps/accessibility/lib/Controller/ConfigController.php
+++ b/apps/accessibility/lib/Controller/ConfigController.php
@@ -37,6 +37,7 @@ use OCP\AppFramework\OCSController;
use OCP\IConfig;
use OCP\IRequest;
use OCP\IUserSession;
+use OCP\PreConditionNotMetException;
class ConfigController extends OCSController {
@@ -103,7 +104,7 @@ class ConfigController extends OCSController {
*
* @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 @@ class ConfigController extends OCSController {
*
* @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
index c2e46f92cfd..fd2a2ca6d28 100644
--- a/apps/dav/lib/CalDAV/Schedule/Plugin.php
+++ b/apps/dav/lib/CalDAV/Schedule/Plugin.php
@@ -325,7 +325,7 @@ EOF;
* 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
index 02dc7c5d015..1c35e2c400c 100644
--- a/apps/dav/lib/CardDAV/AddressBookImpl.php
+++ b/apps/dav/lib/CardDAV/AddressBookImpl.php
@@ -82,7 +82,6 @@ class AddressBookImpl implements IAddressBook {
/**
* @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
index e28a5ca2f08..ca3853c76e6 100644
--- a/apps/dav/lib/CardDAV/PhotoCache.php
+++ b/apps/dav/lib/CardDAV/PhotoCache.php
@@ -36,6 +36,7 @@ use OCP\Files\SimpleFS\ISimpleFile;
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
index 076e5b6483b..c831ab86dc7 100644
--- a/apps/dav/lib/Connector/Sabre/FilesPlugin.php
+++ b/apps/dav/lib/Connector/Sabre/FilesPlugin.php
@@ -276,7 +276,6 @@ class FilesPlugin extends ServerPlugin {
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 @@ class FilesPlugin extends ServerPlugin {
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
index 324c0d718da..640111397ff 100644
--- a/apps/encryption/lib/HookManager.php
+++ b/apps/encryption/lib/HookManager.php
@@ -26,6 +26,7 @@ namespace OCA\Encryption;
use OCA\Encryption\Hooks\Contracts\IHook;
class HookManager {
+ /** @var IHook[] */
private $hookInstances = [];
/**
@@ -51,8 +52,6 @@ class HookManager {
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
index 2add685133e..16596ea05a6 100644
--- a/apps/files/lib/Controller/ApiController.php
+++ b/apps/files/lib/Controller/ApiController.php
@@ -332,7 +332,7 @@ class ApiController extends Controller {
*
* @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
index 2bac8410f91..3ba0474daaf 100644
--- 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
index 360b5c95ee4..95997288193 100644
--- 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
index 279e581f95e..42c4cddb171 100644
--- a/apps/files_external/lib/Command/ListCommand.php
+++ b/apps/files_external/lib/Command/ListCommand.php
@@ -97,15 +97,13 @@ class ListCommand extends Base {
}
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 @@ class ListCommand extends Base {
}
/**
- * @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
index 192bb6e02bd..aa00bf623c1 100644
--- a/apps/files_external/lib/Service/UserTrait.php
+++ b/apps/files_external/lib/Service/UserTrait.php
@@ -55,7 +55,7 @@ trait UserTrait {
* 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
index e1b666c14c1..1d4f6993168 100644
--- 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
index 78b2eb1bc53..c629860df23 100644
--- a/apps/files_sharing/lib/Controller/ShareAPIController.php
+++ b/apps/files_sharing/lib/Controller/ShareAPIController.php
@@ -1466,7 +1466,7 @@ class ShareAPIController extends OCSController {
/**
* Cleanup the remaining locks
- * @throws @LockedException
+ * @throws LockedException
*/
public function cleanup() {
if ($this->lockedNode !== null) {
@@ -1642,7 +1642,7 @@ class ShareAPIController extends OCSController {
*
* @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
index b523dd3d37d..3ed777a8f71 100644
--- a/apps/files_sharing/lib/Controller/ShareesAPIController.php
+++ b/apps/files_sharing/lib/Controller/ShareesAPIController.php
@@ -54,7 +54,7 @@ use function usort;
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
index d3c6deeec2e..2f1f6da79ca 100644
--- a/apps/files_sharing/lib/Helper.php
+++ b/apps/files_sharing/lib/Helper.php
@@ -63,7 +63,7 @@ class Helper {
/**
* 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
index 487011584c7..02e656a4fd5 100644
--- a/apps/files_sharing/lib/SharedMount.php
+++ b/apps/files_sharing/lib/SharedMount.php
@@ -215,7 +215,7 @@ class SharedMount extends MountPoint implements MoveableMount {
*/
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
index 03c097725a1..4b216de8e70 100644
--- 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
index 751303e8109..bdd3e8399ea 100644
--- 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+, ...)*/?>
--
GitLab