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

Merge pull request #469 from matrix-org/rav/fix_jsdoc_build

Browse Source 
fix jsdoc
This commit is contained in:
Richard van der Hoff
2017-06-20 14:01:14 +01:00
committed by GitHub
parent 8c9150db66 d7f92b4f72
commit c96f7e5a13
3 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/crypto/OlmDevice.js
View File

@@ -589,7 +589,7 @@ OlmDevice.prototype.getOutboundGroupSessionKey = function(sessionId) {
* @property {string} room_Id * @property {string} room_Id
* @property {string} session pickled Olm.InboundGroupSession * @property {string} session pickled Olm.InboundGroupSession
* @property {Object<string, string>} keysClaimed * @property {Object<string, string>} keysClaimed
* @property {[string]} forwardingCurve25519KeyChain Devices involved in forwarding * @property {Array<string>} forwardingCurve25519KeyChain Devices involved in forwarding
* this session to us (normally empty). * this session to us (normally empty).
*/ */
@@ -661,7 +661,7 @@ OlmDevice.prototype._getInboundGroupSession = function(
* *
* @param {string} roomId room in which this session will be used * @param {string} roomId room in which this session will be used
* @param {string} senderKey base64-encoded curve25519 key of the sender * @param {string} senderKey base64-encoded curve25519 key of the sender
* @param {string[]} forwardingCurve25519KeyChain Devices involved in forwarding * @param {Array<string>} forwardingCurve25519KeyChain Devices involved in forwarding
* this session to us. * this session to us.
* @param {string} sessionId session identifier * @param {string} sessionId session identifier
* @param {string} sessionKey base64-encoded secret key * @param {string} sessionKey base64-encoded secret key
@@ -781,7 +781,7 @@ OlmDevice.prototype.importInboundGroupSession = function(data) {
* @return {null} the sessionId is unknown * @return {null} the sessionId is unknown
* *
* @return {{result: string, senderKey: string, * @return {{result: string, senderKey: string,
* forwardingCurve25519KeyChain: [string], * forwardingCurve25519KeyChain: Array<string>,
* keysClaimed: Object<string, string>}} * keysClaimed: Object<string, string>}}
*/ */
OlmDevice.prototype.decryptGroupMessage = function( OlmDevice.prototype.decryptGroupMessage = function(
@@ -864,8 +864,8 @@ OlmDevice.prototype.hasInboundSessionKeys = function(roomId, senderKey, sessionI
* @param {string} sessionId session identifier * @param {string} sessionId session identifier
* *
* @returns {{chain_index: number, key: string, * @returns {{chain_index: number, key: string,
* forwarding_curve25519_key_chain: [string], * forwarding_curve25519_key_chain: Array<string>,
* sender_claimed_ed25519_key: string, * sender_claimed_ed25519_key: string
* }} * }}
* details of the session key. The key is a base64-encoded megolm key in * details of the session key. The key is a base64-encoded megolm key in
* export format. * export format.

2
src/models/event.js
View File

@@ -316,7 +316,7 @@ utils.extend(module.exports.MatrixEvent.prototype, {
* @param {string=} claimedEd25519Key ed25519 key claimed by the sender of * @param {string=} claimedEd25519Key ed25519 key claimed by the sender of
* this event. See {@link module:models/event.MatrixEvent#getClaimedEd25519Key}. * this event. See {@link module:models/event.MatrixEvent#getClaimedEd25519Key}.
* *
* @param {string[]=} forwardingCurve25519KeyChain list of curve25519 keys * @param {Array<string>=} forwardingCurve25519KeyChain list of curve25519 keys
* involved in telling us about the senderCurve25519Key and claimedEd25519Key. * involved in telling us about the senderCurve25519Key and claimedEd25519Key.
* See {@link module:models/event.MatrixEvent#getForwardingCurve25519KeyChain}. * See {@link module:models/event.MatrixEvent#getForwardingCurve25519KeyChain}.
*/ */

3
travis.sh
View File

@@ -8,3 +8,6 @@ npm run lint
npm install https://matrix.org/packages/npm/olm/olm-2.2.2.tgz npm install https://matrix.org/packages/npm/olm/olm-2.2.2.tgz
npm run test npm run test
npm run gendoc