[ADF-2905] Updated JSDocs for content services (#3269)

* [ADF-2905] Updated JSDocs for content services * [ADF-2905] Added missing update to version manager MD file
2025-07-24 17:32:15 +00:00 · 2018-05-04 13:56:01 +01:00
parent b393708514
commit 563af3bbfa
15 changed files with 50 additions and 40 deletions
--- a/docs/content-services/add-permission-panel.component.md
+++ b/docs/content-services/add-permission-panel.component.md
@@ -1,12 +1,12 @@
 ---
 Added: v2.4.0
 Status: Active
-Last reviewed: 2018-05-03
+Last reviewed: 2018-05-04
 ---

 # Add Permission Component

-Allow user to search people or group that could be added to the current node permissions.
+Searches for people or groups to add to the current node permissions.

 ![Add Permission Component](../docassets/images/add-permission-component.png)

@@ -14,24 +14,20 @@ Allow user to search people or group that could be added to the current node per

 ```html
 <adf-add-permission [nodeId]="nodeId"
-                    (success)="onSuccess($event)" (error)="onError($event)">
+    (success)="onSuccess($event)" (error)="onError($event)">
 </adf-add-permission>
 ```

 ## Class members

-### Properties
-
-| Name | Type | Default value | Description |
-| -- | -- | -- | -- |
-
 ### Events

 | Name | Type | Description |
 | -- | -- | -- |
-| select | `EventEmitter<MinimalNodeEntryEntity>` |  |
+| select | `EventEmitter<any>` | Emitted when a permission list item is selected. |

 ## Details
+
 This component uses a [Search component](../search.component.md) to retrieve the
 groups and people that could be added to the permission list of the current node.
-The `select` event will be emitted when a result is clicked from the list.
+The `select` event is emitted when a result is clicked from the list.
--- a/docs/content-services/add-permission.component.md
+++ b/docs/content-services/add-permission.component.md
@@ -6,7 +6,7 @@ Last reviewed: 2018-05-03

 # Add Permission Component

-Allow user to search people or group that could be added to the current node permissions.
+Searches for people or groups to add to the current node permissions.

 ![Add Permission Component](../docassets/images/add-permission-component.png)

@@ -14,7 +14,7 @@ Allow user to search people or group that could be added to the current node per

 ```html
 <adf-add-permission [nodeId]="nodeId"
-                    (success)="onSuccess($event)" (error)="onError($event)">
+    (success)="onSuccess($event)" (error)="onError($event)">
 </adf-add-permission>
 ```

@@ -24,18 +24,17 @@ Allow user to search people or group that could be added to the current node per

 | Name | Type | Default value | Description |
 | -- | -- | -- | -- |
-| nodeId | `string` | "" |  |
+| nodeId | `string` |  | ID of the target node. |

 ### Events

 | Name | Type | Description |
 | -- | -- | -- |
-| success | `EventEmitter<MinimalNodeEntryEntity>` |  |
-| error | `EventEmitter<any>` |  |
+| error | `EventEmitter<any>` | Emitted when an error occurs during the update. |
+| success | `EventEmitter<MinimalNodeEntryEntity>` | Emitted when the node is updated successfully. |

 ## Details

 This component extends the [Add permission panel component](../add-permission-panel.component.md) 
 and apply the action confirm when the selection made is accepted.
-The `success` event will be emitted when the node is correctly updated.
-The `error` event will be thrown whenever the node update permission will fail.
+
--- a/docs/content-services/document-list.service.md
+++ b/docs/content-services/document-list.service.md
@@ -18,7 +18,7 @@ Implements node operations used by the Document List component.
    -   `targetParentId: string = null` -  The id of the folder where the node will be copied
    -   **Returns** `Observable<any>` - NodeEntry for the copied node
 -   `createFolder(name: string = null, parentId: string = null): Observable<MinimalNodeEntity>`<br/>
-    Create a new folder in the path.
+    Creates a new folder in the path.
    -   `name: string = null` -  Folder name
    -   `parentId: string = null` -  Parent folder ID
    -   **Returns** `Observable<MinimalNodeEntity>` - Details of the created folder node
@@ -51,7 +51,7 @@ Implements node operations used by the Document List component.
    -   **Returns** `string` - Path to the icon file
 -   `getNode(nodeId: string = null, includeFields: string[] =  []): Observable<NodeEntry>`<br/>
    Gets a node via its node ID.
-    -   `nodeId: string = null` -  
+    -   `nodeId: string = null` -  ID of the target node
    -   `includeFields: string[] =  []` -  Extra information to include (available options are "aspectNames", "isLink" and "association")
    -   **Returns** `Observable<NodeEntry>` - Details of the folder
 -   `hasPermission(node: any = null, permission: PermissionsEnum | string = null): boolean`<br/>
@@ -61,7 +61,7 @@ Implements node operations used by the Document List component.
    -   **Returns** `boolean` - True if the node has the permission, false otherwise

 -   `moveNode(nodeId: string = null, targetParentId: string = null): Observable<any>`<br/>
-    Move a node to destination node
+    Moves a node to destination node.
    -   `nodeId: string = null` -  The id of the node to be moved
    -   `targetParentId: string = null` -  The id of the folder where the node will be moved
    -   **Returns** `Observable<any>` - NodeEntry for the moved node
--- a/docs/content-services/rating.service.md
+++ b/docs/content-services/rating.service.md
@@ -1,6 +1,7 @@
 ---
 Added: v2.0.0
 Status: Active
+Last reviewed: 2018-05-04
 ---

 # Rating service
@@ -15,18 +16,18 @@ Manages ratings for items in Content Services.
    Removes the current user's rating for a node.
    -   `nodeId: string = null` -  Target node
    -   `ratingType: any = null` -  Type of rating to remove (can be "likes" or "fiveStar")
-    -   **Returns** `any` - 
+    -   **Returns** `any` - Null response indicating that the operation is complete
 -   `getRating(nodeId: string = null, ratingType: any = null): any`<br/>
    Gets the current user's rating for a node.
    -   `nodeId: string = null` -  Node to get the rating from
    -   `ratingType: any = null` -  Type of rating (can be "likes" or "fiveStar")
-    -   **Returns** `any` - 
+    -   **Returns** `any` - The rating value
 -   `postRating(nodeId: string = null, ratingType: any = null, vote: any = null): any`<br/>
    Adds the current user's rating for a node.
    -   `nodeId: string = null` -  Target node for the rating
    -   `ratingType: any = null` -  Type of rating (can be "likes" or "fiveStar")
    -   `vote: any = null` -  Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
-    -   **Returns** `any` -
+    -   **Returns** `any` - Details about the rating, including the new value

 ## Details

--- a/docs/content-services/upload-drag-area.component.md
+++ b/docs/content-services/upload-drag-area.component.md
@@ -1,7 +1,7 @@
 ---
 Added: v2.0.0
 Status: Active
-Last reviewed: 2018-04-16
+Last reviewed: 2018-05-04
 ---

 # Upload Drag Area Component
@@ -42,7 +42,7 @@ export class AppComponent {
 | maxFilesSize | `number` |  | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
 | rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
 | versioning | `boolean` | false | Toggles versioning. |
-| parentId | `` |  |  |
+| parentId | `` |  | **Deprecated:** 2.4.0  use rootFolderId ID of parent folder node. |

 ### Events

--- a/docs/content-services/version-list.component.md
+++ b/docs/content-services/version-list.component.md
@@ -21,9 +21,9 @@ Displays the version history of a node in a Version Manager component
 | -- | -- | -- | -- |
 | allowDownload | `boolean` | true | Enable/disable possibility to download a version of the current node. |
 | id | `string` |  | **Deprecated:** in 2.3.0 |
-| node | `MinimalNodeEntryEntity` |  |  |
-| showActions | `boolean` | true | show/hide version actions |
-| showComments | `boolean` | true | show/hide comments |
+| node | `MinimalNodeEntryEntity` |  | The target node. |
+| showActions | `boolean` | true | Toggles showing/hiding of version actions |
+| showComments | `boolean` | true | Toggles showing/hiding of comments |

 ## Details

--- a/docs/content-services/version-manager.component.md
+++ b/docs/content-services/version-manager.component.md
@@ -28,16 +28,16 @@ Displays the version history of a node with the ability to upload a new version.

 | Name | Type | Default value | Description |
 | -- | -- | -- | -- |
-| allowDownload | `boolean` | true |  |
-| node | `MinimalNodeEntryEntity` |  |  |
-| showComments | `boolean` | true |  |
+| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
+| node | `MinimalNodeEntryEntity` |  | Target node to manage version history. |
+| showComments | `boolean` | true | Toggles showing/hiding of comments. |

 ### Events

 | Name | Type | Description |
 | -- | -- | -- |
-| uploadError | `EventEmitter<Object>` |  |
-| uploadSuccess | `EventEmitter<Object>` |  |
+| uploadError | `EventEmitter<Object>` | Emitted when an error occurs during upload. |
+| uploadSuccess | `EventEmitter<Object>` | Emitted when a file is uploaded successfully. |

 ## Details