OpenCloud
/
riot-web
mirror of https://github.com/vector-im/riot-web
1
0
Fork 0
Code Issues Releases Wiki Activity

Improve _addMatrixClientListener docs

pull/21833/head
Luke Barnard 2017-12-13 15:43:39 +00:00
parent 31ea092d99
commit fe6b7c0ea2
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/actions/MatrixActionCreators.js
View File

@ -81,8 +81,8 @@ export default {
}, },
/** /**
* Start listening to events emitted by matrixClient, dispatch an action created by the * Start listening to events of type eventName on matrixClient and when they are emitted,
* actionCreator function. * dispatch an action created by the actionCreator function.
* @param {MatrixClient} matrixClient a MatrixClient to register a listener with. * @param {MatrixClient} matrixClient a MatrixClient to register a listener with.
* @param {string} eventName the event to listen to on MatrixClient. * @param {string} eventName the event to listen to on MatrixClient.
* @param {function} actionCreator a function that should return an action to dispatch * @param {function} actionCreator a function that should return an action to dispatch