From ddcd2234e671036e736652c3c34b14313ee5cb09 Mon Sep 17 00:00:00 2001 From: ianmuchyri Date: Fri, 25 Oct 2024 14:48:11 +0300 Subject: [PATCH] fix comment for enable Signed-off-by: ianmuchyri --- src/channels.ts | 2 +- src/domains.ts | 2 +- src/groups.ts | 2 +- src/things.ts | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/channels.ts b/src/channels.ts index 731b5ec8..12f2a127 100644 --- a/src/channels.ts +++ b/src/channels.ts @@ -289,7 +289,7 @@ export default class Channels { public async Enable (channelId: string, domainId: string, token: string): Promise { // Enables channel with specified id. /** - * @method Enable - Enables channel with specified id. + * @method Enable - Enables a previously disabled channel with specified id. * @param {Object} channelId - Channel ID. * @param {string} domainId - The Domain ID. * @param {String} token - Authentication token. diff --git a/src/domains.ts b/src/domains.ts index 8097e016..7f58b047 100644 --- a/src/domains.ts +++ b/src/domains.ts @@ -282,7 +282,7 @@ export default class Domains { public async EnableDomain (domainID: string, token: string): Promise { // EnableDomain enables domain with provided ID. /** - * @method EnableDomain - Enables domain with provided ID. + * @method EnableDomain - Enables a previously disabled domain with provided ID. * @param {string} domainId - The Domain ID. * @param {string} token - user token. * @returns {object} - returns an object Response that carries the status code and a response message. diff --git a/src/groups.ts b/src/groups.ts index 5fbe0221..a3bcc0d4 100644 --- a/src/groups.ts +++ b/src/groups.ts @@ -239,7 +239,7 @@ export default class Groups { public async EnableGroup (groupId: string, domainId: string, token: string): Promise { // Enable a group. /** - * @method EnableGroup - Enables a group when given a valid token and group ID. + * @method EnableGroup - Enables a previously disabled group when given a valid token and group ID. * @param {string} groupId - The group's ID. * @param {string} domainId - The Domain ID. * @param {string} token - The user's access token. diff --git a/src/things.ts b/src/things.ts index 249cb809..1ff1efef 100644 --- a/src/things.ts +++ b/src/things.ts @@ -178,7 +178,7 @@ export default class Things { public async Enable (thingId: string, domainId: string, token: string): Promise { // Enables a thing. /** - * @method Enable - Enables a thing when provided with a valid token and thing ID. + * @method Enable - Enables a previously disabled thing when provided with a valid token and thing ID. * @param {string} thingID - Thing ID. * @param {string} domainId - The Domain ID. * @param {string} token - User token.