[ADF-1769] Added prop tables and fixed script (#2896)

* [ADF-1769] Added prop tables and fixed script

* [ADF-1769] Corrected JSDoc formatting errors

* [ADF-1769] Restored default column to prop tables

lib/process-services/attachment/process-attachment-list.component.ts

@@ -30,18 +30,31 @@ export class ProcessAttachmentListComponent implements OnChanges, AfterContentIn
     @ContentChild(EmptyListComponent)
     emptyTemplate: EmptyListComponent;
 
+    /** (**required**) The ID of the process instance to display. */
     @Input()
     processInstanceId: string;
 
+    /** Disable/Enable read-only mode for attachment list. */
     @Input()
     disabled: boolean = false;
 
+    /** Emitted when the attachment is double-clicked or the
+     * view option is selected from the context menu by the user from
+     * within the component. Returns a Blob representing the object
+     * that was clicked.
+     */
     @Output()
     attachmentClick = new EventEmitter();
 
+    /** Emitted when the attachment list has fetched all the attachments.
+     * Returns a list of attachments.
+     */
     @Output()
     success = new EventEmitter();
 
+    /** Emitted when the attachment list is not able to fetch the attachments
+     * (eg, following a network error).
+     */
     @Output()
     error: EventEmitter<any> = new EventEmitter<any>();
 

lib/process-services/comments/process-comments.component.ts

@@ -27,12 +27,15 @@ import { Observer } from 'rxjs/Observer';
 })
 export class ProcessCommentsComponent implements OnChanges {
 
+    /** (**required**) The numeric ID of the process instance to display comments for. */
     @Input()
     processInstanceId: string;
 
+    /** Should the comments be read-only? */
     @Input()
     readOnly: boolean = true;
 
+    /** Emitted when an error occurs. */
     @Output()
     error: EventEmitter<any> = new EventEmitter<any>();
 

lib/process-services/people/components/people-list/people-list.component.ts

@@ -33,15 +33,19 @@ export class PeopleListComponent implements AfterViewInit, AfterContentInit {
     @ViewChild(DataTableComponent)
     peopleDataTable: DataTableComponent;
 
+    /** The array of user data used to populate the people list. */
     @Input()
     users: UserProcessModel[];
 
+    /** Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. */
     @Input()
     actions: boolean = false;
 
+    /** Emitted when the user clicks a row in the people list. */
     @Output()
     clickRow: EventEmitter<UserProcessModel> = new EventEmitter<UserProcessModel>();
 
+    /** Emitted when the user clicks in the 'Three Dots' drop down menu for a row. */
     @Output()
     clickAction: EventEmitter<UserEventModel> = new EventEmitter<UserEventModel>();
 

lib/process-services/people/components/people/people.component.ts

@@ -30,12 +30,15 @@ import { PeopleSearchComponent } from '../people-search/people-search.component'
 })
 export class PeopleComponent implements OnInit, AfterViewInit {
 
+    /** The array of User objects to display. */
     @Input()
     people: UserProcessModel[] = [];
 
+    /** The numeric ID of the task. */
     @Input()
     taskId: string = '';
 
+    /** Should the data be read-only? */
     @Input()
     readOnly: boolean = false;
 

lib/process-services/process-list/components/process-filters.component.ts

@@ -30,24 +30,33 @@ import { ProcessFilterService } from './../services/process-filter.service';
 })
 export class ProcessFiltersComponent implements OnInit, OnChanges {
 
+    /** The parameters to filter the task filter. If there is no match then the default one
+     * (ie, the first filter in the list) is selected.
+     */
     @Input()
     filterParam: FilterProcessRepresentationModel;
 
+    /** Emitted when the user selects a filter from the list. */
     @Output()
     filterClick: EventEmitter<ProcessInstanceFilterRepresentation> = new EventEmitter<ProcessInstanceFilterRepresentation>();
 
+    /** Emitted when the list of filters has been successfully loaded from the server. */
     @Output()
     success: EventEmitter<ProcessInstanceFilterRepresentation[]> = new EventEmitter<ProcessInstanceFilterRepresentation[]>();
 
+    /** Emitted when an error occurs. */
     @Output()
     error: EventEmitter<any> = new EventEmitter<any>();
 
+    /** Display filters available to the current user for the application with the specified ID. */
     @Input()
     appId: number;
 
+    /** Display filters available to the current user for the application with the specified name. */
     @Input()
     appName: string;
 
+    /** Toggle to show or hide the filter's icon. */
     @Input()
     showIcon: boolean = true;
 

lib/process-services/process-list/components/process-instance-details.component.ts

@@ -32,6 +32,7 @@ import { ProcessInstanceTasksComponent } from './process-instance-tasks.componen
 })
 export class ProcessInstanceDetailsComponent implements OnChanges {
 
+    /** (required) The numeric ID of the process instance to display. */
     @Input()
     processInstanceId: string;
 
@@ -41,23 +42,29 @@ export class ProcessInstanceDetailsComponent implements OnChanges {
     @ViewChild(ProcessInstanceTasksComponent)
     tasksList: ProcessInstanceTasksComponent;
 
+    /** Toggles whether to show or hide the title. */
     @Input()
     showTitle: boolean = true;
 
+    /** Toggles whether to show or hide the refresh button. */
     @Input()
     showRefreshButton: boolean = true;
 
+    /** Emitted when the current process is cancelled by the user from within the component. */
     @Output()
     processCancelled: EventEmitter<any> = new EventEmitter<any>();
 
+    /** Emitted when an error occurs. */
     @Output()
     error: EventEmitter<any> = new EventEmitter<any>();
 
+    /** Emitted when a task is clicked. */
     @Output()
     taskClick: EventEmitter<TaskDetailsEvent> = new EventEmitter<TaskDetailsEvent>();
 
     processInstanceDetails: ProcessInstance;
 
+    /** Emitted when the "show diagram" button is clicked. */
     @Output()
     showProcessDiagram: EventEmitter<any> = new EventEmitter<any>();
 

lib/process-services/process-list/components/process-instance-header.component.ts

@@ -26,6 +26,7 @@ import { ProcessInstance } from '../models/process-instance.model';
 })
 export class ProcessInstanceHeaderComponent implements OnChanges {
 
+    /** (**required**) Full details of the process instance to display information about. */
     @Input()
     processInstance: ProcessInstance;
 

lib/process-services/process-list/components/process-instance-tasks.component.ts

@@ -32,12 +32,17 @@ import { ProcessService } from './../services/process.service';
 })
 export class ProcessInstanceTasksComponent implements OnInit, OnChanges {
 
+    /** (**required**) The ID of the process instance to display tasks for. */
     @Input()
     processInstanceDetails: ProcessInstance;
 
+    /** Toggles whether to show a refresh button next to the list of tasks to allow
+     * it to be updated from the server.
+     */
     @Input()
     showRefreshButton: boolean = true;
 
+    /** Emitted when an error occurs. */
     @Output()
     error: EventEmitter<any> = new EventEmitter<any>();
 
@@ -59,6 +64,7 @@ export class ProcessInstanceTasksComponent implements OnInit, OnChanges {
     @ViewChild('taskdetails')
     taskdetails: any;
 
+    /** Emitted when a task is clicked. */
     @Output()
     taskClick: EventEmitter<TaskDetailsEvent> = new EventEmitter<TaskDetailsEvent>();
 

lib/process-services/process-list/components/process-list.component.ts

@@ -33,35 +33,47 @@ export class ProcessInstanceListComponent implements OnChanges, AfterContentInit
 
     @ContentChild(DataColumnListComponent) columnList: DataColumnListComponent;
 
+    /** The id of the app. */
     @Input()
     appId: number;
 
+    /** The processDefinitionKey of the process. */
     @Input()
     processDefinitionKey: string;
 
+    /** Defines the state of the processes. Possible values are `running`, `completed` and `all` */
     @Input()
     state: string;
 
+    /** Defines the sort ordering of the list. Possible values are `created-desc`, `created-asc`,
+     * `ended-desc`, `ended-asc`.
+     */
     @Input()
     sort: string;
 
+    /** The name of the list. */
     @Input()
     name: string;
 
+    /** The presetColumn of the custom schema to fetch. */
     @Input()
     presetColumn: string;
 
     requestNode: ProcessFilterParamRepresentationModel;
 
+    /** Data source to define the datatable. */
     @Input()
     data: DataTableAdapter;
 
+    /** Emitted when a row in the process list is clicked. */
     @Output()
     rowClick: EventEmitter<string> = new EventEmitter<string>();
 
+    /** Emitted when the list of process instances has been loaded successfully from the server. */
     @Output()
     success: EventEmitter<ProcessInstance[]> = new EventEmitter<ProcessInstance[]>();
 
+    /** Emitted when an error occurs while loading the list of process instances from the server. */
     @Output()
     error: EventEmitter<any> = new EventEmitter<any>();