Skip to content

Commit b3ec086

Browse files
authored
Restore broken link to CryptoApi (#4692)
1 parent e287ff6 commit b3ec086

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

src/@types/crypto.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ interface Extensible {
3030

3131
/* eslint-disable camelcase */
3232

33-
/** The result of a call to CryptoApi.exportRoomKeys */
33+
/** The result of a call to {@link crypto-api!CryptoApi.exportRoomKeys} */
3434
export interface IMegolmSessionData extends Extensible {
3535
/** Sender's Curve25519 device key */
3636
sender_key: string;

src/crypto-api/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ export interface CryptoApi {
584584
/**
585585
* Determine if a key backup can be trusted.
586586
*
587-
* @param info - key backup info.
587+
* @param info - key backup info dict from {@link CryptoApi.getKeyBackupInfo}.
588588
*/
589589
isKeyBackupTrusted(info: KeyBackupInfo): Promise<BackupTrustInfo>;
590590

src/models/device.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export type DeviceMap = Map<string, Map<string, Device>>;
2727
type DeviceParameters = Pick<Device, "deviceId" | "userId" | "algorithms" | "keys"> & Partial<Device>;
2828

2929
/**
30-
* Information on a user's device, as returned by CryptoApi.getUserDeviceInfo.
30+
* Information on a user's device, as returned by {@link crypto-api!CryptoApi.getUserDeviceInfo}.
3131
*/
3232
export class Device {
3333
/** id of the device */

src/models/event.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1079,7 +1079,7 @@ export class MatrixEvent extends TypedEventEmitter<MatrixEventEmittedEvents, Mat
10791079
* signing the public curve25519 key with the ed25519 key.
10801080
*
10811081
* In general, applications should not use this method directly, but should
1082-
* instead use CryptoApi#getEncryptionInfoForEvent.
1082+
* instead use {@link crypto-api!CryptoApi#getEncryptionInfoForEvent}.
10831083
*/
10841084
public getClaimedEd25519Key(): string | null {
10851085
return this.claimedEd25519Key;

0 commit comments

Comments
 (0)