[ADF-1769] Added JSDocs for services (#2961)

lib/core/services/thumbnail.service.ts

@@ -156,8 +156,8 @@ export class ThumbnailService {
     }
 
     /**
-     * Get thumbnail URL for the given document node.
-     * @param document Node to get URL for.
+     * Gets a thumbnail URL for the given document node.
+     * @param node Node to get URL for.
      */
     public getDocumentThumbnailUrl(node: any): string {
         let thumbnail = this.contentService.getDocumentThumbnailUrl(node);
@@ -165,8 +165,8 @@ export class ThumbnailService {
     }
 
     /**
-     * Get mimeType SVG
-     * @param mimeType
+     * Gets a thumbnail URL for a MIME type.
+     * @param mimeType MIME type for the thumbnail
      */
     public getMimeTypeIcon(mimeType: string): string {
         let icon = this.mimeTypeIcons[mimeType];
@@ -174,7 +174,7 @@ export class ThumbnailService {
     }
 
     /**
-     * Get default SVG
+     * Gets a "miscellaneous" thumbnail URL for types with no other icon defined.
      */
     public getDefaultMimeTypeIcon(): string {
         return this.DEFAULT_ICON;

lib/core/services/translation.service.ts

@@ -62,6 +62,11 @@ export class TranslationService {
         });
     }
 
+    /**
+     * Adds a new folder of translation source files.
+     * @param name Name for the translation provider
+     * @param path Path to the folder
+     */
     addTranslationFolder(name: string = '', path: string = '') {
         if (!this.customLoader.providerRegistered(name)) {
             this.customLoader.registerProvider(name, path);
@@ -83,15 +88,29 @@ export class TranslationService {
         }
     }
 
+    /**
+     * Sets the target language for translations.
+     * @param lang Code name for the language
+     */
     use(lang: string): Observable<any> {
         this.customLoader.init(lang);
         return this.translate.use(lang);
     }
 
+    /**
+     * Gets the translation for the supplied key.
+     * @param key Key to translate
+     * @param interpolateParams String(s) to be interpolated into the main message
+     */
     get(key: string|Array<string>, interpolateParams?: Object): Observable<string|any> {
         return this.translate.get(key, interpolateParams);
     }
 
+    /**
+     * Directly returns the translation for the supplied key.
+     * @param key Key to translate
+     * @param interpolateParams String(s) to be interpolated into the main message
+     */
     instant(key: string | Array<string>, interpolateParams?: Object): string | any {
         return this.translate.instant(key, interpolateParams);
     }

lib/core/services/upload.service.ts

@@ -72,12 +72,8 @@ export class UploadService {
     }
 
     /**
-     * Add files to the uploading queue to be uploaded.
-     *
-     * Examples:
-     *  addToQueue(file); // pass one file
-     *  addToQueue(file1, file2, file3); // pass multiple files
-     *  addToQueue(...[file1, file2, file3]); // pass an array of files
+     * Adds files to the uploading queue to be uploaded
+     * @param files One or more separate parameters or an array of files to queue
      */
     addToQueue(...files: FileModel[]): FileModel[] {
         const allowedFiles = files.filter(f => this.filterElement(f));
@@ -96,9 +92,9 @@ export class UploadService {
     }
 
     /**
-     * Pick all the files in the queue that are not been uploaded yet and upload it into the directory folder.
+     * Finds all the files in the queue that are not yet uploaded and uploads them into the directory folder.
      *
-     * @param emitter @deprecated emitter to invoke on file status change
+     * @param emitter (Deprecated) Emitter to invoke on file status change
      *
      * @memberof UploadService
      */
@@ -127,6 +123,10 @@ export class UploadService {
         }
     }
 
+    /**
+     * Cancels uploading of files.
+     * @param files One or more separate parameters or an array of files
+     */
     cancelUpload(...files: FileModel[]) {
         files.forEach(file => {
             const promise = this.cache[file.id];
@@ -141,6 +141,7 @@ export class UploadService {
         });
     }
 
+    /** Clears the upload queue */
     clearQueue() {
         this.queue = [];
         this.totalComplete = 0;
@@ -148,6 +149,10 @@ export class UploadService {
         this.totalError = 0;
     }
 
+    /**
+     * Gets an upload promise for a file.
+     * @param file The target file
+     */
     getUploadPromise(file: FileModel) {
         let opts: any = {
             renditions: 'doclib'

lib/core/services/user-preferences.service.ts

@@ -48,6 +48,11 @@ export class UserPreferencesService {
         this.defaults.supportedPageSizes = this.appConfig.get('pagination.supportedPageSizes', this.defaults.supportedPageSizes);
     }
 
+    /**
+     * Gets a preference property.
+     * @param property Name of the property
+     * @param defaultValue Default to return if the property is not found
+     */
     get(property: string, defaultValue?: string): string {
         const key = this.getPropertyKey(property);
         const value = this.storage.getItem(key);
@@ -57,6 +62,11 @@ export class UserPreferencesService {
         return value;
     }
 
+    /**
+     * Sets a preference property.
+     * @param property Name of the property
+     * @param value New value for the property
+     */
     set(property: string, value: any) {
         if (!property) { return; }
 
@@ -66,22 +76,33 @@ export class UserPreferencesService {
         );
     }
 
+    /** Gets the active storage prefix for preferences. */
     getStoragePrefix(): string {
         return this.storage.getItem('USER_PROFILE') || 'GUEST';
     }
 
+    /**
+     * Sets the active storage prefix for preferences.
+     * @param value Name of the prefix
+     */
     setStoragePrefix(value: string) {
         this.storage.setItem('USER_PROFILE', value || 'GUEST');
     }
 
+    /**
+     * Gets the full property key with prefix.
+     * @param property The property name
+     */
     getPropertyKey(property: string): string {
         return `${this.getStoragePrefix()}__${property}`;
     }
 
+    /** Gets an array containing the available page sizes. */
     getDifferentPageSizes(): number[] {
         return this.defaults.supportedPageSizes;
     }
 
+    /** Authorization type (can be "ECM", "BPM" or "ALL"). */
     set authType(value: string) {
         this.storage.setItem('AUTH_TYPE', value);
         this.apiService.reset();
@@ -91,6 +112,7 @@ export class UserPreferencesService {
         return this.storage.getItem('AUTH_TYPE') || 'ALL';
     }
 
+    /** Prevents the CSRF Token from being submitted if true. Only valid for Process Services. */
     set disableCSRF(value: boolean) {
         this.set('DISABLE_CSRF', value);
         this.apiService.reset();
@@ -100,6 +122,7 @@ export class UserPreferencesService {
         return this.get('DISABLE_CSRF') === 'true';
     }
 
+    /** Pagination size. */
     set paginationSize(value: number) {
         this.set('PAGINATION_SIZE', value);
     }
@@ -108,6 +131,7 @@ export class UserPreferencesService {
         return Number(this.get('PAGINATION_SIZE')) || this.defaults.paginationSize;
     }
 
+    /** Current locale setting. */
     get locale(): string {
         const locale = this.get('LOCALE');
         return locale;
@@ -118,6 +142,7 @@ export class UserPreferencesService {
         this.set('LOCALE', value);
     }
 
+    /** Gets the default locale. */
     public getDefaultLocale(): string {
         return this.appConfig.get<string>('locale') || this.translate.getBrowserLang() || 'en';
     }