inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added JSDocs for directives (#2964)

Browse Source
This commit is contained in:
Andy Stark
2018-02-20 14:00:18 +00:00
committed by Eugenio Romano
parent d731cc651c
commit b45048b5ed
26 changed files with 137 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lib/process-services/process-list/components/process-audit.directive.ts
View File

@@ -33,21 +33,27 @@ const PDF_FORMAT: string = 'pdf';
})
export class ProcessAuditDirective implements OnChanges {
/** ID of the process. */
@Input('process-id')
processId: string;
/** Name of the file to download (for PDF downloads). */
@Input()
fileName: string = 'Audit';
/** Format for the audit information (can be "pdf" or "json"). */
@Input()
format: string = 'pdf';
/** Enables downloading of the audit file on clicking. */
@Input()
download: boolean = true;
/** Emitted when the decorated element is clicked. */
@Output()
clicked: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when an error occurs. */
@Output()
error: EventEmitter<any> = new EventEmitter<any>();

6
lib/process-services/task-list/components/task-audit.directive.ts
View File

@@ -33,21 +33,27 @@ const PDF_FORMAT: string = 'pdf';
})
export class TaskAuditDirective implements OnChanges {
/** (**required**) The id of the task. */
@Input('task-id')
taskId: string;
/** Name of the downloaded file (for PDF downloads). */
@Input()
fileName: string = 'Audit';
/** Format of the audit information. Can be "pdf" or "json". */
@Input()
format: string = 'pdf';
/** Enables downloading of the audit when the decorated element is clicked. */
@Input()
download: boolean = true;
/** Emitted when the decorated element is clicked. */
@Output()
clicked: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when an error occurs. */
@Output()
error: EventEmitter<any> = new EventEmitter<any>();