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

Fix function doc syntax

Browse Source
This commit is contained in:
J. Ryan Stinnett
2019-09-18 10:38:52 +01:00
parent 2bfa891f0a
commit 745185e689
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/client.js
View File

@@ -4154,7 +4154,7 @@ MatrixClient.prototype.stopClient = function() {
global.clearTimeout(this._checkTurnServersTimeoutID); global.clearTimeout(this._checkTurnServersTimeoutID);
}; };
/* /**
* Get the API versions supported by the server, along with any * Get the API versions supported by the server, along with any
* unstable APIs it supports * unstable APIs it supports
* @return {Promise<object>} The server /versions response * @return {Promise<object>} The server /versions response
@@ -4174,7 +4174,7 @@ MatrixClient.prototype.getVersions = async function() {
return this._serverVersionsCache; return this._serverVersionsCache;
}; };
/* /**
* Query the server to see if it support members lazy loading * Query the server to see if it support members lazy loading
* @return {Promise<boolean>} true if server supports lazy loading * @return {Promise<boolean>} true if server supports lazy loading
*/ */
@@ -4188,7 +4188,7 @@ MatrixClient.prototype.doesServerSupportLazyLoading = async function() {
|| (unstableFeatures && unstableFeatures["m.lazy_load_members"]); || (unstableFeatures && unstableFeatures["m.lazy_load_members"]);
}; };
/* /**
* Query the server to see if the `id_server` parameter is required * Query the server to see if the `id_server` parameter is required
* when registering with an 3pid, adding a 3pid or resetting password. * when registering with an 3pid, adding a 3pid or resetting password.
* @return {Promise<boolean>} true if id_server parameter is required * @return {Promise<boolean>} true if id_server parameter is required
@@ -4211,7 +4211,7 @@ MatrixClient.prototype.doesServerRequireIdServerParam = async function() {
} }
}; };
/* /**
* Query the server to see if the `id_access_token` parameter can be safely * Query the server to see if the `id_access_token` parameter can be safely
* passed to the homeserver. Some homeservers may trigger errors if they are not * passed to the homeserver. Some homeservers may trigger errors if they are not
* prepared for the new parameter. * prepared for the new parameter.
@@ -4243,7 +4243,7 @@ MatrixClient.prototype.doesServerSupportSeparateAddAndBind = async function() {
|| (unstableFeatures && unstableFeatures["m.separate_add_and_bind"]); || (unstableFeatures && unstableFeatures["m.separate_add_and_bind"]);
}; };
/* /**
* Get if lazy loading members is being used. * Get if lazy loading members is being used.
* @return {boolean} Whether or not members are lazy loaded by this client * @return {boolean} Whether or not members are lazy loaded by this client
*/ */
@@ -4251,7 +4251,7 @@ MatrixClient.prototype.hasLazyLoadMembersEnabled = function() {
return !!this._clientOpts.lazyLoadMembers; return !!this._clientOpts.lazyLoadMembers;
}; };
/* /**
* Set a function which is called when /sync returns a 'limited' response. * Set a function which is called when /sync returns a 'limited' response.
* It is called with a room ID and returns a boolean. It should return 'true' if the SDK * It is called with a room ID and returns a boolean. It should return 'true' if the SDK
* can SAFELY remove events from this room. It may not be safe to remove events if there * can SAFELY remove events from this room. It may not be safe to remove events if there