[ADF-1769] Added JSDocs and updated prop table script (#2838)

* [ADF-1769] Added JSDocs and updated prop table script

* [ADF-1769] Fixed lint error in JSDoc
This commit is contained in:
Andy Stark
2018-01-17 17:11:22 +00:00
committed by Eugenio Romano
parent 3461749dc6
commit c9a3b048b4
25 changed files with 194 additions and 100 deletions

View File

@@ -37,15 +37,21 @@ export class AppsListComponent implements OnInit {
public static DEFAULT_TASKS_APP_ICON: string = 'glyphicon-asterisk';
public static DEFAULT_TASKS_APP_MATERIAL_ICON: string = 'favorite_border';
/** (**required**) Defines the layout of the apps. There are two possible
* values, "GRID" and "LIST".
*/
@Input()
layoutType: string = AppsListComponent.LAYOUT_GRID;
/** Provides a way to filter the apps to show. */
@Input()
filtersAppId: any[];
/** Emitted when an app entry is clicked. */
@Output()
appClick: EventEmitter<AppDefinitionRepresentationModel> = new EventEmitter<AppDefinitionRepresentationModel>();
/** Emitted when an error occurs. */
@Output()
error: EventEmitter<any> = new EventEmitter<any>();

View File

@@ -25,12 +25,19 @@ import { ProcessContentService } from '@alfresco/adf-core';
})
export class CreateProcessAttachmentComponent implements OnChanges {
/** (required) The ID of the process instance to display. */
@Input()
processInstanceId: string;
/** Emitted when an error occurs while creating or uploading an attachment
* from the user within the component.
*/
@Output()
error: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when an attachment is successfully created or uploaded
* from within the component.
*/
@Output()
success: EventEmitter<any> = new EventEmitter<any>();

View File

@@ -25,12 +25,19 @@ import { ProcessContentService } from '@alfresco/adf-core';
})
export class AttachmentComponent implements OnChanges {
/** (required) The numeric ID of the task to display. */
@Input()
taskId: string;
/** Emitted when an error occurs while creating or uploading an
* attachment from the user within the component.
*/
@Output()
error: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when an attachment is created or uploaded successfully
* from within the component.
*/
@Output()
success: EventEmitter<any> = new EventEmitter<any>();

View File

@@ -27,9 +27,11 @@ import { Component, EventEmitter, Input, Output } from '@angular/core';
export class CommentListComponent {
/** The comments data used to populate the list. */
@Input()
comments: CommentProcessModel[];
/** Emitted when the user clicks on one of the comment rows. */
@Output()
clickRow: EventEmitter<CommentProcessModel> = new EventEmitter<CommentProcessModel>();

View File

@@ -27,12 +27,15 @@ import { Observer } from 'rxjs/Observer';
})
export class CommentsComponent implements OnChanges {
/** The numeric ID of the task. */
@Input()
taskId: string;
/** Are the comments read only? */
@Input()
readOnly: boolean = false;
/** Emitted when an error occurs while displaying/adding a comment. */
@Output()
error: EventEmitter<any> = new EventEmitter<any>();

View File

@@ -30,21 +30,31 @@ import { TaskListService } from './../services/tasklist.service';
})
export class ChecklistComponent implements OnInit, OnChanges {
/** (required) The id of the parent task to which subtasks are
* attached.
*/
@Input()
taskId: string;
/** Toggle readonly state of the form. All form widgets
* will render as readonly if enabled.
*/
@Input()
readOnly: boolean = false;
/** (required) The assignee id that the subtasks are assigned to. */
@Input()
assignee: string;
/** Emitted when a new checklist task is created. */
@Output()
checklistTaskCreated: EventEmitter<TaskDetailsModel> = new EventEmitter<TaskDetailsModel>();
/** Emitted when a checklist task is deleted. */
@Output()
checklistTaskDeleted: EventEmitter<string> = new EventEmitter<string>();
/** Emitted when an error occurs. */
@Output()
error: EventEmitter<any> = new EventEmitter<any>();