Cleanup useless comments (#176)

Yolo PR, just performed a cleanup type comments that are already
specified in code

Author: bigcat88

lib/Controller/ConfigController.php

@@ -25,9 +25,6 @@ public function __construct(
 	 * @NoCSRFRequired
 	 *
 	 * Set Admin config values
-	 *
-	 * @param array $values
-	 * @return DataResponse
 	 */
 	public function setAdminConfig(array $values): DataResponse {
 		foreach ($values as $key => $value) {

lib/Controller/ExAppsPageController.php

@@ -93,8 +93,6 @@ public function __construct(
 
 	/**
 	 * @NoCSRFRequired
-	 *
-	 * @return TemplateResponse
 	 */
 	#[NoCSRFRequired]
 	public function viewApps(): TemplateResponse {
@@ -141,9 +139,6 @@ private function getExAppsWithUpdates(): array {
 	 * Using the same algorithm of ExApps listing as for regular apps.
 	 * Returns all apps for a category from the App Store
 	 *
-	 * @param string $requestedCategory
-	 * @return array
-	 *
 	 * @throws Exception
 	 */
 	private function getAppsForCategory(string $requestedCategory = ''): array {
@@ -272,8 +267,6 @@ private function getAppsForCategory(string $requestedCategory = ''): array {
 
 	/**
 	 * @NoCSRFRequired
-	 *
-	 * @return JSONResponse
 	 */
 	public function listApps(): JSONResponse {
 		$apps = $this->getAppsForCategory('');
@@ -431,9 +424,6 @@ public function enableApp(string $appId, array $groups = []): JSONResponse {
 	 * Deploy ExApp if it was not deployed yet.
 	 *
 	 * @PasswordConfirmationRequired
-	 * @param array $appIds
-	 * @param array $groups
-	 * @return JSONResponse
 	 */
 	public function enableApps(array $appIds, array $groups = []): JSONResponse {
 		try {
@@ -584,10 +574,6 @@ private function registerApiScopes(ExApp $exApp, array $requestedExAppScopeGroup
 
 	/**
 	 * @PasswordConfirmationRequired
-	 *
-	 * @param string $appId
-	 *
-	 * @return JSONResponse
 	 */
 	#[PasswordConfirmationRequired]
 	public function disableApp(string $appId): JSONResponse {
@@ -596,10 +582,6 @@ public function disableApp(string $appId): JSONResponse {
 
 	/**
 	 * @PasswordConfirmationRequired
-	 *
-	 * @param array $appIds
-	 *
-	 * @return JSONResponse
 	 */
 	#[PasswordConfirmationRequired]
 	public function disableApps(array $appIds): JSONResponse {
@@ -705,12 +687,6 @@ public function enableExApp(string $appId): JSONResponse {
 		]);
 	}
 
-	/**
-	 * @param ExApp $exApp
-	 * @param SimpleXMLElement $infoXml
-	 *
-	 * @return void
-	 */
 	private function upgradeExAppScopes(ExApp $exApp, SimpleXMLElement $infoXml): void {
 		$newExAppScopes = $this->service->getExAppRequestedScopes($exApp, $infoXml);
 
@@ -751,9 +727,6 @@ public function uninstallApp(string $appId, bool $removeContainer = true, bool $
 	 * Using default force mechanism for ExApps
 	 *
 	 * @PasswordConfirmationRequired
-	 *
-	 * @param string $appId
-	 * @return JSONResponse
 	 */
 	#[PasswordConfirmationRequired]
 	public function force(string $appId): JSONResponse {
@@ -764,17 +737,13 @@ public function force(string $appId): JSONResponse {
 
 	/**
 	 * Get all available categories
-	 *
-	 * @return JSONResponse
 	 */
 	public function listCategories(): JSONResponse {
 		return new JSONResponse($this->getAllCategories());
 	}
 
 	/**
 	 * Get ExApp status, that includes initialization information
-	 *
-	 * @return JSONResponse
 	 */
 	public function getAppStatus(string $appId): JSONResponse {
 		$exApp = $this->service->getExApp($appId);

lib/Controller/NotificationsController.php

@@ -32,10 +32,6 @@ public function __construct(
 	/**
 	 * @NoCSRFRequired
 	 * @PublicPage
-	 *
-	 * @param array $params
-	 *
-	 * @return Response
 	 */
 	#[AppAPIAuth]
 	#[PublicPage]

lib/Controller/OCSApiController.php

@@ -37,11 +37,7 @@ public function __construct(
 	 * @NoAdminRequired
 	 * @NoCSRFRequired
 	 *
-	 * @param int $level
-	 * @param string $message
-	 *
 	 * @throws OCSBadRequestException
-	 * @return DataResponse
 	 */
 	#[AppAPIAuth]
 	#[PublicPage]
@@ -74,7 +70,6 @@ public function log(int $level, string $message): DataResponse {
 	 * @PublicPage
 	 * @NoCSRFRequired
 	 *
-	 * @return DataResponse
 	 */
 	#[AppAPIAuth]
 	#[PublicPage]
@@ -89,7 +84,6 @@ public function getNCUsersList(): DataResponse {
 	 *
 	 * Get ExApp status, that required during initialization step with progress information
 	 *
-	 * @return DataResponse
 	 */
 	#[AppAPIAuth]
 	#[PublicPage]

lib/Controller/OCSExAppController.php

@@ -27,10 +27,7 @@ public function __construct(
 	/**
 	 * @NoCSRFRequired
 	 *
-	 * @param string $list
-	 *
 	 * @throws OCSBadRequestException
-	 * @return DataResponse
 	 */
 	#[NoCSRFRequired]
 	public function getExAppsList(string $list = 'enabled'): DataResponse {
@@ -43,12 +40,8 @@ public function getExAppsList(string $list = 'enabled'): DataResponse {
 	/**
 	 * @NoCSRFRequired
 	 *
-	 * @param string $appId
-	 * @param int $enabled
-	 *
 	 * @throws OCSNotFoundException
 	 * @throws OCSBadRequestException
-	 * @return DataResponse
 	 */
 	#[NoCSRFRequired]
 	public function setExAppEnabled(string $appId, int $enabled): DataResponse {

lib/Controller/OCSUiController.php

@@ -40,14 +40,6 @@ public function __construct(
 	 * @PublicPage
 	 * @NoCSRFRequired
 	 *
-	 * @param string $name
-	 * @param string $displayName
-	 * @param string $actionHandler
-	 * @param string $icon
-	 * @param string $mime
-	 * @param int $permissions
-	 * @param int $order
-	 * @return DataResponse
 	 * @throws OCSBadRequestException
 	 */
 	#[AppAPIAuth]
@@ -68,10 +60,7 @@ public function registerFileActionMenu(string $name, string $displayName, string
 	 * @PublicPage
 	 * @NoCSRFRequired
 	 *
-	 * @param string $name
-	 *
 	 * @throws OCSNotFoundException
-	 * @return DataResponse
 	 */
 	#[AppAPIAuth]
 	#[PublicPage]

lib/Controller/TalkBotController.php

@@ -58,10 +58,7 @@ public function registerExAppTalkBot(string $name, string $route, string $descri
 	 * @NoCSRFRequired
 	 * @PublicPage
 	 *
-	 * @param string $route
-	 *
 	 * @throws OCSNotFoundException
-	 * @return Response
 	 */
 	#[AppAPIAuth]
 	#[NoCSRFRequired]

lib/Controller/TopMenuController.php

@@ -42,9 +42,7 @@ public function __construct(
 	/**
 	 * @NoCSRFRequired
 	 * @NoAdminRequired
-	 * @param string $appId
-	 * @param string $name
-	 * @return TemplateResponse
+	 *
 	 * @throws Exception
 	 */
 	#[NoAdminRequired]

lib/DeployActions/AIODockerActions.php

@@ -25,17 +25,13 @@ public function __construct(
 
 	/**
 	 * Detecting AIO instance by config setting or AIO_TOKEN env as fallback
-	 *
-	 * @return bool
 	 */
 	public function isAIO(): bool {
 		return filter_var(getenv('THIS_IS_AIO'), FILTER_VALIDATE_BOOL);
 	}
 
 	/**
 	 * Registers DaemonConfig with default params to use AIO Docker Socket Proxy
-	 *
-	 * @return DaemonConfig|null
 	 */
 	public function registerAIODaemonConfig(): ?DaemonConfig {
 		$defaultDaemonConfig = $this->config->getAppValue(Application::APP_ID, 'default_daemon_config');
@@ -79,8 +75,6 @@ public function registerAIODaemonConfig(): ?DaemonConfig {
 
 	/**
 	 * Registers DaemonConfig with default params to use AIO Docker Socket Proxy with GPU
-	 *
-	 * @return DaemonConfig|null
 	 */
 	private function registerAIODaemonConfigWithGPU(): ?DaemonConfig {
 		$daemonConfigWithGPU = $this->daemonConfigService->getDaemonConfigByName(self::AIO_DAEMON_CONFIG_NAME_GPU);
@@ -114,8 +108,6 @@ private function registerAIODaemonConfigWithGPU(): ?DaemonConfig {
 	/**
 	 * Check if /dev/dri folder mounted to the container.
 	 * In AIO this means that NEXTCLOUD_ENABLE_DRI_DEVICE=true
-	 *
-	 * @return bool
 	 */
 	private function isGPUsEnabled(): bool {
 		$devDri = '/dev/dri';

lib/DeployActions/DockerActions.php

@@ -56,11 +56,6 @@ public function getAcceptsDeployId(): string {
 
 	/**
 	 * Pull image, create and start container
-	 *
-	 * @param DaemonConfig $daemonConfig
-	 * @param array $params
-	 *
-	 * @return array
 	 */
 	public function deployExApp(DaemonConfig $daemonConfig, array $params = []): array {
 		if ($daemonConfig->getAcceptsDeployId() !== 'docker-install') {
@@ -432,13 +427,6 @@ public function buildDeployEnvs(array $params, array $envOptions, array $deployC
 		return $autoEnvs;
 	}
 
-	/**
-	 * @param string $appId
-	 * @param DaemonConfig $daemonConfig
-	 * @param array $params
-	 *
-	 * @return array
-	 */
 	public function loadExAppInfo(string $appId, DaemonConfig $daemonConfig, array $params = []): array {
 		$this->initGuzzleClient($daemonConfig);
 		$containerInfo = $this->inspectContainer($this->buildDockerUrl($daemonConfig), $this->buildExAppContainerName($appId));
@@ -521,12 +509,6 @@ public function initGuzzleClient(DaemonConfig $daemonConfig): void {
 		$this->guzzleClient = new Client($guzzleParams);
 	}
 
-	/**
-	 * @param array $guzzleParams
-	 * @param array $deployConfig
-	 *
-	 * @return array
-	 */
 	private function setupCerts(array $guzzleParams, array $deployConfig): array {
 		if (!$this->config->getSystemValueBool('installed', false)) {
 			$certs = \OC::$SERVERROOT . '/resources/config/ca-bundle.crt';
@@ -557,9 +539,6 @@ private function buildDevicesParams(array $devices): array {
 	/**
 	 * Build default volume for ExApp.
 	 * For now only one volume created per ExApp.
-	 *
-	 * @param string $appId
-	 * @return array
 	 */
 	private function buildDefaultExAppVolume(string $appId): array {
 		return [
@@ -572,13 +551,6 @@ private function buildDefaultExAppVolume(string $appId): array {
 		];
 	}
 
-	/**
-	 * Build ExApp container name (prefix + appid)
-	 *
-	 * @param string $appId
-	 *
-	 * @return string
-	 */
 	public function buildExAppContainerName(string $appId): string {
 		return self::EX_APP_CONTAINER_PREFIX . $appId;
 	}
@@ -640,10 +612,8 @@ private function isGPUAvailable(): bool {
 	 * Return default GPU device requests for container.
 	 * For now only NVIDIA GPUs supported.
 	 * TODO: Add support for other GPU vendors
-	 *
-	 * @return array[]
 	 */
-	private function buildDefaultGPUDeviceRequests() {
+	private function buildDefaultGPUDeviceRequests(): array {
 		return [
 			[
 				'Driver' => 'nvidia', // Currently only NVIDIA GPU vendor