fix comment for enable

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
absmach · Oct 25, 2024 · ddcd223 · ddcd223
1 parent 4d00010
commit ddcd223
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git 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<Channel> {
     // 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
@@ -282,7 +282,7 @@ export default class Domains {
   public async EnableDomain (domainID: string, token: string): Promise<Response> {
     // 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
@@ -239,7 +239,7 @@ export default class Groups {
   public async EnableGroup (groupId: string, domainId: string, token: string): Promise<Group> {
     // 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
@@ -178,7 +178,7 @@ export default class Things {
   public async Enable (thingId: string, domainId: string, token: string): Promise<Thing> {
     // 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.