class and method descriptions added

Author: ivanproskuryakov

sample/sample17-controllers-inheritance/controllers/AbstractContollerTemplate.ts

@@ -9,7 +9,13 @@ import {Body} from "../../../src/decorator/Body";
 import {MockedRepository} from "../repository/MockedRepository";
 import {IInstance} from "../interface/IInstance";
 
+/**
+ * @description the base controller class used by derivatives
+ */
 export abstract class AbstractControllerTemplate {
+  /**
+   * @description domain part of a system, also called object|entity|model
+   */
   protected domain: string;
   protected repository: MockedRepository;
 

sample/sample17-controllers-inheritance/repository/MockedRepository.ts

@@ -8,6 +8,9 @@ export class MockedRepository {
     this.domain = domain;
   }
 
+  /**
+   * @description Dummy method to return collection of items
+   */
   public getCollection(): Promise<IInstance[]> {
     return Promise.resolve([
       {
@@ -25,6 +28,9 @@ export class MockedRepository {
     ]);
   }
 
+  /**
+   * @description Dummy method to create a new item in storage and return its instance
+   */
   public create(payload: IPayload): Promise<IInstance> {
     return Promise.resolve(
       {
@@ -34,6 +40,9 @@ export class MockedRepository {
     );
   }
 
+  /**
+   * @description Dummy method to find item in storage
+   */
   public find(id: number): Promise<IInstance> {
     return Promise.resolve(
       {
@@ -43,10 +52,16 @@ export class MockedRepository {
     );
   }
 
+  /**
+   * @description Dummy method to delete item in storage by id
+   */
   public delete(id: number): Promise<void> {
     return Promise.resolve();
   }
 
+  /**
+   * @description Dummy method to update item in storage by id
+   */
   public update(id: number, payload: IPayload): Promise<IInstance> {
     return Promise.resolve(
       {