[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

lib/content-services/document-list/services/document-list.service.ts

@@ -90,7 +90,7 @@ export class DocumentListService {
     }
 
     /**
-     * Move a node to destination node
+     * Moves a node to destination node.
      *
      * @param nodeId The id of the node to be moved
      * @param targetParentId The id of the folder where the node will be moved
@@ -102,7 +102,7 @@ export class DocumentListService {
     }
 
     /**
-     * Create a new folder in the path.
+     * Creates a new folder in the path.
      * @param name Folder name
      * @param parentId Parent folder ID
      * @returns Details of the created folder node
@@ -128,7 +128,7 @@ export class DocumentListService {
 
     /**
      * Gets a node via its node ID.
-     * @param nodeId
+     * @param nodeId ID of the target node
      * @param includeFields Extra information to include (available options are "aspectNames", "isLink" and "association")
      * @returns Details of the folder
      */

lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts

@@ -38,6 +38,7 @@ export class AddPermissionPanelComponent {
     @ViewChild('search')
     search: SearchComponent;
 
+    /** Emitted when a permission list item is selected. */
     @Output()
     select: EventEmitter<any> = new EventEmitter();
 

lib/content-services/permission-manager/components/add-permission/add-permission.component.ts

@@ -27,12 +27,15 @@ import { NodePermissionService } from '../../services/node-permission.service';
 })
 export class AddPermissionComponent {
 
+    /** ID of the target node. */
     @Input()
     nodeId: string;
 
+    /** Emitted when the node is updated successfully. */
     @Output()
     success: EventEmitter<MinimalNodeEntryEntity> = new EventEmitter();
 
+    /** Emitted when an error occurs during the update. */
     @Output()
     error: EventEmitter<any> = new EventEmitter();
 

lib/content-services/social/services/rating.service.ts

@@ -32,6 +32,7 @@ export class RatingService {
      * Gets the current user's rating for a node.
      * @param nodeId Node to get the rating from
      * @param ratingType Type of rating (can be "likes" or "fiveStar")
+     * @returns The rating value
      */
     getRating(nodeId: string, ratingType: any): any {
         return Observable.fromPromise(this.apiService.getInstance().core.ratingsApi.getRating(nodeId, ratingType))
@@ -44,6 +45,7 @@ export class RatingService {
      * @param nodeId Target node for the rating
      * @param ratingType Type of rating (can be "likes" or "fiveStar")
      * @param vote Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
+     * @returns Details about the rating, including the new value
      */
     postRating(nodeId: string, ratingType: any, vote: any): any {
         let ratingBody: RatingBody = {
@@ -59,6 +61,7 @@ export class RatingService {
      * Removes the current user's rating for a node.
      * @param nodeId Target node
      * @param ratingType Type of rating to remove (can be "likes" or "fiveStar")
+     * @returns Null response indicating that the operation is complete
      */
     deleteRating(nodeId: string, ratingType: any): any {
         return Observable.fromPromise(this.apiService.getInstance().core.ratingsApi.removeRating(nodeId, ratingType))

lib/content-services/tag/services/tag.service.ts

@@ -23,6 +23,7 @@ import 'rxjs/add/observable/throw';
 @Injectable()
 export class TagService {
 
+    /** Emitted when tag information is updated. */
     @Output()
     refresh = new EventEmitter();
 

lib/content-services/upload/components/upload-drag-area.component.ts

@@ -34,7 +34,7 @@ import { UploadBase } from './base-upload/upload-base';
 })
 export class UploadDragAreaComponent extends UploadBase implements NodePermissionSubject {
 
-    /** @deprecaretd 2.4.0  use rootFolderId ID of parent folder node. */
+    /** @deprecated 2.4.0  use rootFolderId ID of parent folder node. */
     @Input()
     set parentId(nodeId: string) {
         this.rootFolderId = nodeId;

lib/content-services/version-manager/version-list.component.ts

@@ -40,18 +40,19 @@ export class VersionListComponent implements OnChanges {
     @Input()
     id: string;
 
+    /** The target node. */
     @Input()
     node: MinimalNodeEntryEntity;
 
-    /** show/hide comments */
+    /** Toggles showing/hiding of comments */
     @Input()
     showComments = true;
 
-    /** Enable/disable possibility to download a version of the current node. */
+    /** Enable/disable downloading a version of the current node. */
     @Input()
     allowDownload = true;
 
-    /** show/hide version actions */
+    /** Toggles showing/hiding of version actions */
     @Input()
     showActions = true;
 

lib/content-services/version-manager/version-manager.component.ts

@@ -43,18 +43,23 @@ import { trigger, state, style, animate, transition } from '@angular/animations'
 })
 export class VersionManagerComponent {
 
+    /** Target node to manage version history. */
     @Input()
     node: MinimalNodeEntryEntity;
 
+    /** Toggles showing/hiding of comments. */
     @Input()
     showComments = true;
 
+    /** Enable/disable downloading a version of the current node. */
     @Input()
     allowDownload = true;
 
+    /** Emitted when a file is uploaded successfully. */
     @Output()
     uploadSuccess = new EventEmitter();
 
+    /** Emitted when an error occurs during upload. */
     @Output()
     uploadError = new EventEmitter();