Improve docblock annotations for tokens and their exceptions

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

diff --git a/lib/private/Authentication/Exceptions/ExpiredTokenException.php b/lib/private/Authentication/Exceptions/ExpiredTokenException.php
index 18618a557f3c26a2eb09fc3f6dbb7dbf58a4daec..15069313712e2ccb96e7bca8bb23a8a354b907d3 100644 (file)
--- a/lib/private/Authentication/Exceptions/ExpiredTokenException.php
+++ b/lib/private/Authentication/Exceptions/ExpiredTokenException.php
@@ -28,7 +28,7 @@ namespace OC\Authentication\Exceptions;
 use OC\Authentication\Token\IToken;
 
 /**
- * @deprecated 28.0.0 use OCP version instead
+ * @deprecated 28.0.0 use {@see \OCP\Authentication\Exceptions\ExpiredTokenException} instead
  */
 class ExpiredTokenException extends \OCP\Authentication\Exceptions\ExpiredTokenException {
        public function __construct(

diff --git a/lib/private/Authentication/Exceptions/WipeTokenException.php b/lib/private/Authentication/Exceptions/WipeTokenException.php
index 9b24ca244302125a82a9ce133690f5a2ceb04547..25b7cb74359c23c11d959743099b902371eecac9 100644 (file)
--- a/lib/private/Authentication/Exceptions/WipeTokenException.php
+++ b/lib/private/Authentication/Exceptions/WipeTokenException.php
@@ -28,7 +28,7 @@ namespace OC\Authentication\Exceptions;
 use OC\Authentication\Token\IToken;
 
 /**
- * @deprecated 28.0.0 use OCP version instead
+ * @deprecated 28.0.0 use {@see \OCP\Authentication\Exceptions\WipeTokenException} instead
  */
 class WipeTokenException extends \OCP\Authentication\Exceptions\WipeTokenException {
        public function __construct(

diff --git a/lib/private/Authentication/Token/IToken.php b/lib/private/Authentication/Token/IToken.php
index e8c3b638b9f367b1c94f8370a0a09b3f4339522c..eb172f33396027ff60e1a957d51203e06e6089c8 100644 (file)
--- a/lib/private/Authentication/Token/IToken.php
+++ b/lib/private/Authentication/Token/IToken.php
@@ -28,5 +28,8 @@ namespace OC\Authentication\Token;
 
 use OCP\Authentication\Token\IToken as OCPIToken;
 
+/**
+ * @deprecated 28.0.0 use {@see \OCP\Authentication\Token\IToken} instead
+ */
 interface IToken extends OCPIToken {
 }

diff --git a/lib/public/Authentication/Exceptions/ExpiredTokenException.php b/lib/public/Authentication/Exceptions/ExpiredTokenException.php
index 58f2f22d5c7236b8dd1c99f2b828c4adce276799..5c1f4a30541ca0697ec9b30dcb2b179d63d3d2bb 100644 (file)
--- a/lib/public/Authentication/Exceptions/ExpiredTokenException.php
+++ b/lib/public/Authentication/Exceptions/ExpiredTokenException.php
@@ -28,11 +28,11 @@ namespace OCP\Authentication\Exceptions;
 use OCP\Authentication\Token\IToken;
 
 /**
- * @since 28.0
+ * @since 28.0.0
  */
 class ExpiredTokenException extends InvalidTokenException {
        /**
-        * @since 28.0
+        * @since 28.0.0
         */
        public function __construct(
                private IToken $token,
@@ -41,7 +41,7 @@ class ExpiredTokenException extends InvalidTokenException {
        }
 
        /**
-        * @since 28.0
+        * @since 28.0.0
         */
        public function getToken(): IToken {
                return $this->token;

diff --git a/lib/public/Authentication/Exceptions/InvalidTokenException.php b/lib/public/Authentication/Exceptions/InvalidTokenException.php
index 7d55694d3ea8cbd4a2c78f3df49cb21fdf1b192e..4869cbd64659f1094fb5c0cafeff99074a75f9e5 100644 (file)
--- a/lib/public/Authentication/Exceptions/InvalidTokenException.php
+++ b/lib/public/Authentication/Exceptions/InvalidTokenException.php
@@ -27,7 +27,7 @@ namespace OCP\Authentication\Exceptions;
 use Exception;
 
 /**
- * @since 28.0
+ * @since 28.0.0
  */
 class InvalidTokenException extends Exception {
 }

diff --git a/lib/public/Authentication/Exceptions/WipeTokenException.php b/lib/public/Authentication/Exceptions/WipeTokenException.php
index 9e80432ef522daaf6dbff7c97315ec181b64ae14..81ea2dc57ad7de604f2f1b9d25a3450afb5935d7 100644 (file)
--- a/lib/public/Authentication/Exceptions/WipeTokenException.php
+++ b/lib/public/Authentication/Exceptions/WipeTokenException.php
@@ -28,11 +28,11 @@ namespace OCP\Authentication\Exceptions;
 use OCP\Authentication\Token\IToken;
 
 /**
- * @since 28.0
+ * @since 28.0.0
  */
 class WipeTokenException extends InvalidTokenException {
        /**
-        * @since 28.0
+        * @since 28.0.0
         */
        public function __construct(
                private IToken $token,
@@ -41,7 +41,7 @@ class WipeTokenException extends InvalidTokenException {
        }
 
        /**
-        * @since 28.0
+        * @since 28.0.0
         */
        public function getToken(): IToken {
                return $this->token;

diff --git a/lib/public/Authentication/Token/IToken.php b/lib/public/Authentication/Token/IToken.php
index e6161f3b14cdaa1bbc2c49f980a37f2df80d7182..7b6ce8327c60bd547bd4f5584b3ffff628a460d2 100644 (file)
--- a/lib/public/Authentication/Token/IToken.php
+++ b/lib/public/Authentication/Token/IToken.php
@@ -32,10 +32,25 @@ use JsonSerializable;
  * @since 28.0.0
  */
 interface IToken extends JsonSerializable {
+       /**
+        * @since 28.0.0
+        */
        public const TEMPORARY_TOKEN = 0;
+       /**
+        * @since 28.0.0
+        */
        public const PERMANENT_TOKEN = 1;
+       /**
+        * @since 28.0.0
+        */
        public const WIPE_TOKEN = 2;
+       /**
+        * @since 28.0.0
+        */
        public const DO_NOT_REMEMBER = 0;
+       /**
+        * @since 28.0.0
+        */
        public const REMEMBER = 1;
 
        /**