Add see-links to route files

Signed-off-by: Joas Schilling <coding@schilljs.com>

12 files changed, 37 insertions, 0 deletions

diff --git a/appinfo/routes/routesCallController.php b/appinfo/routes/routesCallController.php
index 14ea3b13b..9ea9f6018 100644
--- a/appinfo/routes/routesCallController.php
+++ b/appinfo/routes/routesCallController.php
@@ -30,9 +30,13 @@ $requirements = [
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\CallController::getPeersForCall() */
 		['name' => 'Call#getPeersForCall', 'url' => '/api/{apiVersion}/call/{token}', 'verb' => 'GET', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\CallController::joinCall() */
 		['name' => 'Call#joinCall', 'url' => '/api/{apiVersion}/call/{token}', 'verb' => 'POST', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\CallController::updateCallFlags() */
 		['name' => 'Call#updateCallFlags', 'url' => '/api/{apiVersion}/call/{token}', 'verb' => 'PUT', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\CallController::leaveCall() */
 		['name' => 'Call#leaveCall', 'url' => '/api/{apiVersion}/call/{token}', 'verb' => 'DELETE', 'requirements' => $requirements],
 	],
 ];
diff --git a/appinfo/routes/routesChatController.php b/appinfo/routes/routesChatController.php
index 337f478d6..9b70c25b0 100644
--- a/appinfo/routes/routesChatController.php
+++ b/appinfo/routes/routesChatController.php
@@ -36,13 +36,21 @@ $requirementsWithMessageId = [
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\ChatController::receiveMessages() */
 		['name' => 'Chat#receiveMessages', 'url' => '/api/{apiVersion}/chat/{token}', 'verb' => 'GET', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\ChatController::sendMessage() */
 		['name' => 'Chat#sendMessage', 'url' => '/api/{apiVersion}/chat/{token}', 'verb' => 'POST', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\ChatController::clearHistory() */
 		['name' => 'Chat#clearHistory', 'url' => '/api/{apiVersion}/chat/{token}', 'verb' => 'DELETE', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\ChatController::deleteMessage() */
 		['name' => 'Chat#deleteMessage', 'url' => '/api/{apiVersion}/chat/{token}/{messageId}', 'verb' => 'DELETE', 'requirements' => $requirementsWithMessageId],
+		/** @see \OCA\Talk\Controller\ChatController::setReadMarker() */
 		['name' => 'Chat#setReadMarker', 'url' => '/api/{apiVersion}/chat/{token}/read', 'verb' => 'POST', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\ChatController::markUnread() */
 		['name' => 'Chat#markUnread', 'url' => '/api/{apiVersion}/chat/{token}/read', 'verb' => 'DELETE', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\ChatController::mentions() */
 		['name' => 'Chat#mentions', 'url' => '/api/{apiVersion}/chat/{token}/mentions', 'verb' => 'GET', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\ChatController::shareObjectToChat() */
 		['name' => 'Chat#shareObjectToChat', 'url' => '/api/{apiVersion}/chat/{token}/share', 'verb' => 'POST', 'requirements' => $requirements],
 	],
 ];
diff --git a/appinfo/routes/routesCommandController.php b/appinfo/routes/routesCommandController.php
index a2e59a922..81e15df9b 100644
--- a/appinfo/routes/routesCommandController.php
+++ b/appinfo/routes/routesCommandController.php
@@ -25,6 +25,7 @@ declare(strict_types=1);
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\CommandController::index() */
 		['name' => 'Command#index', 'url' => '/api/{apiVersion}/command', 'verb' => 'GET', 'requirements' => [
 			'apiVersion' => 'v1',
 		]],
diff --git a/appinfo/routes/routesFederationController.php b/appinfo/routes/routesFederationController.php
index 6991e78fc..bfac9871d 100644
--- a/appinfo/routes/routesFederationController.php
+++ b/appinfo/routes/routesFederationController.php
@@ -29,8 +29,11 @@ $requirements = [
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\FederationController::acceptShare() */
 		['name' => 'Federation#acceptShare', 'url' => 'api/{apiVersion}/federation/invitation/{id}', 'verb' => 'POST', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\FederationController::rejectShare() */
 		['name' => 'Federation#rejectShare', 'url' => 'api/{apiVersion}/federation/invitation/{id}', 'verb' => 'DELETE', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\FederationController::getShares() */
 		['name' => 'Federation#getShares', 'url' => 'api/{apiVersion}/federation/invitation', 'verb' => 'GET', 'requirements' => $requirements],
 	],
 ];
diff --git a/appinfo/routes/routesFilesIntegrationController.php b/appinfo/routes/routesFilesIntegrationController.php
index 8e17c43c2..1c082aec4 100644
--- a/appinfo/routes/routesFilesIntegrationController.php
+++ b/appinfo/routes/routesFilesIntegrationController.php
@@ -25,10 +25,12 @@ declare(strict_types=1);
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\FilesIntegrationController::getRoomByFileId() */
 		['name' => 'FilesIntegration#getRoomByFileId', 'url' => '/api/{apiVersion}/file/{fileId}', 'verb' => 'GET', 'requirements' => [
 			'apiVersion' => 'v1',
 			'fileId' => '.+'
 		]],
+		/** @see \OCA\Talk\Controller\FilesIntegrationController::getRoomByShareToken() */
 		['name' => 'FilesIntegration#getRoomByShareToken', 'url' => '/api/{apiVersion}/publicshare/{shareToken}', 'verb' => 'GET', 'requirements' => [
 			'apiVersion' => 'v1',
 			'shareToken' => '.+',
diff --git a/appinfo/routes/routesGuestController.php b/appinfo/routes/routesGuestController.php
index bcd92dd46..76c7fe7b1 100644
--- a/appinfo/routes/routesGuestController.php
+++ b/appinfo/routes/routesGuestController.php
@@ -25,6 +25,7 @@ declare(strict_types=1);
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\GuestController::setDisplayName() */
 		['name' => 'Guest#setDisplayName', 'url' => '/api/{apiVersion}/guest/{token}/name', 'verb' => 'POST', 'requirements' => [
 			'apiVersion' => 'v1',
 			'token' => '^[a-z0-9]{4,30}$',
diff --git a/appinfo/routes/routesHostedSignalingServerController.php b/appinfo/routes/routesHostedSignalingServerController.php
index 628d60368..bdf30c084 100644
--- a/appinfo/routes/routesHostedSignalingServerController.php
+++ b/appinfo/routes/routesHostedSignalingServerController.php
@@ -29,8 +29,11 @@ $requirements = [
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\HostedSignalingServerController::requestTrial() */
 		['name' => 'HostedSignalingServer#requestTrial', 'url' => '/api/{apiVersion}/hostedsignalingserver/requesttrial', 'verb' => 'POST', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\HostedSignalingServerController::auth() */
 		['name' => 'HostedSignalingServer#auth', 'url' => '/api/{apiVersion}/hostedsignalingserver/auth', 'verb' => 'POST', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\HostedSignalingServerController::deleteAccount() */
 		['name' => 'HostedSignalingServer#deleteAccount', 'url' => '/api/{apiVersion}/hostedsignalingserver/delete', 'verb' => 'DELETE', 'requirements' => $requirements],
 	],
 ];
diff --git a/appinfo/routes/routesMatterbridgeController.php b/appinfo/routes/routesMatterbridgeController.php
index 08d3cec2e..f400ea0db 100644
--- a/appinfo/routes/routesMatterbridgeController.php
+++ b/appinfo/routes/routesMatterbridgeController.php
@@ -30,9 +30,13 @@ $requirements = [
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\MatterbridgeController::getBridgeOfRoom() */
 		['name' => 'Matterbridge#getBridgeOfRoom', 'url' => '/api/{apiVersion}/bridge/{token}', 'verb' => 'GET', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\MatterbridgeController::getBridgeProcessState() */
 		['name' => 'Matterbridge#getBridgeProcessState', 'url' => '/api/{apiVersion}/bridge/{token}/process', 'verb' => 'GET', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\MatterbridgeController::editBridgeOfRoom() */
 		['name' => 'Matterbridge#editBridgeOfRoom', 'url' => '/api/{apiVersion}/bridge/{token}', 'verb' => 'PUT', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\MatterbridgeController::deleteBridgeOfRoom() */
 		['name' => 'Matterbridge#deleteBridgeOfRoom', 'url' => '/api/{apiVersion}/bridge/{token}', 'verb' => 'DELETE', 'requirements' => $requirements],
 	],
 ];
diff --git a/appinfo/routes/routesMatterbridgeSettingsController.php b/appinfo/routes/routesMatterbridgeSettingsController.php
index 69bfd8afe..cfd0a4839 100644
--- a/appinfo/routes/routesMatterbridgeSettingsController.php
+++ b/appinfo/routes/routesMatterbridgeSettingsController.php
@@ -29,7 +29,9 @@ $requirements = [
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\MatterbridgeSettingsController::stopAllBridges() */
 		['name' => 'MatterbridgeSettings#stopAllBridges', 'url' => '/api/{apiVersion}/bridge', 'verb' => 'DELETE', 'requirements' => $requirements],
+		/** @see \OCA\Talk\Controller\MatterbridgeSettingsController::getMatterbridgeVersion() */
 		['name' => 'MatterbridgeSettings#getMatterbridgeVersion', 'url' => '/api/{apiVersion}/bridge/version', 'verb' => 'GET', 'requirements' => $requirements],
 	],
 ];
diff --git a/appinfo/routes/routesPageController.php b/appinfo/routes/routesPageController.php
index 4ba719803..0a97cb12a 100644
--- a/appinfo/routes/routesPageController.php
+++ b/appinfo/routes/routesPageController.php
@@ -25,10 +25,15 @@ declare(strict_types=1);
 
 return [
 	'routes' => [
+		/** @see \OCA\Talk\Controller\PageController::index() */
 		['name' => 'Page#index', 'url' => '/', 'verb' => 'GET'],
+		/** @see \OCA\Talk\Controller\PageController::notFound() */
 		['name' => 'Page#notFound', 'url' => '/not-found', 'verb' => 'GET'],
+		/** @see \OCA\Talk\Controller\PageController::duplicateSession() */
 		['name' => 'Page#duplicateSession', 'url' => '/duplicate-session', 'verb' => 'GET'],
+		/** @see \OCA\Talk\Controller\PageController::showCall() */
 		['name' => 'Page#showCall', 'url' => '/call/{token}', 'root' => '', 'verb' => 'GET'],
+		/** @see \OCA\Talk\Controller\PageController::authenticatePassword() */
 		['name' => 'Page#authenticatePassword', 'url' => '/call/{token}', 'root' => '', 'verb' => 'POST'],
 	],
 ];
diff --git a/appinfo/routes/routesPublicShareAuthController.php b/appinfo/routes/routesPublicShareAuthController.php
index b177e0de8..158a9ef2f 100644
--- a/appinfo/routes/routesPublicShareAuthController.php
+++ b/appinfo/routes/routesPublicShareAuthController.php
@@ -25,6 +25,7 @@ declare(strict_types=1);
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\PublicShareAuthController::createRoom() */
 		['name' => 'PublicShareAuth#createRoom', 'url' => '/api/{apiVersion}/publicshareauth', 'verb' => 'POST', 'requirements' => ['apiVersion' => 'v1'],],
 	],
 ];
diff --git a/appinfo/routes/routesReactionController.php b/appinfo/routes/routesReactionController.php
index 375478e3f..508de618e 100644
--- a/appinfo/routes/routesReactionController.php
+++ b/appinfo/routes/routesReactionController.php
@@ -25,14 +25,17 @@ declare(strict_types=1);
 
 return [
 	'ocs' => [
+		/** @see \OCA\Talk\Controller\ReactionController::react() */
 		['name' => 'Reaction#react', 'url' => '/api/{apiVersion}/reaction/{token}/{messageId}', 'verb' => 'POST', 'requirements' => [
 			'apiVersion' => 'v1',
 			'token' => '^[a-z0-9]{4,30}$',
 		]],
+		/** @see \OCA\Talk\Controller\ReactionController::delete() */
 		['name' => 'Reaction#delete', 'url' => '/api/{apiVersion}/reaction/{token}/{messageId}', 'verb' => 'DELETE', 'requirements' => [
 			'apiVersion' => 'v1',
 			'token' => '^[a-z0-9]{4,30}$',
 		]],
+		/** @see \OCA\Talk\Controller\ReactionController::getReactions() */
 		['name' => 'Reaction#getReactions', 'url' => '/api/{apiVersion}/reaction/{token}/{messageId}', 'verb' => 'GET', 'requirements' => [
 			'apiVersion' => 'v1',
 			'token' => '^[a-z0-9]{4,30}$',