Second part of the action comment refactoring

ref #39

src/models/actions/CreatePermission.ts

@@ -11,33 +11,33 @@ import { PermissionAction } from '../enums/PermissionAction';
 import { PermissionTarget } from '../enums/PermissionTargets';
 
 /**
- * Defines a track of given length.
-*/
+ * This classed is used to create a new Permission entity from a json body (post request).
+ */
 export class CreatePermission {
 
     /**
-     * The permissions's principal's id.
+     * The new permissions's principal's id.
      */
     @IsInt()
     @IsNotEmpty()
     principal: number;
 
     /**
-     * The permissions's target.
+     * The new permissions's target.
      */
     @IsNotEmpty()
     @IsEnum(PermissionTarget)
     target: PermissionTarget;
 
     /**
-     * The permissions's action.
+     * The new permissions's action.
      */
     @IsNotEmpty()
     @IsEnum(PermissionAction)
     action: PermissionAction;
 
     /**
-     * Converts a Permission object based on this.
+     * Creates a new Permission entity from this.
      */
     public async toPermission(): Promise<Permission> {
         let newPermission: Permission = new Permission();
@@ -49,6 +49,9 @@ export class CreatePermission {
         return newPermission;
     }
 
+    /**
+     * Gets the new permission's principal by it's id.
+     */
     public async getPrincipal(): Promise<Principal> {
         let principal = await getConnectionManager().get().getRepository(Principal).findOne({ id: this.principal })
         if (!principal) { throw new PrincipalNotFoundError(); }