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

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

Browse Source 
* [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
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/comments.component.md
View File

@@ -1,4 +1,4 @@
# ADF Comments Component
# Comments Component
Displays comments from users involved in a specified task and allows an involved user to add a comment to the task.
@@ -16,12 +16,12 @@ Displays comments from users involved in a specified task and allows an involved
### Properties
| Name | Type | Description |
| --- | --- | --- |
| taskId | string | The numeric ID of the task |
| readOnly | boolean | The boolean flag |
| ---- | ---- | ----------- |
| taskId | `string` | The numeric ID of the task. |
| readOnly | `boolean` | Are the comments read only? <br/> Default value: `false` |
### Events
| Name | Description |
| --- | --- |
| error | Raised when an error occurs while displaying/adding a comment |
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | `EventEmitter<any>` | Emitted when an error occurs while displaying/adding a comment. |