matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-26 17:03:12 +03:00
Code Activity

Fix jsdocs

Browse Source
This commit is contained in:
Richard van der Hoff
2017-06-07 11:02:27 +01:00
parent 2c54d76085
commit 4b6575d94a
3 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/crypto/algorithms/base.js
View File

@@ -89,6 +89,7 @@ export {EncryptionAlgorithm}; // https://github.com/jsdoc3/jsdoc/issues/1272
/**
* base type for decryption implementations
*
* @alias module:crypto/algorithms/base.DecryptionAlgorithm
* @param {object} params parameters
* @param {string} params.userId The UserID for the local user
* @param {module:crypto} params.crypto crypto core
@@ -144,7 +145,7 @@ class DecryptionAlgorithm {
/**
* Determine if we have the keys necessary to respond to a room key request
*
* @param {module:crypto#RoomKeyRequest} keyRequest
* @param {module:crypto~IncomingRoomKeyRequest} keyRequest
* @return {boolean} true if we have the keys and could (theoretically) share
* them; else false.
*/
@@ -155,7 +156,7 @@ class DecryptionAlgorithm {
/**
* Send the response to a room key request
*
* @param {module:crypto#RoomKeyRequest} keyRequest
* @param {module:crypto~IncomingRoomKeyRequest} keyRequest
*/
shareKeysWithDevice(keyRequest) {
throw new Error("shareKeysWithDevice not supported for this DecryptionAlgorithm");