matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-08-18 05:42:00 +03:00
Code Activity

Megolm: clarify jsdoc

Browse Source 
Clarify somewhat misleading jsdoc text
This commit is contained in:
Richard van der Hoff
2016-09-18 13:52:48 +01:00
parent 9e57a9352a
commit 4f22610499
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lib/crypto/algorithms/megolm.js
View File

@@ -171,9 +171,9 @@ MegolmEncryption.prototype._prepareNewSession = function(room) {
* @param {string} session_id * @param {string} session_id
* *
* @param {Object<string, Object<string, boolean>|boolean>} shareMap * @param {Object<string, Object<string, boolean>|boolean>} shareMap
* Map from userid to true (meaning this is a new user in the room, so all * Map from userid to either: true (meaning this is a new user in the room,
* of his devices need the keys), or a map from deviceid to true (meaning * so all of his devices need the keys); or a map from deviceid to true
* this user has one or more new devices, which need the keys). * (meaning this user has one or more new devices, which need the keys).
* *
* @return {module:client.Promise} Promise which resolves once the key sharing * @return {module:client.Promise} Promise which resolves once the key sharing
* message has been sent. * message has been sent.