Mark old classes as deprecated

matrix-org · May 26, 2023 · 78fb7ba · 78fb7ba
1 parent 9c5e1d2
commit 78fb7ba
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/src/crypto/verification/Base.ts b/src/crypto/verification/Base.ts
@@ -57,6 +57,7 @@ export type VerificationEventHandlerMap = {
     [VerificationEvent.Cancel]: (e: Error | MatrixEvent) => void;
 };
 
+/** @deprecated Avoid referencing this class directly; instead use {@link Crypto.Verifier}. */
 // The type parameters of VerificationBase are no longer used, but we need some placeholders to maintain
 // backwards compatibility with applications that reference the class.
 export class VerificationBase<

diff --git a/src/crypto/verification/QRCode.ts b/src/crypto/verification/QRCode.ts
@@ -36,6 +36,7 @@ export type QrCodeEvent = VerifierEvent;
 /** @deprecated use VerifierEvent */
 export const QrCodeEvent = VerifierEvent;
 
+/** @deprecated Avoid referencing this class directly; instead use {@link Crypto.Verifier}. */
 export class ReciprocateQRCode extends Base {
     public reciprocateQREvent?: ShowQrCodeCallbacks;
 

diff --git a/src/crypto/verification/SAS.ts b/src/crypto/verification/SAS.ts
@@ -219,6 +219,7 @@ export type SasEvent = VerifierEvent;
 /** @deprecated use VerifierEvent */
 export const SasEvent = VerifierEvent;
 
+/** @deprecated Avoid referencing this class directly; instead use {@link Crypto.Verifier}. */
 export class SAS extends Base {
     private waitingForAccept?: boolean;
     public ourSASPubKey?: string;