[ADF-3745] Added docs for proc cloud services (#4183)

lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts

@@ -33,6 +33,7 @@ export class AppsProcessCloudService {
 
     /**
      * Gets a list of deployed apps for this user by status.
+     * @param status Required status value
      * @returns The list of deployed apps
      */
     getDeployedApplicationsByStatus(status: string): Observable<ApplicationInstanceModel[]> {

lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts

@@ -44,11 +44,11 @@ export class PeopleCloudComponent implements OnInit {
     static MODE_SINGLE = 'single';
     static MODE_MULTIPLE = 'multiple';
 
-    /** Name of the application. If specified, shows the users who have access to the app. */
+    /** Name of the application. If specified, this shows the users who have access to the app. */
     @Input()
     appName: string;
 
-    /** Mode of the user selection (single/multiple). */
+    /** User selection mode (single/multiple). */
     @Input()
     mode: string = PeopleCloudComponent.MODE_SINGLE;
 
@@ -56,7 +56,11 @@ export class PeopleCloudComponent implements OnInit {
     @Input()
     roles: string[];
 
-    /** Array of users to be pre-selected. Pre-select all users in multi selection mode and only the first user of the array in single selection mode. */
+    /**
+     * Array of users to be pre-selected. All users in the
+     * array are pre-selected in multi selection mode, but only the first user
+     * is pre-selected in single selection mode.
+     */
     @Input()
     preSelectUsers: IdentityUserModel[];
 

lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts

@@ -38,7 +38,7 @@ import { TaskDetailsCloudModel } from '../../start-task/models/task-details-clou
 })
 export class TaskHeaderCloudComponent implements OnInit {
 
-    /** (Required) The appName */
+    /** (Required) The name of the application. */
     @Input()
     appName: string;
 
@@ -46,7 +46,7 @@ export class TaskHeaderCloudComponent implements OnInit {
     @Input()
     taskId: string;
 
-    /** The id of the task. */
+    /** Toggles Read Only Mode. This disables click selection and editing for all cells. */
     @Input()
     readOnly: boolean = false;
 

lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts

@@ -36,6 +36,12 @@ export class TaskHeaderCloudService {
         this.contextRoot = this.appConfigService.get('bpmHost', '');
     }
 
+    /**
+     * Gets details of a task.
+     * @param appName Name of the app
+     * @param taskId ID of the task whose details you want
+     * @returns Task details
+     */
     getTaskById(appName: string, taskId: string): Observable<TaskDetailsCloudModel> {
         if (appName && taskId) {
 
@@ -58,6 +64,13 @@ export class TaskHeaderCloudService {
         }
     }
 
+    /**
+     * Updates the details (name, description, due date) for a task.
+     * @param appName Name of the app
+     * @param taskId ID of the task to update
+     * @param updatePayload Data to update the task
+     * @returns Updated task details
+     */
     updateTask(appName: string, taskId: string, updatePayload: any): any {
         if (appName && taskId) {
 
@@ -82,6 +95,13 @@ export class TaskHeaderCloudService {
         }
     }
 
+    /**
+     * Claims a task for an assignee.
+     * @param appName Name of the app
+     * @param taskId ID of the task to claim
+     * @param assignee User to assign the task to
+     * @returns Details of the claimed task
+     */
     claimTask(appName: string, taskId: string, assignee: string): any {
         if (appName && taskId) {
 
@@ -104,6 +124,12 @@ export class TaskHeaderCloudService {
         }
     }
 
+    /**
+     * Un-claims a task.
+     * @param appName Name of the app
+     * @param taskId ID of the task to unclaim
+     * @returns Details of the task that was unclaimed
+     */
     unclaimTask(appName: string, taskId: string): any {
         if (appName && taskId) {