[ADF-1769] Added JSDocs and methods and updated script (#2927)

lib/core/services/content.service.ts

@@ -133,7 +133,7 @@ export class ContentService {
     /**
      * Get thumbnail URL for the given document node.
      *
-     * @param {string|MinimalNodeEntity} nodeId or node to get URL for.
+     * @param {string|MinimalNodeEntity} node Node to get URL for.
      * @param {boolean} [attachment] Retrieve content as an attachment for download
      * @param {string} [ticket] Custom ticket to use for authentication
      * @returns {string} The URL address pointing to the content.
@@ -166,7 +166,7 @@ export class ContentService {
 
     /**
      * Get content for the given node.
-     * @param nodeId {string}.
+     * @param nodeId ID of the target node
      *
      * @returns {Observable<any>} URL address.
      */
@@ -178,7 +178,9 @@ export class ContentService {
 
     /**
      * Create a folder
-     * @param name - the folder name
+     * @param relativePath Location to create the folder
+     * @param name Folder name
+     * @param parentId Node ID of parent folder
      */
     createFolder(relativePath: string, name: string, parentId?: string): Observable<FolderCreatedEvent> {
         return Observable.fromPromise(this.apiService.getInstance().nodes.createFolder(name, relativePath, parentId))
@@ -195,8 +197,8 @@ export class ContentService {
 
     /**
      * Check if the user has permissions on that node
-     * @param MinimalNode -  node to check allowableOperations
-     * @param PermissionsEnum - create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
+     * @param node Node to check allowableOperations
+     * @param permission Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
      *
      * @returns {boolean} has permission
      */
@@ -221,7 +223,7 @@ export class ContentService {
 
     /**
      * Check if the node has the properties allowableOperations
-     * @param MinimalNode -  node to check allowableOperations
+     * @param node Node to check allowableOperations
      *
      * @returns {boolean} has AllowableOperations
      */

lib/core/services/cookie.service.ts

@@ -20,6 +20,9 @@ import { Injectable } from '@angular/core';
 @Injectable()
 export class CookieService {
 
+    /**
+     * Checks if cookies are enabled.
+     */
     isEnabled(): boolean {
         // for certain scenarios Chrome may say 'true' but have cookies still disabled
         if (navigator.cookieEnabled === false) {
@@ -31,8 +34,8 @@ export class CookieService {
     }
 
     /**
-     * Retrieve cookie by key.
-     *
+     * Retrieves a cookie by its key.
+     * @param key Key to identify the cookie
      * @returns {string | null}
      */
     getItem(key: string): string | null {
@@ -43,10 +46,10 @@ export class CookieService {
 
     /**
      * Set a cookie.
-     * @param key
-     * @param data
-     * @param expiration
-     * @param path
+     * @param key Key to identify the cookie
+     * @param data Data value to set for the cookie
+     * @param expiration Expiration date of the data
+     * @param path "Pathname" to store the cookie
      *
      * @returns {boolean}
      */

lib/core/services/deleted-nodes-api.service.ts

@@ -33,6 +33,10 @@ export class DeletedNodesApiService {
        return this.apiService.getInstance().core.nodesApi;
     }
 
+    /**
+     * Gets a list of nodes in the trash.
+     * @param options Options for JSAPI call
+     */
     getDeletedNodes(options?: Object): Observable<NodePaging> {
         const { nodesApi, handleError } = this;
         const defaultOptions = {

lib/core/services/discovery-api.service.ts

@@ -28,6 +28,9 @@ export class DiscoveryApiService {
 
     constructor(private apiService: AlfrescoApiService) { }
 
+    /**
+     * Gets product information for Content Services.
+     */
     public getEcmProductInfo() {
         return Observable.fromPromise(
             this.apiService.getInstance().discovery.discoveryApi.getRepositoryInformation())
@@ -35,6 +38,9 @@ export class DiscoveryApiService {
             .catch(this.handleError);
     }
 
+    /**
+     * Gets product information for Process Services.
+     */
     public getBpmProductInfo() {
         return Observable.fromPromise(
             this.apiService.getInstance().activiti.aboutApi.getAppVersion())

lib/core/userinfo/services/ecm-user.service.ts

@@ -33,8 +33,8 @@ export class EcmUserService {
     }
 
     /**
-     * get User Information via ECM
-     * @param userName - the user name
+     * Gets information about a user identified by their username.
+     * @param userName Target username
      */
     getUserInfo(userName: string): Observable<EcmUserModel> {
         return Observable.fromPromise(this.apiService.getInstance().core.peopleApi.getPerson(userName))
@@ -42,10 +42,17 @@ export class EcmUserService {
             .catch(err => this.handleError(err));
     }
 
+    /**
+     * Gets information about the user who is currently logged-in.
+     */
     getCurrentUserInfo() {
         return this.getUserInfo('-me-');
     }
 
+    /**
+     * Returns a profile image as a URL.
+     * @param avatarId Target avatar
+     */
     getUserProfileImage(avatarId: string) {
         if (avatarId) {
             let nodeObj = {entry: {id: avatarId}};