[ADF-1769] Added prop tables and JSDocs (#2906)

lib/content-services/tag/tag-actions.component.ts

@@ -34,15 +34,19 @@ import { TagService } from './services/tag.service';
 })
 export class TagActionsComponent implements OnChanges {
 
+    /** The identifier of a node. */
     @Input()
     nodeId: string;
 
+    /** Emitted when a tag is added successfully. */
     @Output()
     successAdd: EventEmitter<any> = new EventEmitter();
 
+    /** Emitted when an error occurs. */
     @Output()
     error: EventEmitter<any> = new EventEmitter();
 
+    /** Emitted when an action is chosen. */
     @Output()
     result = new EventEmitter();
 

lib/content-services/tag/tag-list.component.ts

@@ -35,6 +35,7 @@ export class TagListComponent implements OnInit {
 
     tagsEntries: any;
 
+    /** Emitted when a tag is selected. */
     @Output()
     result = new EventEmitter();
 

lib/content-services/tag/tag-node-list.component.ts

@@ -32,12 +32,13 @@ import { TagService } from './services/tag.service';
     encapsulation: ViewEncapsulation.None
 })
 export class TagNodeListComponent implements OnChanges {
-
+    /** The identifier of a node. */
     @Input()
     nodeId: string;
 
     tagsEntries: any;
 
+    /** Emitted when a tag is selected. */
     @Output()
     results = new EventEmitter();
 

lib/core/form/components/start-form.component.ts

@@ -48,24 +48,31 @@ import { FormOutcomeModel } from './widgets/core/index';
 })
 export class StartFormComponent extends FormComponent implements OnChanges, OnInit {
 
+    /** Definition ID of the process to start. */
     @Input()
     processDefinitionId: string;
 
+    /** Process ID of the process to start. */
     @Input()
     processId: string;
 
+    /** Should form outcome buttons be shown? */
     @Input()
     showOutcomeButtons: boolean = true;
 
+    /** Should the refresh button be shown? */
     @Input()
     showRefreshButton: boolean = true;
 
+    /** Is the form read-only (ie, can't be edited)? */
     @Input()
     readOnlyForm: boolean = false;
 
+    /** Emitted when the user clicks one of the outcome buttons that completes the form. */
     @Output()
     outcomeClick: EventEmitter<any> = new EventEmitter<any>();
 
+    /** Emitted when a field of the form is clicked. */
     @Output()
     formContentClicked: EventEmitter<ContentLinkModel> = new EventEmitter<ContentLinkModel>();
 

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

@@ -30,18 +30,28 @@ export class TaskAttachmentListComponent implements OnChanges, AfterContentInit
     @ContentChild(EmptyListComponent)
     emptyTemplate: EmptyListComponent;
 
+    /** (**required**) The ID of the task to display. */
     @Input()
     taskId: string;
 
+    /** Disable/Enable read only mode for attachement list. */
     @Input()
     disabled: boolean = false;
 
+    /** Emitted when the attachment is double-clicked or a view
+     * option is selected from the context menu by the user from within the component.
+     * Returns a Blob representing the clicked object.
+     */
     @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 an error occurs while fetching the attachments. */
     @Output()
     error: EventEmitter<any> = new EventEmitter<any>();
 

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

@@ -46,30 +46,43 @@ import { AttachFileWidgetComponent, AttachFolderWidgetComponent } from '../../co
 })
 export class StartProcessInstanceComponent implements OnChanges {
 
+    /** (optional) Limit the list of processes that can be started to those
+     * contained in the specified app.
+     */
     @Input()
     appId: number;
 
+    /** (optional) Definition name of the process to start. */
     @Input()
     processDefinitionName: string;
 
+    /** Variables in input to the process
+     * [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md).
+     */
     @Input()
     variables: ProcessInstanceVariable[];
 
+    /** Parameter to pass form field values in the start form if it is associated. */
     @Input()
     values: FormValues;
 
+    /** (optional) Name to assign to the current process. */
     @Input()
     name: string;
 
+    /** Hide or show the process selection drodown. */
     @Input()
     showSelectProcessDropdown: boolean = true;
 
+    /** Emitted when the process starts. */
     @Output()
     start: EventEmitter<ProcessInstance> = new EventEmitter<ProcessInstance>();
 
+    /** Emitted when the process is canceled. */
     @Output()
     cancel: EventEmitter<ProcessInstance> = new EventEmitter<ProcessInstance>();
 
+    /** Emitted when an error occurs. */
     @Output()
     error: EventEmitter<ProcessInstance> = new EventEmitter<ProcessInstance>();
 

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

@@ -40,15 +40,19 @@ export class StartTaskComponent implements OnInit {
 
     public FORMAT_DATE: string = 'DD/MM/YYYY';
 
+    /** (required) The id of the app. */
     @Input()
     appId: number;
 
+    /** Emitted when the task is successfully created. */
     @Output()
     success: EventEmitter<any> = new EventEmitter<any>();
 
+    /** Emitted when the cancel button is clicked by the user. */
     @Output()
     cancel: EventEmitter<void> = new EventEmitter<void>();
 
+    /** Emitted when an error occurs. */
     @Output()
     error: EventEmitter<any> = new EventEmitter<any>();