From 70a5208fccda054a3cad96700d361cbfc20cd89f Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 20 Jun 2017 13:33:04 +0100 Subject: [PATCH 1/2] Run gendoc as part of the travis build ... so that I don't get surprised by it not working when it lands on develop --- travis.sh | 3 +++ 1 file changed, 3 insertions(+) diff --git a/travis.sh b/travis.sh index 5f47ad56a..68d915def 100755 --- a/travis.sh +++ b/travis.sh @@ -8,3 +8,6 @@ npm run lint npm install https://matrix.org/packages/npm/olm/olm-2.2.2.tgz npm run test + +npm run gendoc + From d7f92b4f7205aacb98eece91f39687bf3066ae00 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 20 Jun 2017 13:51:08 +0100 Subject: [PATCH 2/2] fix jsdoc --- src/crypto/OlmDevice.js | 10 +++++----- src/models/event.js | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/crypto/OlmDevice.js b/src/crypto/OlmDevice.js index 0f4615958..392b059ee 100644 --- a/src/crypto/OlmDevice.js +++ b/src/crypto/OlmDevice.js @@ -589,7 +589,7 @@ OlmDevice.prototype.getOutboundGroupSessionKey = function(sessionId) { * @property {string} room_Id * @property {string} session pickled Olm.InboundGroupSession * @property {Object} keysClaimed - * @property {[string]} forwardingCurve25519KeyChain Devices involved in forwarding + * @property {Array} forwardingCurve25519KeyChain Devices involved in forwarding * 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} senderKey base64-encoded curve25519 key of the sender - * @param {string[]} forwardingCurve25519KeyChain Devices involved in forwarding + * @param {Array} forwardingCurve25519KeyChain Devices involved in forwarding * this session to us. * @param {string} sessionId session identifier * @param {string} sessionKey base64-encoded secret key @@ -781,7 +781,7 @@ OlmDevice.prototype.importInboundGroupSession = function(data) { * @return {null} the sessionId is unknown * * @return {{result: string, senderKey: string, - * forwardingCurve25519KeyChain: [string], + * forwardingCurve25519KeyChain: Array, * keysClaimed: Object}} */ OlmDevice.prototype.decryptGroupMessage = function( @@ -864,8 +864,8 @@ OlmDevice.prototype.hasInboundSessionKeys = function(roomId, senderKey, sessionI * @param {string} sessionId session identifier * * @returns {{chain_index: number, key: string, - * forwarding_curve25519_key_chain: [string], - * sender_claimed_ed25519_key: string, + * forwarding_curve25519_key_chain: Array, + * sender_claimed_ed25519_key: string * }} * details of the session key. The key is a base64-encoded megolm key in * export format. diff --git a/src/models/event.js b/src/models/event.js index cbe2fd91d..748009d98 100644 --- a/src/models/event.js +++ b/src/models/event.js @@ -316,7 +316,7 @@ utils.extend(module.exports.MatrixEvent.prototype, { * @param {string=} claimedEd25519Key ed25519 key claimed by the sender of * this event. See {@link module:models/event.MatrixEvent#getClaimedEd25519Key}. * - * @param {string[]=} forwardingCurve25519KeyChain list of curve25519 keys + * @param {Array=} forwardingCurve25519KeyChain list of curve25519 keys * involved in telling us about the senderCurve25519Key and claimedEd25519Key. * See {@link module:models/event.MatrixEvent#getForwardingCurve25519KeyChain}. */